rspec-sleeping_king_studios 2.0.3 → 2.1.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3427b043889c866103ff0e5a58222621798f825
-  data.tar.gz: 3f7ea93de6bc4be9d9c6a5687be25eb57b406e78
+  metadata.gz: 9989fe8d25e1e4cc3e01704d54d783d7de466edb
+  data.tar.gz: 5134740008100f8fc5617da5d0fb4df269666c7d
 SHA512:
-  metadata.gz: 5696860258e7bb62a86b97af732f8cab837bca81f6665cffb46dcf28ec407b54031e8c6d28029762b8039b5eab220db4515d39c35773593946ad6d42b8b2af9c
-  data.tar.gz: ec5dcd4a1a3ecd74e7dbf88e3761a27ed3e5e46fb295709a64b54a9f4b27cc9632311ef6883add79968104747c6d67a6eaa5654a135026c805f71c68e49326fd
+  metadata.gz: 9818552afcebbd54b0fab96dca38e66701922563fe30492d47dd0193d7a4ab524d906d1e40abe3362c6f5077369cd9e9737894dcacf837a1c640bc2db4e7324c
+  data.tar.gz: 158147781997f5e0ba2c27a1a3e85ec2dbaab392e87bcddd2e7ca33ab6c403ffeafb85bfecbfe01a832cf337b5c93f158d10de2f1ab48df5deda1ba30b7e9414

data/CHANGELOG.md

@@ -1,11 +1,21 @@
 # Changelog
 
+## 2.1.0
+
+### Concerns
+
+#### `WrapExamples` Concern
+
+Added module RSpec::SleepingKingStudios::Concerns::WrapExamples to support a common use case for shared examples/shared contexts and avoid surprising behavior when using multiple adjacent shared contexts (or shared examples that have side effects).
+
 ## 2.0.3
 
 Internal update to add support for RSpec 3.3.
 
 ## 2.0.2
 
+### Matchers
+
 #### `construct` and `respond_to` Matchers
 
 Added new fluent syntax for keyword expectations:

data/DEVELOPMENT.md

@@ -2,38 +2,26 @@
 
 ## Tasks
 
-### Release Candidate
+### Planned Features
 
-### 2.0.3
-
-- Add support for RSpec 3.3
-  - Transition from RSpec::Matchers::Pretty to RSpec::Matchers::EnglishPhrasing?
-  - Support new implementation of RSpec::Matchers::BuiltIn::Include
-
-### 2.1.0+
-
-- Add #wrap_context, #wrap_examples (alias encapsulate_X ?) for pattern `describe ""; include_examples "": end`
-  - Configuration option 'alias_wrap_examples'?
-  - Automatically-focused #fwrap_context, #fwrap_examples?
 - Add #have_constant matcher.
+- Add shared examples for 'should have constant', 'should have immutable constant'
 - Add shared examples for 'should not have reader/writer/property'
-
-### 2.2.0+
-
 - Add shared examples for #belongs_to, #has_one, #has_many, #embedded_in, #embeds_one, #embeds_many.
 - Add shared examples for core ActiveModel validations.
-- Add alt doc test formatter - --format=list ? --format=documentation-list ?
-  - Prints full expanded example name for each example
-- Add minimal test formatter - --format=smoke ? --format=librarian ?
-  - Prints nothing for examples
-  - Suppress STDOUT output? As configurable option for any formatted?
-
-### 3.0.0
-
-- Ensure behavior of `#have_reader`, `#have_writer`, `#have_property` is consistent.
 
 ### Maintenance
 
 - Remove SCENARIOS from spec files.
+- Refactor #respond_to, #be_constructible to use RSpec 3 method reflection.
 - Revisit failure messages for #respond_to, #be_constructible.
 - Pare down Cucumber features for matchers - repurpose as documentation/examples only.
+- - Ensure behavior of `#have_reader`, `#have_writer`, `#have_property` is consistent (non-compatible; needs version 3.0).
+
+### Icebox
+
+- Add alt doc test formatter - --format=list ? --format=documentation-list ?
+  - Prints full expanded example name for each example
+- Add minimal test formatter - --format=smoke ? --format=librarian ?
+  - Prints nothing for examples
+  - Suppress STDOUT output? As configurable option for any formatted?

data/README.md

@@ -61,14 +61,57 @@ RSpec::SleepingKingStudios defines a few concerns that can be included in or ext
 
 Utility functions for defining shared examples. If included in a module, any shared examples defined in that module are scoped to the module, rather than placed in a global scope. This allows you to define different shared examples with the same name in different contexts, similar to the current behavior when defining a shared example inside an example group. To use the defined examples, simply `include` the module in an example group. **Important Note:** Shared examples and aliases must be defined **before** including the module in an example group. Any shared examples or aliases defined afterword will not be available inside the example group.
 
-### `::alias_shared_examples`
+#### `::alias_shared_examples`
 
 (also `::alias_shared_context`) Aliases a defined shared example group, allowing it to be accessed using a new name. The example group must be defined in the current context using `shared_examples`. The aliases must be defined before including the module into an example group, or they will not be available in the example group.
 
-### `::shared_examples`
+#### `::shared_examples`
 
 (also `::shared_context`) Defines a shared example group within the context of the current module. Unlike a top-level example group defined using RSpec#shared_examples, these examples are not globally available, and must be mixed into an example group by including the module. The shared examples must be defined before including the module, or they will not be available in the example group.
 
+### Wrap Examples
+
+    require 'rspec/sleeping_king_studios/concerns/wrap_examples'
+
+    RSpec.describe String do
+      extend RSpec::SleepingKingStudios::Concerns::WrapExamples
+
+      shared_context 'with a long quote' do
+        let(:quote) do
+          'Greetings, starfighter! You have been recruited by the Star League'\
+          ' to defend the frontier against Xur and the Ko-Dan armada!'
+        end # let
+      end # shared context
+
+      shared_context 'with a short quote' do`
+        let(:quote) { 'Greetings, programs!' }
+      end # shared_context
+
+      describe '#length' do
+        wrap_context 'with a long quote' do
+          it { expect(quote.length).to be == 124 }
+        end # wrap_context
+
+        wrap_context 'with a short quote' do
+          it { expect(quote.length).to be == 20 }
+        end # wrap_context
+      end # describe
+    end # describe
+
+A simplified syntax for re-using shared context or examples without having to explicitly wrap them in `describe` blocks or allowing memoized values or callbacks to change the containing context. In the example above, if the programmer had used the standard `include_context` instead, the first expectation would have failed, as the value of :quote would have been overwritten.
+
+#### `::wrap_examples`
+
+(also `::wrap_context`) Creates an implicit `describe` block and includes the context or examples within the `describe` block to avoid leaking values or callbacks to the outer context. Any parameters or keywords will be passed along to the `include_examples` call. If a block is given, it is evaluated in the context of the `describe` block after the `include_examples` call, allowing you to define additional examples or customize the values and callbacks defined in the shared examples.
+
+#### `::fwrap_examples`
+
+(also `::fwrap_context`) A shortcut for wrapping the context or examples in an automatically-focused `describe` block, similar to the built-in `fit` and `fdescribe` methods.
+
+#### `::xwrap_examples`
+
+(also `::xwrap_context`) A shortcut for wrapping the context or examples in an automatically-skipped `describe` block, similar to the built-in `xit` and `xdescribe` methods.
+
 ## Custom Matchers
 
 To enable a custom matcher, simply require the associated file. Matchers can be required individually or by category:

data/lib/rspec/sleeping_king_studios/concerns/wrap_examples.rb

@@ -0,0 +1,78 @@
+# lib/rspec/sleeping_king_studios/concerns/wrap_examples.rb
+
+require 'rspec/sleeping_king_studios/concerns'
+
+module RSpec::SleepingKingStudios::Concerns
+  # Methods for encapsulating shared example groups to include contexts or
+  # examples without affecting the surrounding context.
+  #
+  # @examples
+  module WrapExamples
+    # Includes the specified shared example group and wraps it inside a
+    # `describe` block. If a block is provided, it is evaluated in the
+    # context of the describe block after the example group has been included.
+    #
+    # @param [String] name The name of the shared example group to be wrapped.
+    # @param [Array] args Optional array of arguments that are passed on to
+    #   the shared example group.
+    # @param [Hash] kwargs Optional hash of keyword arguments that are passed
+    #   on to the shared example group.
+    #
+    # @yield Additional code to run in the context of the wrapping `describe`
+    #   block, such as additional examples or memoized values.
+    def wrap_examples name, *args, **kwargs, &block
+      describe name do
+        include_examples name, *args, **kwargs
+
+        instance_eval(&block) if block_given?
+      end # describe
+    end # method wrap_examples
+    alias_method :wrap_context, :wrap_examples
+
+    # Includes the specified shared example group and wraps it inside a
+    # focused `fdescribe` block. If a block is provided, it is evaluated in the
+    # context of the fdescribe block after the example group has been included.
+    #
+    # @param [String] name The name of the shared example group to be wrapped.
+    # @param [Array] args Optional array of arguments that are passed on to
+    #   the shared example group.
+    # @param [Hash] kwargs Optional hash of keyword arguments that are passed
+    #   on to the shared example group.
+    #
+    # @yield Additional code to run in the context of the wrapping `fdescribe`
+    #   block, such as additional examples or memoized values.
+    def fwrap_examples name, *args, **kwargs, &block
+      fdescribe name do
+        include_examples name, *args, **kwargs
+
+        instance_eval(&block) if block_given?
+      end # describe
+    end # method fwrap_examples
+    alias_method :fwrap_context, :fwrap_examples
+
+    # Includes the specified shared example group and wraps it inside a
+    # skipped `xdescribe` block. If a block is provided, it is evaluated in the
+    # context of the xdescribe block after the example group has been included.
+    # Mostly used to temporarily disable a wrapped example group while updating
+    # or debugging a spec.
+    #
+    # @param [String] name The name of the shared example group to be wrapped.
+    # @param [Array] args Optional array of arguments that are passed on to
+    #   the shared example group.
+    # @param [Hash] kwargs Optional hash of keyword arguments that are passed
+    #   on to the shared example group.
+    #
+    # @yield Additional code to run in the context of the wrapping `fdescribe`
+    #   block, such as additional examples or memoized values.
+    def xwrap_examples name, *args, **kwargs, &block
+      xdescribe name do
+        include_examples name, *args, **kwargs
+
+        instance_eval(&block) if block_given?
+      end # describe
+    end # method fwrap_examples
+    alias_method :xwrap_context, :xwrap_examples
+
+
+  end # module
+end # module

data/lib/rspec/sleeping_king_studios/version.rb

@@ -11,13 +11,13 @@ module RSpec
       # Major version.
       MAJOR = 2
       # Minor version.
-      MINOR = 0
+      MINOR = 1
       # Patch version.
-      PATCH = 3
+      PATCH = 0
       # Prerelease version.
-      PRERELEASE = nil
+      PRERELEASE = 'rc'
       # Build metadata.
-      BUILD = nil
+      BUILD = 0
 
       # Generates the gem version string from the Version constants.
       def self.to_gem_version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0.rc.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -118,20 +118,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +185,7 @@ files:
 - lib/rspec/sleeping_king_studios/concerns.rb
 - lib/rspec/sleeping_king_studios/concerns/all.rb
 - lib/rspec/sleeping_king_studios/concerns/shared_example_group.rb
+- lib/rspec/sleeping_king_studios/concerns/wrap_examples.rb
 - lib/rspec/sleeping_king_studios/configuration.rb
 - lib/rspec/sleeping_king_studios/examples.rb
 - lib/rspec/sleeping_king_studios/examples/all.rb
@@ -234,9 +229,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6
@@ -244,4 +239,3 @@ signing_key:
 specification_version: 4
 summary: A collection of RSpec patches and custom matchers.
 test_files: []
-has_rdoc: