configure 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Philipp Brüll
+
+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,53 @@
+
+= Configure
+
+Configure offers an easy way for configure your application using a DSL. It provides a single-method interface that
+receives a block and returns well-structured configuration values.
+
+== Usage
+
+The most simple way <tt>configure</tt> can be used is to pass a block to the <tt>Configure.process</tt> method and
+receive back a hash with the configuration values.
+
+  laser = Configure.process do
+    title "red laser"
+    wave_length 700
+  end
+
+  laser == {
+    :title => "red laser",
+    :wave_length => 700
+  } # => true
+
+It is also possible to pass blocks to configuration keys and combine multiple values to an array.
+
+  laser = Configure.process do
+    title "red and violet pulse laser"
+    pulses do
+      wave_length 700
+      duration 20
+    end
+    pulses do
+      wave_length 400
+      duration 20
+    end
+  end
+
+  laser == {
+    :title => "red and violet pulse laser",
+    :pulses => [
+      { :wave_length => 700, :duration => 20 },
+      { :wave_length => 400, :duration => 20 }
+    ]
+  } # => true
+
+== Development
+
+Development has been done test-driven and the code follows at most the Clean Code paradigms. Code smells has been
+removed by using the reek[http://github.com/kevinrutherford/reek] code smell detector.
+
+This project is still under development. Any bug report and contribution is welcome!
+
+== Support
+
+Apart from contribution, support via Flattr[http://flattr.com/thing/145021/Configure-DSL-for-Ruby] is welcome.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+gem 'rspec'
+gem 'reek'
+require 'rspec'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'reek/rake/task'
+
+task :default => :spec
+
+namespace :gem do
+
+  desc "Builds the gem"
+  task :build do
+    system "gem build *.gemspec && mkdir -p pkg/ && mv *.gem pkg/"
+  end
+
+  desc "Builds and installs the gem"
+  task :install => :build do
+    system "gem install pkg/"
+  end
+
+end
+
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = true
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.add [ "README.rdoc", "lib/**/*.rb" ]
+  rdoc.main = "README.rdoc"
+  rdoc.title = ""
+end
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = "spec/lib/**/*_spec.rb"
+end
+
+namespace :spec do
+
+  desc "Run all integration specs in spec/acceptance directory"
+  RSpec::Core::RakeTask.new(:acceptance) do |task|
+    task.pattern = "spec/acceptance/**/*_spec.rb"
+  end
+
+end

data/lib/configure.rb

@@ -0,0 +1,18 @@
+
+module Configure
+
+  autoload :Injector, File.join(File.dirname(__FILE__), "configure", "injector")
+  autoload :Sandbox, File.join(File.dirname(__FILE__), "configure", "sandbox")
+
+  def self.process(&block)
+    process_configuration Hash, &block
+  end
+
+  def self.process_configuration(configuration_class, &block)
+    injector = Injector.new configuration_class
+    sandbox = Sandbox.new injector
+    sandbox.instance_eval &block
+    injector.configuration
+  end
+
+end

data/lib/configure/injector.rb

@@ -0,0 +1,43 @@
+
+# Creates a configuration from the passed class and provides methods to inject values.
+class Configure::Injector
+
+  attr_reader :configuration
+
+  def initialize(configuration_class)
+    @configuration_class = configuration_class
+    @configuration = @configuration_class.new
+  end
+
+  def put_block(key, &block)
+    value = Value.new @configuration, key
+    value.put Configure.process_configuration(@configuration_class, &block)
+  end
+
+  def put_arguments(key, arguments)
+    value = Value.new @configuration, key
+    value.put arguments.size == 1 ? arguments.first : arguments
+  end
+
+  # Injector for a single configuration value.
+  class Value
+
+    def initialize(configuration, key)
+      @configuration, @key = configuration, key
+    end
+
+    def get
+      @configuration[@key]
+    end
+
+    def put(value)
+      @configuration[@key] = exists? ? [ get, value ].flatten : value
+    end
+
+    def exists?
+      @configuration.has_key? @key
+    end
+
+  end
+
+end

data/lib/configure/sandbox.rb

@@ -0,0 +1,17 @@
+
+# The sandbox can be used to catch method calls and delegates them the to passed injector.
+class Configure::Sandbox
+
+   def initialize(injector)
+     @injector = injector
+   end
+
+   def method_missing(method_name, *arguments, &block)
+     if block_given?
+       @injector.put_block method_name, &block
+     else
+       @injector.put_arguments method_name, arguments
+     end
+   end
+
+end

data/spec/acceptance/configure_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Configure do
+
+  describe "process" do
+
+    it "should turn method call into hash values" do
+      configuration = described_class.process do
+        test_key "one"
+      end
+
+      configuration.should == {
+        :test_key => "one"
+      }
+    end
+
+    it "should combine multiple arguments to an array" do
+      configuration = described_class.process do
+        test_key "one", "two"
+      end
+
+      configuration.should == {
+        :test_key => [ "one", "two" ]
+      }
+    end
+
+    it "should combine the values of multiple calls to an array" do
+      configuration = described_class.process do
+        test_key "one", "two"
+        test_key "three", "four"
+      end
+
+      configuration.should == {
+        :test_key => [ "one", "two", "three", "four" ]
+      }
+    end
+
+    it "should build nested configurations out of the passed blocks" do
+      configuration = described_class.process do
+        test_key do
+          nested_test_key "one"
+        end
+      end
+
+      configuration.should == {
+        :test_key => { :nested_test_key => "one" }
+      }
+    end
+
+    it "should combine nested configurations to an array" do
+      configuration = described_class.process do
+        test_key do
+          nested_test_key "one"
+        end
+        test_key do
+          nested_test_key "two"
+        end
+      end
+
+      configuration.should == {
+        :test_key => [
+          { :nested_test_key => "one" },
+          { :nested_test_key => "two" }
+        ]
+      }
+    end
+
+  end
+
+end

data/spec/lib/configure/injector_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+
+describe Configure::Injector do
+
+  before :each do
+    @injector = described_class.new Hash
+  end
+
+  describe "initialize" do
+
+    it "should create a configuration" do
+      @injector.configuration.should be_instance_of(Hash)
+    end
+
+  end
+
+  describe "put_block" do
+
+    before :each do
+      @block = Proc.new { }
+      Configure.stub(:process_configuration => :nested_configuration)
+    end
+
+    it "should process a newly created configuration" do
+      Configure.should_receive(:process_configuration).with(Hash, &@block)
+      @injector.put_block :test_key, &@block
+    end
+
+    it "should nest the configuration" do
+      @injector.put_block :test_key, &@block
+      @injector.configuration[:test_key].should == :nested_configuration
+    end
+
+    it "should combine nested configurations to an array" do
+      @injector.put_block :test_key, &@block
+      @injector.put_block :test_key, &@block
+      @injector.configuration[:test_key].should == [ :nested_configuration, :nested_configuration ]
+    end
+
+  end
+
+  describe "put_arguments" do
+
+    it "should assign a value" do
+      @injector.put_arguments :test_key, [ "one" ]
+      @injector.configuration[:test_key].should == "one"
+    end
+
+    it "should assign an array of values" do
+      @injector.put_arguments :test_key, [ "one", "two" ]
+      @injector.configuration[:test_key].should == [ "one", "two" ]
+    end
+
+    it "should combine existing with new values" do
+      @injector.put_arguments :test_key, [ "one" ]
+      @injector.put_arguments :test_key, [ "two" ]
+      @injector.configuration[:test_key].should == [ "one", "two" ]
+    end
+
+  end
+
+end

data/spec/lib/configure/sandbox_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+
+describe Configure::Sandbox do
+
+  before :each do
+    @injector = mock Configure::Injector, :put_arguments => nil, :put_block => nil
+    @sandbox = described_class.new @injector
+  end
+
+  it "should pass method calls without a block to the injector's :put_arguments" do
+    @injector.should_receive(:put_arguments).with(:test_key, [ "value" ])
+    @sandbox.test_key "value"
+  end
+
+  it "should pass method calls with a block to the injector's :put_block" do
+    block = Proc.new { }
+    @injector.should_receive(:put_block).with(:test_key, &block)
+    @sandbox.test_key &block
+  end
+
+end

data/spec/lib/configure_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Configure do
+
+  before :each do
+    @block = Proc.new { }
+  end
+
+  describe "#process" do
+
+    before :each do
+      described_class.stub(:process_configuration)
+    end
+
+    it "should call :process_configuration" do
+      described_class.should_receive(:process_configuration).with(Hash, &@block)
+      described_class.process &@block
+    end
+
+  end
+
+  describe "#process_configuration" do
+
+    before :each do
+      @injector = mock described_class::Injector, :configuration => :configuration
+      described_class::Injector.stub :new => @injector
+
+      @sandbox = mock described_class::Sandbox, :instance_eval => nil
+      described_class::Sandbox.stub :new => @sandbox
+    end
+
+    it "should initialize the injector" do
+      described_class::Injector.should_receive(:new).with(Hash).and_return(@injector)
+      described_class.process_configuration Hash, &@block
+    end
+
+    it "should initialize the sandbox" do
+      described_class::Sandbox.should_receive(:new).with(@injector).and_return(@sandbox)
+      described_class.process_configuration Hash, &@block
+    end
+
+    it "should evaluate the block in the sandbox" do
+      @sandbox.should_receive(:instance_eval).with(&@block)
+      described_class.process_configuration Hash, &@block
+    end
+
+    it "should return the configuration" do
+      configuration = described_class.process_configuration Hash, &@block
+      configuration.should == :configuration
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+gem 'rspec', '>= 2'
+require 'rspec'
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "configure"))

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: configure
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Philipp Br\xC3\xBCll"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :development
+  version_requirements: *id002
+description: It provides a single-method interface that receives a block and returns well-structured configuration values.
+email: b.phifty@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- LICENSE
+- Rakefile
+- lib/configure.rb
+- lib/configure/injector.rb
+- lib/configure/sandbox.rb
+- spec/lib/configure_spec.rb
+- spec/lib/configure/injector_spec.rb
+- spec/lib/configure/sandbox_spec.rb
+- spec/spec_helper.rb
+- spec/acceptance/configure_spec.rb
+has_rdoc: true
+homepage: http://github.com/phifty/configure
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: configure
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Configure offers an easy way for configure your application using a DSL.
+test_files: 
+- spec/lib/configure_spec.rb
+- spec/lib/configure/injector_spec.rb
+- spec/lib/configure/sandbox_spec.rb
+- spec/acceptance/configure_spec.rb