the_array_comparator 0.1.1

data/.gitignore

@@ -0,0 +1,16 @@
+.$*$
+.bundle
+coverage/
+doc/yardoc/
+*.gem
+!.git*
+nohup*
+*.old
+*.out
+pkg/
+pkg/*
+.rvmrc
+*.s??
+tmp/
+doc/*
+.yardoc/

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--t "~bm"

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p374

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+gemfile: gemfiles/Gemfile.travis
+rvm:
+  - 1.9.3
+#  - 1.9.2
+script: bundle exec rake test:travis_specs

data/CONTRIBUTIONS.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Gemfile

@@ -0,0 +1,30 @@
+source :rubygems
+
+gemspec 
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'aruba'
+  gem 'fuubar'
+  gem 'ffaker'
+end
+
+group :documentation do
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
+end
+
+group :development do
+  gem 'tmrb'
+  gem 'debugger'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'awesome_print'
+  gem 'travis-lint'
+  gem 'activesupport'
+  gem 'fuubar'
+  gem 'churn'
+end

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    the_array_comparator (0.1.1)
+      active_support
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arrayfields (4.7.4)
+    aruba (0.5.1)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    awesome_print (1.1.0)
+    builder (3.1.4)
+    childprocess (0.3.7)
+      ffi (~> 1.0, >= 1.0.6)
+    chronic (0.9.0)
+    churn (0.0.27)
+      chronic (>= 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 3.1.0)
+      sexp_processor (~> 4.1.0)
+    coderay (1.0.8)
+    columnize (0.3.6)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    debugger (1.3.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.7)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.7)
+    diff-lcs (1.1.3)
+    fattr (2.2.1)
+    ffaker (1.15.0)
+    ffi (1.3.1)
+    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)
+    github-markup (0.7.5)
+    hashr (0.0.22)
+    hirb (0.7.1)
+    json (1.7.6)
+    json_pure (1.7.6)
+    main (5.1.1)
+      arrayfields (>= 4.7.4)
+      chronic (>= 0.6.2)
+      fattr (>= 2.2.0)
+      map (>= 5.1.0)
+    map (6.2.0)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    pry (0.9.11.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-doc (0.4.4)
+      pry (>= 0.9.9.6)
+      yard (~> 0.8.1)
+    rake (10.0.3)
+    redcarpet (2.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.12.2)
+    ruby-progressbar (1.0.2)
+    ruby_parser (3.1.1)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.1.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.3)
+    thor (0.17.0)
+    tmrb (1.2.7)
+      thor
+    travis-lint (1.5.0)
+      hashr (~> 0.0.22)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  aruba
+  awesome_print
+  churn
+  debugger
+  ffaker
+  fuubar
+  github-markup
+  pry
+  pry-doc
+  rake
+  redcarpet
+  rspec
+  simplecov
+  the_array_comparator!
+  tmrb
+  travis-lint
+  yard

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Max Meyer
+
+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/README.md

@@ -0,0 +1,121 @@
+# The Array Comparator
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/maxmeyer/the_array_comparator)
+[![Build Status](https://travis-ci.org/maxmeyer/the_array_comparator.png?branch=master)](https://travis-ci.org/maxmeyer/the_array_comparator)
+
+Can be used to compare to arrays with a consistent api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'comparator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comparator
+
+## Usage
+
+Currently the following strategies are supported
+<table>
+  <tr>
+    <th>Strategy</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>:contains_all</td>
+    <td>True if all of the given keywords are part of the data</td>
+  </tr>
+  <tr>
+    <td>:contains_any</td>
+    <td>True if any of the given keywords are part of the data</td>
+  </tr>
+  <tr>
+    <td>:not_contains</td>
+    <td>True if the given keywords are not part of the data</td>
+  </tr>
+  <tr>
+    <td>:contains_all_as_substring</td>
+    <td>True if all given keywords are a substring of an data element</td>
+  </tr>
+  <tr>
+    <td>:contains_any_as_substring</td>
+    <td>True if any given keyword are a substring of an data element</td>
+  </tr>
+  <tr>
+    <td>:not_contains_substring</td>
+    <td>True if none of the given keywords is a substring of an data element</td>
+  </tr>
+  <tr>
+    <td>:is_equal</td>
+    <td>True if both, the keywords and the data, are identical</td>
+  </tr>
+  <tr>
+    <td>:is_not_equal</td>
+    <td>True if the keywords are didfferent from the data</td>
+  </tr>
+</table>
+
+### Simple example
+
+```ruby
+require 'the_array_comparator'
+comparator = TheArrayComparator::Comparator.new
+data = %w{ a b c d }
+keyword_overlap = %w{ a b }
+
+comparator.add_check data , :contains_all , keyword_overlap
+
+result = comparator.success?
+puts result #should be true
+```
+
+### Example with substrings
+
+```ruby
+require 'the_array_comparator'
+comparator = TheArrayComparator::Comparator.new
+data = %w{ acd b }
+keyword_overlap = %w{ cd b }
+
+comparator.add_check data , :contains_all_as_substring, keyword_overlap 
+
+result = comparator.success?
+puts result #should be true
+```
+
+### Example with exceptions
+
+```ruby
+require 'the_array_comparator'
+comparator = TheArrayComparator::Comparator.new
+data = %w{ acd b }
+keyword_overlap = %w{ a b }
+exceptions = %w{ cd }
+
+comparator.add_check data , :contains_all_as_substring, keyword_overlap, exceptions
+
+result = comparator.success?
+puts result #should be false
+```
+
+### Extend the library
+
+If you wish to write your own comparators you can do so. Just register those classes with a keyword.
+
+```ruby
+TheArrayComparator::Comparator.register :my_contains, Strategies::MyContains
+```
+
+## Contributing
+
+Please see CONTRIBUTIONS.md
+
+## Copyright
+
+(c) 2013 Max Meyer. All rights reserved. Please also see LICENSE.md

data/Rakefile

@@ -0,0 +1,93 @@
+#!/usr/bin/env rake
+
+unless ENV['TRAVIS_CI'] == 'true'
+  namespace :gem do
+    require 'bundler/gem_tasks'
+  end
+
+  require 'yard'
+  require 'rubygems/package_task'
+  require 'active_support/core_ext/string/strip'
+end
+
+YARD::Rake::YardocTask.new() do |y|
+  y.options << '--verbose'
+end
+
+desc 'start tmux'
+task :terminal do
+  sh "script/terminal"
+end
+
+task :term => :terminal
+task :t => :terminal
+
+namespace :version do
+  version_file = Dir.glob('lib/**/version.rb').first
+
+  desc 'bump version of library to new version'
+  task :bump do
+
+    new_version = ENV['VERSION'] || ENV['version']
+
+    raw_module_name = File.open(version_file, "r").readlines.grep(/module/).first
+    module_name = raw_module_name.chomp.match(/module\s+(\S+)/) {$1}
+
+    version_string = %Q{#main #{module_name}
+module #{module_name}
+  VERSION = '#{new_version}'
+end}
+
+    File.open(version_file, "w") do |f|
+      f.write version_string.strip_heredoc
+    end
+
+    sh "git add #{version_file}" 
+    sh "git commit -m 'version bump to #{new_version}'" 
+    project = 'the_array_comparator'
+    sh "git tag #{project}-v#{new_version}" 
+  end
+
+  desc 'show version of library'
+  task :show do
+    raw_version = File.open(version_file, "r").readlines.grep(/VERSION/).first
+
+    if raw_version
+      version = raw_version.chomp.match(/VERSION\s+=\s+["']([^'"]+)["']/) { $1 }
+      puts version
+    else
+      warn "Could not parse version file \"#{version_file}\""
+    end
+
+  end
+
+  desc 'Restore version file from git repository'
+  task :restore do
+    sh "git checkout #{version_file}"
+  end
+
+end
+
+namespace :travis do
+  desc 'Runs travis-lint to check .travis.yml'
+  task :check do
+    sh 'travis-lint'
+  end
+end
+
+namespace :test do
+  desc 'Run specs'
+  task :specs do
+    sh 'bundle exec rspec spec'
+  end
+
+  desc 'Run tests in "travis mode"'
+  task :travis_specs do
+    ENV['TRAVIS_CI'] = 'true'
+    sh 'rspec spec'
+  end
+end
+
+task :console do
+  sh 'script/console'
+end

data/TODO.md

@@ -0,0 +1 @@
+* Add clear (last) probe

data/gemfiles/Gemfile.default

@@ -0,0 +1,30 @@
+source :rubygems
+
+gemspec 
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'aruba'
+  gem 'fuubar'
+  gem 'ffaker'
+end
+
+group :documentation do
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
+end
+
+group :development do
+  gem 'tmrb'
+  gem 'debugger'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'awesome_print'
+  gem 'travis-lint'
+  gem 'activesupport'
+  gem 'fuubar'
+  gem 'churn'
+end

data/gemfiles/Gemfile.travis

@@ -0,0 +1,15 @@
+source :rubygems
+
+gemspec path: '../'
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'fuubar'
+end
+
+group :documentation do
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
+end

data/lib/the_array_comparator/check.rb

@@ -0,0 +1,27 @@
+#encoding: utf-8
+
+# the main module
+module TheArrayComparator
+  # the check 
+  class Check
+    extend Forwardable
+
+    # Delegates success? to check
+    def_delegator :@check, :success?
+
+    # @!attribute [r] sample
+    #   the sample of the check
+    attr_reader :sample
+
+    # Creates new check
+    def initialize(strategy_klass,sample)
+      @check = strategy_klass.new(sample)
+      @sample = sample
+    end
+
+    # Checks for success
+    def success?
+      @check.success?
+    end
+  end
+end

data/lib/the_array_comparator/comparator.rb

@@ -0,0 +1,123 @@
+#encoding: utf-8
+
+# 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
+
+    # Create a new comparator instance
+    # and register default comparators
+    #
+    # @return [Comparator]
+    #   a new comparator
+    def initialize
+      @checks = []
+    end
+
+    # Add a check to test against
+    #
+    # @param [Array] data
+    #   the data which should be used as check, will be passed to the concrete comparator strategy
+    #
+    # @param [Symbol] type
+    #   the comparator strategy (needs to be registered first)
+    #
+    # @param [Array] keywords
+    #   what to look for in the data, will be passed to the concrete comparator strategy
+    #
+    # @param [Hash] options 
+    #   exception, should not be considered as match
+    #
+    # @option options [Hash] exceptions
+    #   the exceptions from keywords
+    #
+    # @option options [String] tag
+    #   a tag to identify the check
+    #
+    # @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)
+      opts = {
+        exceptions: [],
+        tag:'',
+      }.merge options
+
+      sample = Sample.new(data,keywords,opts[:exceptions],opts[:tag])
+      strategy_klass = Comparator.comparators[type]
+      check = Check.new(strategy_klass,sample)
+
+      @checks << check
+      return check
+    end
+
+    def result
+      @checks.each { |c| return Result.new(c.sample) unless c.success? }
+
+      Result.new
+    end
+
+    # Run all checks
+    #
+    # @return [TrueClass, FalseClass]
+    #   the result of all checks. if at least one fails the result will be
+    #   'false'. If all are true, the result will be true.
+    def success?
+      result.of_checks
+    end
+
+    # Delete check
+    #
+    # @param [Integer] number
+    #   the index of the check which should be deleted
+    def delete_check(number)
+      if @checks[number]
+        @checks.delete_at(number) 
+      else
+        raise Exceptions::CheckDoesNotExist, "You tried to delete a check, which does not exist!"
+      end
+    end
+
+    # Delete the last check added
+    def delete_last_check
+      delete_check(-1)
+    end
+
+    # List all added checks
+    #
+    # @return [Array]
+    #   all available checks
+    def list_checks
+      @checks
+    end
+  end
+end

data/lib/the_array_comparator/exceptions.rb

@@ -0,0 +1,21 @@
+# the main module
+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
+    class UnknownCheckType < Exception
+    end
+
+    # Used if one tries to register an
+    # incompatible comparator
+    class IncompatibleComparator < Exception
+    end
+
+    # Used if one tries to delete an
+    # unexisting probe
+    class CheckDoesNotExist < Exception
+    end
+  end
+end

data/lib/the_array_comparator/result.rb

@@ -0,0 +1,21 @@
+#encoding: utf-8
+
+# the main module
+module TheArrayComparator
+  # the check result
+  class Result
+    def initialize(sample=nil)
+      @sample = sample
+    end
+
+    def of_checks
+      return true if @sample.blank?
+      false
+    end
+
+    def failed_sample
+      @sample
+    end
+
+  end
+end

data/lib/the_array_comparator/sample.rb

@@ -0,0 +1,28 @@
+#encoding: utf-8
+
+# the main module
+module TheArrayComparator
+  # class holding the data for the comparism
+  class Sample
+    # @!attribute [rw] keywords
+    #   data used to search in other data set
+    #
+    # @!attribute [rw] data
+    #   test data
+    #
+    # @!attribute [rw] exceptions
+    #   exceptions from data search
+    #
+    # @!attribute [rw] tag
+    #   description of the probe
+    attr_accessor :data, :keywords, :exceptions, :tag
+
+    def initialize(data=[],keywords=[],exceptions=[],tag=nil)
+      @keywords = keywords
+      @data = data
+      @exceptions = exceptions
+      @tag = tag
+    end
+
+  end
+end