the_array_comparator 0.2.0 → 0.3.0

data/.rspec

@@ -1,2 +1,3 @@
 --format Fuubar
---t "~bm"
+-t "~bm"
+--order rand

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec 
 

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    the_array_comparator (0.1.1)
+    the_array_comparator (0.2.0)
       active_support
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     active_support (3.0.0)
       activesupport (= 3.0.0)
@@ -17,16 +17,16 @@ GEM
       rspec-expectations (>= 2.7.0)
     awesome_print (1.1.0)
     builder (3.1.4)
-    childprocess (0.3.7)
-      ffi (~> 1.0, >= 1.0.6)
+    childprocess (0.3.8)
+      ffi (~> 1.0, >= 1.0.11)
     chronic (0.9.0)
-    churn (0.0.27)
+    churn (0.0.28)
       chronic (>= 0.2.3)
       hirb
       json_pure
       main
-      ruby_parser (~> 3.1.0)
-      sexp_processor (~> 4.1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.1)
     coderay (1.0.8)
     columnize (0.3.6)
     cucumber (1.2.1)
@@ -34,37 +34,37 @@ GEM
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
-    debugger (1.3.0)
+    debugger (1.3.1)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.1.1)
-      debugger-ruby_core_source (~> 1.1.7)
+      debugger-ruby_core_source (~> 1.1.8)
     debugger-linecache (1.1.2)
       debugger-ruby_core_source (>= 1.1.1)
-    debugger-ruby_core_source (1.1.7)
+    debugger-ruby_core_source (1.1.8)
     diff-lcs (1.1.3)
     fattr (2.2.1)
     ffaker (1.15.0)
-    ffi (1.3.1)
+    ffi (1.4.0)
     fuubar (1.1.0)
       rspec (~> 2.0)
       rspec-instafail (~> 0.2.0)
       ruby-progressbar (~> 1.0.0)
-    gherkin (2.11.5)
-      json (>= 1.4.6)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
     github-markup (0.7.5)
     hashr (0.0.22)
     hirb (0.7.1)
-    json (1.7.6)
-    json_pure (1.7.6)
+    json (1.7.7)
+    json_pure (1.7.7)
     main (5.1.1)
       arrayfields (>= 4.7.4)
       chronic (>= 0.6.2)
       fattr (>= 2.2.0)
       map (>= 5.1.0)
-    map (6.2.0)
+    map (6.3.0)
     method_source (0.8.1)
-    multi_json (1.5.0)
-    pry (0.9.11.4)
+    multi_json (1.6.1)
+    pry (0.9.12)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
@@ -85,7 +85,7 @@ GEM
     ruby-progressbar (1.0.2)
     ruby_parser (3.1.1)
       sexp_processor (~> 4.1)
-    sexp_processor (4.1.4)
+    sexp_processor (4.1.5)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
@@ -94,9 +94,9 @@ GEM
     thor (0.17.0)
     tmrb (1.2.7)
       thor
-    travis-lint (1.5.0)
+    travis-lint (1.6.0)
       hashr (~> 0.0.22)
-    yard (0.8.3)
+    yard (0.8.4.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -9,7 +9,7 @@ Can be used to compare to arrays with a consistent api.
 
 Add this line to your application's Gemfile:
 
-    gem 'comparator'
+    gem 'the_array_comparator'
 
 And then execute:
 
@@ -17,7 +17,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install comparator
+    $ gem install the_array_comparator
 
 ## Usage
 

data/TODO.md

@@ -1 +1,2 @@
-* Add clear (last) probe
+* Cache -> only check if there are __no__ new objects
+

data/gemfiles/Gemfile.default

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec 
 

data/lib/the_array_comparator/cache.rb

@@ -3,64 +3,63 @@
 # the main module
 module TheArrayComparator
   #caching class
-  class Cache
+  class Cache < StrategyDispatcher
 
-    # Create cache
-    def initialize
-      @cache = []
-      @new_objects = false
-    end
+    strategy_reader :caching_strategies
+    attr_reader :caches
 
-    # 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
+    # Variable to store available caches
+    def initialize
+      super()
+      @caches = {}
 
-      obj
+      register :anonymous_cache, CachingStrategies::AnonymousCache
+      register :single_value_cache, CachingStrategies::SingleValueCache
     end
 
-    # Return all stored objects
-    #
-    # @return [Array]
-    #   the cache
-    def stored_objects
-      @new_objects = false
-      @cache
+    # @see [StrategyDispatcher]
+    def class_must_have_methods
+      [
+        :add,
+        :clear,
+        :stored_objects,
+        :new_objects?,
+        :delete_object,
+        :fetch_object,
+      ]
     end
 
-    # Clear the cache (delete all objects)
-    def clear
-      @cache = []
+    # @see [StrategyDispatcher]
+    def exception_to_raise_for_invalid_strategy
+      Exceptions::IncompatibleCachingStrategy
     end
 
-    # Are there new objects
+    # Retrieve cache 
     #
-    # @return [TrueClass,FalseClass]
-    #   the result of the check
-    def new_objects?
-      @new_objects
-    end
+    # @param [Symbol] cache
+    #   the cache to be used
+    def [](cache)
+      c = cache.to_sym
 
-    # Delete an object from cache by number
-    #
-    # @return
-    #   the deleted object
-    def delete_object(num)
-      @cache.delete_at(num)
+      raise Exceptions::CacheDoesNotExist, "Unknown cache \":#{c}\" given. Did you create it in advance?"  unless caches.has_key?(c)
+      caches[c]
     end
 
-    # Request an object from cache by number
+    # Add a new cache
+    #
+    # @param [Symbol] cache
+    #   the cache to be created
     #
-    # @return
-    #   the requested object
-    def fetch_object(num)
-      @cache[num]
+    # @param [Symbol] strategy
+    #   the cache strategy to be used
+    def add(cache,strategy)
+      c = cache.to_sym
+      s = strategy.to_sym
+
+      raise Exceptions::UnknownCachingStrategy, "Unknown caching strategy \":#{strategy}\" given. Did you register it in advance?"  unless caching_strategies.has_key?(strategy)
+
+      caches[c] = caching_strategies[s].new 
+      caches[c]
     end
   end
 end

data/lib/the_array_comparator/caching_strategies/anonymous_cache.rb

@@ -0,0 +1,69 @@
+#encoding: utf-8
+
+# the main module
+module TheArrayComparator
+  #caching strategies
+  module CachingStrategies
+    #anonymous cache
+    class AnonymousCache
+
+      # 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
+end

data/lib/the_array_comparator/caching_strategies/single_value_cache.rb

@@ -0,0 +1,69 @@
+#encoding: utf-8
+
+# the main module
+module TheArrayComparator
+  #caching strategies
+  module CachingStrategies
+    #anonymous cache
+    class SingleValueCache
+
+      # 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
+        @cache.delete_at(0)
+      end
+
+      # Request an object from cache by number
+      #
+      # @return
+      #   the requested object
+      def fetch_object
+        @cache[0]
+      end
+    end
+  end
+end

data/lib/the_array_comparator/comparator.rb

@@ -1,46 +1,48 @@
 #encoding: utf-8
+require 'the_array_comparator/caching_strategies/anonymous_cache'
+require 'the_array_comparator/caching_strategies/single_value_cache'
 
 # the main module
 module TheArrayComparator
   # the main comparator shell class
-  class Comparator
-
-    # VARIABLE to store strategies
-    @comparators = {}
-    class << self
-
-      # @!attribute [rw] command
-      #   Return all available comparator strategies
-      attr_accessor :comparators
-
-      # Register a new comparator strategy
-      #
-      # @param [String,Symbol] name
-      #   The name which can be used to refer to the registered strategy
-      #
-      # @param [Comparator] klass
-      #   The strategy class which should be registered
-      #
-      # @raise Exceptions::IncompatibleComparator
-      #   Raise exception if an incompatible comparator class is given
-      def register(name,klass)
-        @comparators ||= {}
-
-        if klass.new.respond_to?(:success?)
-          @comparators[name.to_sym] = klass
-        else
-          raise Exceptions::IncompatibleComparator, "Registering #{klass} failed. It does not support \"success?\"-instance-method"
-        end
-      end
-    end
+  class Comparator < StrategyDispatcher
+
+    strategy_reader :comparators
 
     # Create a new comparator instance
     # and register default comparators
     #
     # @return [Comparator]
     #   a new comparator
-    def initialize
-      @cache = Cache.new
+    def initialize(cache=Cache.new)
+      super()
+
+      @cache = cache
+      @cache.add(:checks, :anonymous_cache)
+      @cache.add(:result, :single_value_cache)
+
+      register :contains_all, SearchingStrategies::ContainsAll
+      register :contains_any, SearchingStrategies::ContainsAny
+      register :not_contains, SearchingStrategies::ContainsNot
+      register :contains_all_as_substring, SearchingStrategies::ContainsAllWithSubstringSearch
+      register :contains_any_as_substring, SearchingStrategies::ContainsAnyWithSubstringSearch
+      register :not_contains_substring, SearchingStrategies::ContainsNotWithSubstringSearch
+      register :is_equal, SearchingStrategies::IsEqual
+      register :is_not_equal, SearchingStrategies::IsNotEqual
+
+      @result = Result.new
+    end
+
+    # @see StrategyWrapper
+    def exception_invalid_strategy
+      Exceptions::IncompatibleComparator
+    end
+
+    # @see StrategyWrapper
+    def class_must_have_methods
+      [
+        :success?,
+      ]
     end
 
     # Add a check to test against
@@ -66,17 +68,19 @@ module TheArrayComparator
     # @raise [Exceptions::UnknownCheckType]
     #   if a unknown strategy is given (needs to be registered first)
     def add_check(data,type,keywords,options={})
-      raise Exceptions::UnknownCheckType, "Unknown check type \":#{type}\" given. Did you register it in advance?" unless Comparator.comparators.has_key?(type)
+      t = type.to_sym
+
+      raise Exceptions::UnknownCheckType, "Unknown check type \":#{t}\" given. Did you register it in advance?" unless comparators.has_key?(t)
       opts = {
         exceptions: [],
         tag:'',
       }.merge options
 
       sample = Sample.new(data,keywords,opts[:exceptions],opts[:tag])
-      strategy_klass = Comparator.comparators[type]
+      strategy_klass = comparators[t]
       check = Check.new(strategy_klass,sample)
 
-      @cache.add check
+      @cache[:checks].add check
     end
 
     # The result of all checks defined
@@ -84,9 +88,13 @@ module TheArrayComparator
     # @return [Result] 
     #   the result class with all the data need for further analysis
     def result
-      @cache.stored_objects.each { |c| return Result.new(c.sample) unless c.success? }
+      if @cache[:checks].new_objects?
+        @cache[:checks].stored_objects.each do |c| 
+          @result = Result.new(c.sample) unless c.success?
+        end
+      end
 
-      Result.new
+      @result
     end
 
     # Run all checks
@@ -103,8 +111,8 @@ module TheArrayComparator
     # @param [Integer] number
     #   the index of the check which should be deleted
     def delete_check(number)
-      if @cache.fetch_object(number)
-        @cache.delete_object(number) 
+      if @cache[:checks].fetch_object(number)
+        @cache[:checks].delete_object(number) 
       else
         raise Exceptions::CheckDoesNotExist, "You tried to delete a check, which does not exist!"
       end
@@ -120,7 +128,7 @@ module TheArrayComparator
     # @return [Array]
     #   all available checks
     def list_checks
-      @cache.stored_objects
+      @cache[:checks].stored_objects
     end
   end
 end

data/lib/the_array_comparator/exceptions.rb

@@ -3,19 +3,48 @@ module TheArrayComparator
   # exceptions which are going to be raised under
   # certain conditions
   module Exceptions 
-    # Used when one tries to add an unknown 
-    # probe type to check for
+    # Used if one tries to add an unknown 
+    # check type 
     class UnknownCheckType < Exception
     end
+    #
+    # Used if one tries to add an unknown 
+    # caching strategy
+    class UnknownCachingStrategy < Exception
+    end
 
     # Used if one tries to register an
     # incompatible comparator
     class IncompatibleComparator < Exception
     end
+    #
+    # Used if one tries to register an
+    # incompatible caching strategy
+    class IncompatibleCachingStrategy < Exception
+    end
 
     # Used if one tries to delete an
     # unexisting probe
     class CheckDoesNotExist < Exception
     end
+    
+    # Used if one tries to use an unexisting
+    # cache
+    class CacheDoesNotExist < Exception
+    end
+
+    # Used if one forgot to implement that
+    # method
+    class MustHaveMethodNotImplemented < Exception
+    end
+
+    # Used if one use the library the wrong way
+    class WrongUsageOfLibrary < Exception
+    end
+
+    # Use if one tries to register an internal
+    # keyword
+    class UsedInternalKeyword < Exception
+    end
   end
 end

data/lib/the_array_comparator/{strategies → searching_strategies}/base.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     #base class for strategies
     class Base
 

data/lib/the_array_comparator/{strategies → searching_strategies}/contains_all.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     #strategy contains
     class ContainsAll < Base
       

data/lib/the_array_comparator/{strategies → searching_strategies}/contains_all_with_substring_search.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     # strategy contains substring
     class ContainsAllWithSubstringSearch < Base
 

data/lib/the_array_comparator/{strategies → searching_strategies}/contains_any.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     #strategy contains
     class ContainsAny < Base
       

data/lib/the_array_comparator/{strategies → searching_strategies}/contains_any_with_substring_search.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     # strategy contains substring
     class ContainsAnyWithSubstringSearch < Base
 

data/lib/the_array_comparator/{strategies → searching_strategies}/contains_not.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     #strategy contains
     class ContainsNot < Base
       

data/lib/the_array_comparator/{strategies → searching_strategies}/contains_not_with_substring_search.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     # strategy not contains substring
     class ContainsNotWithSubstringSearch < Base
 

data/lib/the_array_comparator/{strategies → searching_strategies}/is_equal.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     #strategy is equal
     class IsEqual < Base
       

data/lib/the_array_comparator/{strategies → searching_strategies}/is_not_equal.rb

@@ -3,7 +3,7 @@
 # the main module
 module TheArrayComparator
   # the available strategies
-  module Strategies
+  module SearchingStrategies
     #strategy is not equal
     class IsNotEqual < Base