Class: Excursion::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/excursion/configuration.rb

Constant Summary collapse

DEFAULT_CONFIGURATION_OPTIONS = 
{
  # TODO
    # exclude_pattern: to exclude certain routes from being shared
    # include_pattern: to only include certain routes
  register_app: true, # whether or not to register the app automatically on init
  default_url_options: {}, # default_url_options used when building routes for this app
  retry_limit: 3, # retry limit for datastores that user remote servers
  enable_cors: false, # enables cross-origin resource sharing for this app
  cors_whitelist: :pool, # whitelist for allowing cors for specific domains - defaults to only allow registered excursion apps
  cors_blacklist: nil, # blacklist for denying cors for specific domains
  cors_allow_methods: %w(POST PUT PATCH GET DELETE), # list of allowed cors request methods (Access-Control-Allow-Methods)
  cors_allow_headers: %w(origin content-type accept x-requested-with x-csrf-token), # list of allowed cors request headers (Access-Control-Allow-Headers)
  cors_allow_credentials: true, # allow credentials with cors requests (Access-Control-Allow-Credentials)
  cors_max_age: 1728000 # cors max age (Access-Control-Max-Age)
}

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args) ⇒ Object

DEFAULT_CONFIGURATION_OPTIONS.keys.each do |key|

define_method "#{key.to_s}=" do |val|
  @changed[key] = [send(key), val]
  instance_variable_set "@#{key.to_s}", val
end

end



28
29
30
31
32
33
34
35
 
# File 'lib/excursion/configuration.rb', line 28

def method_missing(meth, *args)
  if meth.to_s.match(/\A(.*)=\Z/)
    @changed[$1] = [send($1), *args]
    instance_variable_set "@#{$1.to_s}", *args
  else
    instance_variable_get "@#{meth}"
  end
end

Instance Method Details

#changed ⇒ Object

Returns a hash of all the changed keys and values after being reconfigured



38
39
40
41
42
 
# File 'lib/excursion/configuration.rb', line 38

def changed
  @changed = {}
  to_hash.each { |key,val| @changed[key] = [@saved_state[key], val] if @saved_state[key] != val }
  @changed
end

#changed?(key) ⇒ Boolean

Check whether a key was changed after being reconfigured

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/excursion/configuration.rb', line 45

def changed?(key)
  changed.has_key?(key)
end

#configure(args = {}, &block) ⇒ Object

Pass arguments and/or a block to configure the available options



50
51
52
53
54
55
 
# File 'lib/excursion/configuration.rb', line 50

def configure(args={}, &block)
  save_state
  configure_with_args args
  configure_with_block &block if block_given?
  self
end

#configure_with_args(args) ⇒ Object

Accepts arguments which are used to configure available options



58
59
60
61
62
 
# File 'lib/excursion/configuration.rb', line 58

def configure_with_args(args)
  args.select { |k,v| DEFAULT_CONFIGURATION_OPTIONS.keys.include?(k) }.each do |key,val|
    instance_variable_set "@#{key.to_s}", val
  end
end

#configure_with_block(&block) ⇒ Object

Accepts a block which is used to configure available options



65
66
67
 
# File 'lib/excursion/configuration.rb', line 65

def configure_with_block(&block)
  self.instance_eval(&block) if block_given?
end

#save_state ⇒ Object

Saves a copy of the current state, to be used later to determine what was changed



70
71
72
73
 
# File 'lib/excursion/configuration.rb', line 70

def save_state
  @saved_state = clone.to_hash
  @changed = {}
end

#to_hash ⇒ Object Also known as: to_h 



75
76
77
78
79
80
81
 
# File 'lib/excursion/configuration.rb', line 75

def to_hash
  h = {}
  DEFAULT_CONFIGURATION_OPTIONS.keys.each do |key|
    h[key] = instance_variable_get "@#{key.to_s}"
  end
  h
end