simonmenke-ec 0.0.2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Simon Menke
+
+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/lib/ec/list_specification.rb

@@ -0,0 +1,73 @@
+
+module EC
+  
+  class ListSpecification < Specification
+    
+    attr_accessor :child # :nodoc:
+    attr_accessor :update_policy # :nodoc:
+    
+    def initialize(name=:root, parent=nil, &block) # :nodoc:
+      @child = nil
+      @update_policy = :merge
+      super(name, parent) do |spec|
+        spec.should_be_a Array
+        block.call(spec) if block
+      end
+    end
+    
+    def process(value, parent=nil, path=[:root]) # :nodoc:
+      @processors.each do |processor|
+        processor.call(self, value, parent, path)
+      end
+      value.each_with_index do |v , idx|
+        @child.process(v, value, path + [idx])
+      end
+    end
+    
+    # specify a list as the list element
+    def list(&block)
+      @child ||= EC::ListSpecification.new(:item, self)
+      block.call(@child)
+    end
+    
+    # specify a terminal node as the list element
+    def conf(&block)
+      @child = EC::Specification.new(:item, self)
+      block.call(@child)
+    end
+    
+    # specify a map as the list element
+    def map(&block)
+      @child = EC::MapSpecification.new(:item, self)
+      block.call(@child)
+    end
+    
+    # set the update policy
+    def on_update(policy)
+      unless [:merger, :replace].include? policy
+        raise SpecificationError, "EC supports only :merge and :replace policies"
+      end
+      @update_policy = policy
+    end
+    
+    def update(base, delta) # :nodoc:
+      case @update_policy
+      when :merge   then merge(base, delta)
+      when :replace then replace(base, delta)
+      end
+    end
+    
+    def merge(base, delta) # :nodoc:
+      result = []
+      result += base  if base
+      result += delta if delta
+      result if base and delta
+    end
+    
+    def replace(base, delta) # :nodoc:
+      delta == nil ? base : delta
+    end
+    
+  end
+  
+end

data/lib/ec/macros.rb

@@ -0,0 +1,57 @@
+
+module EC
+  
+  class ValidationError < StandardError ; end
+  class SpecificationError < StandardError ; end
+  
+  module Macros
+    
+    # Add a processor
+    def processor(&block)
+      @processors << block
+    end
+    
+    # Raise unless this spec is present in the parent
+    def should_be_present
+      unless parent.is_a? MapSpecification
+        raise SpecificationError, "#{pretty_path(parent.path)} needs to be of type Map"
+      end
+      parent.processor do |spec, value, parent, path|
+        unless value.include? self.name.to_sym
+          raise ValidationError, "#{pretty_path(path)} needs a #{self.name.inspect} entry"
+        end
+      end
+    end
+    
+    # Raise unless this spec is of type <tt>type</tt>
+    def should_be_a(type)
+      processor do |spec, value, parent, path|
+        unless value.is_a? type
+          raise ValidationError, "#{pretty_path(path)} needs to be a #{type.inspect}"
+        end
+      end
+    end
+    
+    # Raise if this spec is empty
+    def should_not_be_empty
+      processor do |spec, value, parent, path|
+        empty = if value.respond_to? :empty?
+          value.empty?
+        elsif value.respond_to? :count
+          value.count == 0
+        elsif value.respond_to? :size
+          value.size == 0
+        elsif value.respond_to? :length
+          value.length == 0
+        else
+          raise ValidationError, "#{pretty_path(path)} doesn't respond to :empty?, :count, :size or :length"
+        end
+        if empty
+          raise ValidationError, "#{pretty_path(path)} must not be empty."
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/ec/map_specification.rb

@@ -0,0 +1,79 @@
+
+module EC
+  
+  class MapSpecification < Specification
+    
+    attr_accessor :children # :nodoc:
+    attr_accessor :update_policy # :nodoc:
+    
+    def initialize(name=:root, parent=nil, &block) # :nodoc:
+      @children = {}
+      @update_policy = :merge
+      super(name, parent) do |spec|
+        spec.should_be_a Hash
+        block.call(spec) if block
+      end
+    end
+    
+    def process(value, parent=nil, path=[:root]) # :nodoc:
+      @processors.each do |processor|
+        processor.call(self, value, parent, path)
+      end
+      @children.each do |k,v|
+        v.process(value[k], value, path + [k]) if value.include? k
+      end
+    end
+    
+    # specify a list with key name.
+    def list(name, &block)
+      @children[name.to_sym] ||= EC::ListSpecification.new(name, self)
+      block.call(@children[name.to_sym])
+    end
+    
+    # specify a terminal node with key name.
+    def conf(name, &block)
+      @children[name.to_sym] ||= EC::Specification.new(name, self)
+      block.call(@children[name.to_sym])
+    end
+    
+    # specify a map with key name.
+    def map(name, &block)
+      @children[name.to_sym] ||= EC::MapSpecification.new(name, self)
+      block.call(@children[name.to_sym])
+    end
+    
+    # set the update policy
+    def on_update(policy)
+      unless [:merger, :replace].include? policy
+        raise SpecificationError, "EC supports only :merge and :replace policies"
+      end
+      @update_policy = policy
+    end
+    
+    def update(base, delta) # :nodoc:
+      case @update_policy
+      when :merge   then merge(base, delta)
+      when :replace then replace(base, delta)
+      end
+    end
+    
+    def merge(base, delta) # :nodoc:
+      result = (base || {}).dup
+      delta.each do |k,v|
+        key = k.to_sym
+        if @children[key]
+          result[key] = @children[key].update(result[key], v)
+        else
+          result[key] = v
+        end
+      end
+      result
+    end
+    
+    def replace(base, delta) # :nodoc:
+      delta == nil ? base : delta
+    end
+    
+  end
+  
+end

data/lib/ec/specification.rb

@@ -0,0 +1,44 @@
+
+module EC
+  
+  class Specification
+    
+    include Macros
+    
+    # the name/key of this specification
+    attr_accessor :name
+    # the parent of this specification
+    attr_accessor :parent
+    attr_accessor :processors # :nodoc:
+    
+    def initialize(name=:root, parent=nil, &block) # :nodoc:
+      @name = name
+      @parent = parent
+      @processors = []
+      block.call(self) if block
+    end
+    
+    def process(value, parent=nil, path=[:root]) # :nodoc:
+      @processors.each do |processor|
+        processor.call(self, value, parent, path)
+      end
+    end
+    
+    def update(base, delta) # :nodoc:
+      delta == nil ? base : delta
+    end
+    
+    private
+    
+    def pretty_path(path) # :nodoc:
+      path.collect do |component|
+        case component
+        when Symbol, String then ".#{component}"
+        when Fixnum then "[#{component}]"
+        end
+      end.join().sub(/^\./, '')
+    end
+    
+  end
+  
+end

data/lib/ec/store.rb

@@ -0,0 +1,54 @@
+
+module EC
+  
+  class Store
+    
+    attr_accessor :specification
+    
+    # pass a block to specify this store
+    def initialize(&block)
+      specify &block
+      @data = nil
+    end
+    
+    # edit this stores specifictaion
+    def specify(&block)
+      @specification ||= EC::MapSpecification.new
+      block.call(@specification) if block
+      @specification
+    end
+    
+    # reset the date in this store. When you pass true the specifictaion will be reset too.
+    def reset!(clear_specification=false)
+      @data = nil
+      @specification = nil if clear_specification
+    end
+    
+    # configre this store with a ruby object. The root must be a Hash.
+    def configure_with_ruby(ruby)
+      @data = @specification.update(@data, ruby)
+    end
+    
+    # configre this store with a YAML file.
+    def configure_with_yaml(path)
+      configure_with_ruby YAML.load_file(path)
+    end
+    
+    # validate this store. This method will raise a EC::ValidationError when the store is invalid
+    def validate
+      @specification.process(@data)
+    end
+    
+    # access the data in this store.
+    def config
+      @data || {}
+    end
+    
+  end
+  
+  # access the global store.
+  def self.store
+    @__store = EC::Store.new
+  end
+  
+end

data/lib/ec.rb

@@ -0,0 +1,12 @@
+
+require 'yaml'
+
+module EC
+  
+end
+
+require File.dirname(__FILE__)+'/ec/store'
+require File.dirname(__FILE__)+'/ec/macros'
+require File.dirname(__FILE__)+'/ec/specification'
+require File.dirname(__FILE__)+'/ec/map_specification'
+require File.dirname(__FILE__)+'/ec/list_specification'

data/test/list_specification_test.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ListSpecificationTest < Test::Unit::TestCase
+  
+  context "ListSpecification" do
+    
+    setup do
+      
+      @spec = EC::ListSpecification.new do |list|
+        list.map do |map|
+          map.conf :name do |name|
+            name.should_be_present
+            name.should_be_a String
+            name.should_not_be_empty
+          end
+          map.conf :age do |age|
+            age.should_be_a Numeric
+          end
+        end
+      end
+      
+    end
+    
+    should "raise ValidationError with nil" do
+      lambda{
+        @spec.process(nil)
+      }.should raise_error(EC::ValidationError, /root needs to be a Array/)
+    end
+    
+    should "raise ValidationError with empty string" do
+      lambda{
+        @spec.process('')
+      }.should raise_error(EC::ValidationError, /root needs to be a Array/)
+    end
+    
+    should "not raise ValidationError with empty array" do
+      lambda{
+        @spec.process([])
+      }.should_not raise_error(EC::ValidationError)
+    end
+    
+    should "not raise ValidationError with valid array" do
+      lambda{
+        @spec.process([
+          {:name => 'simon', :age => 22},
+          {:name => 'anais'}
+        ])
+      }.should_not raise_error(EC::ValidationError)
+    end
+    
+    should "not raise ValidationError with invalid age" do
+      lambda{
+        @spec.process([
+          {:name => 'simon'},
+          {:name => 'anais', :age => '21'}
+        ])
+      }.should raise_error(EC::ValidationError, "root[1].age needs to be a Numeric")
+    end
+    
+    should "not raise ValidationError with invalid map" do
+      lambda{
+        @spec.process([
+          {},
+          {:name => 'anais'}
+        ])
+      }.should raise_error(EC::ValidationError, "root[0] needs a :name entry")
+    end
+    
+  end
+  
+end

data/test/map_specification_test.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class MapSpecificationTest < Test::Unit::TestCase
+  
+  context "MapSpecification" do
+    
+    setup do
+      @spec = EC::MapSpecification.new do |map|
+        map.should_be_a Hash
+        map.should_not_be_empty
+        map.conf(:hello) do |hello|
+          hello.should_be_a String
+          hello.should_not_be_empty
+        end
+        map.conf(:bye) do |bye|
+          bye.should_be_present
+        end
+        map.conf(:bye) do |bye|
+          bye.should_be_a String
+          bye.should_not_be_empty
+        end
+      end
+    end
+    
+    should "raise ValidationError with nil" do
+      lambda{
+        @spec.process(nil)
+      }.should raise_error(EC::ValidationError, /root needs to be a Hash/)
+    end
+    
+    should "raise ValidationError with empty string" do
+      lambda{
+        @spec.process('')
+      }.should raise_error(EC::ValidationError, /root needs to be a Hash/)
+    end
+    
+    should "raise ValidationError with empty hash" do
+      lambda{
+        @spec.process({})
+      }.should raise_error(EC::ValidationError, /root must not be empty./)
+    end
+    
+    should "not raise ValidationError with none empty hash" do
+      lambda{
+        @spec.process({ :bye => 'moon' })
+      }.should_not raise_error(EC::ValidationError)
+    end
+    
+    should "raise ValidationError with invalid child" do
+      lambda{
+        @spec.process({ :bye => 1 })
+      }.should raise_error(EC::ValidationError, /root.bye needs to be a String/)
+    end
+    
+  end
+  
+end

data/test/specification_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SpecificationTest < Test::Unit::TestCase
+  
+  context "Specification" do
+    
+    setup do
+      @spec = EC::Specification.new do |value|
+        value.should_be_a String
+        value.should_not_be_empty
+      end
+    end
+    
+    should "raise ValidationError with nil" do
+      lambda{
+        @spec.process(nil)
+      }.should raise_error(EC::ValidationError, /root needs to be a String/)
+    end
+    
+    should "raise ValidationError with empty string" do
+      lambda{
+        @spec.process('')
+      }.should raise_error(EC::ValidationError, /root must not be empty./)
+    end
+    
+  end
+  
+end

data/test/store_test.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class StoreTest < Test::Unit::TestCase
+  
+  context 'Store' do 
+    
+    setup do
+      @path = File.dirname(__FILE__)+'/test.yml'
+      File.open(@path, 'w+') do |f|
+        f.write YAML.dump({'general' => { 'name'  => 'ec', 'version' => '0.0.1' }})
+      end
+      
+      @path2 = File.dirname(__FILE__)+'/test2.yml'
+      File.open(@path2, 'w+') do |f|
+        f.write YAML.dump({'general' => { 'name'  => 'ec2' }})
+      end
+      
+      @store = EC::Store.new do |root|
+        root.map(:general) do |general|
+          general.should_be_present
+          general.conf(:name) do |name|
+            name.should_be_present
+            name.should_be_a String
+            name.should_not_be_empty
+          end
+        end
+      end
+      
+      @store.configure_with_yaml(@path)
+    end
+    
+    should "be valid" do
+      lambda { @store.validate }.should_not raise_error(EC::ValidationError)
+    end
+    
+    should "have correct data" do
+      @store.config[:general][:name].should be('ec')
+      @store.config[:general][:version].should be('0.0.1')
+    end
+    
+    should "merge data" do
+      @store.configure_with_yaml(@path2)
+      @store.config[:general][:name].should be('ec2')
+      @store.config[:general][:version].should be('0.0.1')
+    end
+    
+    should "reset!" do
+      @store.reset!
+      @store.config.should be({})
+    end
+    
+    should "reset!(true)" do
+      @store.reset!(true)
+      @store.config.should be({})
+      @store.specification.should be(nil)
+    end
+    
+  end
+  
+  def teardown
+    File.unlink @path  if File.exist? @path
+    File.unlink @path2 if File.exist? @path2
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,55 @@
+require 'test/unit'
+require 'rubygems'
+require 'context'
+require 'matchy'
+
+require File.dirname(__FILE__)+'/../lib/ec'
+
+class Test::Unit::TestCase
+  
+  def raise_error(obj = StandardError, msg_re=nil)
+    e = ::EC::RaiseExceptionExpectation.new(obj, self)
+    msg_re = Regexp.new(Regexp.escape(msg_re)) if msg_re.is_a? String
+    e.msg_re = msg_re
+    e
+  end
+  
+end
+
+module EC
+  class RaiseExceptionExpectation < Matchy::Expectations::Base
+    attr_accessor :msg_re
+    def matches?(receiver)
+      @receiver = receiver
+      begin
+        receiver.call
+        return false
+      rescue StandardError => e
+        @error = e
+        return false unless e.class.ancestors.include?(@expected)
+        return false if @msg_re and e.message !~ @msg_re
+      
+        return true
+      end
+    end
+    
+    def failure_message
+      extra = ""
+      if @error
+        if !@error.class.ancestors.include?(@expected)
+          extra = "but #{@error.class.name} was raised instead"
+        elsif @msg_re
+          extra = "but #{@error.message.inspect} did not match #{@msg_re.inspect}"
+        end
+      else
+        extra = "but none was raised"
+      end
+      
+      "Expected #{@receiver.inspect} to raise #{@expected.name}, #{extra}."
+    end
+    
+    def negative_failure_message
+      "Expected #{@receiver.inspect} to not raise #{@expected.name}."
+    end
+  end
+end

data/test/update_test.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class UpdateTest < Test::Unit::TestCase
+  
+  context "MapSpecification" do
+    
+    setup do
+      @spec = EC::MapSpecification.new do |map|
+        map.should_not_be_empty
+        map.conf(:hello) do |hello|
+          hello.should_be_a String
+          hello.should_not_be_empty
+        end
+        map.conf(:bye) do |bye|
+          bye.should_be_present
+        end
+        map.conf(:bye) do |bye|
+          bye.should_be_a String
+          bye.should_not_be_empty
+        end
+      end
+    end
+    
+    should "update with replace policy" do
+      @spec.update_policy = :replace
+      result = @spec.update({:hello => 'world', :bye => 'moon'}, {:hello => 'sun', :bye => 'earth'})
+      result.should be({:hello => 'sun', :bye => 'earth'})
+    end
+    
+    should "update with merge policy" do
+      @spec.update_policy = :merge
+      result = @spec.update({:hello => 'world', :bye => 'moon'}, {:bye => 'earth'})
+      result.should be({:hello => 'world', :bye => 'earth'})
+    end
+    
+  end
+  
+  context "ListSpecification" do
+    
+    setup do
+      @spec = EC::ListSpecification.new do |list|
+        list.should_not_be_empty
+        list.conf do |hello|
+          hello.should_be_a String
+          hello.should_not_be_empty
+        end
+      end
+    end
+    
+    should "update with replace policy" do
+      @spec.update_policy = :replace
+      result = @spec.update(%w( world moon ), %w( sun earth ))
+      result.should be(%w( sun earth ))
+    end
+    
+    should "update with merge policy" do
+      @spec.update_policy = :merge
+      result = @spec.update(%w( world moon ), %w( sun earth ))
+      result.should be(%w( world moon sun earth ))
+    end
+    
+  end
+  
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: simonmenke-ec
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Simon Menke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-24 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: simon.menke@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- test/list_specification_test.rb
+- test/map_specification_test.rb
+- test/specification_test.rb
+- test/store_test.rb
+- test/test_helper.rb
+- test/update_test.rb
+- LICENSE.txt
+- README.textile
+- lib/ec/list_specification.rb
+- lib/ec/macros.rb
+- lib/ec/map_specification.rb
+- lib/ec/specification.rb
+- lib/ec/store.rb
+- lib/ec.rb
+has_rdoc: true
+homepage: http://github.com/simonmenke/ec
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ec
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: EC (EasyConfig) brings verifiable configuration.
+test_files: 
+- test/list_specification_test.rb
+- test/map_specification_test.rb
+- test/specification_test.rb
+- test/store_test.rb
+- test/test_helper.rb
+- test/update_test.rb