itrigga-config 0.0.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Al Davidson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= itrigga-config.git
+
+Description goes here.
+
+== Contributing to itrigga-config.git
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Al Davidson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "itrigga-config"
+  gem.homepage = "http://github.com/drsnooks/itrigga-config"
+  gem.license = "MIT"
+  gem.summary = %Q{iTrigga's config object & initialization}
+  gem.description = %Q{Allows you to define default abitrary config and override per-key by loading in a YAML file }
+  gem.email = "aldavidson@itrigga.com"
+  gem.authors = ["Al Davidson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "itrigga-config.git #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/itrigga/config/configuration.rb

@@ -0,0 +1,225 @@
+require 'itrigga/config/macros'
+require 'singleton'
+
+module Itrigga
+  module Config
+    class Configuration
+      include ::Singleton
+      
+      include Itrigga::Config::Macros
+    
+      def_param( 'constants', {
+          :RAILS_ENV => ( defined?(RAILS_ENV) ? RAILS_ENV : ENV['RAILS_ENV'] || 'development'),
+          :TRIGGA_SHARED_DIR => '/var/www/itrigga/shared'
+      })
+      
+      def_param('search_tracker', {
+        :host => 'http://localhost:3001',
+        :access_token => 'GGH4672LqctJmNp5LFGG'
+      } )
+      
+      def_param('sessions', {
+        :expire_in_hours => 24
+      })
+      
+      # what server should we scp worker generated sitemaps to
+      def_param('sitemap', {
+        :targets => [:localhost]  
+      })
+      
+      # urls split by application to hit to warm caches
+      def_param('cache_urls', {
+        :trigga_dot_com => ["http://itrigga.com/refresh_stats"]  
+      })
+    
+      def_param( 'timers', 
+        :tick_interval_seconds => 60,
+        :specs => [
+          {:name=>'Update all sources', :cron_string=>"2 * * * *", :job_yaml=>"--- !ruby/object:UpdateSourceJobSchedulerJob {}\n\n"},
+          {:name=>'Expire items', :cron_string=>"1 0 * * *", :job_yaml=>"--- !ruby/object:ExpireItemsJob \ndatetime: \n"},
+          {:name=>'Hello World heartbeat', :cron_string=>"* * * * *", :job_yaml=>"--- !ruby/object:HelloWorldJob \noptions: {}\n\n"},
+          {:name=>'Update item site scores', :cron_string=>"*/10 * * * *", :job_yaml=>"--- !ruby/object:UpdateItemSiteScoresJob \noptions: {}\n\n"},
+          {:name=>'Issue send_item_subscription_email jobs', :cron_string=>"15 13 * * 5", :job_yaml=>"--- !ruby/object:IssueSendItemSubscriptionEmailJobsJob \noptions: {}\n\n"},
+          {:name=>'Update Site Popular & Recent Searches', :cron_string=>"*/10 * * * *", :job_yaml=>"--- !ruby/object:UpdateCachedSiteSearchesJobSchedulerJob \noptions: {}\n\n"},
+          {:name=>'Update Cached Site Tags', :cron_string=>"*/20 * * * *", :job_yaml=>"--- !ruby/object:UpdateCachedSiteTagsJobSchedulerJob \noptions: {}\n\n"},
+          {:name=>'Update Cached Channel Tags', :cron_string=>"*/20 * * * *", :job_yaml=>"--- !ruby/object:UpdateCachedChannelTagsJobSchedulerJob \noptions: {}\n\n"},
+          {:name=>'Delete Expired items', :cron_string=>"30 0 * * *", :job_yaml=>"--- !ruby/object:DeleteExpiredItemsJob \ndatetime: \n"},          
+          {:name=>'Delete old benchmark events', :cron_string=>"45 0 * * *", :job_yaml=>"--- !ruby/object:DeleteOldBenchmarkEventsJob \ndatetime: \n"},
+          {:name=>'Increment Cache Version', :cron_string=>"*/5 * * * *", :job_yaml=>"--- !ruby/object:IncrementCacheVersionJob {}\n\n"},
+          {:name=>'Activate Items', :cron_string=>"0 4 * * * *", :job_yaml=>"--- !ruby/object:ActivateItemsJob {}\n\n"},
+          {:name=>'Expire old unallocated items', :cron_string=>"1 0 * * *", :job_yaml=>"--- !ruby/object:ExpireOldUnallocatedItemsJob \ndatetime: \n"},
+          {:name=>'Clear old sessions', :cron_string=>"0 3 * * *", :job_yaml=>"--- !ruby/object:ClearSessionsJob {} \n\n"},
+          {:name=>'Update Seatwave Cached Performances', :cron_string=>"0 2 * * *", :job_yaml=>"--- !ruby/object:UpdateSeatwaveCachedPerformancesJob {} \n\n"},
+          {:name=>'Optimize all Tables', :cron_string=>"30 3 * * *", :job_yaml=>"--- !ruby/object:OptimizeTableJobSchedulerJob {}\n\n"},
+          {:name=>'Generate All Sitemaps', :cron_string=>"0 */4 * * *", :job_yaml=>"--- !ruby/object:GenerateAllSitemapsJob {}\n\n"},
+          {:name=>'Warm the itrigga.com stats caches', :cron_string=>"0 2,14 * * *", :job_yaml=>"--- !ruby/object:WarmTriggaDotComCachesJob {}\n\n"},
+          {:name=>'Schedule item email deliveries', :cron_string=>"0 */1 * * * *", :job_yaml=>"--- !ruby/object:SendChannelItemsEmailJobSchedulerJob {}\n\n"},
+          {:name=>'Optimize solr index', :cron_string=>"0 2 * * * *", :job_yaml=>"--- !ruby/object:OptimizeSolrIndexJob {}\n\n"}
+          
+        ]
+      )
+    
+      def_param( 'memcache',
+        :enabled => true,
+        :options => {
+          :c_threshold => 10_000,
+          :compression => true,
+          :debug => false,
+          :namespace => "trigga_default",
+          :readonly => false,
+          :urlencode => false
+        },
+        :servers => 'localhost:11211',
+        :lifetime_seconds => 60
+      )
+    
+      def_param( 'sites', [] )
+    
+      def_param( 'facebook',
+        :perms => "email,publish_stream,offline_access,read_stream"   
+      )
+    
+      def_param( 'processes',
+        :web => {
+          :port => 3000,
+          :servers => 3,
+          :request_timeout => 30
+        },
+        :solr => {
+          :paths => {
+              :root=> "vendor/plugins/acts_as_solr/solr/",
+              :instances_root => "../solr/instances",
+              :data=> "../solr/data"
+          },
+          :url => "http://127.0.0.1:8983/solr",
+          :jvm_options=> "" # for production: -server -d64 -Xmx1024M -Xms64M
+        },
+        :broker => {
+          :options => {
+            :host => '127.0.0.1',
+            :port => 5672,
+            :vhost => 'itrigga.com',
+            :user => 'trigga',
+            :pass => 'n0sp00n3r15m5plz',
+            :timeout => 5,
+            :logging => false, # <- extremely verbose protocol logging,
+            :prefetch => 1 # <- maximum of this many msgs to be sent to the client at any one time (stop rabbit flooding the worker, also stop messages disappearing when client dies)
+          },
+          :connection_check_seconds => 5,
+          :queues => [
+            {:name=>'priority_high',
+              :binding => { :exchange_name=>'jobs_exchange', :key => 'trigga.jobs.priority.high.*' },
+              :options=>{:durable=>true, :ack=>true} # <- ack=true says to acknowledge each msg (otherwise they can get lost) 
+            },
+            {:name=>'priority_med',
+              :binding => { :exchange_name=>'jobs_exchange', :key => 'trigga.jobs.priority.med.*' },
+              :options=>{:durable=>true, :ack=>true} # <- ack=true says to acknowledge each msg (otherwise they can get lost) 
+            },  
+            {:name=>'priority_low',
+              :binding => { :exchange_name=>'jobs_exchange', :key => 'trigga.jobs.priority.low.*' },
+              :options=>{:durable=>true, :ack=>true} # <- ack=true says to acknowledge each msg (otherwise they can get lost) 
+            }
+          ],
+          :exchanges => [
+            { :name=>'jobs_exchange', 
+              :key_root=>'trigga',
+              :options=>{:type=>:topic, :passive=>false, :durable=>true, :auto_delete => false },
+              :default_msg_options=>{:mandatory => true, :immediate=>false, :persistent => true}
+            }
+          ],
+          :default_exchange_name => 'jobs_exchange',
+          :unique_process_search_string => 'rabbitmq-server'
+        },
+        :job_resubmitter=> {
+          :tick_interval_seconds => 10,
+          :max_batch_size => 100
+        },
+        :timer => {
+          :tick_interval_seconds => 10,
+          :reactivate_stale_seconds => 14400,
+          :reactivate_old_queued_seconds => 14400
+        },
+        # worker's queue_names determines which queues (defined in the broker config above)
+        # each worker process will subscribe to. 
+        # the default 'worker' will subscribe to them all, 
+        # but you can have separate hi/med/low priority workers to prevent 
+        # workers getting swamped by one type of slow-running job (e.g. UpdateItemLinksJob)
+        :worker => {
+          :queue_names=>['priority_high', 'priority_med', 'priority_low']
+        },
+        :"worker-hi" => {
+          :queue_names=>['priority_high']
+        },
+        :"worker-med" => {
+          :queue_names=>['priority_med']
+        },
+        :"worker-low" => {
+          :queue_names=>['priority_low']
+        },
+        :term_extractor => {
+          :port => 4567,
+          :url => "http://localhost:4567/terms"
+        },
+        :memcached => {
+          :port => 11212,
+          :max_mem_mb => 64,
+          :user => 'root'
+        }
+      )
+    
+      def_param( 'processes_to_start', 
+        [:broker, :solr, :memcached, :web, :"worker", :timer, :scheduled_job_resubmitter, :term_extractor] # <- start these processes, in this order        
+      )
+      def_param( 'ssh_hosts_to_monitor',
+        [:localhost]
+      )
+      def_param( 'monit_templates_to_render',
+        []
+      )
+      def_param( 'cron_templates_to_render',
+        []
+      )
+      def_param( 'monitoring_templates_to_render',
+        []
+      )
+      
+      def_param('mysql',
+        :replication_user => { :username => "ws_status", :password =>  "ws_status123" }
+      )
+      
+      def_param( 'hosts',
+      [
+        { :host => "localhost", :display_name => "localhost", :port => 22, :user => ENV["USER"], :ssh_key_path => nil, :mysql_user => "tn", :mysql_pwd => "n0sp00n3r15m5plz", :types => [:db_slave_stats, :process_stats, :broker_stats] }
+      ]
+      )
+    
+      # Aliases 
+      # TODO: refactor refs to these
+      def rabbit_mq; processes[:broker]; end
+      def web_service_term_extractor; processes[:term_extractor]; end
+      def scheduled_job_submitter; processes[:job_resubmitter]; end
+    
+      def environment
+        RAILS_ENV
+      end
+    
+      def environment_type
+        case environment
+          when /test/: 'test'
+          when /development/: 'development'
+          else 'production'
+        end
+      end
+    
+      def is_test?; environment_type == 'test'; end
+      def is_production?; environment_type == 'production'; end
+      def is_development?; environment_type == 'development'; end
+
+      def exchange_config(name)
+        @rabbit_mq[:exchanges].find{ |e| e[:name] == name }
+      end
+    
+    end
+  end
+end
+

data/lib/itrigga/config/environment.rb

@@ -0,0 +1,30 @@
+require 'itrigga/config/configuration'
+
+raise ArgumentError.new("you must define ITRIGGA_APP_NAME if you're going to use itrigga/config/environment") unless defined?(ITRIGGA_APP_NAME)
+puts "initialising itrigga-config for '#{ITRIGGA_APP_NAME}' app"
+
+app_name_upper = ITRIGGA_APP_NAME.upcase
+app_name_lower = ITRIGGA_APP_NAME.downcase
+config_file_env_var_name = "#{app_name_upper}_CONFIG_FILE"
+
+param = ARGV.find{|a| a.match(/--#{app_name_lower}-config-file=(.*)/)}
+given_file = param ? param.gsub(/--#{app_name_lower}-config-file=(.*)/, '\1') : nil
+
+ITRIGGA_CONFIG = Itrigga::Config::Configuration.instance()
+[ given_file, ENV["#{app_name_upper}_CONFIG_FILE"], "/etc/#{app_name_lower}_config_file" ].compact.each { |f|
+  if File.exists?(f)
+    true_path = (File.symlink?(f) ? File.readlink(f) : f)
+    puts "loading #{app_name_lower} config file #{true_path}"
+    ITRIGGA_CONFIG.from_file(true_path) 
+    break
+  end
+}
+
+# silence warnings, before we load the convenient Rails silence_warnings method:
+old_verbose = $VERBOSE
+$VERBOSE = false
+begin
+  ITRIGGA_CONFIG.constants.each { |k,v|  eval("#{k}='#{v}'") }
+ensure
+  $VERBOSE = old_verbose
+end

data/lib/itrigga/config/macros.rb

@@ -0,0 +1,189 @@
+require 'yaml'
+
+module Itrigga 
+ module Config
+   module Macros
+     def self.included(klass)
+       klass.send(:include, InstanceMethods)
+     
+       # provides a convenient array of all param names without the "@", handy for dumping / debugging
+       define_method( :params ) do
+         klass.instance_variables.map{ |v| v.gsub(/@(.+)/, '\1') } - ['inheritable_attributes']
+       end
+     
+       define_method(:param) do |arg|
+         if klass.instance_variables.include? "@#{arg}"
+           klass.instance_variable_get("@#{arg}") 
+         else
+           raise ArgumentError.new("no param found called '#{arg}'")
+         end
+       end
+     
+     
+       klass.class_eval {
+         
+         class << self
+         
+           def param_getter( name, default_value=nil, &block )
+               instance_variable_set( "@#{name}", default_value )
+               define_method( name.to_s ) do
+                 if instance_variables.include? "@#{name}"
+                   instance_variable_get("@#{name}")
+                 else
+                   if block
+                     instance_variable_set("@#{name}", block.call(self) )  
+                   else
+                     instance_variable_set("@#{name}", default_value)
+                   end
+                 end
+               end
+             end
+           
+           def param_setter( name )
+             define_method(:recursive_update) do |p, h|
+               h.each do |k, v|
+                 prev = p[k.to_sym]
+                 if prev.is_a?(Hash) && v.is_a?(Hash)
+                   recursive_update(prev, v)
+                 else
+                   p[k.to_sym]=v
+                 end
+               end
+             end
+           
+             define_method("#{name}=") do |val|                
+               if val.is_a?(Hash) && self.send("#{name}".to_sym).is_a?(Hash)
+                 recursive_update(self.send("#{name}".to_sym), val)
+               else
+                 instance_variable_set("@#{name}", val)
+               end
+             end
+           end
+           
+           
+           def def_param( name, default_value, &block )
+             param_getter( name, default_value, &block )
+             param_setter( name )
+           end
+         
+         
+         end
+
+       
+       } # klass.class_eval
+   
+     end
+    end
+    
+    module InstanceMethods
+      
+      def initialize(file=nil)
+        self.from_file(file) unless file.to_s.empty?
+        self
+      end
+      
+      def to_hash
+        h = {}
+        params.each do |p|
+          h[p] = param(p)
+        end
+        h
+      end
+      
+      def from_hash( h )
+        h.keys.each do |k|
+          self.class.def_param(k,h[k]) unless params.include?(k)
+          self.class.instance_variable_set("@#{k}", h[k] )
+          self.instance_variable_set("@#{k}", h[k] )
+        end
+        self
+      end
+      
+      def from_file( f )
+        raise ArgumentError.new("#{f.to_s} is not a valid file") unless File.file?(f.to_s)
+        h = File.open( f ){ |yml| ::YAML::load( yml ) }
+        c = from_hash(h)
+        self.instance_variable_set("@from_file", f.to_s)
+        c
+      end
+      
+      def to_file(f)
+        File.open( f, "w+" ) do |f|
+          f.write( to_hash.to_yaml )
+        end
+      end
+      
+      def loaded_file
+        self.instance_variable_get("@from_file")
+      end
+      
+      def loaded_file_basename
+        loaded_file ? File.basename(loaded_file) : nil
+      end
+      
+      def site_config_root
+        "#{RAILS_ROOT}/config/itrigga" 
+      end
+      
+      def site_keys
+        Dir.chdir(site_config_root) do
+          Dir['*/'].map{ |d| d.gsub( /(.*)[\/\\]/, '\1' ) }
+        end
+      end
+      
+      def site_config_files(site_dir)
+        Dir.chdir(File.join(site_config_root, site_dir)) do
+          Dir['*.yml']
+        end
+      end
+      
+      def load_site_config_file( site_name, filename )
+        path = File.join(site_config_root, site_name, filename)
+        File.open( path ){ |yml| ::YAML::load( yml ) }
+      end
+      
+      def load_site_config( site_name )
+        h = {}
+        site_config_files(site_name).each do |f|
+          key_name = f.gsub(/(.*)\.yml/, '\1').to_sym
+          h[key_name] = load_site_config_file(site_name, f)
+        end
+        h
+      end
+      
+      def load_site_config_for_all_sites
+        default_config = load_site_config('default_site')
+        
+        h = {}
+        site_keys.each do |site|
+          h[site] = default_config.merge(load_site_config(site))
+        end
+        
+        self.sites = h
+        self
+      end
+      
+      def site_config( site_key )
+        self.sites[site_key]
+      end
+      
+      def site_config_with_defaults( site_key )
+        config = site_config('default_site').clone
+        this_site_config = site_config(site_key)
+        config.merge!(this_site_config) if this_site_config
+        config
+      end
+      
+      def apply_action_mailer_config( site_key )
+        Net::SMTP.enable_tls(OpenSSL::SSL::VERIFY_NONE)
+        
+        mailer_settings = site_config_with_defaults(site_key)[:actionmailer]
+        ActionMailer::Base.smtp_settings = mailer_settings[:smtp_settings]
+      end
+      
+    end
+    
+      
+    
+  end
+end

data/lib/itrigga/config.rb

@@ -0,0 +1 @@
+require 'itrigga/config/configuration'

data/spec/config_spec.rb

@@ -0,0 +1,374 @@
+require 'spec_helper'
+
+describe Itrigga::Config::Configuration do
+  
+  describe "defining a param" do
+    it "should set the given param as an instance variable" do
+      Itrigga::Config::Configuration.def_param( "blart", "flange")
+      Itrigga::Config::Configuration.instance_variables.should include("@blart")
+    end
+    
+    it "should let you read back a param once set" do
+      Itrigga::Config::Configuration.def_param( "blart", "flange")
+      Itrigga::Config::Configuration.instance().blart.should == "flange"
+    end
+  end
+  
+  describe "params" do
+    it "should return an array of all param names without the '@'" do
+      Itrigga::Config::Configuration.def_param( "blart", "flange" )
+      Itrigga::Config::Configuration.def_param( "monkeys", {:infinite=>true} )
+      Itrigga::Config::Configuration.instance().params.should include("blart")
+      Itrigga::Config::Configuration.instance().params.should include("monkeys")
+    end
+    
+    it "should not include 'inheritable_attributes'" do
+      Itrigga::Config::Configuration.def_param( "blart", "flange" )
+      Itrigga::Config::Configuration.instance().params.should_not include("inheritable_attributes")
+    end
+    
+      
+  end
+  
+  describe "param" do
+    it "should return the value of the given param" do
+      Itrigga::Config::Configuration.def_param( "blart", "flange" )
+      Itrigga::Config::Configuration.instance().param("blart").should == "flange"
+    end
+    
+    describe "when asked for a param that doesn't exist" do
+      it "should raise an ArgumentError" do
+        lambda{ 
+          Itrigga::Config::Configuration.instance().param("asfasfasf")
+        }.should raise_error(ArgumentError)
+      end
+    end
+  end
+  
+  describe "environment" do
+    before(:each) do
+      RAILS_ENV = "blart" unless defined?(RAILS_ENV)
+    end
+    
+    it "should be RAILS_ENV" do
+      Itrigga::Config::Configuration.instance().environment.should == RAILS_ENV
+    end
+  end
+  
+  describe "environment_type" do
+    before(:each) do 
+      @tc = Itrigga::Config::Configuration.instance()
+    end
+    
+    describe "when environment name contains 'test'" do
+      it "should return 'test'" do
+        @tc.stub!(:environment).and_return('test')
+        @tc.environment_type.should == 'test'
+        
+        @tc.stub!(:environment).and_return('monkey_test')
+        @tc.environment_type.should == 'test'
+      end
+    end
+    describe "when environment name contains 'development'" do
+      it "should return 'test'" do
+        @tc.stub!(:environment).and_return('development')
+        @tc.environment_type.should == 'development'
+        
+        @tc.stub!(:environment).and_return('donkey_development')
+        @tc.environment_type.should == 'development'
+      end
+    end
+    describe "when environment name doesn't contain 'test' OR 'development'" do
+      it "should return 'production'" do
+        @tc.stub!(:environment).and_return('production')
+        @tc.environment_type.should == 'production'
+        
+        @tc.stub!(:environment).and_return('cheese_widgets')
+        @tc.environment_type.should == 'production'
+      end
+    end
+  end
+  
+  describe "to_hash" do
+    before(:each) do
+      Itrigga::Config::Configuration.def_param( :a_2_level_hash, {:key=>'a key', :sub_hash=>{:sub_key_1=>"sub_value 1", :sub_key_2=>"sub_value 2"}} )
+      Itrigga::Config::Configuration.def_param( :array_of_arrays, [['0 0', '0 1'], ['1 0', '1 1']] )
+      Itrigga::Config::Configuration.def_param( :array_of_hashes, [ {:key=>'val'}, {:key=>'val 2'} ] )
+      @tc = Itrigga::Config::Configuration.instance()
+    end
+    
+    it "should generate a correct hash to arbitrary depth" do
+      h = @tc.to_hash
+      h.keys.sort.should == @tc.params.sort
+      h.keys.each do |key|
+        h[key].should == @tc.param(key)
+      end
+      
+    end
+  end
+  
+  describe "hash import/export" do
+    before(:each) do
+      @hash  = {
+        :a_2_level_hash => {:key=>'a new key', :sub_hash=>{:sub_key_1=>"sub_value 1 new", :sub_key_2=>"sub_value 2 new"}},
+        :array_of_arrays => [['0 0 2', '0 1 2'], ['1 0 2', '1 1 2']] ,
+        :array_of_hashes => [ {:key=>'val 2'}, {:key=>'val 2 2'} ]
+      }
+      Itrigga::Config::Configuration.def_param( :a_2_level_hash, {:key=>'a key', :sub_hash=>{:sub_key_1=>"sub_value 1", :sub_key_2=>"sub_value 2"}} )
+      Itrigga::Config::Configuration.def_param( :array_of_arrays, [['0 0', '0 1'], ['1 0', '1 1']] )
+      Itrigga::Config::Configuration.def_param( :array_of_hashes, [ {:key=>'val'}, {:key=>'val 2'} ] )
+    end
+      
+    describe "from_hash" do
+      context "all params" do
+        before(:each) do
+          @tc = Itrigga::Config::Configuration.instance().from_hash(@hash)
+        end
+
+        it "should define a param for each key in the hash" do
+          @tc.params.should include( "a_2_level_hash" )
+          @tc.params.should include( "array_of_arrays" )
+          @tc.params.should include( "array_of_hashes" )
+        end
+      
+        it "should set the param value to the hash key value" do
+          @tc.param('a_2_level_hash').should == @hash[:a_2_level_hash]
+          @tc.param('array_of_arrays').should == @hash[:array_of_arrays]
+          @tc.param('array_of_hashes').should == @hash[:array_of_hashes]
+        
+          @tc.a_2_level_hash.should == @hash[:a_2_level_hash]
+        end
+      end
+      
+      context "when the param doesnt already exist" do
+        before(:each) do
+          @hash[:new_param] = {:key1=>'some value'}
+          @tc = Itrigga::Config::Configuration.instance().from_hash(@hash)
+        end
+        
+        it "should define the param with the given value as default" do
+          @tc.new_param.should == {:key1=>'some value'}
+        end
+      end
+    end
+    
+    describe "from_file" do
+      before(:each) do
+        @f = mock("file")
+        File.stub!(:file?).with("/my/file/path").and_return true
+        File.stub!(:open).with("/my/file/path").and_yield(@f)
+        YAML.stub!(:load).and_return( @hash )
+      end
+      
+      it "should load the given file as YAML" do
+        YAML.should_receive(:load).with(@f).and_return( @hash )
+        @tc = Itrigga::Config::Configuration.instance().from_file( "/my/file/path" )
+      end
+      
+      it "should initialise from the parsed hash" do
+        @tc = Itrigga::Config::Configuration.instance()
+        @tc.should_receive( :from_hash ).with(@hash)
+        @tc.from_file( "/my/file/path" )
+      end
+    end
+    
+    describe "to_file" do
+      before(:each) do
+        @tc = Itrigga::Config::Configuration.instance()
+        @yaml =  "some yaml"
+        @f = mock("file")
+        File.stub!(:open).and_yield( @f )
+      end
+      
+      it "should serialise the config object to YAML" do
+        @f.stub!(:write)
+        @tc.should_receive(:to_hash).and_return(@hash)
+        @hash.should_receive(:to_yaml).and_return( @yaml )
+        @tc.to_file( "/some/file/path" )
+      end
+      
+      it "should write the yaml to the given file" do
+        @tc.stub!(:to_hash).and_return(@hash)
+        @hash.stub!(:to_yaml).and_return( @yaml )
+        @f.should_receive(:write).with( "some yaml" )
+        @tc.to_file( "/some/file/path" )
+      end
+      
+    end
+  end
+  
+  describe "site_keys" do
+    before(:each) do 
+      @tc = Itrigga::Config::Configuration.instance()
+      RAILS_ROOT='/some/dir'
+    end
+    
+    it "should have one element for each subdir of site_config_root" do
+      @tc.should_receive(:site_config_root).and_return("blart")
+      Dir.should_receive(:chdir).with("blart")
+      @tc.site_keys
+    end
+    
+    it "should strip any trailing slashes from each element" do
+      Dir.stub!(:chdir).and_yield
+      Dir.stub!(:[]).and_return( ['dir1/', 'dir2\\'] )
+      @tc.site_keys.should == ['dir1', 'dir2']
+    end
+    
+  end
+  
+  describe "site_config_files" do
+    before(:each) do 
+      @tc = Itrigga::Config::Configuration.instance()
+    end
+    
+    it "should return an array of all yml files under the given dir" do
+      @tc.should_receive(:site_config_root).and_return("blart")
+      Dir.should_receive(:chdir).with('blart/site_dir').and_yield
+      Dir.should_receive(:[]).with("*.yml").and_return(["file1.yml", "file2.yml"] )
+      @tc.site_config_files("site_dir").should == ["file1.yml", "file2.yml"]
+    end
+  end
+  
+  describe "load_site_config_file" do
+    before(:each) do 
+      @tc = Itrigga::Config::Configuration.instance()
+      @file_contents = "file contents"
+      @data = {:my_key => {:subkey1 => "value1"}}
+      File.stub!(:open).and_yield(@file_contents)
+    end
+    
+    it "should load the given file from the given site sub dir" do
+      @tc.should_receive(:site_config_root).and_return("site_config_dir")
+      File.should_receive(:open).with("site_config_dir/site_name/filename.yml").and_yield( @file_contents )
+      @tc.load_site_config_file("site_name", "filename.yml")
+    end
+    
+    
+    it "should return the resulting data decoded from yaml" do
+      YAML.should_receive(:load).with(@file_contents).and_return( @data )
+      @tc.load_site_config_file("site_name", "filename.yml").should == @data
+    end
+  end
+  
+  describe "load_site_config" do
+    before(:each) do
+      @tc = Itrigga::Config::Configuration.instance()
+      @tc.stub!(:site_config_files).and_return( ['file1.yml', 'file2.yml'] )
+      @tc.stub!(:load_site_config_file).and_return( {} )
+    end
+    
+    it "should get all config files for the given site" do
+      @tc.should_receive(:site_config_files).with("my_site").and_return( [] )
+      @tc.load_site_config("my_site")
+    end
+  
+    describe "for each config file for the given site" do
+      it "should make a key from the filename.to_sym" do
+        keys = @tc.load_site_config("my_site").keys
+        keys.sort{|a,b| a.to_s <=> b.to_s }.should == [:file1, :file2]
+      end
+      
+      it "should load the config file" do
+        @tc.should_receive(:load_site_config_file).with("my_site", "file1.yml").and_return( {} )
+        @tc.should_receive(:load_site_config_file).with("my_site", "file2.yml").and_return( {} )
+        @tc.load_site_config("my_site")
+      end
+      
+      it "should set the key to the loaded data" do
+        @tc.stub!(:load_site_config_file).and_return( {:key1=>:value1} , {:key2=>:value2} )
+        @tc.load_site_config("my_site").should == {
+          :file1 => {:key1=>:value1},
+          :file2 => {:key2=>:value2}
+        }
+      end
+      
+    end
+    
+  end
+  
+  describe "apply_action_mailer_config" do
+    before(:each) do
+      @tc = Itrigga::Config::Configuration.instance()
+      unless defined?(Net::SMTP)
+        module Net
+          module SMTP
+            module_function
+            
+            def enable_tls(opt)
+            end
+          end
+        end
+      end
+      
+      unless defined?(ActionMailer::Base)
+        module ActionMailer
+          class Base
+            def self.smtp_settings=(opt)
+            end
+          end
+        end
+      end
+    end
+    
+    it "should get the site-specific-but-defaulted ActionMailer settings" do
+      @tc.should_receive(:site_config_with_defaults).with('blart').and_return( :actionmailer => { :smtp_settings => {:setting1=>'setting1'} }  )
+      @tc.apply_action_mailer_config('blart')
+    end
+    
+    it "should apply those settings to ActionMailer::Base" do
+      @tc.stub!(:site_config_with_defaults).with('blart').and_return( :actionmailer => { :smtp_settings => {:setting1=>'setting1'} } )
+      ActionMailer::Base.should_receive(:smtp_settings=).with({:setting1=>'setting1'})
+      @tc.apply_action_mailer_config('blart')
+    end
+  end
+  
+  describe "site_config_with_defaults" do
+    before(:each) do  
+      @tc = Itrigga::Config::Configuration.instance()
+      @tc.stub!(:site_config).with("blart")
+      @tc.stub!(:site_config).with("default_site").and_return(@config = {:blart=>'flange'} )
+      @config.stub!(:clone).and_return(@config2 = {:blart=>'flange'})
+    end
+      
+    it "should get the default site's config" do
+      @tc.should_receive(:site_config).with("default_site").at_least(:once).and_return(:blart=>'flange')
+      @tc.site_config_with_defaults("blart")
+    end
+    
+    it "should clone the default site's config" do
+      @tc.stub!(:site_config).with("default_site").and_return(@config = {:blart=>'flange'} )
+      @config.should_receive(:clone).and_return(@config2 = {:blart=>'flange'})
+      @tc.site_config_with_defaults("blart")
+    end
+    
+    it "should get the requested site's config" do
+      @tc.should_receive(:site_config).with("blart").and_return(:blart=>'flange')
+      @tc.site_config_with_defaults("blart")
+    end
+    
+    context "when the requested site's config is empty" do
+      before(:each) do
+        @tc.stub!(:site_config).with("blart").and_return(nil)
+      end
+      
+      it "should return the cloned default site config" do
+        @tc.site_config_with_defaults("blart").should == @config2
+      end
+    end
+    
+    context "when the requested site's config is not empty" do
+      before(:each) do
+        @tc.stub!(:site_config).with("blart").and_return(@config = {:blart=>'flange'})
+        @config2.stub!(:merge!).with( @config ).and_return(@config3 = {:cheese=>'emmental'})
+      end
+      
+      it "should merge the requested site config into the defaults config" do
+        @config2.should_receive(:merge!).with( @config ).and_return(@config3 = {:cheese=>'emmental'})
+        @tc.site_config_with_defaults("blart")
+      end
+      
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'itrigga/config'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'itrigga-config.git'
+
+class Test::Unit::TestCase
+end

data/test/test_itrigga-config.git.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestItriggaConfig.git < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: itrigga-config
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Al Davidson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+description: "Allows you to define default abitrary config and override per-key by loading in a YAML file "
+email: aldavidson@itrigga.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/itrigga/config.rb
+- lib/itrigga/config/configuration.rb
+- lib/itrigga/config/environment.rb
+- lib/itrigga/config/macros.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_itrigga-config.git.rb
+has_rdoc: true
+homepage: http://github.com/drsnooks/itrigga-config
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: iTrigga's config object & initialization
+test_files: []
+