iqeo-conf 0.0.1 → 0.0.2

data/.bundle/config

@@ -1 +1,2 @@
---- {}
+---
+BUNDLE_BIN: bin

data/.gitignore

@@ -1,2 +1,3 @@
 .idea/
+.rvmrc
 

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile.lock

@@ -1,14 +1,26 @@
 PATH
   remote: .
   specs:
-    iqeo-conf (0.0.1)
+    iqeo-conf (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   iqeo-conf!
+  rake (~> 0.9.2)
+  rspec (~> 2.9.0)

data/README.md

@@ -4,19 +4,7 @@ A DSL for writing configuration files.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```
-gem 'iqeo-conf'
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself as:
+It's a gem...
 
 ```
 $ gem install iqeo-conf
@@ -26,9 +14,13 @@ $ gem install iqeo-conf
 
 ### Defining a configuration
 
+```ruby
+require 'iqeo/configuration'
+```
+
 Set values...
 
-#### Defining a Configuration object directly
+#### Directly on a configuration object
 
 ```ruby
 conf = Iqeo::Configuration.new
@@ -41,7 +33,7 @@ conf.charlie { :a => 1, :b => 2, :c => 3 }
 conf.delta [ 1, 2, 3 ]
 ```
 
-#### Configuration DSL - block yield style
+#### Configuration DSL block yield style
 
 ```ruby
 conf = Iqeo::Configuration.new do |c|
@@ -54,7 +46,7 @@ conf = Iqeo::Configuration.new do |c|
 end
 ```
 
-### Configuration DSL - freestyle
+### Configuration DSL instance_eval style
 
 ```ruby
 conf = Iqeo::Configuration.new do
@@ -78,13 +70,26 @@ conf.charlie    =>  { :a => 1, :b => 2, :c => 3 }
 conf.delta      =>  [ 1, 2, 3 ]
 ```
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+## Other features
+
+This README may not be complete, see rspec tests for all features.
+
+## Todo
+
+* Hash operators [] & []= - done!
+* Nested configurations - done!
+* Nested configurations inherit settings
+* Nested configurations override inherited settings
+* Indifferent hash access, symbol, strings, case sensitivity optional ?
+* Iterate over items hash - access to hash / mixin enumerable / delegation to hash ?
+* Load configurations from a string or file at creation
+* Load configurations from a string or file after creation / in DSL
+* Configuration file load path - array of Dir.glob like file specs ?
+* Load other formats ? - No need... DSL is just ruby, just do it natively.
+* Blank slate for DSL ? - optional ?
+* Use an existing configuration for defaults
+* Global configuration - watch for collisions ?
+* Consider issues around deferred interpolation / procs / lambdas etc...
 
 ## License
 

data/Rakefile

@@ -6,4 +6,9 @@ Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/test*.rb']
   t.verbose = true
-end
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/iqeo-conf.gemspec

@@ -9,8 +9,12 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/iqeo/iqeo-conf"
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
   gem.name          = "iqeo-conf"
   gem.require_paths = ["lib"]
   gem.version       = Iqeo::Configuration::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.9.0"
+  gem.add_development_dependency "rake", "~> 0.9.2"
+
 end

data/lib/iqeo/configuration/version.rb

@@ -1,5 +1,5 @@
 module Iqeo
   class Configuration
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/iqeo/configuration.rb

@@ -1,12 +1,24 @@
 
 require_relative "configuration/version"
 
+# todo: inherited settings for nested configurations - POLS ?
+# todo: load configurations from string & file
+# todo: configuration file load path
+# todo: iterate over items hash - access to hash / mixin enumerable / delegation to hash ?
+# todo: indifferent hash access
+# todo: use an existing configuration for defaults
+# todo: global configuration - watch for collisions ?
+# todo: deferred interpolation / procs / lambdas etc...
+# todo: blank slate for DSL - optional ?
+# todo: load other formats from string & file - YAML, XML?
+
 module Iqeo
 
   class Configuration
 
-    # todo: tests - init without block, with block & param, with plain block
-    # todo: instance_eval vs. yield (arity == 0) ?
+    def self.version
+      VERSION
+    end
 
     def initialize &block
       @items = {}
@@ -19,16 +31,18 @@ module Iqeo
       end
     end
 
-    # todo: tests - with value, without value, multiple values ?, optional '=' with value ?
-    # todo: why does '=' break for instance eval ? - is it actually setting a local variable ???
-
-    def method_missing name, *value
-      name = name.to_s.chomp('=').to_sym
-      return @items[name] if value.empty?
-      @items[name] = value.first
+    def method_missing name, *values
+      case name
+      when :[]= then return @items[values.shift] = values.size > 1 ? values : values.first
+      when :[]  then return @items[values.shift]
+      else
+        name = name.to_s.chomp('=').to_sym
+        return @items[name] if values.empty?
+        return @items[name] = values if values.size > 1
+        return @items[name] = values.first
+      end
     end
-
-  end
+ end
 
 end
 

data/spec/configuration_spec.rb

@@ -0,0 +1,280 @@
+require 'spec_helper'
+require 'iqeo/configuration'
+
+include Iqeo
+
+describe Configuration do
+
+  it 'reports the correct version' do
+    Configuration.version.should == Configuration::VERSION
+  end
+
+  context 'creation' do
+
+    it 'does not require a block' do
+      Configuration.new.should be_a Configuration
+    end
+
+    it 'accepts a block with arity 0' do
+      Configuration.new {  }.should be_a Configuration
+    end
+
+    it 'instance_eval\'s block with arity 0' do
+      conf_eval = nil
+      conf_new = Configuration.new { conf_eval = self }
+      conf_new.should be conf_eval
+    end
+
+    it 'accepts a block with arity 1' do
+      Configuration.new { |arg| }.should be_a Configuration
+    end
+
+    it 'yields self to block with arity 1' do
+      conf_yielded = nil
+      conf_new = Configuration.new { |conf| conf_yielded = conf }
+      conf_new.should be conf_yielded
+    end
+
+  end
+
+  context 'settings retrieval' do
+
+    it 'returns nil for non-existent settings' do
+      conf = Configuration.new
+      conf.not_a_setting.should be_nil
+    end
+
+  end
+
+  context 'single value setting' do
+
+    it 'accepts simple values' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha 1
+        conf.bravo "two"
+        conf.charlie 3.0
+        conf.delta :four
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+      conf.bravo.should   == "two" and conf.bravo.should be_a String
+      conf.charlie.should == 3.0   and conf.charlie.should be_a Float
+      conf.delta.should == :four   and conf.delta.should be_a Symbol
+    end
+
+    it 'accepts complex values' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha = [ :a, :b, :c ]
+        conf.bravo = { :a => 1, :b => 2, :c => 3 }
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == [ :a, :b, :c] and conf.alpha.should be_an Array
+      conf.alpha.size.should == 3
+      conf.alpha[0].should == :a
+      conf.alpha[1].should == :b
+      conf.alpha[2].should == :c
+      conf.bravo.should == { :a => 1, :b => 2, :c => 3} and conf.bravo.should be_a Hash
+      conf.bravo.size.should == 3
+      conf.bravo[:a].should == 1
+      conf.bravo[:b].should == 2
+      conf.bravo[:c].should == 3
+    end
+
+  end
+
+  context 'multiple value setting' do
+
+    it 'accepts hash without brackets' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha :a => 1, :b => 2, :c => 3
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == { :a => 1, :b => 2, :c => 3} and conf.alpha.should be_a Hash
+    end
+
+    it 'treats multiple values as an array' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha :a, :b, :c
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == [ :a, :b, :c ] and conf.alpha.should be_an Array
+    end
+
+    it 'treats hash without brackets after multiple values as last element of array' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha 1, 2, 3, :a => 4, :b => 5, :c => 6
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == [ 1, 2, 3, { :a => 4, :b => 5, :c => 6} ] and conf.alpha.should be_a Array
+    end
+
+  end
+
+  context 'hash operators [] & []= access' do
+
+    it 'accepts symbol keys' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf[:alpha] = 1
+      end.to_not raise_error
+      conf[:alpha].should == 1
+    end
+
+    it 'accepts non-symbol (string) keys' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf['alpha'] = 1
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf['alpha'].should == 1
+    end
+
+  end
+
+  context 'nested configuration' do
+
+    it 'is supported' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha Configuration.new
+        conf.alpha.bravo Configuration.new
+        conf.alpha.bravo.charlie true
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should be_a Configuration
+      conf.alpha.bravo.should be_a Configuration
+      conf.alpha.bravo.charlie.should be_true
+    end
+
+    it 'inherits settings' do
+      pending 'todo'
+    end
+
+    it 'can override inherited settings' do
+      pending 'todo'
+    end
+
+  end
+
+  context 'yield DSL' do
+
+    it 'accepts settings without =' do
+      conf = nil
+      expect do
+        conf = Configuration.new do |c|
+          c.alpha :value
+        end
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == :value
+    end
+
+    it 'accepts settings with =' do
+      conf = nil
+      expect do
+        conf = Configuration.new do |c|
+          c.alpha = :value
+        end
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == :value
+    end
+
+    it 'can refer to an existing setting' do
+      conf = nil
+      expect do
+        conf = Configuration.new do |c|
+          c.alpha = :value
+          c.bravo = c.alpha
+          c.charlie c.bravo
+        end
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == :value
+      conf.bravo.should == :value
+      conf.charlie.should == :value
+    end
+
+    it 'returns value when creating/changing a setting' do
+      conf = nil
+      expect do
+        conf = Configuration.new do |c|
+          c.bravo = c.alpha = :value
+        end
+      end.to_not raise_error
+      conf.alpha.should == :value
+      conf.bravo.should == :value
+    end
+
+  end
+
+  context 'instance_eval DSL' do
+
+    it 'accepts settings without =' do
+      conf = nil
+      expect do
+        conf = Configuration.new do
+          alpha :value
+        end
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == :value
+    end
+
+    it 'sets local variables with =' do
+      conf = alpha = nil
+      expect do
+        alpha = nil
+        conf = Configuration.new do
+          alpha = :value
+          bravo alpha
+        end
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should be_nil
+      conf.bravo.should == :value
+      alpha.should == :value        # local alpha set by matching variables
+    end
+
+    it 'can refer to an existing setting' do
+      conf = nil
+      expect do
+        conf = Configuration.new do |c|
+          c.alpha :value
+          c.bravo c.alpha
+          c.charlie c.bravo
+        end
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should == :value
+      conf.bravo.should == :value
+      conf.charlie.should == :value
+    end
+
+    it 'returns value when creating/changing a setting' do
+      conf = nil
+      expect do
+        conf = Configuration.new do
+          bravo alpha :value
+        end
+      end.to_not raise_error
+      conf.alpha.should == :value
+      conf.bravo.should == :value
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iqeo-conf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
-dependencies: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 description: A configuration DSL
 email:
 - gerard.fowley@iqeo.net
@@ -20,6 +52,7 @@ extra_rdoc_files: []
 files:
 - .bundle/config
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
 - Gemfile.lock
@@ -29,7 +62,11 @@ files:
 - iqeo-conf.gemspec
 - lib/iqeo/configuration.rb
 - lib/iqeo/configuration/version.rb
+- pkg/iqeo-conf-0.0.1.gem
+- pkg/iqeo-conf-0.0.2.gem
 - scratch.txt
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/iqeo/iqeo-conf
 licenses: []
 post_install_message: