arrayfu 0.0.2 → 0.0.3

data/lib/core/version.rb

@@ -1,3 +1,3 @@
 module ArrayFu
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/examples/class_usage.rb

@@ -0,0 +1,210 @@
+require 'spec_helper'
+
+example "Basic" do
+  class SomeClass
+    array :names
+  end
+
+  SomeClass.names.should_not be_nil
+end
+
+example 'Allow the array to have a read accessor' do
+  class SomeClass
+    array :names do|a|
+      a.readable
+    end
+  end
+  SomeClass.names.should_not be_nil
+end
+
+example 'Allow the array to have a write accessor' do
+  class SomeClass
+    array :names do|a|
+      a.writable
+    end
+  end
+  SomeClass.names.should_not be_nil
+end
+
+example 'Allow the array to have a read and write accessor' do
+  class SomeClass
+    array :names do|a|
+      a.read_and_write
+    end
+  end
+  SomeClass.names.should_not be_nil
+end
+
+example 'Add a mutator method to the class that stores the array' do
+  class SomeClass
+    array :names do|a|
+      a.mutator :add_item
+    end
+  end
+
+  SomeClass.add_item("JP")
+  SomeClass.names.count.should == 1
+end
+
+example 'Add multiple mutators to the class that stores the array' do
+  class SomeClass
+    array :names do|a|
+      a.mutator :add_item,:add_it,:push_it
+    end
+  end
+
+  SomeClass.add_item("JP")
+  SomeClass.add_it("JP")
+  SomeClass.push_it("JP")
+  SomeClass.names.count.should == 3
+end
+
+example 'Add a mutator that ignores addition' do
+  class SomeClass
+    array :names do|a|
+      a.mutator :add_item do|item|
+      end
+    end
+  end
+
+  SomeClass.add_item("JP")
+  SomeClass.names.count.should == 0
+end
+
+example 'Add a mutator that does other custom logic as well as addition' do
+  class SomeClass
+    array :secondary
+    array :names do|a|
+      a.mutator :add_item do|item|
+        @secondary.push item
+        @names.push item
+      end
+    end
+  end
+
+  SomeClass.add_item("JP")
+  SomeClass.names.count.should == 1
+  SomeClass.secondary.count.should == 1
+end
+
+example 'Add a singular constraint and failure condition to each of the mutators' do
+  class NotBeJP
+    include Singleton
+    def is_satisfied_by(item)
+      return item != "JP"
+    end
+    def name
+      return "The value should not be JP"
+    end
+  end
+  class CriteriaViolation
+    include Singleton
+    def run(description,value)
+      
+    end
+  end
+
+  class SomeClass
+    array :names do|a|
+      a.mutator :add_item,:add_it
+      a.new_item_must NotBeJP.instance,CriteriaViolation.instance
+    end
+  end
+
+  SomeClass.add_item("JP")
+  SomeClass.add_it("JP")
+  SomeClass.names.count.should == 0
+end
+
+example 'Add multiple constraints and a failure condition to each of the mutators' do
+  class NotBeJP
+    include Singleton
+    def is_satisfied_by(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)
+      return item != nil
+    end
+    def name
+      return "The value should not be nil"
+    end
+  end
+  class CriteriaViolation
+    include Singleton
+    def run(description,value)
+      
+    end
+  end
+
+  class SomeClass
+    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
+  end
+
+  SomeClass.add_item("JP")
+  SomeClass.add_it("JP")
+  SomeClass.add_item(nil)
+  SomeClass.names.count.should == 0
+end
+
+example 'Add an explicit processing visitor to the array' do
+  class DisplayItem
+    @@number_of_items_displayed = 0
+    class << self
+      def run_using(item)
+        @@number_of_items_displayed += 1
+      end
+      def item_count
+        return @@number_of_items_displayed
+      end
+    end
+  end
+
+  class SomeClass
+    array :names do|a|
+      a.mutator :add_item
+      a.process_using :display_all,DisplayItem
+    end
+  end
+
+  (1..10).each{|item| SomeClass.add_item(item)}
+  SomeClass.display_all
+  DisplayItem.item_count.should == 10
+end
+
+example 'Add an method based processing visitor to the array based on a method that exists on the items in the array' do
+  class Item
+    def process
+      SomeClass.increment
+    end
+  end
+
+  class SomeClass
+    @@items_visited = 0
+    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
+    end
+    def self.number_of_items_visited
+      @@items_visited
+    end
+  end
+
+  (1..10).each{|item| SomeClass.add_item(Item.new)}
+  SomeClass.display_all
+  SomeClass.number_of_items_visited.should == 10
+end

data/spec/examples/instance_usage.rb

@@ -0,0 +1,243 @@
+require 'spec_helper'
+
+example "Basic" do
+  class SomeClass
+    def initialize
+      array :names
+    end
+  end
+
+  SomeClass.new.names.should_not be_nil 
+end
+
+example 'Allow the array to have a read accessor' do
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.readable
+      end
+    end
+  end
+  SomeClass.new.names.should_not be_nil
+end
+
+example 'Allow the array to have a write accessor' do
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.writable
+      end
+    end
+  end
+  SomeClass.new.names.should_not be_nil
+end
+
+example 'Allow the array to have a read and write accessor' do
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.read_and_write
+      end
+    end
+  end
+  SomeClass.new.names.should_not be_nil
+end
+
+example 'Add a mutator method to the class that stores the array' do
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.mutator :add_item
+      end
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("JP")
+  items.names.count.should == 1
+end
+
+example 'Add multiple mutators to the class that stores the array' do
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.mutator :add_item,:add_it,:push_it
+      end
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("JP")
+  items.add_it("JP")
+  items.push_it("JP")
+  items.names.count.should == 3
+end
+
+example 'Add a mutator that ignores addition' do
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.mutator :add_item do|item|
+        end
+      end
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("JP")
+  items.names.count.should == 0
+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
+      end
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("JP")
+  items.names.count.should == 1
+  items.secondary.count.should == 1
+end
+
+example 'Add a singular constraint and failure condition to each of the mutators' do
+  class NotBeJP
+    include Singleton
+    def is_satisfied_by(item)
+      return item != "JP"
+    end
+    def name
+      return "The value should not be JP"
+    end
+  end
+  class CriteriaViolation
+    include Singleton
+    def run(description,value)
+
+    end
+  end
+
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.mutator :add_item,:add_it
+        a.new_item_must NotBeJP.instance,CriteriaViolation.instance
+      end
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("JP")
+  items.add_it("JP")
+  items.names.count.should == 0
+end
+
+example 'Add multiple constraints and a failure condition to each of the mutators' do
+  class NotBeJP
+    include Singleton
+    def is_satisfied_by(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)
+      return item != nil
+    end
+    def name
+      return "The value should not be nil"
+    end
+  end
+  class CriteriaViolation
+    include Singleton
+    def run(description,value)
+
+    end
+  end
+
+  class SomeClass
+    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
+    end
+  end
+
+  items = SomeClass.new
+  items.add_item("JP")
+  items.add_it("JP")
+  items.add_item(nil)
+  items.names.count.should == 0
+end
+
+example 'Add an explicit processing visitor to the array' do
+  class DisplayItem
+    @@number_of_items_displayed = 0
+    class << self
+      def run_using(item)
+        @@number_of_items_displayed += 1
+      end
+      def item_count
+        return @@number_of_items_displayed
+      end
+    end
+  end
+
+  class SomeClass
+    def initialize
+      array :names do|a|
+        a.mutator :add_item
+        a.process_using :display_all,DisplayItem
+      end
+    end
+  end
+
+  items = SomeClass.new
+  (1..10).each{|item| items.add_item(item)}
+  items.display_all
+  DisplayItem.item_count.should == 10
+end
+
+example 'Add an method based processing visitor to the array based on a method that exists on the items in the array' do
+  class Item
+    def process
+      SomeClass.increment
+    end
+  end
+
+  class SomeClass
+    @@items_visited = 0
+
+    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
+    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
+    end
+    def self.number_of_items_visited
+      @@items_visited
+    end
+  end
+
+  items = SomeClass.new
+  (1..10).each{|item| items.add_item(Item.new)}
+  items.display_all
+  SomeClass.number_of_items_visited.should == 10
+end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'fileutils'
 require 'fakes-rspec'
 require 'singleton'
+require 'rspec'
+
+include RSpec::Matchers
 
 Dir.chdir(File.join(File.dirname(__FILE__),"..,lib".split(','))) do
   require 'arrayfu.rb'
@@ -15,3 +18,10 @@ def catch_exception
   exception
 end
 
+def example name,&block
+  describe "Example:" do
+    it name do
+      yield
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arrayfu
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70297638968580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70297638968580
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70297638968140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70297638968140
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70297638967680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70297638967680
 - !ruby/object:Gem::Dependency
   name: fakes-rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70297638967240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,12 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70297638967240
 description: Simple DSL For Declaritive Arrays
 email:
 - open_source@developwithpassion.com
@@ -102,6 +82,8 @@ files:
 - lib/core/visitor_detail.rb
 - lib/core/visitor_detail_step.rb
 - lib/core/writeable_step.rb
+- spec/examples/class_usage.rb
+- spec/examples/instance_usage.rb
 - spec/spec_helper.rb
 - spec/specs/add_criterion_spec.rb
 - spec/specs/dsl_spec.rb
@@ -131,11 +113,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: arrayfu
-rubygems_version: 1.8.21
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Simple DSL For Declaritive Arrays
 test_files:
+- spec/examples/class_usage.rb
+- spec/examples/instance_usage.rb
 - spec/spec_helper.rb
 - spec/specs/add_criterion_spec.rb
 - spec/specs/dsl_spec.rb