the_array_comparator 0.1.1 → 0.2.0

data/.yardopts

@@ -0,0 +1,6 @@
+--verbose
+-
+API-GUIDE.md
+CONTRIBUTIONS.md
+LICENSE.md
+RELEASE_NOTES.md

data/API-GUIDE.md

@@ -0,0 +1,18 @@
+# API Guide
+
+This very brief documentation should give you a good starting point on how to discover the API:
+
+```
+Comparator                           # Main class dispatching the work
+|
+-- Check, Result, Sample             # Helper classes for easier testing
+|
+-- Strategies
+|  |
+|  -- ContainsAll                    # Strategies doing the hard work:
+|  |                                 # compare data with keywords and
+|  -- ...                            # return the result
+|
+-- Cache                             # Cache checks for easier retrieval
+ 
+```

data/README.md

@@ -112,10 +112,15 @@ If you wish to write your own comparators you can do so. Just register those cla
 TheArrayComparator::Comparator.register :my_contains, Strategies::MyContains
 ```
 
+## Further reading
+
+Please the the full api-documentation on [rdoc info](http://rdoc.info/github/maxmeyer/the_array_comparator/frames) for further reading.
+I just give you a brief overview of all the available methods. There's also a brief [guide](API-GUIDE.md) about howto discover the API.
+
 ## Contributing
 
-Please see CONTRIBUTIONS.md
+Please see [CONTRIBUTIONS.md](CONTRIBUTIONS.md).
 
 ## Copyright
 
-(c) 2013 Max Meyer. All rights reserved. Please also see LICENSE.md
+(c) 2013 Max Meyer. All rights reserved. Please also see [LICENSE.md](LICENSE.md).

data/Rakefile

@@ -11,7 +11,7 @@ unless ENV['TRAVIS_CI'] == 'true'
 end
 
 YARD::Rake::YardocTask.new() do |y|
-  y.options << '--verbose'
+#  y.options << '--verbose'
 end
 
 desc 'start tmux'

data/lib/the_array_comparator/cache.rb

@@ -0,0 +1,66 @@
+#encoding: utf-8
+
+# the main module
+module TheArrayComparator
+  #caching class
+  class Cache
+
+    # Create cache
+    def initialize
+      @cache = []
+      @new_objects = false
+    end
+
+    # Add object to cache
+    #
+    # @param [Object] obj
+    #   the object which should be added to the cache
+    #
+    # @return [Object]
+    #   the object which has beed added
+    def add(obj)
+      @cache << obj
+      @new_objects = true
+
+      obj
+    end
+
+    # Return all stored objects
+    #
+    # @return [Array]
+    #   the cache
+    def stored_objects
+      @new_objects = false
+      @cache
+    end
+
+    # Clear the cache (delete all objects)
+    def clear
+      @cache = []
+    end
+
+    # Are there new objects
+    #
+    # @return [TrueClass,FalseClass]
+    #   the result of the check
+    def new_objects?
+      @new_objects
+    end
+
+    # Delete an object from cache by number
+    #
+    # @return
+    #   the deleted object
+    def delete_object(num)
+      @cache.delete_at(num)
+    end
+
+    # Request an object from cache by number
+    #
+    # @return
+    #   the requested object
+    def fetch_object(num)
+      @cache[num]
+    end
+  end
+end

data/lib/the_array_comparator/comparator.rb

@@ -40,7 +40,7 @@ module TheArrayComparator
     # @return [Comparator]
     #   a new comparator
     def initialize
-      @checks = []
+      @cache = Cache.new
     end
 
     # Add a check to test against
@@ -76,12 +76,15 @@ module TheArrayComparator
       strategy_klass = Comparator.comparators[type]
       check = Check.new(strategy_klass,sample)
 
-      @checks << check
-      return check
+      @cache.add check
     end
 
+    # The result of all checks defined
+    #
+    # @return [Result] 
+    #   the result class with all the data need for further analysis
     def result
-      @checks.each { |c| return Result.new(c.sample) unless c.success? }
+      @cache.stored_objects.each { |c| return Result.new(c.sample) unless c.success? }
 
       Result.new
     end
@@ -100,8 +103,8 @@ module TheArrayComparator
     # @param [Integer] number
     #   the index of the check which should be deleted
     def delete_check(number)
-      if @checks[number]
-        @checks.delete_at(number) 
+      if @cache.fetch_object(number)
+        @cache.delete_object(number) 
       else
         raise Exceptions::CheckDoesNotExist, "You tried to delete a check, which does not exist!"
       end
@@ -117,7 +120,7 @@ module TheArrayComparator
     # @return [Array]
     #   all available checks
     def list_checks
-      @checks
+      @cache.stored_objects
     end
   end
 end

data/lib/the_array_comparator/sample.rb

@@ -17,10 +17,23 @@ module TheArrayComparator
     #   description of the probe
     attr_accessor :data, :keywords, :exceptions, :tag
 
-    def initialize(data=[],keywords=[],exceptions=[],tag=nil)
-      @keywords = keywords
-      @data = data
-      @exceptions = exceptions
+    # New sample
+    #
+    # @param [Array] data ([])
+    #  the data to look for keywords
+    #
+    # @param [Set] keywords (Set.new)
+    #   the keywords (singular values/arrays will be transformed to a set)
+    #
+    # @param [Set] exceptions (Set.new)
+    #   the exceptions  (singular values/arrays will be transformed to a set)
+    #
+    # @param [String] tag (nil)
+    #   a tag to identify a sample
+    def initialize(data=[],keywords=Set.new,exceptions=Set.new,tag=nil)
+      @keywords = Set.new( [ *keywords ] )
+      @data = *data
+      @exceptions = Set.new( [ *exceptions ] )
       @tag = tag
     end
 

data/lib/the_array_comparator/version.rb

@@ -1,6 +1,4 @@
-#encoding: utf-8
-
 #main TheArrayComparator
 module TheArrayComparator
-  VERSION = '0.1.1'
-end
+  VERSION = '0.2.0'
+end

data/lib/the_array_comparator.rb

@@ -6,6 +6,7 @@ require 'forwardable'
 
 require 'the_array_comparator/version'
 require 'the_array_comparator/exceptions'
+require 'the_array_comparator/cache'
 require 'the_array_comparator/sample'
 require 'the_array_comparator/check'
 require 'the_array_comparator/result'

data/spec/cache_spec.rb

@@ -0,0 +1,89 @@
+#enconding: utf-8
+require 'spec_helper'
+
+describe Cache do
+
+  let(:cache) { Cache.new }
+
+  it "adds abitrary objects to cache" do
+    expect {
+      cache.add %w{obj}
+      cache.add('obj')
+    }.to_not raise_error
+  end
+
+  it "returns all cached objects" do
+    objects = []
+
+    objects << cache.add('obj')
+    objects << cache.add('obj')
+    objects << cache.add('obj')
+
+    expect(cache.stored_objects).to eq(objects)
+  end
+
+  it "clears cache" do
+    cache.add('obj')
+    cache.add('obj')
+    cache.add('obj')
+    expect(cache.stored_objects.size).to eq(3) 
+
+    cache.clear
+    expect(cache.stored_objects.size).to eq(0) 
+  end
+
+  it "tells the requester if there are new objects" do
+    cache.add('obj')
+    expect(cache.new_objects?).to eq(true) 
+  end
+
+  it "tells the requester if there __no__ new objects" do
+    cache.add('obj')
+    cache.stored_objects
+    expect(cache.new_objects?).to eq(false) 
+  end
+
+  it "works with sub-sequent requests to the cache as well" do
+    cache.add('obj')
+    cache.stored_objects
+    cache.add('obj')
+    expect(cache.new_objects?).to eq(true) 
+
+    cache.add('obj')
+    cache.stored_objects
+    cache.add('obj')
+    cache.stored_objects
+    expect(cache.new_objects?).to eq(false) 
+  end
+
+  it "returns the same objecs if requested multiple times" do
+    cache.add('obj')
+    cache.add('obj')
+    run1 = cache.stored_objects
+    run2 = cache.stored_objects
+
+    expect(run1).to be(run2) 
+    expect(run1).to eq(run2) 
+  end
+
+  it "deletes specific objects from cache (by number)" do
+    cache.add('obj')
+    c_created = cache.add('obj')
+    cache.add('obj')
+
+    c_deleted = cache.delete_object(1) 
+
+    expect(c_created).to eq(c_deleted)
+  end
+
+  it "gets you a specific object" do
+    cache.add('obj')
+    c_created = cache.add('obj')
+    cache.add('obj')
+
+    c_fetched = cache.fetch_object(1) 
+
+    expect(c_created).to eq(c_fetched)
+  end
+
+end

data/spec/comparator/comparator_spec.rb

@@ -91,7 +91,7 @@ describe Comparator do
     expect(result).to eq(true)
   end
   
-  it "fails if a least one subtest fails", :test => true do
+  it "fails if a least one subtest fails" do
     comparator = Comparator.new
     data = %w{ a b c d }
     keyword_overlap = %w{ a }
@@ -182,7 +182,7 @@ describe Comparator do
     expect(result.of_checks).to eq(true)
   end
 
-  it "tells you which check has failed and made the whole thing failed" do
+  it "tells you which check has failed and made the whole thing failed" , :test => true do
     comparator = Comparator.new
     data = %w{ a b c d }
     keyword_successfull = %w{ a b }

data/spec/sample_spec.rb

@@ -17,8 +17,22 @@ describe Sample do
       sample = Sample.new(data, keywords, exceptions, tag)
 
       expect(sample.data).to eq(data)
-      expect(sample.keywords).to eq(keywords)
-      expect(sample.exceptions).to eq(exceptions)
+      expect(sample.keywords).to eq(Set.new(keywords))
+      expect(sample.exceptions).to eq(Set.new(exceptions))
       expect(sample.tag).to eq(tag)
   end
+
+  it "takes singular values and return them into arrays" do
+      data = 'data'
+      keywords = 'keywords'
+      exceptions = 'exceptions'
+
+      sample = Sample.new(data, keywords, exceptions)
+
+      expect(sample.data).to eq([ data ])
+      expect(sample.keywords).to eq(Set.new( [ keywords ] ) )
+      expect(sample.exceptions).to eq(Set.new( [ exceptions ] ) )
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_array_comparator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -38,6 +38,8 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- .yardopts
+- API-GUIDE.md
 - CONTRIBUTIONS.md
 - Gemfile
 - Gemfile.lock
@@ -49,6 +51,7 @@ files:
 - gemfiles/Gemfile.default
 - gemfiles/Gemfile.travis
 - lib/the_array_comparator.rb
+- lib/the_array_comparator/cache.rb
 - lib/the_array_comparator/check.rb
 - lib/the_array_comparator/comparator.rb
 - lib/the_array_comparator/exceptions.rb
@@ -70,6 +73,7 @@ files:
 - script/console
 - script/terminal
 - spec/benchmark/benchmark_spec.rb
+- spec/cache_spec.rb
 - spec/check_spec.rb
 - spec/comparator/base_spec.rb
 - spec/comparator/comparator_spec.rb
@@ -113,6 +117,7 @@ specification_version: 3
 summary: you need to compare arrays? then this gem is very suitable for you.
 test_files:
 - spec/benchmark/benchmark_spec.rb
+- spec/cache_spec.rb
 - spec/check_spec.rb
 - spec/comparator/base_spec.rb
 - spec/comparator/comparator_spec.rb