rspec-subject-extensions 0.1.0

data/README.md

@@ -0,0 +1,55 @@
+# RSpec Subject Extensions
+
+rspec-subject-extensions adds `each` short-hand to generate a nested example group with
+a single example that specifies the expected value of each attribute of the subject.
+
+[![build status](http://travis-ci.org/ZenCocoon/rspec-subject-extensions.png)](http://travis-ci.org/ZenCocoon/rspec-subject-extensions)
+
+## Documentation
+
+The [Cucumber features](http://relishapp.com/ZenCocoon/rspec-subject-extensions)
+are the most comprehensive and up-to-date docs for end-users.
+
+The [RDoc](http://rubydoc.info/gems/rspec-subject-extensions/0.1.0/frames) provides
+additional information for contributors and/or extenders.
+
+All of the documentation is open source and a work in progress. If you find it
+lacking or confusing, you can help improve it by submitting requests and
+patches to the [rspec-subject-extensions issue
+tracker](https://github.com/ZenCocoon/rspec-subject-extensions/issues).
+
+## Install
+
+    gem install rspec-subject-extensions
+
+## Usage
+
+### Each
+
+Creates a nested example group named by `each` and the submitted `attribute`,
+and then generates an example for each attribute using the submitted block.
+
+    # This ...
+    describe Object do
+      each(:item) { should be_an(Integer) }
+    end
+
+    # ... generates the same runtime structure as this:
+    describe Object do
+      describe "each item"
+        it "should be an Integer" do
+          subject.items.each do |item|
+            item.should be_an(Integer)
+          end
+        end
+      end
+    end
+
+The `attribute` can be a `Symbol` or a `String`.
+
+## Also see
+
+* [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
+* [http://github.com/rspec/rspec-core](http://github.com/rspec/rspec-core)
+* [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)
+* [http://github.com/rspec/rspec-mocks](http://github.com/rspec/rspec-mocks)

data/features/README.md

@@ -0,0 +1,35 @@
+rspec-subject-extensions adds `each` short-hand to generate a nested example group with
+a single example that specifies the expected value of each attribute of the subject.
+
+## Each
+
+Creates a nested example group named by +each+ and the submitted +attribute+,
+and then generates an example for each attribute using the submitted block.
+
+    # This ...
+    describe Object do
+      each(:item) { should be_an(Integer) }
+    end
+
+    # ... generates the same runtime structure as this:
+    describe Object do
+      describe "each item"
+        it "should be an Integer" do
+          subject.items.each do |item|
+            item.should be_an(Integer)
+          end
+        end
+      end
+    end
+
+The +attribute+ can be a +Symbol+ or a +String+.
+
+## Issues
+
+The documentation for rspec-subject-extensions is a work in progress. We'll be adding
+Cucumber features over time, and clarifying existing ones.  If you have
+specific features you'd like to see added, find the existing documentation
+incomplete or confusing, or, better yet, wish to write a missing Cucumber
+feature yourself, please [submit an
+issue](http://github.com/ZenCocoon/rspec-subject-extensions/issues) or a [pull
+request](http://github.com/ZenCocoon/rspec-subject-extensions).

data/features/class_methods/each_attribute_of_subject.feature

@@ -0,0 +1,33 @@
+Feature: each attribute of subject
+
+  Use the each() method as a short-hand to generate a nested example group with
+  a single example that specifies the expected value of each attribute of the
+  subject.  This can be used with an implicit or explicit subject.
+
+  each() accepts a symbol or a string, and a block representing the example.
+
+      each(:item)     { should be_an(Item)    }
+      each("article") { should be_an(Article) }
+
+  Scenario: specify value of each attribute
+    Given a file named "example_spec.rb" with:
+      """
+      require 'rspec/subject/extensions'
+
+      class Movie
+        def ratings
+          [9, 7, 9]
+        end
+      end
+
+      describe Movie do
+        each(:rating) { should be_an(Integer) }
+      end
+      """
+    When I run `rspec example_spec.rb --format documentation`
+    Then the output should contain:
+      """
+      Movie
+        each rating
+          should be a kind of Integer
+      """

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/rspec/subject/extensions/class_methods.rb

@@ -0,0 +1,66 @@
+require 'active_support/inflector'
+
+module RSpec
+  module Subject
+    module Extensions
+      module ClassMethods
+        # Creates a nested example group named by +each+ and the submitted +attribute+,
+        # and then generates an example for each attribute using the submitted block.
+        #
+        # @param [Symbol, String] attribute
+        #   The singular name of the subject method containing all the attributes.
+        #
+        # @yield
+        #   Example to run against each attribute.
+        #
+        # @raise [NoMethodError]
+        #   The subject doesn't respond to the pluralized version of the attribute or it doesn't respond to each.
+        #
+        # @example
+        #   # This ...
+        #   describe Object do
+        #     each(:item) { should be_an(Integer) }
+        #   end
+        #
+        #   # ... generates the same runtime structure as this:
+        #   describe Object do
+        #     describe "each item"
+        #       it "should be an Interger" do
+        #         subject.items.each do |item|
+        #           item.should be_an(Integer)
+        #         end
+        #       end
+        #     end
+        #   end
+        def each(attribute, &block)
+          describe("each #{attribute}") do
+            attribute = attribute.to_s.pluralize
+
+            example do
+              if subject.respond_to?(attribute) && subject.send(attribute).respond_to?(:each)
+                subject.send(attribute).each do |item|
+                  self.class.class_eval do
+                    define_method(:subject) do
+                      @_subject ||= item
+                    end
+                  end
+
+                  instance_eval(&block)
+                end
+              else
+                self.class.class_eval do
+                  define_method(:subject) do
+                    @_subject ||= super().send(attribute).each
+                  end
+                end
+
+                instance_eval(&block)
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/rspec/subject/extensions/version.rb

@@ -0,0 +1,10 @@
+module RSpec
+  module Subject
+    module Extensions
+      # @private
+      module Version
+        STRING = '0.1.0'
+      end
+    end
+  end
+end

data/lib/rspec/subject/extensions.rb

@@ -0,0 +1,13 @@
+require 'rspec/core'
+require 'rspec/subject/extensions/class_methods'
+require 'rspec/subject/extensions/version'
+
+module RSpec
+  module Subject
+    # RSpec::Subject::Extensions let's you use short-hands to generate nested examples groups
+    module Extensions
+    end
+  end
+end
+
+RSpec::Core::ExampleGroup.extend(RSpec::Subject::Extensions::ClassMethods)

data/lib/rspec-subject-extensions.rb

@@ -0,0 +1 @@
+require 'rspec/subject/extensions'

data/spec/rspec/subject/extensions/class_methods_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module RSpec::Subject::Extensions::ClassMethods
+  describe "initialization" do
+    it "should extend RSpec::Core::ExampleGroup with RSpec::Subject::Extensions::ClassMethods" do
+      RSpec::Core::ExampleGroup.respond_to?('each').should be_true
+    end
+  end
+
+  describe "#each" do
+    context "with an Object having #items returning an Array of Integers" do
+      subject do
+        Class.new do
+          def items
+            [1, 2]
+          end
+        end.new
+      end
+
+      each(:item) { should be_an(Integer) }
+    end
+
+    context "when it doesn't respond to the pluralized version of the attribute" do
+      subject { Object.new }
+
+      context "it raises an error" do
+        each(:item) do
+          expect do
+            should be_an(Integer)
+          end.to raise_error(NoMethodError)
+        end
+      end
+    end
+
+    context "when it doesn't return an object responding to each" do
+      subject do
+        Class.new do
+          def items
+            1
+          end
+        end.new
+      end
+
+      context "it raises an error" do
+        each(:item) do
+          expect do
+            should be_an(Integer)
+          end.to raise_error(NoMethodError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec/subject/extensions'
+
+RSpec::configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,285 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-subject-extensions
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "S\xC3\xA9bastien Grosjean"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-02 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: relish
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        - 9
+        version: 0.1.9
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: guard-cucumber
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: appraisal
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :development
+  version_requirements: *id013
+description: rspec-subject-extensions let's you use short-hands to generate nested examples groups
+email: public@zencocoon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/rspec-subject-extensions.rb
+- lib/rspec/subject/extensions.rb
+- lib/rspec/subject/extensions/class_methods.rb
+- lib/rspec/subject/extensions/version.rb
+- README.md
+- features/README.md
+- features/class_methods/each_attribute_of_subject.feature
+- features/support/env.rb
+- spec/rspec/subject/extensions/class_methods_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ZenCocoon/rspec-subject-extensions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: rspec-subject-extensions-0.1.0
+test_files: 
+- features/README.md
+- features/class_methods/each_attribute_of_subject.feature
+- features/support/env.rb
+- spec/rspec/subject/extensions/class_methods_spec.rb
+- spec/spec_helper.rb