Class: Arrow::Config

Inherits:

Object

• Object
• Object
• Arrow::Config

show all

Extends:

Forwardable

Includes:

HashUtilities

Defined in:

lib/arrow/config.rb

Overview

  section.

  [<b>loader</b>]
  The name of a class or module to use to load templates for use in the
  appserver. Defaults to 'Arrow::Template'.

Defined Under Namespace

Classes: ConfigStruct, Loader, YamlLoader

Constant Summary

DEFAULTS =

Define the layout and defaults for the underlying structs

{
  :logging      => { :global => 'notice' },

  :gems               => {
    :require_signed => false,
    :autoinstall    => false,
    :path           => Arrow::Path.new([ "gems", *Gem.path ]),
    :applets        => {},
  },

  :applets => {
    :path      => Arrow::Path.new( "applets:/www/applets" ),
    :pattern   => '**/*.rb',
    :pollInterval  => 5,
    :layout      => {},
    :config      => {},
    :missingApplet => '/missing',
    :errorApplet => '/error',
  },

  :templates => {
    :loader      => 'Arrow::Template',
    :path      => Arrow::Path.new( "templates:/www/templates" ),
    :cache     => true,
    :cacheConfig => {
      :maxNum     => 20,
      :maxSize    => (1<<17) * 20,
      :maxObjSize   => (1<<17),
      :expiration   => 36
    },
  },

  :session => {
    :idType      => 'md5:.',
    :lockType    => 'recommended',
    :storeType   => 'file:/tmp',
    :idName      => 'arrow-session',
    :rewriteUrls => true,
    :expires   => "+48h",
  },
}

Constants included from HashUtilities

HashMergeFunction

Class Attribute Summary

• + (Object) default_loader

  Returns the value of attribute default_loader.

• + (Object) loaders

  Returns the value of attribute loaders.

Instance Attribute Summary

• - (Object) create_time

  The time the configuration was loaded.

• - (Object) name

  The name of the associated record stored on permanent storage for this configuration.

Class Method Summary

• + (Object) get_loader(name = nil)

  Get the loader by the given name, creating a new one if one is not already instantiated.

• + (Object) load(source, loader_obj = nil)

  Read and return an Arrow::Config object from the given file or configuration source using the specified loader.

Instance Method Summary

• - (Boolean) changed?

  Returns true if the configuration has changed since it was last loaded, either by setting one of its members or changing the file from which it was loaded.

• - (Object) changed_reason

  If the configuration has changed, return the reason.

• - (Config) initialize(confighash = {}) constructor

  Create a new Arrow::Config object.

• - (Object) loader

  Fetch the loader from this config object, or create an instance of the default one if none is yet associated with it.

• - (Object) loader(new_loader)

  Change the configuration object’s loader.

• - (Object) method_missing(sym, *args) protected

  Hook up delegators to struct-members as they are called.

• - (Object) reload

  Reload the configuration from the original source if it has changed.

• - (Boolean) respond_to?(sym)

  Returns true for methods which can be autoloaded.

• - (Object) write(name = @name, *args)

  Write the configuration object using the specified name and any additional args.

Methods included from HashUtilities

#stringify_keys, #symbolify_keys

Methods inherited from Object

deprecate_class_method, deprecate_method, inherited

Methods included from Loggable

#log

199
200
201
202
203
204
205
206
207
208
209

# File 'lib/arrow/config.rb', line 199

def initialize( confighash={} )
  ihash = internify_keys( untaint_values(confighash) )
  mergedhash = DEFAULTS.merge( ihash, &HashMergeFunction )

  @struct      = ConfigStruct.new( mergedhash )
  @create_time = Time.now
  @name        = nil
  @loader      = nil

  super()
end

320
321
322
323
324
325
326
327
328
329
330
331
332
333

# File 'lib/arrow/config.rb', line 320

def method_missing( sym, *args )
  key = sym.to_s.sub( /(=|\?)$/, '' ).to_sym
  return nil unless @struct.member?( key )

  self.log.debug( "Autoloading #{key} accessors." )

  self.class.class_eval %{
    def #{key}; @struct.#{key}; end
    def #{key}=(*args); @struct.#{key} = *args; end
    def #{key}?; @struct.#{key}?; end
  }

  @struct.__send__( sym, *args )
end

164
165
166

# File 'lib/arrow/config.rb', line 164

def default_loader
  @default_loader
end

164
165
166

# File 'lib/arrow/config.rb', line 164

def loaders
  @loaders
end

224
225
226

# File 'lib/arrow/config.rb', line 224

def create_time
  @create_time
end

228
229
230

# File 'lib/arrow/config.rb', line 228

def name
  @name
end

170
171
172
173

# File 'lib/arrow/config.rb', line 170

def self::get_loader( name=nil )
  name ||= self.default_loader
  self.loaders[name] ||= Arrow::Config::Loader.create( name )
end

178
179
180
181
182
183
184
185
186
187
188
189
190

# File 'lib/arrow/config.rb', line 178

def self::load( source, loader_obj=nil )
  loader_obj = self.get_loader( loader_obj ) unless
    loader_obj.is_a?( Arrow::Config::Loader )
  my_source = source.dup
  my_source.untaint
  confighash = loader_obj.load( my_source )

  obj = new( confighash )
  obj.loader = loader_obj
  obj.name = my_source

  return obj
end

271
272
273

# File 'lib/arrow/config.rb', line 271

def changed?
  return self.changed_reason ? true : false
end

278
279
280
281
282
283
284
285
286
287

# File 'lib/arrow/config.rb', line 278

def changed_reason
  return "Struct was modified" if @struct.modified?

  if self.name && self.loader.is_newer?( self.name, self.create_time )
    return "Config source (%s) has been updated since %s" %
      [ self.name, self.create_time ]
  end

  return nil
end

245
246
247

# File 'lib/arrow/config.rb', line 245

def loader
  @loader ||= self.class.get_loader
end

234
235
236
237
238
239
240

# File 'lib/arrow/config.rb', line 234

def loader=( new_loader )
  if new_loader.is_a?( Arrow::Config::Loader )
    @loader = new_loader
  else
    @loader = self.class.get_loader( new_loader )
  end
end

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312

# File 'lib/arrow/config.rb', line 292

def reload
  return false unless @loader && @name

  # Even if reloading fails, reset the creation time so we don't keep
  # trying to reload a broken config
  self.create_time = Time.now

  confighash = @loader.load( @name )
  ihash = internify_keys( untaint_values(confighash) )
  mergedhash = DEFAULTS.merge( ihash, &HashMergeFunction )

  @struct = ConfigStruct.new( mergedhash )

rescue => err
  self.log.error "Error while trying to reload the config: %s" % err.message
  err.backtrace.each {|frame| self.log.debug "  " + frame }

  return false
else
  return true
end

262
263
264
265

# File 'lib/arrow/config.rb', line 262

def respond_to?( sym )
  return true if @struct.member?( sym.to_s.sub(/(=|\?)$/, '') )
  super
end

252
253
254
255
256
257
258

# File 'lib/arrow/config.rb', line 252

def write( name=@name, *args )
  raise ArgumentError,
    "No name associated with this config." unless name
  lobj = self.loader
  strHash = stringify_keys( @struct.to_h )
  self.loader.save( strHash, name, *args )
end