the_array_comparator 0.4.0 → 0.5.0

data/Gemfile

@@ -27,4 +27,5 @@ group :development do
   gem 'activesupport'
   gem 'fuubar'
   gem 'churn'
+  gem 'fedux_org-stdlib'
 end

data/Gemfile.lock

@@ -1,14 +1,12 @@
 PATH
   remote: .
   specs:
-    the_array_comparator (0.2.0)
-      active_support
+    the_array_comparator (0.4.0)
+      activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    active_support (3.0.0)
-      activesupport (= 3.0.0)
     activesupport (3.0.0)
     arrayfields (4.7.4)
     aruba (0.5.1)
@@ -43,6 +41,8 @@ GEM
     debugger-ruby_core_source (1.1.8)
     diff-lcs (1.1.3)
     fattr (2.2.1)
+    fedux_org-stdlib (0.1.0)
+      activesupport
     ffaker (1.15.0)
     ffi (1.4.0)
     fuubar (1.1.0)
@@ -107,6 +107,7 @@ DEPENDENCIES
   awesome_print
   churn
   debugger
+  fedux_org-stdlib
   ffaker
   fuubar
   github-markup

data/README.md

@@ -3,9 +3,14 @@
 [![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)
 
-The Array Comparator can be used to compare to arrays with a consistent api: It
-lets you write more concise tests and makes error detection in a commandline
-environment easier - see [Use Cases](#use_cases). 
+
+The Array Comparator lets you add multiple checks comparing two arrays each.
+This way it lets you write more concise tests and makes error detection in a
+commandline environment a lot easier -- [Use Cases](#use_cases). If you're
+interested, please have a look at the <a
+href="http://www.github.com/maxmeyer/the_array_comparator">git repository</a>.
+
+
 
 It also supports caching of previous comparism runs to reduce the amount of
 time for each subsequent run - if no further check was added.
@@ -28,6 +33,7 @@ Or install it yourself as:
 
 Currently the following strategies are supported
 <table>
+  <caption>Supported search strategies for checks</caption>
   <tr>
     <th>Strategy</th>
     <th>Description</th>
@@ -66,6 +72,45 @@ Currently the following strategies are supported
   </tr>
 </table>
 
+To add a check you need to use `#add_check`-method. It accepts four arguments
+* `data`: The data which should be searched
+* `strategy`: The kind of check which should be added (see the table above for supported strategies)
+* `keywords`: The keywords which should be looked up in data
+* `options` (optional): Options for the check to be added (see the table below for valid options)
+
+```ruby
+comparator.add_check data , operation, keywords, options
+```
+
+<table>
+  <caption>Supported options for check</caption>
+  <tr>
+    <th>Option</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>:tag</td>
+    <td>If you need to know which check caused the test suite to fail, add a
+    tag to the check. The array comparator records the sample which fails the
+    whole test suite. You can use *whatever* you want/can imagine as a tag:
+    e.g. `String`, `Symbol`. Personally I prefer to use `Symbol`s.</td> 
+   </tr>
+  <tr>
+    <td>:exceptions</td>
+    <td>Some times you have a quite generic check which matches to many lines
+    in the sample. To help you with that, you can add an exception to a
+    check.</td> 
+  </tr>
+</table>
+
+```ruby
+comparator.add_check data , operation, keywords, tag: :test_tag, exceptions: [ 'lala' ]
+```
+
+If you ask the comparator for success before a check was added, it will return
+`true`. If you ask it for the `#failed_sample` it will return an empty result
+to you.
+
 ### Simple example
 
 ```ruby
@@ -103,7 +148,7 @@ data = %w{ acd b }
 keyword_overlap = %w{ a b }
 exceptions = %w{ cd }
 
-comparator.add_check data , :contains_all_as_substring, keyword_overlap, exceptions
+comparator.add_check data , :contains_all_as_substring, keyword_overlap, exceptions: exceptions
 
 result = comparator.success?
 puts result #should be false
@@ -130,6 +175,7 @@ puts result #should be true
 ### Example with tag
 
 ```ruby
+#simple, isn't it?
 require 'the_array_comparator'
 comparator = TheArrayComparator::Comparator.new
 data = %w{ a b c d }
@@ -137,10 +183,25 @@ keyword_successfull = %w{ a b }
 keyword_failed = %w{ e }
 
 comparator.add_check data , :contains_all , keyword_successfull
+#comparator.add_check data , :contains_all , keyword_failed, tag: :this_is_another_tag
 comparator.add_check data , :contains_all , keyword_failed, tag: 'this is a failed sample'
 
 comparator.success?
-puts comparator.result.failed_sample
+puts comparator.result.failed_sample.tag
+
+#use WHATEVER you want!
+require 'the_array_comparator'
+require 'ostruct'
+comparator = TheArrayComparator::Comparator.new
+data = %w{ a b c d }
+keyword_successfull = %w{ a b }
+keyword_failed = %w{ e }
+
+comparator.add_check data , :contains_all , keyword_successfull
+comparator.add_check data , :contains_all , keyword_failed, tag: OpenStruct.new( id: 1, text: 'this is another tag as well' )
+
+comparator.success?
+puts comparator.result.failed_sample.tag.text
 ```
 
 ### Example with access to result

data/Rakefile

@@ -1,93 +1 @@
-#!/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
+require 'fedux_org/stdlib/rake'

data/gemfiles/Gemfile.default

@@ -27,4 +27,5 @@ group :development do
   gem 'activesupport'
   gem 'fuubar'
   gem 'churn'
+  gem 'fedux_org-stdlib'
 end

data/lib/the_array_comparator/comparator.rb

@@ -90,7 +90,7 @@ module TheArrayComparator
     def result
       if @cache[:checks].new_objects?
         @cache[:checks].stored_objects.each do |c| 
-          @result = Result.new(c.sample) unless c.success?
+          @result = Result.new( c.sample ) unless c.success?
         end
       end
 

data/lib/the_array_comparator/result.rb

@@ -14,7 +14,13 @@ module TheArrayComparator
     end
 
     def failed_sample
-      @sample
+      @sample || null_sample
+    end
+
+    private
+
+    def null_sample
+      Sample.new
     end
 
   end

data/lib/the_array_comparator/sample.rb

@@ -37,5 +37,11 @@ module TheArrayComparator
       @tag = tag
     end
 
+    # Check if sample is blank: no values for keywords, data, exceptions, tag
+    #
+    # @return [true,false] the result of check
+    def blank?
+      @keywords.blank? and @data.blank? and @exceptions.blank? and @tag.blank?
+    end
   end
 end

data/lib/the_array_comparator/version.rb

@@ -1,4 +1,4 @@
 #main TheArrayComparator
 module TheArrayComparator
-  VERSION = '0.4.0'
-end
+  VERSION = '0.5.0'
+end

data/spec/comparator/comparator_spec.rb

@@ -165,4 +165,19 @@ describe Comparator do
     result = comparator.result
     expect(result.failed_sample).to eq(c.sample)
   end
+
+  it "tells you the result of the check although no checks were added" do
+    comparator = Comparator.new
+    comparator.success?
+    result = comparator.result
+    expect( comparator.success? ).to eq(true)
+  end
+
+  it "returns an empty result if no checks were added but it is asked for a result" do
+    comparator = Comparator.new
+    comparator.success?
+
+    result = comparator.result
+    expect(result.failed_sample).to be_blank
+  end
 end

data/spec/sample_spec.rb

@@ -34,5 +34,10 @@ describe Sample do
       expect(sample.exceptions).to eq(Set.new( [ exceptions ] ) )
   end
 
+  context '#blank' do
+    it "checks if all values are blank" do
+      expect( Sample.new.blank? ).to be_true
+    end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_array_comparator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport