arrayfu 0.0.8 → 0.1.0

data/spec/examples/{instance_usage.rb → usage.rb}

@@ -2,31 +2,39 @@ require 'spec_helper'
 
 example "Basic" do
   class SomeClass
-    def initialize
-      array :names
-    end
-  end
+    include ArrayFu
 
-  SomeClass.new.names.should_not be_nil 
+    array :names
+
+  end
 end
 
 example 'Allow the array to have a read accessor' do
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.readable
+    end
+
     def initialize
-      array :names do|a|
-        a.readable
-      end
+      initialize_arrayfu
     end
+
   end
   SomeClass.new.names.should_not be_nil
 end
 
 example 'Allow the array to have a write accessor' do
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.writable
+    end
+
     def initialize
-      array :names do|a|
-        a.writable
-      end
+      initialize_arrayfu
     end
   end
   SomeClass.new.names.should_not be_nil
@@ -34,10 +42,14 @@ end
 
 example 'Allow the array to have a read and write accessor' do
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.read_and_write
+    end
+
     def initialize
-      array :names do|a|
-        a.read_and_write
-      end
+      initialize_arrayfu
     end
   end
   SomeClass.new.names.should_not be_nil
@@ -45,10 +57,13 @@ end
 
 example 'Add a mutator method to the class that stores the array' do
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item
+    end
     def initialize
-      array :names do|a|
-        a.mutator :add_item
-      end
+      initialize_arrayfu
     end
   end
 
@@ -59,11 +74,15 @@ end
 
 example 'Add multiple mutators to the class that stores the array' do
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item, :add_it, :push_it
+    end
     def initialize
-      array :names do|a|
-        a.mutator :add_item,:add_it,:push_it
-      end
+      initialize_arrayfu
     end
+
   end
 
   items = SomeClass.new
@@ -75,12 +94,16 @@ end
 
 example 'Add a mutator that ignores addition' do
   class SomeClass
-    def initialize
-      array :names do|a|
-        a.mutator :add_item do|item|
-        end
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item do|item|
       end
     end
+    def initialize
+      initialize_arrayfu
+    end
+
   end
 
   items = SomeClass.new
@@ -90,15 +113,23 @@ end
 
 example 'Add a mutator that does other custom logic as well as addition' do
   class SomeClass
-    def initialize
-      array :secondary
-      array :names do|a|
-        a.mutator :add_item do|item|
-          @secondary.push item
-          @names.push item
-        end
+    include ArrayFu
+
+    array :secondary do |a|
+      a.readable
+    end
+
+    array :names do|a|
+      a.readable
+      a.mutator :add_item do|item|
+        @secondary.push item
+        @names.push item
       end
     end
+
+    def initialize
+      initialize_arrayfu
+    end
   end
 
   items = SomeClass.new
@@ -108,28 +139,36 @@ example 'Add a mutator that does other custom logic as well as addition' do
 end
 
 example 'Add a singular constraint and failure condition to each of the mutators' do
-  class NotBeJP
-    include Singleton
-    def is_satisfied_by(item)
+  module NotBeJP
+    extend self
+
+    def matches?(item)
       return item != "JP"
     end
+
     def name
       return "The value should not be JP"
     end
   end
-  class CriteriaViolation
-    include Singleton
+
+  module CriteriaViolation
+    extend self
+
     def run(description,value)
 
     end
   end
 
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item,:add_it
+      a.new_item_must NotBeJP, CriteriaViolation
+    end
+
     def initialize
-      array :names do|a|
-        a.mutator :add_item,:add_it
-        a.new_item_must NotBeJP.instance,CriteriaViolation.instance
-      end
+      initialize_arrayfu
     end
   end
 
@@ -140,38 +179,49 @@ example 'Add a singular constraint and failure condition to each of the mutators
 end
 
 example 'Add multiple constraints and a failure condition to each of the mutators' do
-  class NotBeJP
-    include Singleton
-    def is_satisfied_by(item)
+  module NotBeJP
+    extend self
+
+    def matches?(item)
       return item != "JP"
     end
+
     def name
       return "The value should not be JP"
     end
   end
-  class NotBeNil
-    include Singleton
-    def is_satisfied_by(item)
+
+  module NotBeNil
+    extend self
+
+    def matches?(item)
       return item != nil
     end
+
     def name
       return "The value should not be nil"
     end
   end
-  class CriteriaViolation
-    include Singleton
-    def run(description,value)
 
+  module CriteriaViolation
+    extend self
+
+    def run(description,value)
+      # puts "Criteria violated - #{description} - #{value}"
     end
   end
 
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item,:add_it
+      a.addition_constraint NotBeJP
+      a.addition_constraint NotBeNil, CriteriaViolation
+    end
+
     def initialize
-      array :names do|a|
-        a.mutator :add_item,:add_it
-        a.new_item_must NotBeJP.instance,CriteriaViolation.instance
-        a.new_item_must NotBeNil.instance,CriteriaViolation.instance
-      end
+      initialize_arrayfu
     end
   end
 
@@ -196,12 +246,16 @@ example 'Add an explicit processing visitor to the array' do
   end
 
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item
+      a.process_using :display_all,DisplayItem
+    end
     def initialize
-      array :names do|a|
-        a.mutator :add_item
-        a.process_using :display_all,DisplayItem
-      end
+      initialize_arrayfu
     end
+
   end
 
   items = SomeClass.new
@@ -219,14 +273,14 @@ example 'Add an method based processing visitor to the array based on a method t
 
   class SomeClass
     @@items_visited = 0
+    include ArrayFu
 
-    def initialize
-      array :names do|a|
-        a.mutator :add_item
-        a.process_using :display_all,:process #the second symbol is the name of a method on an element in the array
-      end
+    array :names do|a|
+      a.mutator :add_item
+      a.process_using :display_all, :process #the second symbol is the name of a method on an element in the array
     end
 
+
     #the process method of the Item class invokes this method (a little bit roundabout, but it hopefully demonstrates the capability
     def self.increment
       @@items_visited += 1
@@ -234,6 +288,9 @@ example 'Add an method based processing visitor to the array based on a method t
     def self.number_of_items_visited
       @@items_visited
     end
+    def initialize
+      initialize_arrayfu
+    end
   end
 
   items = SomeClass.new
@@ -250,12 +307,15 @@ example 'Augment configuration using configuration block' do
   end
 
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item
+      a.configure_using ArrayConfigs.add_another_mutator
+    end
 
     def initialize
-      array :names do|a|
-        a.mutator :add_item
-        a.configure_using ArrayConfigs.add_another_mutator
-      end
+      initialize_arrayfu
     end
   end
 
@@ -265,23 +325,60 @@ example 'Augment configuration using configuration block' do
   items.names.count.should == 2
 end
 
-example 'Augment configuration using configuration instance' do
-  class ArrayConfigs
+example 'Augment configuration using configuration instance (anything that responds to configure with the array definition as the argument)' do
+
+  module ArrayConfiguration
+    extend self
+
     def configure(item)
       item.mutator :once_more
     end
   end
 
   class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item
+      a.configure_using ArrayConfiguration
+    end
 
     def initialize
-      array :names do|a|
-        a.mutator :add_item
-        a.configure_using ArrayConfigs.new
+      initialize_arrayfu
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("Yo")
+  items.once_more("Yo")
+  items.names.count.should == 2
+end
+
+example 'Augment configuration using configuration block' do
+
+  module ArrayConfiguration
+    extend self
+
+    def configuration_block
+      Proc.new do|array|
+        array.mutator :once_more
       end
     end
   end
 
+  class SomeClass
+    include ArrayFu
+
+    array :names do|a|
+      a.mutator :add_item
+      a.configure_using ArrayConfiguration.configuration_block
+    end
+    def initialize
+      initialize_arrayfu
+    end
+
+  end
+
   items = SomeClass.new
   items.add_item("Yo")
   items.once_more("Yo")

data/spec/specs/{dsl_spec.rb → array_definition_spec.rb}

@@ -1,29 +1,29 @@
 require 'spec_helper'
 
 module ArrayFu
-  describe Dsl do
-    context "when a criteria is specified" do
+  describe ArrayDefinition do
+    context "when a constraint is specified" do
       let(:fail_option){fake}
-      let(:real_criteria){fake}
-      let(:criteria){fake}
-      let(:sut){Dsl.new(:name)}
+      let(:real_constraint){fake}
+      let(:constraint){fake}
+      let(:sut){ArrayDefinition.new(:name)}
       before (:each) do
-        AddCriterion.stub(:new).with(real_criteria,fail_option).and_return(criteria)
+        ItemConstraint.stub(:new).with(real_constraint,fail_option).and_return(constraint)
       end
       before (:each) do
-        sut.new_item_must(real_criteria,fail_option)
+        sut.new_item_must(real_constraint,fail_option)
       end
       it "should be added to the list of add specifications for the array" do
-        sut.criteria[0].should == criteria
+        sut.constraints[0].should == constraint
       end
     end
     context "when specifying mutators" do
       context "and a singular mutator is specified" do
         let(:mutator){fake}
         let(:name){"sdfsdf"}
-        let(:sut){Dsl.new("sdf")}
+        let(:sut){ArrayDefinition.new("sdf")}
         before (:each) do
-          MutatorDetail.stub(:new).with(name,nil).and_return(mutator)
+          MutatorDefinition.stub(:new).with(name,nil).and_return(mutator)
         end
         before (:each) do
           sut.mutator(name)
@@ -34,10 +34,10 @@ module ArrayFu
       end
       context "and a set of mutators are specified" do
         let(:mutator){fake}
-        let(:sut){Dsl.new("sdf")}
+        let(:sut){ArrayDefinition.new("sdf")}
         before (:each) do
-          MutatorDetail.stub(:new).with(:sdf,nil).and_return(mutator)
-          MutatorDetail.stub(:new).with(:other,nil).and_return(mutator)
+          MutatorDefinition.stub(:new).with(:sdf,nil).and_return(mutator)
+          MutatorDefinition.stub(:new).with(:other,nil).and_return(mutator)
         end
         before (:each) do
           sut.mutator(:sdf,:other)
@@ -52,9 +52,9 @@ module ArrayFu
       let(:visitor){fake}
       let(:the_visitor){fake}
       let(:name){"sdfsdf"}
-      let(:sut){Dsl.new("sdf")}
+      let(:sut){ArrayDefinition.new("sdf")}
       before (:each) do
-        VisitorDetail.stub(:new).with(name,the_visitor).and_return(visitor)
+        VisitorDefinition.stub(:new).with(name,the_visitor).and_return(visitor)
       end
       before (:each) do
         sut.process_using(name,the_visitor)
@@ -68,7 +68,7 @@ module ArrayFu
       context "and they are explicit configurators" do
         let(:configurator1){fake}
         let(:configurator2){fake}
-        subject{Dsl.new('name')}
+        subject{ArrayDefinition.new('name')}
 
         before (:each) do
           def configurator1.respond_to?(name) true end
@@ -79,7 +79,7 @@ module ArrayFu
           subject.configure_using configurator1,configurator2
         end
 
-        it "should invoke the configurator with the dsl" do
+        it "should invoke the configurator with the definition" do
           configurator1.should have_received(:configure,subject)
           configurator2.should have_received(:configure,subject)
         end
@@ -88,7 +88,7 @@ module ArrayFu
       context "and they are a set of blocks" do
         let(:configurator1){fake}
         let(:configurator2){fake}
-        subject{Dsl.new('name')}
+        subject{ArrayDefinition.new('name')}
         before (:each) do
           @first_ran = false
           @second_ran = false
@@ -98,7 +98,7 @@ module ArrayFu
           subject.configure_using lambda{|item| item.should == subject;@first_ran = true},lambda{|item| item.should == subject;@second_ran = true}
         end
 
-        it "should invoke each block with the dsl" do
+        it "should invoke each block with the definition" do
           @first_ran.should be_true
           @second_ran.should be_true
         end
@@ -106,7 +106,7 @@ module ArrayFu
 
       context "and they are a mixture of blocks and explicit configurators" do
         let(:configurator1){fake}
-        subject{Dsl.new('name')}
+        subject{ArrayDefinition.new('name')}
         before (:each) do
           @first_ran = false
           def configurator1.respond_to?(name) true end
@@ -121,8 +121,6 @@ module ArrayFu
           configurator1.should have_received(:configure,subject)
         end
       end
-      
     end
-
   end
 end