application_configuration 1.2.2 → 1.5.0

data/README

@@ -0,0 +1,50 @@
+There are no setters available for the configuration settings. You have to edit the files in order to update the settings.
+To retrieve a setting: 
+app_config.setting_name
+
+or 
+Application::Configuration.setting_name
+In Rails the load order of configuration files is as follows:
+application_configuration.yml
+application_configuration_RAILS_ENV.yml
+Configuration settings behave just like Rails environment files do. If you have a configuration setting specified in both application_configuration.yml and application_configuration_development.yml the setting in application_configuration_development.yml will override the the one in application_configuration.yml.
+# application_configuration.yml:
+email_address: help@helium.com
+
+# application_configuration_development.yml:
+email_address: help@localhost
+
+# console in development mode:
+app_config.email_address # => 'help@localhost'
+
+# console in production or test mode:
+app_config.email_address # => 'help@helium.com'
+Settings get reloaded every minute by default. There is no need to restart the app if you make a config file change. This can be changed by setting the following in your config yml file:
+reload_settings_every: <%= 24.hours %> # or some other length of time.
+Settings can be namespaced. In order to help better ‘group’ settings together. Settings in the yml files can be namespace using the familiar Ruby syntax of ’::’:
+my::name: "mark bates" 
+my::email: "mbates@helium.com" 
+
+# console:
+app_config.my.name # => "mark bates" 
+app_config.my.email # => "mbates@helium.com
+
+app_config.my__name # => "mark bates" 
+app_config.my__email # => "mbates@helium.com" #notice the double '_'
+The config yml files get run through ERB so you can do things like:
+time_right_now: <%= Time.now %>
+twenty_four_hours: <%= 1.day %>
+To load additional files put the following in environment.rb (or your specific environment if you want to only load them in a particular environment):
+app_config.load_file(full_path_to_file)
+
+or
+Application::Configuration.load_file(full_path_to_file)
+
+Anything you set in this new file will override, if any, settings from the other files previously loaded. You can call ‘load_file’ as many times as you would like to load as many files as you like. The order in which you load the files determines the precedent for settings getting overridden, so make sure you load them in the correct sequence. The order in which these files get loaded in will be preserved on subsequent reloads of the settings.
+To reload settings you simply need to do the following:
+app_config.reload
+
+or
+Application::Configuration.reload
+
+Keep in mind that if you’re trying to reload the settings for your running app, it will do you no good to go into a console window and type this command as the settings are cached per instance of your rails app, and opening a console window is a different instance then the one currently running in mongel. If you wish to reload your settings on every request you can put this command in your application.rb file. But make sure you REMOVE it before you check in.

data/lib/application_configuration.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'singleton'
 require 'yaml'
 require 'erb'

data/test/application_configuration_unit_test.rb

@@ -0,0 +1,162 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'webrick'
+include WEBrick
+
+class ConfServlet < HTTPServlet::AbstractServlet
+  def do_GET(request, response)
+    # puts "request: #{request.inspect}"
+    h = {"url_test" => "remote", "some_remote_config" => "wizbang!"}
+    response.status = 200
+    response.body = h.to_yaml
+    response["Content-Type"] = "text/yaml"
+  end
+
+  alias :do_POST :do_GET
+end
+
+class ConfServer
+  
+  class << self
+    
+    attr_accessor :server
+    
+    def start
+      server = HTTPServer.new(:Port => 8000)
+      server.mount("/conf", ConfServlet)
+
+      ["TERM", "INT"].each do |signal|
+        trap(signal){server.shutdown}
+      end
+      server.start
+    end
+    
+    def stop
+      server.shutdown
+    end
+    
+  end
+  
+end
+
+
+class ApplicationConfigurationUnitTest < Test::Unit::TestCase
+
+  def setup
+    Application::Configuration.whiny_config_missing = false
+  end
+  
+  def teardown
+    Application::Configuration.whiny_config_missing = true
+  end
+  
+  def test_false
+    assert !app_config.should_be_false
+    assert_not_nil app_config.should_be_false
+  end
+
+  def test_param_doesnt_exist
+    assert_nil Application::Configuration.asldkfjasdfkljasdfsldj
+  end
+
+  def test_loads_application_configuration
+    assert_equal "bar", Application::Configuration.foo
+    assert_equal 4, Application::Configuration.four
+    assert_equal({"one" => 1, "two" => 2, "three" => 3}, Application::Configuration.my_hash)
+    assert_equal Time.now.beginning_of_month, Time.parse(Application::Configuration.my_time)
+    assert_equal([1, 2, 3, "mark", "bates"], Application::Configuration.my_array)
+  end
+  
+  def test_environment_overrides
+    assert_equal "rock!", Application::Configuration.pickles
+  end
+  
+  def test_reload_every
+    time = Application::Configuration.instance.last_reload_time
+    assert_not_nil time
+    assert_equal "bar", Application::Configuration.foo
+    sleep(3)
+    assert_equal "bar", Application::Configuration.foo
+    assert Application::Configuration.instance.last_reload_time > time
+  end
+  
+  def test_nested_arrays
+    assert_equal([["Pro", "Con"], ["Yes", "No"], ["For", "Against"], ["Agree", "Disagree"], ["Support", "Oppose"], ["True", "False"], ["Innocent", "Guilty"], ["Right", "Wrong"]], Application::Configuration.all_debate_pairing_options)
+  end
+  
+  def test_namespaces
+    assert_equal "my foo", Application::Configuration::instance.final_configuration_settings["my__foo"]
+    assert_equal "my foo", Application::Configuration.my__foo
+    assert_equal "my foo", Application::Configuration.my.foo
+    assert_equal Application::Configuration.my__foo, Application::Configuration.my.foo
+    assert_equal "marky kang", Application::Configuration::mark__name
+    assert_equal "marky kang", Application::Configuration::mark.name
+    assert_equal Application::Configuration::mark__name, Application::Configuration::mark.name
+  end
+  
+  def test_object_hook
+    assert_equal Application::Configuration.pickles, app_config.pickles
+  end
+  
+  def test_load_file
+    # assert_nil Application::Configuration.add
+    assert_nil Application::Configuration.add
+    assert_instance_of Application::Configuration, Application::Configuration.load_file("#{RAILS_ROOT}/config/application_configuration_additional.yml")
+    assert_equal 2, Application::Configuration.add
+    assert_equal "bar", Application::Configuration.foo
+    Application::Configuration.reload
+    assert_equal 2, Application::Configuration.add
+    assert_equal "bar", Application::Configuration.foo
+  end
+  
+  def test_load_file_not_found
+    assert_nil Application::Configuration.load_file("asldfjasdfljasdflsdfjasdl")
+  end
+  
+  def test_load_url_not_found
+    assert_nil Application::Configuration.load_url("asldfjasdfljasdflsdfjasdl")
+  end
+  
+  def test_load_url
+    t = Thread.new do
+      ConfServer.start
+    end
+    sleep(2)
+    assert_nil Application::Configuration.some_remote_config
+    assert_equal "local", Application::Configuration.url_test
+    assert_instance_of Application::Configuration, Application::Configuration.load_url("http://localhost:8000/conf")
+    assert_equal "wizbang!", Application::Configuration.some_remote_config
+    assert_equal "remote", Application::Configuration.url_test
+  end
+  
+  def test_load_hash
+    # puts "start of test_load_hash:"
+    assert_nil app_config.some_hash_config
+    # puts "load hash:"
+    app_config.load_hash({"some_hash_config" => 1}, :test_load_hash_settings)
+    assert_equal 1, app_config.some_hash_config
+    # puts "reload"
+    app_config.reload
+    assert_equal 1, app_config.some_hash_config
+    # puts "load_hash 2"
+    app_config.load_hash({"some_hash_config" => 2}, :test_load_hash_settings_two)
+    assert_equal 2, app_config.some_hash_config
+    # puts "reload 2"
+    app_config.reload
+    assert_equal 2, app_config.some_hash_config
+  end
+  
+  def test_revert
+    assert_nil app_config.my_revert_test
+    app_config.load_hash({:my_revert_test => 1}, :revert_test_1)
+    assert_equal 1, app_config.my_revert_test
+    app_config.revert
+    assert_nil app_config.my_revert_test
+    5.times do |i|
+      app_config.load_hash({:my_revert_test => i}, "revert_test_#{i}")
+      assert_equal i, app_config.my_revert_test
+    end
+    app_config.revert(2)
+    assert_equal 2, app_config.my_revert_test
+  end
+
+end

data/test/rails/config/application_configuration.yml

@@ -0,0 +1,113 @@
+foo: bar
+four: <%= 2 + 2 %>
+my_hash:
+  one: 1
+  two: 2
+  three: <%= 1 + 2 %>
+my_time: <%= Time.now.beginning_of_month %>
+my_array:
+  - 1
+  - 2
+  - 3
+  - mark
+  - bates
+pickles: are yummy!
+mark::name: "marky kang"
+url_test: local
+radiant_server_url: http://localhost:3001
+cms_layouts:
+  about: my_test_layout
+  foo: another_layout
+default_cms_layout: application
+radiant_server_time_out: <%= 1.second %>
+whiny_config_missing: false
+reload_settings_every: <%= 1.hour %>
+
+# rails_sales_visa:
+#   gateway: paypal
+#   login: seller_1193780413_biz_api1.helium.com
+#   password: VJ4SZRNE6TB7T6Q5
+
+rails_sales_default:
+  # gateway: paypal
+  # login: seller_1193780413_biz_api1.helium.com
+  # password: VJ4SZRNE6TB7T6Q5
+  gateway: authorize_net
+  login: 2fD6yH48
+  password: 29AVG493Sh4j6utn
+
+rails_sales_currency_type_default: USD
+
+page_cache_storage: cachetastic
+  
+album_cache_options:
+  servers:
+    - 127.0.0.1:11211
+    
+doctor_be_cache_options:
+  adapter: drb
+  store_options:
+    host: "druby://127.0.0.1:61676"
+    
+doctor_ce_cache_options:
+  adapter: drb
+  store_options:
+    host: "druby://127.0.0.1:61676"
+    
+cachetastic_caches_page_cache_options:
+  default_expiry: <%= 1.hour %>
+  expiry_swing: <%= 15.minutes %>
+
+cachetastic_caches_rails_session_cache_options:
+  adapter: local_memory
+  store_options:
+    dir: /cachetastic/
+
+memcache_benchmark_cache_options:
+  debug: false
+  adapter: memcache
+  marshall_method: none
+  store_options:  
+    c_threshold: 10_000
+    compression: true
+    debug: false
+    readonly: false
+    urlencode: false
+
+my_file_store_cache_options:
+  debug: false
+  adapter: file
+  store_options:
+    dir: "/cachetastic/test"
+    
+file_benchmark_cache_options:
+  debug: false
+  adapter: file
+  store_options:
+    dir: "/cachetastic/benchmark"
+    
+local_memory_benchmark_cache_options:
+  debug: false
+  adapter: local_memory
+  
+cachetastic_default_options:
+  debug: true
+  adapter: local_memory
+  marshall_method: none
+  default_expiry: <%= 24.hours %>
+  # buffer: simple
+  # store_options:  
+  #   c_threshold: 10_000
+  #   compression: true
+  #   debug: false
+  #   readonly: false
+  #   urlencode: false
+  logging:
+    # logger_1:
+    #   type: file
+    #   file: log/memcached.log
+    logger_2:
+      type: console
+      level: error
+  # servers:
+  #   - 127.0.0.1:11211

data/test/rails/config/application_configuration_additional.yml

@@ -0,0 +1 @@
+add: <%= 1 + 1 %>

data/test/rails/config/application_configuration_test.yml

@@ -0,0 +1,54 @@
+pickles: rock!
+reload_settings_every: <%= 2.seconds %>
+my::foo: "my foo"
+whiny_config_missing: false
+all_debate_pairing_options: 
+  - 
+    - "Pro"
+    - "Con"
+  -
+    - "Yes"
+    - "No"
+  - 
+    - "For"
+    - "Against"
+  - 
+    - "Agree"
+    - "Disagree"
+  - 
+    - "Support"
+    - "Oppose"
+  - 
+    - "True"
+    - "False"
+  - 
+    - "Innocent"
+    - "Guilty"
+  - 
+    - "Right"
+    - "Wrong"
+
+foo_bar_cache_options:
+  default_expiry: <%= 3.seconds %>
+  adapter: local_memory
+  marshall_method: yaml
+  
+your_temp_options_cache_options:
+  adapter: file
+  store_options:
+    dir: /cachetastic/test
+    
+cachetastic_default_options:
+  debug: true
+  adapter: local_memory
+  marshall_method: none
+  default_expiry: <%= 24.hours %>
+  logging:
+    # logger_1:
+    #   type: file
+    #   file: log/memcached.log
+    logger_2:
+      type: console
+      level: debug
+      
+should_be_false: false

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require "test/unit"
+require 'rake'
+require 'fileutils'
+require 'facets/times'
+require File.join(File.dirname(__FILE__), "..", "lib", "application_configuration")
+
+RAILS_ENV = "test"
+RAILS_ROOT = File.join(File.dirname(__FILE__), "rails")
+
+class Test::Unit::TestCase
+end

metadata

@@ -1,42 +1,37 @@
 --- !ruby/object:Gem::Specification 
 name: application_configuration
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.5.0
 platform: ruby
 authors: 
 - markbates
 autorequire: 
-- application_configuration
 bindir: bin
 cert_chain: []
 
-date: 2008-04-07 00:00:00 -04:00
+date: 2008-06-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: "application_configuration was developed by: markbates"
-email: 
+description: A simple system for configuring Ruby applications.
+email: mark@mackframework.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
-- application_configuration-1.2.2.gem
-- init.rb
 - lib/application_configuration.rb
-- lib/tasks/rubyforge_config.yml
-has_rdoc: false
-homepage: 
+- README
+has_rdoc: true
+homepage: http://www.mackframework.com
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 - lib
-- lib
-- lib/tasks
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
@@ -52,9 +47,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: magrathea
-rubygems_version: 1.0.1
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
-summary: application_configuration
-test_files: []
-
+summary: A simple system for configuring Ruby applications.
+test_files: 
+- test/application_configuration_unit_test.rb
+- test/rails
+- test/rails/config
+- test/rails/config/application_configuration.yml
+- test/rails/config/application_configuration_additional.yml
+- test/rails/config/application_configuration_test.yml
+- test/test_helper.rb

data/init.rb

@@ -1 +0,0 @@
-# require 'application_configuration'

data/lib/tasks/rubyforge_config.yml

@@ -1,5 +0,0 @@
---- !ruby/object:RubyForgeConfig 
-gem_name: application_configuration
-package: application_configuration
-project: magrathea
-version: 1.2.2