rspec-sleeping_king_studios 2.1.0 → 2.1.1.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9748e53c33ae330dafb6e3e9aa2a099cc6478602
-  data.tar.gz: 55f4d5e8eb267c66cea63cbeb3a26c97c8b6eb1d
+  metadata.gz: 1649e39464b7d6dd962aeb7c4de50d2aea52c130
+  data.tar.gz: 9617e65ae0caf7522408525bc682ce07caabd7e9
 SHA512:
-  metadata.gz: addb8e4d08c8e8aa7ae646533780c54336a1d863759265cf1626788c0b2b988cefb779a62f5e50a52ca9c40cff944f654aefb48a6915800d0d76bba1e219668a
-  data.tar.gz: 8a42cc1162b4e4c3e8874973b00e2475c8aea4ae9f94be51f0fa0dbe337a0ee6841b166179a0b80c98e82f52f8d08fa0c5b9073cf245d3b01c72e09637fb8af3
+  metadata.gz: 5d57031970580753d83a7310cbead9b82bee16e3fd81e6e0141bdeb6df5c5fa18a2978c225ffd49f595e75b7bd1349180cd2f3acfa59e9ef062e871bf9e7034c
+  data.tar.gz: fa0dd5f37ac2f6e97c0b8fe82b0fb656e82ee5ab0160b3779ba5ab77c0250a5305a34fbed34b272345b46396650b9a2d4d6831bf2fc34a659985b0108e177e0f

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 2.1.1
+
+### Concerns
+
+#### `FocusExamples` Concern
+
+Added module RSpec::SleepingKingStudios::Concerns::FocusExamples to create a shorthand for quickly focusing/skipping included shared example groups, e.g. `include_examples '...'` => `finclude_examples '...'`.
+
+#### `WrapExamples` Concern
+
+Ensured correct behavior when passing an empty keywords hash to a method with optional arguments.
+
+### Matchers
+
+#### `respond_to` Matcher
+
+Added methods `#with_any_keywords` and `#and_any_keywords`, which are both equivalent to the existing `#with_arbitrary_keywords`.
+
 ## 2.1.0
 
 ### Concerns

data/DEVELOPMENT.md

@@ -2,8 +2,11 @@
 
 ## Tasks
 
+- Resolve Aruba deprecation warnings.
+
 ### Planned Features
 
+- Add `#with_any_keywords` alias to RespondToMatcher.
 - Add #have_constant matcher.
 - Add #have_predicate matcher.
 - Add shared examples for 'should have constant', 'should have immutable constant'
@@ -11,6 +14,8 @@
 - Add shared examples for 'should not have reader/writer'
 - Add shared examples for #belongs_to, #has_one, #has_many, #embedded_in, #embeds_one, #embeds_many.
 - Add shared examples for core ActiveModel validations.
+- Add allow/expect(object).to alias_method(:my_method).to(:other_method)
+- Add allow/expect(object).to delegate(:my_method).to(other_object[, :other_method])
 
 ### Maintenance
 
@@ -18,12 +23,16 @@
 - 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).
+- 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 ?
+- Add minimal test formatter - --format=smoke ? --format=librarian ? --format=quiet ?
   - Prints nothing for examples
   - Suppress STDOUT output? As configurable option for any formatted?
+- Add DSL for shared_examples-heavy specs?
+  - #should(name) => include_examples "should #{name}"
+  - #with(name)   => wrap_context "with #{name}"
+  - #when(name)   => wrap_context "when #{name}"

data/README.md

@@ -46,6 +46,45 @@ This option is used with the RSpec matcher examples (see Examples, below), and d
 
 RSpec::SleepingKingStudios defines a few concerns that can be included in or extended into modules or example groups for additional functionality.
 
+### Focus Examples
+
+    require 'rspec/sleeping_king_studios/concerns/focus_examples'
+
+    RSpec.describe String do
+      extend RSpec::SleepingKingStudios::Concerns::WrapExamples
+
+      shared_examples 'should be a greeting' do
+        it { expect(salutation).to be =~ /greeting/i }
+      end # shared_examples
+
+      shared_examples 'should greet the user by name' do
+        it { expect(salutation).to match user.name }
+      end # shared_examples
+
+      let(:salutation) { 'Greetings, programs!' }
+
+      # Focused example groups are always run when config.filter_run :focus is
+      # set to true.
+      finclude_examples 'should be a greeting'
+
+      # Skipped example groups are marked as pending and never run.
+      xinclude_examples 'should greet the user by name'
+    end # describe
+
+A shorthand for focusing or skipping included shared example groups with a single keystroke, e.g. `include_examples '...'` => `finclude_examples '...'`.
+
+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.
+
+*Important Note:* Do not use these methods with example groups that have side effects, e.g. that define a memoized `#let` helper or a `#before` block that is intended to modify the behavior of sibling examples. Wrapping the example group in a `describe` block breaks that relationship. Best practice is to use the `#wrap_examples` method to safely encapsulate example groups with side effects, and the `#fwrap_examples` method to automatically focus such groups.
+
+#### `::finclude_examples`
+
+(also `::finclude_context`) A shortcut for focusing the example group by wrapping it in a `describe` block, similar to the built-in `fit` and `fdescribe` methods.
+
+#### `::xinclude_examples`
+
+(also `::xinclude_context`) A shortcut for skipping the example group by wrapping it in a `describe` block, similar to the built-in `xit` and `xdescribe` methods.
+
 ### Shared Example Groups
 
     require 'rspec/sleeping_king_studios/concerns/shared_example_group'
@@ -196,15 +235,18 @@ Now has additional chaining functionality to validate the number of arguments ac
     expect(instance).to respond_to(:foo).with(2..3).arguments.and_a_block
 
     # With keyword arguments.
-    expect(instance).to respond_to(:foo).with(0, :bar, :baz)
+    expect(instance).to respond_to(:foo).with_keywords(:bar, :baz)
+
+    # With both arguments and keywords.
+    expect(instance).to respond_to(:foo).with(2).arguments.and_keywords(:bar, :baz)
 
 **Chaining:**
 
-* **`#with`:** Expects at most one Integer or Range argument, and zero or more Symbol arguments corresponding to optional keywords. Verifies that the method accepts that keyword, or has a variadic keyword of the form `**params`. As of 2.1.0 and required keywords, verifies that all required keywords are provided.
+* **`#with`:** Expects at most one Integer or Range argument, and zero or more Symbol arguments corresponding to optional keywords. Verifies that the method accepts that keyword, or has a variadic keyword of the form `**kwargs`. As of 2.1.0 and required keywords, verifies that all required keywords are provided.
 * **`#with_unlimited_arguments`:** (also `and_unlimited_arguments`) No parameters. Verifies that the method accepts any number of arguments via a variadic argument of the form `*args`.
 * **`#with_a_block`:** (also `and_a_block`) No parameters. Verifies that the method requires a block argument of the form `&my_argument`. _Important note:_ A negative result _does not_ mean the method cannot accept a block, merely that it does not require one. Also, _does not_ check whether the block is called or yielded.
-* **`#with_keywords`:** (also `and_keywords`) Expects one or more String or Symbol arguments. Verifies that the method accepts each provided keyword or has a variadic keyword of the form `**params`. As of 2.1.0 and required keywords, verifies that all required keywords are provided.
-* **`#with_arbitrary_keywords`:** (also `and_arbitrary_keywords`) No parameters. Verifies that the method accepts any keyword arguments via a variadic keyword of the form `**params`.
+* **`#with_keywords`:** (also `and_keywords`) Expects one or more String or Symbol arguments. Verifies that the method accepts each provided keyword or has a variadic keyword of the form `**kwargs`. As of 2.1.0 and required keywords, verifies that all required keywords are provided.
+* **`#with_any_keywords`:** (also `and_any_keywords`, `and_arbitrary_keywords`, `and_arbitrary_keywords`) No parameters. Verifies that the method accepts any keyword arguments via a variadic keyword of the form `**kwargs`.
 
 ### Core
 

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

@@ -0,0 +1,70 @@
+# lib/rspec/sleeping_king_studios/concerns/focus_examples.rb
+
+require 'rspec/sleeping_king_studios/concerns'
+
+module RSpec::SleepingKingStudios::Concerns
+  # Convenience methods for automatically focusing or skipping shared example
+  # groups.
+  module FocusExamples
+    # Includes the specified shared example group and wraps it inside an
+    # `fdescribe` block named "(focused)". If the spec runner is set to run only
+    # focused specs, this will ensure that the wrapped example group is run.
+    #
+    # @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 Optional block that is passed on to the shared example group.
+    #
+    # @note Do not use this method with example groups that have side effects,
+    #   e.g. define a memoized `#let` helper or a `#before` block that is
+    #   intended to modify the behavior of sibling examples. Wrapping the
+    #   example group in a `describe` block breaks that relationship. Best
+    #   practice is to use the `#wrap_examples` method to safely encapsulate
+    #   example groups with side effects, and the `#fwrap_examples` method to
+    #   automatically focus such groups.
+    def finclude_examples name, *args, **kwargs, &block
+      fdescribe '(focused)' do
+        if kwargs.empty?
+          include_examples name, *args, &block
+        else
+          include_examples name, *args, **kwargs, &block
+        end # if-else
+      end # describe
+    end # method wrap_examples
+    alias_method :finclude_context, :finclude_examples
+
+    # Includes the specified shared example group and wraps it inside an
+    # `xdescribe` block named "(skipped)". This will ensure that the wrapped
+    # example group is not run.
+    #
+    # @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 Optional block that is passed on to the shared example group.
+    #
+    # @note Do not use this method with example groups that have side effects,
+    #   e.g. define a memoized `#let` helper or a `#before` block that is
+    #   intended to modify the behavior of sibling examples. Wrapping the
+    #   example group in a `describe` block breaks that relationship. Best
+    #   practice is to use the `#wrap_examples` method to safely encapsulate
+    #   example groups with side effects, and the `#xwrap_examples` method to
+    #   automatically skip such groups.
+    # groups.
+    def xinclude_examples name, *args, **kwargs, &block
+      xdescribe '(focused)' do
+        if kwargs.empty?
+          include_examples name, *args, &block
+        else
+          include_examples name, *args, **kwargs, &block
+        end # if-else
+      end # describe
+    end # method xinclude_examples
+    alias_method :xinclude_context, :xinclude_examples
+  end # module
+end # module

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

@@ -5,8 +5,6 @@ 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
@@ -22,7 +20,11 @@ module RSpec::SleepingKingStudios::Concerns
     #   block, such as additional examples or memoized values.
     def wrap_examples name, *args, **kwargs, &block
       describe name do
-        include_examples name, *args, **kwargs
+        if kwargs.empty?
+          include_examples name, *args
+        else
+          include_examples name, *args, **kwargs
+        end # if-else
 
         instance_eval(&block) if block_given?
       end # describe
@@ -43,7 +45,11 @@ module RSpec::SleepingKingStudios::Concerns
     #   block, such as additional examples or memoized values.
     def fwrap_examples name, *args, **kwargs, &block
       fdescribe name do
-        include_examples name, *args, **kwargs
+        if kwargs.empty?
+          include_examples name, *args
+        else
+          include_examples name, *args, **kwargs
+        end # if-else
 
         instance_eval(&block) if block_given?
       end # describe
@@ -66,13 +72,15 @@ module RSpec::SleepingKingStudios::Concerns
     #   block, such as additional examples or memoized values.
     def xwrap_examples name, *args, **kwargs, &block
       xdescribe name do
-        include_examples name, *args, **kwargs
+        if kwargs.empty?
+          include_examples name, *args
+        else
+          include_examples name, *args, **kwargs
+        end # if-else
 
         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/matchers/built_in/respond_to.rb

@@ -94,6 +94,8 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       self
     end # method with_arbitrary_keywords
     alias_method :and_arbitrary_keywords, :with_arbitrary_keywords
+    alias_method :with_any_keywords,      :with_arbitrary_keywords
+    alias_method :and_any_keywords,       :with_any_keywords
 
     # Adds a block expectation. The actual object will only match a block
     # expectation if it expects a parameter of the form &block.

data/lib/rspec/sleeping_king_studios/version.rb

@@ -13,11 +13,11 @@ module RSpec
       # Minor version.
       MINOR = 1
       # Patch version.
-      PATCH = 0
+      PATCH = 1
       # 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.1.0
+  version: 2.1.1.rc.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -33,7 +33,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,7 @@ files:
 - lib/rspec/sleeping_king_studios/all.rb
 - lib/rspec/sleeping_king_studios/concerns.rb
 - lib/rspec/sleeping_king_studios/concerns/all.rb
+- lib/rspec/sleeping_king_studios/concerns/focus_examples.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
@@ -229,12 +230,12 @@ 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
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A collection of RSpec patches and custom matchers.