rspec-requestable-examples 0.1.5 → 0.1.6

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 Zach Dennis, Mutually Human Software
+
+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/features/requestable_examples.feature

@@ -0,0 +1,360 @@
+Feature: Requestable examples
+
+  Requestable examples are RSpec's shared examples with the addition that you can 
+  define examples which you can explicitly request later when you include the 
+  requestable example group. Because of this they are a super-set of shared examples.
+  
+  Requestable example groups can be defined using the following mechanism:
+      
+      requestable_examples "description goes here" do ; ... ; end
+      
+  Using this mechanism you have four new methods available to you when writing examples:
+  
+      requestable_it "name"
+      requestable_example "name"
+  
+      requestable_describe "name"
+      requestable_context  "name"
+      
+  You can mix it/describe/context with the above mechanisms, but when you use the 
+  traditional mechanisms those examples will ALWAYS be included. Now, onto using 
+  requestable example groups.
+  
+  Requestable example groups can be included in another group using the same mechanisms
+  that you use when using shared example groups, e.g.:
+  
+      include_examples "name"      # include the examples in the current context
+      it_behaves_like "name"       # include the examples in a nested context
+      it_should_behave_like "name" # include the examples in a nested context
+
+  If you do not pass in any additional options (see below) then all examples are 
+  run. However, if you pass the :examples option with the names of the examples to
+  run then the requested examples will only run ones that you've specified!
+  
+      include_examples "name", :examples => ["example #1"]
+      it_behaves_like "name", :examples => ["example #1"]       # include the examples in a nested context
+      it_should_behave_like "name", :examples => ["example #1"]
+  
+  For more information on how to use these see the corresponding scenarios.
+
+  Background:
+    Given a file named "spec_helper.rb" with:
+      """
+        require "../../lib/rspec-requestable-examples"
+        RSpec.configure do |config|
+          config.extend RSpec::RequestableExamples
+        end
+      """
+
+  Scenario: Ommitting all examples includes them all
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+        let(:collection) { described_class.new([7, 2, 4]) }
+        
+        requestable_example "is not empty" do
+          collection.should_not be_empty
+        end
+
+        requestable_it "has more than 0 items" do
+          collection.should_not be_empty
+        end
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items"
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items"
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the examples should all pass
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          is not empty
+          has more than 0 items
+      
+      Set
+        behaves like a collection with items
+          is not empty
+          has more than 0 items
+      """
+
+  Scenario: Including specific examples
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+        let(:collection) { described_class.new([7, 2, 4]) }
+        
+        requestable_example "is not empty" do
+          collection.should_not be_empty
+        end
+
+        requestable_it "has more than 0 items" do
+          collection.should_not be_empty
+        end
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items", :examples => [
+          "is not empty"
+        ] 
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items", :examples => [
+          "has more than 0 items"
+        ] 
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the examples should all pass
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          is not empty
+      
+      Set
+        behaves like a collection with items
+          has more than 0 items
+      """
+
+  Scenario: Traditional "it" and "describe" examples are always run even when not specified
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+        let(:collection) { described_class.new([7, 2, 4]) }
+        
+        it "always runs traditional examples" do
+          true.should be_true
+        end
+
+        describe "always runs traditional describes" do
+          it "is true" do
+            true.should be_true
+          end
+        end
+        
+        requestable_example "is not empty" do
+          collection.should_not be_empty
+        end
+
+        requestable_it "has more than 0 items" do
+          collection.should_not be_empty
+        end
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items", :examples => []
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items", :examples => ["is not empty"]
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the examples should all pass
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          always runs traditional examples
+          always runs traditional describes
+            is true
+      
+      Set
+        behaves like a collection with items
+          always runs traditional examples
+          is not empty
+          always runs traditional describes
+            is true
+      """
+
+
+  Scenario: Including aliased examples
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+        let(:collection) { described_class.new([7, 2, 4]) }
+        
+        requestable_example "is not empty", :as => "not empty" do
+          collection.should_not be_empty
+        end
+
+        requestable_example "has more than 0 items", :as => "contains at least 1 or more items" do
+          collection.should_not be_empty
+        end
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items", :examples => [
+          "not empty"
+        ] 
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items", :examples => [
+          "contains at least 1 or more items"
+        ] 
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the examples should all pass
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          is not empty
+      
+      Set
+        behaves like a collection with items
+          has more than 0 items
+      """
+
+  Scenario Outline: Including specific <type> blocks
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+        let(:collection) { described_class.new([7, 2, 4]) }
+        
+        requestable_<type> "collection rules" do
+          it "is not empty" do
+            collection.should_not be_empty
+          end
+        end
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items", :examples => [
+          "collection rules"
+        ] 
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items", :examples => [
+          "collection rules"
+        ] 
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the examples should all pass
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          collection rules
+            is not empty
+      
+      Set
+        behaves like a collection with items
+          collection rules
+            is not empty
+      """
+      
+    Examples:
+      | type     |
+      | describe |
+      | context  |
+
+  Scenario Outline: Including aliased <type> blocks
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+        let(:collection) { described_class.new([7, 2, 4]) }
+        
+        requestable_<type> "collection rules", :as => "aliased collection rules" do
+          it "is not empty" do
+            collection.should_not be_empty
+          end
+        end
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items", :examples => [
+          "aliased collection rules"
+        ] 
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items", :examples => [
+          "aliased collection rules"
+        ] 
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the examples should all pass
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          collection rules
+            is not empty
+      
+      Set
+        behaves like a collection with items
+          collection rules
+            is not empty
+      """
+      
+    Examples:
+      | type     |
+      | describe |
+      | context  |
+
+  Scenario: Requesting examples that don't exist
+    Given a file named "collection_spec.rb" with:
+      """
+      require "./spec_helper"
+      require "set"
+
+      requestable_examples "a collection with items" do |options|
+      end
+
+      describe Array do
+        it_behaves_like "a collection with items", :examples => [
+          "collection rules"
+        ] 
+      end
+
+      describe Set do
+        it_behaves_like "a collection with items", :examples => [
+          "collection rules"
+        ] 
+      end
+      """
+    When I run `rspec collection_spec.rb --format documentation`
+    Then the output should contain "2 examples, 0 failures, 2 pending"
+    And the output should contain:
+      """
+      Array
+        behaves like a collection with items
+          collection rules (PENDING: This example was requested but isn't defined, typo?)
+      
+      Set
+        behaves like a collection with items
+          collection rules (PENDING: This example was requested but isn't defined, typo?)
+      """
+

data/features/step_definitions/additional_cli_steps.rb

@@ -0,0 +1,4 @@
+Then /^the example(?:s)? should(?: all)? pass$/ do
+  step %q{the output should contain "0 failures"}
+  step %q{the exit status should be 0}
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+require 'aruba/cucumber'
+
+Before do
+  if RUBY_PLATFORM =~ /java/
+    # ideas taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
+    set_env('JRUBY_OPTS', '-X-C') # disable JIT since these processes are so short lived
+    set_env('JAVA_OPTS', '-d32') # force jRuby to use client JVM for faster startup times
+    @aruba_timeout_seconds = 60
+  else
+    @aruba_timeout_seconds = 5
+  end
+end

data/lib/rspec-requestable-examples.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rspec/requestable-examples"

data/lib/rspec/requestable-examples.rb

@@ -1,17 +1,41 @@
 module RSpec
   module RequestableExamples
+    include RSpec::Core::SharedExampleGroup
+    
     class RequestedExamples < Array
       def initialize(options)
         options ||= {}
+        @do_not_run_any_examples = true if options[:examples] == []
         replace options[:examples] || []
       end
   
       def run?(example)
+        return false if @do_not_run_any_examples
         return true if empty? || include?(example)
         false
       end
     end
-    
+
+    def requestable_examples(*args, &block)
+      if [String, Symbol, Module].any? {|cls| cls === args.first }
+        object = args.shift
+        ensure_shared_example_group_name_not_taken(object)
+        RSpec.world.shared_example_groups[object] = lambda do |options={}|
+          request_examples options
+          instance_eval(&block)
+          verify_requested_examples!
+        end
+      end
+      
+      unless args.empty?
+        mod = Module.new
+        (class << mod; self; end).send(:define_method, :extended) do |host|
+          host.class_eval(&block)
+        end
+        RSpec.configuration.extend(mod, *args)
+      end
+    end
+
     def examples_that_can_be_requested
       @examples_that_can_be_requested ||= []
     end
@@ -31,10 +55,6 @@ module RSpec
     end
     alias_method :requestable_it, :requestable_example
   
-    def requestable_examples
-      @requestable_examples ||= []
-    end
-  
     def requestable_describe(description, options={}, &blk)
       label = options[:as] || description
       examples_that_can_be_requested << label
@@ -52,4 +72,6 @@ module RSpec
     end
   end
 
-end
+end
+
+include RSpec::RequestableExamples

data/lib/rspec/requestable-examples/version.rb

@@ -0,0 +1,7 @@
+module RSpec # :nodoc:
+  module RequestableExamples  # :nodoc:
+    module Version # :nodoc:
+      STRING = '0.1.6'
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: rspec-requestable-examples
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Zach Dennis
@@ -10,10 +10,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-12 00:00:00 Z
-dependencies: []
-
-description: See home page
+date: 2012-01-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.11
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+description: Let's you include specific examples from shared example sets.
 email: zach.dennis@gmail.com
 executables: []
 
@@ -22,13 +76,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/rspec-requestable-examples.rb
 - lib/rspec/requestable-examples.rb
-homepage: http://www.continuousthinking.com
-licenses: []
-
+- lib/rspec/requestable-examples/version.rb
+- README.markdown
+- License.txt
+- features/requestable_examples.feature
+- features/step_definitions/additional_cli_steps.rb
+- features/support/env.rb
+homepage: http://github.com/mhs/rspec-requestable-examples
+licenses: 
+- MIT
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -46,10 +107,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.13
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: rspec-requestable-examples let's you include specific examples from shared example sets
-test_files: []
-
+summary: rspec-requestable-examples-0.1.6
+test_files: 
+- features/requestable_examples.feature
+- features/step_definitions/additional_cli_steps.rb
+- features/support/env.rb
 has_rdoc: