autoconfig 0.1.2 → 1.0.0

data/README.markdown

@@ -17,7 +17,7 @@ Autoconfig in an automated way to create flexible configuration structures repre
 1. require 'autoconfig'
 2. profit!
 
-## Example
+## Basic Example
 
 Lets say you have application.yml in your config folder:
 
@@ -33,8 +33,53 @@ Lets say you have application.yml in your config folder:
 After requiring 'autoconfig' you should expect ApplicationConfig structure that will contain all the information. In production environment
 ApplicationConfig.web.hostname call will return "the.production.com".
 
+## Advance Example
+
+Check it out under test/config/one
+
+    defaults:
+      one: !REQUIRED
+      two: two
+      three: three
+      cache_classes: true
+      tree1:
+        tree2: hey
+        tree3:
+          tree4: blah
+
+    defaults[test,cucumber,development]:
+      cache_classes: false
+
+    defaults[test,cucumber]:
+      one: one
+
+    development:
+      one: yup
+
+    test:
+      something: hello
+      tree1:
+        tree3:
+          tree4: bleh
+
+    production:
+      three: five
+
+Autoconfig can support:
+ * specifying which keys are required via !REQUIRED yaml type
+ * environment specific defaults shared across some environments
+ * deep nested structures
+
 ## Configuration
 
 By default, it will look at config directory of your project and transfer most of your .yml files (it ignores database ones). However,
-you have full control over where it needs to look and what it needs to convert.
+you have full control over where it needs to look and what it needs to convert. Here is a set of environment flags you could use:
 
+ * `AUTOCONFIG_ROOT` - allows setting of the application root. By default it will try to use APP_ROOT, rails root (if rails app) or pwd directory.
+ * `AUTOCONFIG_PATERN` - used to construct a path to your configuration files. By default it is set to config/*.yml
+ * `AUTOCONFIG_PATH` - allows setting a path to your configuration files. If set autoconfig will ignore patern and root, otherwise
+ it look at root and patern to get path to your files.
+ * `AUTOCONFIG_ENV` - allows setting environment in which autoconfig runs, by default it will try to use APP_ENV, Rails.env(if rails app) or
+ development (in that order)
+ * `AUTOCONFIG_IGNORE` - when set it will not create configs for files in the ignore. When not set it will just ignore database.yml. Takes a whitespace
+ separated list. Ex: 'cucumber cache'

data/lib/autoconfig.rb

@@ -1,66 +1,124 @@
 require 'ostruct'
 require 'yaml'
+require 'erb'
+require 'set'
 
 module StringCamelize
   # Taken straight from active support inflector.rb, line 161
   def camelize(first_letter_in_uppercase = true)
     if first_letter_in_uppercase
-      self.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+      to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
     else
-      self.first + camelize(self)[1..-1]
+      first + camelize(self)[1..-1]
     end
   end
 end
 String.send(:include, StringCamelize) unless String.instance_methods.include?("camelize")
 
-module AutoConfig
-  def self.root
-    rails_root = (rails? && (Rails.root || File.expand_path('../', ENV['BUNDLE_GEMFILE'])))
-    ENV['AUTOCONFIG_ROOT'] || ENV['APP_ROOT'] || rails_root || base_dir
-  end
+class AutoConfig
+  REQUIRED = :REQUIRED
+  YAML.add_builtin_type( 'REQUIRED' ){ REQUIRED }
 
-  def self.pattern
-    ENV['AUTOCONFIG_PATTERN'] || 'config/*.yml'
-  end
+  class << self
+    def root
+      rails_root = (rails? && (Rails.root || File.expand_path('../', ENV['BUNDLE_GEMFILE'])))
+      ENV['AUTOCONFIG_ROOT'] || ENV['APP_ROOT'] || rails_root || Dir.pwd
+    end
 
-  def self.path
-    ENV['AUTOCONFIG_PATH'] || File.expand_path(pattern, root)
-  end
+    def pattern
+      ENV['AUTOCONFIG_PATTERN'] || 'config/*.yml'
+    end
 
-  def self.environment
-    ENV['AUTOCONFIG_ENV'] || ENV['APP_ENV'] || (rails? && Rails.env) || base_dir
-  end
+    def path
+      ENV['AUTOCONFIG_PATH'] || File.expand_path(pattern, root)
+    end
 
-  def self.rails?
-    Object::const_defined? "Rails"
-  end
+    def environment
+      ENV['AUTOCONFIG_ENV'] || ENV['APP_ENV'] || (rails? && Rails.env) || 'development'
+    end
 
-  def self.base_dir
-    File.dirname(File.expand_path(__FILE__))
-  end
+    def rails?
+      Object::const_defined? "Rails"
+    end
 
-  def self.ignored_filenames
-    names = ENV['AUTOCONFIG_IGNORE'] ? "database|" + ENV['AUTOCONFIG_IGNORE'].gsub(/\s/,'|') : 'database'
-    Regexp.new(names)
-  end
+    def ignored_filenames
+      names = ENV['AUTOCONFIG_IGNORE'] ? "database|" + ENV['AUTOCONFIG_IGNORE'].gsub(/\s/,'|') : 'database'
+      Regexp.new(names)
+    end
+
+    def reload
+      wipe
+      files = Dir.glob(path)
+      begin
+        old_verbose, $VERBOSE = $VERBOSE, nil
+
+        files.each do |file|
+          name = File.basename(file, '.yml')
+          next if name.match(ignored_filenames)
 
-  files = Dir.glob(path)
+          constant_name = "#{name}Config".gsub('-','_').camelize
+          yaml_config   = YAML::load(ERB.new(IO.read(file)).result)
 
-  begin
-    old_verbose, $VERBOSE = $VERBOSE, nil
+          @ordered_stanza_labels[constant_name] = []
+          @ordered_stanza_labels[constant_name] << 'defaults' if yaml_config.key? 'defaults'
+          @ordered_stanza_labels[constant_name] += yaml_config.keys.grep(/^defaults\[.*#{environment}/).sort_by{ |a| a.count(',') }
+          @ordered_stanza_labels[constant_name] << environment if yaml_config.key? environment
 
-    files.each do |file|
-      name = File.basename(file, '.yml')
-      next if name.match(ignored_filenames)
+          config = @ordered_stanza_labels[constant_name].inject({}) do |acc, label|
+            deep_merge(acc,yaml_config[label])
+          end
 
-      config     = YAML.load_file(file)
-      app_config = config['common'] || {}
-      app_config.update(config['defaults'] || {})
-      app_config.update(config[environment] || {})
+          ensure_requirements_met_and_ostructify!(config, constant_name )
 
-      Object::const_set("#{name}Config".gsub('-','_').camelize.intern, OpenStruct.new(app_config))
+          Object::const_set(constant_name.intern, OpenStruct.new(config))
+        end
+
+        raise @errors.to_a.join( "\n" ) unless @errors.empty?
+
+      ensure
+        $VERBOSE = old_verbose
+      end
+    end
+
+    private
+    # unsets created constants
+    def wipe
+      unless @ordered_stanza_labels.nil?
+        @ordered_stanza_labels.keys.each{|const| Object::const_set(const.intern, nil) }
+      end
+      @ordered_stanza_labels = {}
+      @errors = Set.new
+    end
+
+    # merges two hashes with nested hashes if present
+    def deep_merge( hash1, hash2 )
+      hash1 = hash1.dup
+      ( hash1.keys + hash2.keys ).each do | key |
+        if hash1.key?( key ) && hash2.key?( key ) &&
+           hash1[key].is_a?( Hash ) && hash2[key].is_a?( Hash )
+           hash1[key] = deep_merge( hash1[key], hash2[key] )
+        elsif hash2.key?( key )
+          hash1[key] = hash2[key]
+        end
+      end
+      hash1
+    end
+    # Mutator method that does two things:
+    # * checks if any of the keys were required and not set. Upon finding
+    # it adds key to the error set
+    # * recursively sets open structs for deep hashes
+    def ensure_requirements_met_and_ostructify!( hash, path )
+      hash.each do | key, value |
+        case
+        when value.respond_to?( :keys ) && value.respond_to?( :values )
+          ensure_requirements_met_and_ostructify!( value, path + '.' + key )
+        when value == REQUIRED
+          @errors << "#{path}.#{key} is REQUIRED"
+        end
+        hash[key] = OpenStruct.new(value) if value.is_a?( Hash )
+      end
     end
-  ensure
-    $VERBOSE = old_verbose
   end
 end
+
+AutoConfig.reload

metadata

@@ -1,26 +1,27 @@
 --- !ruby/object:Gem::Specification 
 name: autoconfig
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
-  - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - tjbladez
+- timgaleckas
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-10 00:00:00 -06:00
+date: 2011-10-12 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
 description: Automated way to create flexible configuration structures representing your YAML configuration
-email: tjbladez@gmail.com
+email: nick@tjbladez.com, tim@galeckas.com
 executables: []
 
 extensions: []