aerogel-configurator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37d55037f2ea026955b18c93343504f4e0860f42
+  data.tar.gz: 01170bb9b27c66b10f1e1bf8359c7a2303a0c811
+SHA512:
+  metadata.gz: 688ef787aa153a283fe9e3870a37c98d7290e59235f7d7ba7154279c2c0c609f7e02bf7402564dc9e2e177cff097d6354da37b294b27722baa481d5e8c927d7b
+  data.tar.gz: 45c2d6452816b27b0b3fe3a91d844d847d879a0db30c5200d281ad4e42f6f7b04521c24dabe0fcc9dfa5c5a4ea5ac0ce77914636fa257ef8dcb0566c4b896199

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sublime-project
+*.sublime-workspace
+.rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in configurator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Kukushkin
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+# Configurator
+
+Configuration files for Ruby applications made easy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rb-configurator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rb-configurator
+
+## Usage
+
+Configuration parameters as chain:
+
+    config = Configurator.load "my.conf"
+
+    config.group.a # => 1
+
+Configuration is a HASH:
+
+    config = Configurator.load "my.conf"
+
+    config['group'] # => { :a => 1, :b => 2 }
+
+Store your configuration in the separate file(s) using simple DSL:
+
+    # my.conf
+    foo "hello"
+    bar 42
+    a_group {
+      boolean_param true
+      a_nested_group {
+        inner bar
+        ar_var [1, 2, "three"]
+      }
+    }
+
+
+Load configuration file(s) in your application:
+
+    require 'configurator'
+    config = Configurator.load "my.conf"
+
+    # Access settings:
+    puts config.foo # => "hello"
+    puts config.a_group.a_nested_group.inner # => 42
+
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc "Run tests"
+task :default do
+  system "bundle exec rspec"
+end

data/aerogel-configurator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aerogel/configurator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aerogel-configurator"
+  spec.version       = Configurator::VERSION
+  spec.authors       = ["Alex Kukushkin"]
+  spec.email         = ["alex@kukushk.in"]
+  spec.summary       = %q{Simple configuration files for Ruby applications}
+  spec.description   = %q{Store your application configuration in separate files using simple DSL or YAML. Access your configuration settings in a simple way}
+  spec.homepage      = "https://github.com/kukushkin/aerogel-configurator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/examples/ex1.rb

@@ -0,0 +1,7 @@
+require 'aerogel/configurator'
+
+config = Configurator.new
+
+config.a.foo.bar = "hello"
+
+puts "config: #{config.to_hash}"

data/examples/ex2.conf

@@ -0,0 +1,5 @@
+a {
+    foo {
+        bar "hello"
+    }
+}

data/examples/ex2.rb

@@ -0,0 +1,6 @@
+require 'aerogel/configurator'
+
+
+config = Configurator.load File.dirname( __FILE__ )+"/ex2.conf"
+
+puts "config: #{config.to_hash}"

data/lib/aerogel/configurator.rb

@@ -0,0 +1,4 @@
+require "aerogel/configurator/version"
+require "aerogel/configurator/configurator"
+require "aerogel/configurator/parameter"
+require "aerogel/configurator/dsl"

data/lib/aerogel/configurator/configurator.rb

@@ -0,0 +1,59 @@
+
+class Configurator
+
+  attr_accessor :params
+  # alias_method :to_hash, :params
+
+  # Creates a Configurator object and set default parameters.
+  #
+  def initialize( opts = {} )
+    raise ArgumentError.new("Invalid parameters passed to Configurator.new") unless opts.is_a? Hash
+    @params = opts.dup
+  end
+
+
+  def method_missing(method, *args)
+    # puts "Configurator.method_missing: #{method}"
+    Parameter.new( @params ).send method, *args
+  end
+
+  # Loads contents of a configuration file into an existing Configurator object.
+  #
+  def load( filename )
+    filename_contents = File.read filename
+    cfg = DSL.new( filename_contents, @params )
+    deep_merge( @params, cfg.params )
+  end
+
+  # Clears parameters
+  #
+  def clear!
+    @params = {}
+  end
+
+  # Creates a Configurator object and loads parameters from given file.
+  #
+  # Returns a created object with parameters loaded into it.
+  #
+  def self.load( filename )
+    config = self.new {}
+    config.load filename
+    return config
+  end
+
+private
+
+  # Deep merge parameters hash with +other+ hash.
+  #
+  def deep_merge( left, right )
+    right.each do |key, value|
+      if value.is_a? Hash
+        left[key] ||= {}
+        deep_merge( left[key], right[key] )
+      else
+        left[key] = right[key]
+      end
+    end
+  end
+
+end # class Configurator

data/lib/aerogel/configurator/dsl.rb

@@ -0,0 +1,39 @@
+class Configurator
+private
+
+  class DSL
+    attr_accessor :params
+
+    # +source+ can be either Hash (preprocessed parameters),
+    #   Block (a nested block to be invoked in a context of the object)
+    #   or a String (a config file contents to be evaluated in a context of the object)
+    def initialize( source, root = nil )
+      # @root = root || self
+      @params = {}
+      @root = root || @params
+      if source.is_a? Hash
+        @params = source
+      elsif source.is_a? String
+        self.instance_eval( source )
+      else
+        self.instance_eval( &source )
+      end
+    end
+
+    def method_missing( method, *args, &block )
+      if (not block_given?) && (args.empty?)
+        # puts "DSL: get '#{method}' params:#{@params}"
+        Parameter.new( @root ).send method, *args
+      elsif block_given?
+        nested_set = DSL.new( block, @root )
+        @params[method] = nested_set.params
+      elsif args.size > 1
+        @params[method] = args
+      else
+        @params[method] = args.first
+      end
+    end
+
+  end # class DSL
+end # class Configurator
+

data/lib/aerogel/configurator/parameter.rb

@@ -0,0 +1,80 @@
+class Configurator
+private
+  class Parameter
+
+    def initialize( data = {} )
+      @data = data
+    end
+
+    def method_missing(method, *args)
+      # puts "Parameter.method_missing: #{method}"
+      if method.to_s =~ /=$/
+        @data[method.to_s.match(/^(.*)=$/)[1].to_sym] = args.first
+      elsif @data[method].is_a?(Hash)
+        Parameter.new @data[method]
+      elsif @data[method].nil?
+        Undefined.new @data, [method]
+      elsif @data[method].is_a? Proc
+        @data[method].call
+      else
+        # it's a leaf
+        @data[method]
+      end
+    end
+
+    def raw
+      @data
+    end
+
+    def to_hash
+      @data
+    end
+
+    def inspect
+      @data.inspect
+    end
+
+    # Undefined is a parameter that was not set yet.
+    # It allows accessing its sub-parameters and defines the entire
+    # chain once an assignement method on a sub-parameter is called.
+    #
+    # +root+ is where parameter will be 'mounted' on assignement
+    # +name+ is an Array of chained names starting from mount point
+    #
+    class Undefined
+      def initialize( root, name )
+        # puts "Undefined.new: root=#{root} name=#{name.to_s} "
+        @root = root
+        @name = name # convert to array
+      end
+
+      def method_missing(method, *args)
+        # puts "Undefined.method_missing: #{method} root=#{@root} names=#{@names}"
+        if method.to_s =~ /=$/
+          method = method.to_s.match(/^(.*)=$/)[1].to_sym
+          # deep assign
+          d = ( @root[@name.shift] ||= {} )
+          @name.each do |n|
+            d = ( d[n] ||= {} )
+          end
+          d[method] = args.first
+        else
+          Undefined.new( @root, @name+[method])
+        end
+      end
+
+      def defined?; false; end
+      def nil?; true; end
+      def empty?; true; end
+      def to_s; ''; end
+      def raw; nil; end
+
+      # to_ary defined basically to keep rspec happy
+      def to_ary; []; end
+
+    end # class Undefined
+
+  end # class Parameter
+
+
+end # class Configurator

data/lib/aerogel/configurator/version.rb

@@ -0,0 +1,3 @@
+class Configurator
+  VERSION = "1.0.1"
+end

data/spec/conf/a.conf

@@ -0,0 +1,2 @@
+foo "hello"
+bar 42.0

data/spec/conf/b.conf

@@ -0,0 +1,10 @@
+# Test for overwriting defaults
+#
+
+# will overwrite 'foo'
+foo "hello"
+
+# will overwrite only 'group.a'
+group {
+  a 123
+}

data/spec/conf/c.conf

@@ -0,0 +1,7 @@
+# Test: nested groups
+
+a {
+  b {
+    c "foo"
+  }
+}

data/spec/conf/d.conf

@@ -0,0 +1,4 @@
+# Test: deferred parameters
+
+foo "fuu"               # will be changed to "foo"
+bar lambda{ foo+"bar" }   # then bar should be "foobar"

data/spec/lib/configurator_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Configurator do
+
+  before(:all) do
+    @default_params = {
+      :foo => "abc",
+      :bar => 123,
+      :group => {
+        :a => 1,
+        :b => 2
+      }
+    }
+  end
+
+  it "should respond to 'load' and return a Configurator instance" do
+    Configurator.should respond_to(:load)
+    Configurator.load( test_filename( 'conf/a.conf' ) ).should be_instance_of Configurator
+  end
+
+  describe ".new" do
+
+    it 'should allow no parameters' do
+      config = nil
+      expect { config = Configurator.new }.to_not raise_error
+      config.params.should be_empty # empty Hash
+    end
+    it 'should accept Hash as a set of default parameters' do
+      config = nil
+      expect { config = Configurator.new @default_params }.to_not raise_error
+    end
+  end
+
+  describe ".load" do
+    it "should load parameters from a configuration file" do
+      config = Configurator.load( test_filename( 'conf/a.conf' ) )
+      config.should be_instance_of Configurator
+      config.params.should eql( {:foo=>"hello", :bar=>42.0} )
+    end
+  end
+
+  describe "#params" do
+    it 'should provide access to raw parameters' do
+      config = Configurator.new @default_params
+      config.should respond_to(:params)
+      config.params.should eql( @default_params )
+    end
+  end
+
+  describe "method chaining" do
+    it 'should allow access to parameters and nested parameters for retrieval' do
+      config = Configurator.new @default_params
+      config.foo.should eql "abc"
+      config.bar.should eql 123
+      config.fuu.should be_nil
+      config.group.a.should eql 1
+      config.group.b.should eql 2
+      config.group.c.should be_nil
+    end
+    it 'should allow storing new parameters and nested parameters' do
+      config = Configurator.new
+      config.foo.should be_nil
+      expect do
+        config.foo = "abc"
+        config.bar = 123
+        config.group.a = 1
+        config.group.b = 2
+      end.not_to raise_error
+      config.foo.should eql "abc"
+      config.bar.should eql 123
+      config.fuu.should be_nil
+      config.group.a.should eql 1
+      config.group.b.should eql 2
+      config.group.c.should be_nil
+    end
+  end
+
+  describe "instance" do
+    it { should respond_to :load }
+    it "should load parameters" do
+      config = Configurator.new
+      config.params.should eql({})
+      config.load test_filename( 'conf/a.conf' )
+      config.params.should eql( {:foo=>"hello", :bar=>42.0} )
+    end
+    it "should load and overwrite only defined members" do
+      config = Configurator.new @default_params
+      config.foo.should eql "abc"
+      config.bar.should eql 123
+      config.group.a.should eql 1
+      config.group.b.should eql 2
+      config.load test_filename( 'conf/b.conf' )
+      config.foo.should eql "hello"
+      config.bar.should eql 123 # not overwritten
+      config.group.a.should eql 123
+      config.group.b.should eql 2 # not overwritten
+    end
+
+    it { should respond_to :clear! }
+    it "should clear all parameters on request" do
+      config = Configurator.new @default_params
+      config.foo.should eql "abc"
+      config.clear!
+      config.params.should eql({})
+    end
+
+    it "should respond to #to_hash on each level" do
+      config = Configurator.new @default_params
+      expect { config.to_hash }.to_not raise_error
+      config.to_hash.should be_instance_of Hash
+      config.to_hash.should eql @default_params
+      config.group.to_hash.should be_instance_of Hash
+      config.group.to_hash.should eql @default_params[:group]
+    end
+
+  end
+end # describe Configurator
+

data/spec/lib/dsl_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "Configurator::DSL" do
+
+  it "should allow nested groups" do
+    config = Configurator.load test_filename('conf/c.conf')
+    config.a.b.c.should eql "foo"
+  end
+
+  it "should handle deferred parameters" do
+    config = Configurator.load test_filename('conf/d.conf')
+    config.foo.should eql "fuu"
+    config.bar.should eql "fuubar"
+    config.foo = "foo"
+    config.bar.should eql "foobar"
+  end
+
+
+end # describe Configurator::DSL

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rspec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'aerogel', 'configurator')
+
+def test_filename( name )
+  File.expand_path( File.join( File.dirname(__FILE__), name ))
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: aerogel-configurator
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Store your application configuration in separate files using simple DSL
+  or YAML. Access your configuration settings in a simple way
+email:
+- alex@kukushk.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aerogel-configurator.gemspec
+- examples/ex1.rb
+- examples/ex2.conf
+- examples/ex2.rb
+- lib/aerogel/configurator.rb
+- lib/aerogel/configurator/configurator.rb
+- lib/aerogel/configurator/dsl.rb
+- lib/aerogel/configurator/parameter.rb
+- lib/aerogel/configurator/version.rb
+- spec/conf/a.conf
+- spec/conf/b.conf
+- spec/conf/c.conf
+- spec/conf/d.conf
+- spec/lib/configurator_spec.rb
+- spec/lib/dsl_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kukushkin/aerogel-configurator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple configuration files for Ruby applications
+test_files:
+- spec/conf/a.conf
+- spec/conf/b.conf
+- spec/conf/c.conf
+- spec/conf/d.conf
+- spec/lib/configurator_spec.rb
+- spec/lib/dsl_spec.rb
+- spec/spec_helper.rb