rspec-collection 2.0.0

data/README.md

@@ -0,0 +1,61 @@
+# rspec-collection
+
+Allow RSpec assertions over the elements of a collection.
+
+## Usage
+
+Allow RSpec assertions over the elements of a collection.  For example:
+
+  collection.should all\_be > 0
+
+will specify that each element of the collection should be greater
+than zero.  Each element of the collection that fails the test will
+be reported in the error message.
+
+Examples:
+
+  [1,1,1].should all\_be eq(1)
+  [2,4,6].should all\_be\_even
+  [3,6,9].should all\_be\_divisible_by(3)
+  [1,1,1].should all\_be == 1
+  [2,3,5].should all\_be { |n| prime?(n) }
+
+(for appropriate definitions of prime? and divisible_by?)
+
+### Requirements
+
+* RSpec 2.0.0
+
+## Todo
+
+* Other means of navigation besides left/right keys
+* Vertical view of all slides in a row
+* Generate PDFs (maybe via cucumber)
+* Stop making Nokogiri sad when parsing out snippets
+
+## Contributors
+
+* Jim Weirich
+
+(c) Copyright 2010 Jim Weirich
+
+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/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -wKU
+
+require 'rake/clean'
+require './lib/rspec-collection/version'
+
+CLOBBER.include('*.gemspec')
+
+Project = OpenStruct.new(
+  :name => "rspec-collection",
+  :version => RSpecCollection::VERSION,
+  :author => "Jim Weirich",
+  :author_email => "jim@edgecase.com",
+  :home_page => "http://github.com/jimweirich/rspec-collection")
+
+task :default => :spec
+
+task :spec do
+  sh "rspec -Ilib spec"
+end

data/lib/rspec-collection.rb

@@ -0,0 +1,3 @@
+# Require the package files.
+require 'rspec-collection/all_be.rb'
+

data/lib/rspec-collection/all_be.rb

@@ -0,0 +1,127 @@
+# Allow RSpec assertions over the elements of a collection.  For example:
+#
+#   collection.should all_be > 0
+#
+# will specify that each element of the collection should be greater
+# than zero.  Each element of the collection that fails the test will
+# be reported in the error message.
+#
+# Examples:
+#   [1,1,1].should all_be eq(1)
+#   [2,4,6].should all_be_even
+#   [3,6,9].should all_be_divisible_by(3)
+#   [1,1,1].should all_be == 1
+#   [2,3,5].should all_be { |n| prime?(n) }
+#
+# (for appropriate definitions of prime? and divisible_by?)
+#
+module RSpec
+  module Matchers
+
+    # Helper functions gathered here to avoid global name space
+    # pollution.
+    module AllBe
+      module_function
+
+      # Format a predicate function (with option arguments) for human
+      # readability.
+      def format_predicate(pred, *args)
+        message_elements =
+          ["be #{pred.gsub(/_/, ' ')}"] +
+          args.map { |a| a.inspect }
+        message_elements.join(' ')
+      end
+
+      # Create a collection matcher using +block+ as the matching
+      # condition.  Block should take one or two arguments:
+      #
+      #   lambda { |element| ... }
+      #   lambda { |element, messages| ... }
+      #
+      # If a block wishes to use custom failure messages, it should
+      # append the message to the +messages+ array.  Otherwise we will
+      # format an appropriate error message for each failing element.
+      #
+      def make_matcher(condition_string, &block)
+        Matcher.new :all_be, block do |_block_|
+          @failing_messages = []
+          @broken = []
+          match do |actual|
+            actual.each do |element|
+              unless _block_.call(element, @failing_messages)
+                @broken << element
+              end
+            end
+            @broken.empty?
+          end
+
+          failure_message_for_should do |actual|
+            messages = ["in #{actual.inspect}:"]
+            if @failing_messages.empty?
+              messages += @broken.map { |element| "expected #{element.inspect} to #{condition_string}" }
+            else
+              messages += @failing_messages
+            end
+            messages.join("\n")
+          end
+
+          failure_message_for_should_not do |actual|
+            "expected #{actual.inspect} to not all #{condition_string}"
+          end
+
+          description do
+            "all be"
+          end
+        end
+      end
+    end
+
+    # Handle mapping operators to appropriate collection mappers.
+    class AllBeOperatorMatcher
+      [:==, :!=, :>, :<, :<=, :>=, :=~].each do |op|
+        define_method(op) do |value|
+          AllBe.make_matcher("be #{op} #{value}") { |element|
+            element.send(op, value)
+          }
+        end
+      end
+    end
+
+    alias method_missing_without_all_be method_missing
+
+    # Handle all_be_XXX predicates.  If it doesn't match the
+    # all_be_XXX pattern, delegate to the existing method missing
+    # handler.
+    def method_missing(sym, *args, &block)
+      if sym.to_s =~ /^all_be_(\w+)$/
+        pred = $1
+        pred_method = "#{pred}?"
+        pred_string = AllBe.format_predicate(pred, *args)
+        AllBe.make_matcher(pred_string) { |element|
+          element.send(pred_method, *args, &block)
+        }
+      else
+        method_missing_without_all_be(sym, *args, &block)
+      end
+    end
+
+    # Return a matcher appropriate for matching across elements of a
+    # collection.
+    def all_be(matcher=nil, &block)
+      if matcher
+        AllBe.make_matcher("pass") { |element, messages|
+          if matcher.matches?(element)
+            true
+          else
+            messages << matcher.failure_message_for_should
+            false
+          end
+        }
+      elsif block_given?
+        AllBe.make_matcher("satisfy the block", &block)
+      else
+        AllBeOperatorMatcher.new
+      end
+    end
+  end
+end

data/lib/rspec-collection/version.rb

@@ -0,0 +1,13 @@
+module RSpecCollection
+  module Version
+    COMPONENTS = [
+      Major = 2,
+      Minor = 0,
+      Build = 0,
+    ]
+
+    STRING = COMPONENTS.join(".")
+  end
+
+  VERSION = Version::STRING
+end

data/rakelib/gem.rake

@@ -0,0 +1,64 @@
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+PKG_FILES = FileList['**/*.rb', 'Rakefile', '**/*.rake', 'README.md']
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  SPEC = Gem::Specification.new do |s|
+
+    #### Basic information.
+
+    s.name = Project.name
+    s.version = Project.version
+    s.summary = "Allow RSpec assertions over the elements of a collection."
+    s.description = <<-EOF
+      For example:
+
+        collection.should all_be > 0
+
+      will specify that each element of the collection should be greater
+      than zero.  Each element of the collection that fails the test will
+      be reported in the error message.
+    EOF
+
+    #### Dependencies and requirements.
+
+    s.add_dependency('rspec-core', '>= 2.0.0')
+    #s.requirements << ""
+
+    s.files = PKG_FILES.to_a
+    s.require_path = 'lib'                         # Use these for libraries.
+
+    #### Documentation and testing.
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README.md"]
+    s.rdoc_options = ""
+
+    #### Author and project details.
+
+    s.author = Project.author
+    s.email = Project.author_email
+    s.homepage = Project.home_page
+    s.rubyforge_project = "n/a"
+  end
+
+  Rake::GemPackageTask.new(SPEC) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  file "#{Project.name}.gemspec" => ["Rakefile", "rakelib/gem.rake"] do |t|
+    require 'yaml'
+    open(t.name, "w") { |f| f.puts SPEC.to_yaml }
+  end
+
+  desc "Create a stand-alone gemspec"
+  task :gemspec => "#{Project.name}.gemspec"
+end

data/spec/rspec-collection/all_be_spec.rb

@@ -0,0 +1,272 @@
+require 'spec_helper'
+require 'rspec-collection'
+
+class Integer
+  def divisible_by?(n)
+    (self % n) == 0
+  end
+end
+
+describe "Collection Matchers" do
+
+  # matcher ----------------------------------------------------------
+
+  context "using matchers" do
+    it "matcher passes" do
+      [1,1,1].should all_be eq(1)
+    end
+
+    it "NOT matcher passes" do
+      [1,2,1].should_not all_be eq(1)
+    end
+
+    it "matcher fails correctly" do
+      should_fail([1,2,3]) { |obj|
+        obj.should all_be eq(1)
+      }
+    end
+
+    it "NOT matcher fails correctly" do
+      should_fail([1,1,1]) { |obj|
+        obj.should_not all_be eq(1)
+      }
+    end
+  end
+
+  # block ------------------------------------------------------------
+
+  context "using blocks" do
+    it "block passes" do
+      [0,2,4].should all_be { |item| item.even? }
+    end
+
+    it "NOT block passes" do
+      [0,2,5].should_not all_be { |item| item.even? }
+    end
+
+    it "NOT block fails correctly" do
+      should_fail([0,2,4]) { |obj|
+        obj.should_not all_be { |item| item.even? }
+      }
+    end
+
+    it "NOT block fails correctly" do
+      should_fail([0,2,4]) { |obj|
+        obj.should_not all_be { |item| item.even? }
+      }
+    end
+  end
+
+  # predicates -------------------------------------------------------
+
+  context "using predicates" do
+    it "predicate passes" do
+      [0,2,4].should all_be_even
+    end
+
+    it "NOT predicate passes" do
+      [0,2,5].should_not all_be_even
+    end
+
+    it "predicate fails correctly" do
+      should_fail([0,2,5]) { |obj|
+        obj.should all_be_even
+      }
+    end
+
+    it "NOT predicate fails correctly" do
+      should_fail([0,2,4]) { |obj|
+        obj.should_not all_be_even
+      }
+    end
+  end
+
+  # predicates with args ---------------------------------------------
+
+  context "using predicates with arguments" do
+    it "predicate passes" do
+      [3,6,9].should all_be_divisible_by(3)
+    end
+
+    it "NOT predicate passes" do
+      [3,6,8].should_not all_be_divisible_by(3)
+    end
+
+    it "predicate fails correctly" do
+      should_fail([3,6,8]) { |obj|
+        obj.should all_be_divisible_by(3)
+      }
+    end
+
+    it "NOT predicate fails correctly" do
+      should_fail([3,6,9]) { |obj|
+        obj.should_not all_be_divisible_by(3)
+      }
+    end
+  end
+
+  # operator ---------------------------------------------------------
+
+  context "using operators" do
+    it "operator passes" do
+      [1,1,1].should all_be == 1
+    end
+
+    it "NOT operator passes" do
+      [1,1,2].should_not all_be == 1
+    end
+
+    it "operator fails correctly" do
+      should_fail([1,2,3]) { |obj|
+        obj.should all_be < 3
+      }
+    end
+
+    it "NOT operator fails correctly" do
+      should_fail([1,2,1]) { |obj|
+        obj.should_not all_be < 3
+      }
+    end
+
+    it "=~ operator passes" do
+      ["a", "b", "c"].should all_be =~ /^.$/
+    end
+
+    it "NOT =~ operator passes" do
+      ["a", "b", "c"].should_not all_be =~ /^..$/
+    end
+
+    it "=~ operator fails correctly" do
+      should_fail(["a", "b", "cc"]) { |obj|
+        obj.should all_be =~ /^.$/
+      }
+    end
+
+    it "NOT =~ operator fails correctly" do
+      should_fail(["a", "b", "c"]) { |obj|
+        obj.should_not all_be =~ /^.$/
+      }
+    end
+  end
+
+  private # ----------------------------------------------------------
+
+  def should_fail(obj, &block)
+    lambda {
+      yield(obj)
+    }.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+  end
+end
+
+describe "Error Messages" do
+
+  # matcher ----------------------------------------------------------
+
+  context "when matchers fail" do
+    it "contains multiple items" do
+      lambda {
+        [1,2,3].should all_be eq(1)
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected 1.*got 2.*expected 1.*got 3/m)
+    end
+  end
+
+  context "when NOT matchers fail" do
+    it "contains single failure message" do
+      lambda {
+        [1,1,1].should_not all_be eq(1)
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected \[1, 1, 1\] to not all pass/m)
+    end
+  end
+
+  # block ------------------------------------------------------------
+
+  context "when blocks fail" do
+    it "contains multiple items" do
+      lambda {
+        [1,2,3].should all_be { |n| n == 1 }
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected 2 to satisfy the block.*expected 3 to satisfy the block/m)
+    end
+  end
+
+  context "when NOT matchers fail" do
+    it "contains single failure message" do
+      lambda {
+        [1,1,1].should_not all_be { |n| n == 1 }
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected \[1, 1, 1\] to not all satisfy the block/m)
+    end
+  end
+
+  # predicate --------------------------------------------------------
+
+  context "when predicates fail" do
+    it "contains multiple items" do
+      lambda {
+        [1,0,3].should all_be_zero
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected 1 to be zero.*expected 3 to be zero/m)
+    end
+  end
+
+  context "when NOT predicates fail" do
+    it "contains single failure message" do
+      lambda {
+        [0,0].should_not all_be_zero
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected \[0, 0\] to not all be zero/m)
+    end
+  end
+
+  # predicate with args ----------------------------------------------
+
+  context "when predicates fail" do
+    it "contains multiple items" do
+      lambda {
+        [3,4,5].should all_be_divisible_by(3)
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected 4 to be divisible by 3.*expected 5 to be divisible by 3/m)
+    end
+  end
+
+  context "when NOT predicates fail" do
+    it "contains single failure message" do
+      lambda {
+        [3,6,9].should_not all_be_divisible_by(3)
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected \[3, 6, 9\] to not all be divisible by 3/m)
+    end
+  end
+
+  # operators --------------------------------------------------------
+
+  context "when operators fail" do
+    it "contains multiple items" do
+      lambda {
+        [1,2,3].should all_be == 1
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected 2 to be == 1.*expected 3 to be == 1/m)
+    end
+  end
+
+  context "when NOT predicates fail" do
+    it "contains single failure message" do
+      lambda {
+        [1,1,1].should_not all_be == 1
+      }.should raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        /expected \[1, 1, 1\] to not all be == 1/m)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-collection
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Jim Weirich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: "      For example:\n\n        collection.should all_be > 0\n\n      will specify that each element of the collection should be greater\n      than zero.  Each element of the collection that fails the test will\n      be reported in the error message.\n"
+email: jim@edgecase.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/rspec-collection/all_be.rb
+- lib/rspec-collection/version.rb
+- lib/rspec-collection.rb
+- spec/rspec-collection/all_be_spec.rb
+- spec/spec_helper.rb
+- Rakefile
+- rakelib/gem.rake
+- README.md
+has_rdoc: true
+homepage: http://github.com/jimweirich/rspec-collection
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- ""
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: n/a
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Allow RSpec assertions over the elements of a collection.
+test_files: []
+