rspec-sleeping_king_studios 2.0.0.beta.2 → 2.0.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ac96e7fae3fdf94aa39e7ebfecccfc39766ada0
-  data.tar.gz: 0d96c3c2402360bbf600fce1bd882ea38d8f341f
+  metadata.gz: 8f8068de1e2622240688c78aaa24232869a3b9f0
+  data.tar.gz: 3244ec9495f61915abffb5cdc5fe791b03caad1c
 SHA512:
-  metadata.gz: e5ed09efe3e51e5900e6332fe5e51677c17e47d874aa85304ddad33ab93c12b3f8c5006371e8e80df4efaeeeecdae1fb06fe02bf1a10663df24d7cb7a3b204ed
-  data.tar.gz: 5d4abb850b85fbfffb3544268c4b47b07038816f03e2be7ded0a43ce1bf9963b566ca66db81fa6958eeb491667ac3621ccc8815dbb7807347a8ce2c60793405e
+  metadata.gz: 60e23c171168e16b0f0af51beb9dbb4b26713005cec1b245a8fcbca6160c2c63d22cfea679146ee304a871b6211f1fb9d1f3bad4017afdd676627febda51a4ee
+  data.tar.gz: ee596646cf418ef1a68eff366994efff79bc26c1b2bf650d73b7a0e18513b2e176c0571d26cc68cca5f7af714f1cc02708dcef0c4788df694e9c12d215f9932c

data/CHANGELOG.md

@@ -10,7 +10,7 @@ Support for Ruby 1.9.3 is officially dropped.
 
 ### Concerns
 
-Added module RSpec::SleepingKingStudios::Examples::SharedExampleGroup as a mixin for defining scoped shared example groups. Extend into a module to define shared example groups scoped to that module (and automatically included in example groups when the module is included), or extend into an example group to allow aliasing shared example groups with alternate or more expressive names.
+Added module RSpec::SleepingKingStudios::Concerns::SharedExampleGroup as a mixin for defining scoped shared example groups. Extend into a module to define shared example groups scoped to that module (and automatically included in example groups when the module is included), or extend into an example group to allow aliasing shared example groups with alternate or more expressive names.
 
 ### Custom Examples
 

data/DEVELOPMENT.md

@@ -2,15 +2,11 @@
 
 ## Tasks
 
-### High Priority
+### Release Candidate
 
-### Medium Priority
-
-[RC1]
 - Thorough documentation pass.
-- Test against both RSpec 3.0 and 3.1 (multiple gemfiles? See ActiveModel::Collection for how it's done)
 
-### Low Priority
+### Post 2.0.0
 
-[RC1]
 - Cucumber features for testing matchers, including returned text?
+- add shared examples for #belongs_to, #has_one, #has_many, #embedded_in, #embeds_one, #embeds_many.

data/README.md

@@ -2,7 +2,9 @@
 
 A collection of matchers and extensions to ease TDD/BDD using RSpec. Extends built-in matchers with new functionality, such as support for Ruby 2.0+ keyword arguments, and adds new matchers for testing boolean-ness, object reader/writer properties, object constructor arguments, ActiveModel validations, and more. Also defines shared example groups for more expressive testing.
 
-## Supported Ruby Versions
+## Support
+
+RSpec::SleepingKingStudios is tested against RSpec 3.0 and 3.1.
 
 Currently, the following versions of Ruby are officially supported:
 
@@ -11,7 +13,9 @@ Currently, the following versions of Ruby are officially supported:
 
 ## Contribute
 
-- https://github.com/sleepingkingstudios/rspec-sleeping_king_studios
+### GitHub
+
+The canonical repository for this gem is located at https://github.com/sleepingkingstudios/rspec-sleeping_king_studios.
 
 ### A Note From The Developer
 
@@ -41,10 +45,10 @@ RSpec::SleepingKingStudios defines a few concerns that can be included in or ext
 
 ### Shared Example Groups
 
-    require 'rspec/sleeping_king_studios/examples/shared_example_group'
+    require 'rspec/sleeping_king_studios/concerns/shared_example_group'
 
     module MyCustomExamples
-      extend RSpec::SleepingKingStudios::Examples::SharedExampleGroup
+      extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
       shared_examples 'has custom behavior' do
         # Define expectations here...
@@ -56,16 +60,15 @@ Utility functions for defining shared examples. If included in a module, any sha
 
 ### `::alias_shared_examples`
 
-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.
+(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`
 
-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.
+(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.
 
 ## Custom Matchers
 
-To enable a custom matcher, simply require the associated file. Matchers can be
-required individually or by category:
+To enable a custom matcher, simply require the associated file. Matchers can be required individually or by category:
 
     require 'rspec/sleeping_king_studios/all'
     #=> requires all features, including matchers
@@ -82,12 +85,11 @@ required individually or by category:
 
 These matchers validate ActiveModel functionality, such as validations.
 
-#### have\_errors Matcher
+#### `#have_errors` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/active_model/have_errors'
 
-Verifies that the actual object has validation errors. Optionally can specify
-individual fields to validate, or even specific messages for each attribute.
+Verifies that the actual object has validation errors. Optionally can specify individual fields to validate, or even specific messages for each attribute.
 
 **How To Use:**
 
@@ -99,15 +101,10 @@ individual fields to validate, or even specific messages for each attribute.
 
 **Chaining:**
 
-* **on:** [String, Symbol] Adds a field to validate; the matcher only passes if
-  all validated fields have errors.
-* **with:** [Array<String>] Adds one or more messages to the previously-defined
-  field validation. Raises ArgumentError if no field was previously set.
-* **with\_message:** [String] Adds a message to the previously-defined field
-  validation. Raises ArgumentError if no field was previously set.
-* **with\_messages:** [Array<String>] Adds one or more messages to the
-  previously-defined field validation. Raises ArgumentError if no field was
-  previously set.
+* **`#on`:** [String, Symbol] Adds a field to validate; the matcher only passes if all validated fields have errors.
+* **`#with`:** [Array<String>] Adds one or more messages to the previously-defined field validation. Raises ArgumentError if no field was previously set.
+* **`#with_message`:** [String] Adds a message to the previously-defined field validation. Raises ArgumentError if no field was previously set.
+* **`#with_messages`:** [Array<String>] Adds one or more messages to the previously-defined field validation. Raises ArgumentError if no field was previously set.
 
 ### BuiltIn
 
@@ -115,12 +112,11 @@ individual fields to validate, or even specific messages for each attribute.
 
 These extend the built-in RSpec matchers with additional functionality.
 
-#### be\_kind\_of Matcher
+#### `#be_kind_of` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/built_in/be_kind_of'
 
-Now accepts an Array of types. The matcher passes if the actual object is
-any of the parameter types.
+Now accepts an Array of types. The matcher passes if the actual object is any of the parameter types.
 
 Also allows nil parameter as a shortcut for NilClass.
 
@@ -129,19 +125,17 @@ Also allows nil parameter as a shortcut for NilClass.
     expect(instance).to be_kind_of [String, Symbol, nil]
     #=> passes iff instance is a String, a Symbol, or is nil
 
-#### include Matcher
+#### `#include` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/built_in/include'
 
-Now accepts Proc parameters; items in the actual object are passed into
-proc#call, with a truthy response considered a match to the item. In addition,
-now accepts an optional block as a shortcut for adding a proc expectation.
+Now accepts Proc parameters; items in the actual object are passed into proc#call, with a truthy response considered a match to the item. In addition, now accepts an optional block as a shortcut for adding a proc expectation.
 
 **How To Use:**
 
     expect(instance).to include { |item| item =~ /pattern/ }
 
-#### respond\_to Matcher
+#### `#respond_to` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/built_in/respond_to'
 
@@ -149,25 +143,27 @@ Now has additional chaining functionality to validate the number of arguments ac
 
 **How To Use:**
 
-    # With a variable number of arguments.
-    expect(instance).to respond_to(:foo).with(2..3).arguments.with_a_block
+    # With a block.
+    expect(instance).to respond_to(:foo).with_a_block.
+
+    # With a variable number of arguments and a block.
+    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)
 
 **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\_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`:** 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_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.
 
 ### Core
 
     require 'rspec/sleeping_king_studios/matchers/core/all'
 
-These matchers check core functionality, such as object boolean-ness, the
-existence of properties, and so on.
+These matchers check core functionality, such as object boolean-ness, the existence of properties, and so on.
 
-#### be_boolean Matcher
+#### `#be_boolean` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/be_boolean'
 
@@ -179,46 +175,31 @@ Checks if the provided object is true or false.
 
 **Parameters:** None.
 
-#### construct Matcher
+#### `#construct` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/construct'
 
-Verifies that the actual object can be constructed using :new. Can take an
-optional number of arguments.
+Verifies that the actual object can be constructed using `::new`. Can take an optional number of arguments.
 
 **How To Use:**
 
+    # With an expected number of arguments.
     expect(described_class).to construct.with(1).arguments
 
-**Parameters:** None.
-
-**Chaining:**
-
-* **with:** Expects one Integer or Range argument. If an Integer, verifies that
-  the class's constructor accepts that number of arguments; if a Range,
-  verifies that the constructor accepts both the minimum and maximum number of
-  arguments.
-
-##### Ruby 2.0+
+    # With an expected number of arguments and set of keywords.
+    expect(instance).to construct.with(0, :bar, :baz)
 
-Has additional functionality to support Ruby 2.0 keyword arguments.
-
-**How To Use:**
-  expect(instance).to construct.with(0, :bar, :baz)
+**Parameters:** None.
 
 **Chaining:**
 
-* **with:** Expects one Integer, Range, or nil argument, and zero or more
-  Symbol arguments corresponding to optional keywords. Verifies that the
-  class's constructor 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 one Integer, Range, or nil argument, and zero or more Symbol arguments corresponding to optional keywords. Verifies that the class's constructor accepts that keyword, or has a variadic keyword of the form `**params`.  As of Ruby 2.1 and required keywords, verifies that all required keywords are provided.
 
-#### have\_property Matcher
+#### `#have_property` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/have_property'
 
-Checks if the actual object responds to :property and :property=, and optionally if the curernt value of actual.property is equal to a specified value.
+Checks if the actual object responds to `#property` and `#property=`, and optionally if the current value of `actual.property()` is equal to a specified value.
 
 **How To Use:**
 
@@ -228,18 +209,15 @@ Checks if the actual object responds to :property and :property=, and optionally
 
 **Chaining:**
 
-* **with:** Expects one object, which is checked against the current value of actual.property if actual responds to :property. Can also be used with an RSpec matcher:
+* **`#with`:** (also `#with_value`) Expects one object, which is checked against the current value of `actual.property()` if actual responds to `#property`. Can also be used with an RSpec matcher:
 
     expect(instance).to have_property(:bar).with(an_instance_of(String))
 
-* **with_value:** Alias for `#with`, above.
-
-#### have\_reader Matcher
+#### `#have_reader` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/have_reader'
 
-Checks if the actual object responds to :property, and optionally if the
-current value of actual.property is equal to a specified value.
+Checks if the actual object responds to `#property`, and optionally if the current value of `actual.property()` is equal to a specified value.
 
 **How To Use:**
 
@@ -249,38 +227,21 @@ current value of actual.property is equal to a specified value.
 
 **Chaining:**
 
-* **with:** Expects one object, which is checked against the current value of actual.property if actual responds to :property. Can also be used with an RSpec matcher:
+* **`#with`:** (also `#with_value`) Expects one object, which is checked against the current value of `actual.property()` if actual responds to `#property`. Can also be used with an RSpec matcher:
 
     expect(instance).to have_reader(:bar).with(an_instance_of(String))
 
-* **with_value:** Alias for `#with`, above.
-
-#### have\_writer Matcher
+#### `#have_writer` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/have_writer'
 
-Checks if the actual object responds to :property=.
+Checks if the actual object responds to `#property=`.
 
 **How To Use:**
 
     expect(instance).to have_writer(:foo=)
 
-**Parameters:** Property. Expects a string or symbol that is a valid
-identifier. An equals sign '=' is automatically added if the identifier does
-not already terminate in '='.
-
-#### include\_matching Matcher
-
-    require 'rspec/sleeping_king_studios/matchers/core/include_matching'
-
-Loops through an enumerable actual object and checks if any of the items
-matches the given pattern.
-
-**How To Use:**
-
-    expect(instance).to include_matching(/[01]+/)
-
-**Parameters:** Pattern. Expects a Regexp.
+**Parameters:** Property. Expects a string or symbol that is a valid identifier. An equals sign '=' is automatically added if the identifier does not already terminate in '='.
 
 ## Shared Examples
 
@@ -306,7 +267,7 @@ These examples are shorthand for defining a reader and/or writer expectation.
 
     include_examples 'has property', :foo, 42
 
-Delegates to the `#has_reader` and `#has_writer` matchers (see Core/Has Reader and Core/Has Writer, above) and passes if the actual object responds to the specified property and property writer methods. If a value is specified, the object must respond to the property and return the specified value. Alternatively, you can set a proc as the expected value, which can contain a comparison, an RSpec expectation, or a more complex expression:
+Delegates to the `#has_reader` and `#has_writer` matchers (see Core/#has\_reader and Core/#has\_writer, above) and passes if the actual object responds to the specified property and property writer methods. If a value is specified, the object must respond to the property and return the specified value. Alternatively, you can set a proc as the expected value, which can contain a comparison, an RSpec expectation, or a more complex expression:
 
     include_examples 'has property', :bar, ->() { an_instance_of(String) }
 
@@ -316,7 +277,7 @@ Delegates to the `#has_reader` and `#has_writer` matchers (see Core/Has Reader a
 
     include_examples 'has reader', :foo, 42
 
-Delegates to the `#has_reader` matcher (see Core/Has Reader, above) and passes if the actual object responds to the specified property. If a value is specified, the object must respond to the property and return the specified value. Alternatively, you can set a proc as the expected value, which can contain a comparison, an RSpec expectation, or a more complex expression:
+Delegates to the `#has_reader` matcher (see Core/#has_reader, above) and passes if the actual object responds to the specified property. If a value is specified, the object must respond to the property and return the specified value. Alternatively, you can set a proc as the expected value, which can contain a comparison, an RSpec expectation, or a more complex expression:
 
     include_examples 'has reader', :bar, ->() { an_instance_of(String) }
 
@@ -326,7 +287,7 @@ Delegates to the `#has_reader` matcher (see Core/Has Reader, above) and passes i
 
     include_examples 'has writer', :foo=
 
-Delegates to the `#has_writer` matcher (see Core/Has Writer, above) and passes if the actual object responds to the specified property writer.
+Delegates to the `#has_writer` matcher (see Core/#has_writer, above) and passes if the actual object responds to the specified property writer.
 
 ### RSpec Matcher Examples
 

data/lib/rspec/sleeping_king_studios/all.rb

@@ -1,4 +1,5 @@
 # lib/rspec/sleeping_king_studios/all.rb
 
+require 'rspec/sleeping_king_studios/concerns/all'
 require 'rspec/sleeping_king_studios/examples/all'
 require 'rspec/sleeping_king_studios/matchers/all'

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

@@ -0,0 +1,5 @@
+# lib/rspec/sleeping_king_studios/concerns/all.rb
+
+Dir[File.join File.dirname(__FILE__), '*.rb'].each do |file|
+  require file
+end # end each

data/lib/rspec/sleeping_king_studios/{examples → concerns}/shared_example_group.rb

@@ -1,8 +1,25 @@
-# lib/rspec/sleeping_king_studios/examples/shared_example_group.rb
+# lib/rspec/sleeping_king_studios/concerns/shared_example_group.rb
 
-require 'rspec/sleeping_king_studios/examples'
+require 'rspec/sleeping_king_studios/concerns'
 
-module RSpec::SleepingKingStudios::Examples
+module RSpec::SleepingKingStudios::Concerns
+  # Methods for creating reusable shared example groups and shared contexts in
+  # a module that can be mixed into multiple RSpec example groups.
+  #
+  # @example
+  #   module MySharedExamples
+  #     extend Rspec::SleepingKingStudios::Concerns::SharedExampleGroup
+  #
+  #     shared_examples 'my examples' do
+  #       # Define shared examples here.
+  #     end # shared_examples
+  #   end # module
+  #
+  #   RSpec.describe MyObject do
+  #     include MySharedExamples
+  #
+  #     include_examples 'my examples'
+  #   end # describe
   module SharedExampleGroup
     # 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
@@ -14,13 +31,21 @@ module RSpec::SleepingKingStudios::Examples
     #   as.
     # @param [String] old_name The name under which the shared example group is
     #   currently defined.
+    #
+    # @raise ArgumentError If the referenced shared example group does not
+    #   exist.
     def alias_shared_examples new_name, old_name
       proc = shared_example_groups[self][old_name]
 
+      raise ArgumentError.new(%{Could not find shared examples "#{old_name}"}) if proc.nil?
+
       self.shared_examples new_name, &proc
     end # method alias_shared_examples
+    alias_method :alias_shared_context, :alias_shared_examples
 
     # @api private
+    #
+    # Hook to merge defined example groups when included in another module.
     def included other
       merge_shared_example_groups other
     end # method included
@@ -44,6 +69,7 @@ module RSpec::SleepingKingStudios::Examples
     def shared_examples name, *metadata_args, &block
       RSpec.world.shared_example_group_registry.add(self, name, *metadata_args, &block)
     end # method shared_examples
+    alias_method :shared_context, :shared_examples
 
     private
 

data/lib/rspec/sleeping_king_studios/concerns.rb

@@ -0,0 +1,8 @@
+# lib/rspec/sleeping_king_studios/concerns.rb
+
+require 'rspec/sleeping_king_studios'
+
+module RSpec::SleepingKingStudios
+  # RSpec-related concerns to mix into classes or objects.
+  module Concerns; end
+end # module

data/lib/rspec/sleeping_king_studios/configuration.rb

@@ -3,14 +3,29 @@
 require 'rspec/sleeping_king_studios'
 
 module RSpec::SleepingKingStudios
+  # Configuration options for RSpec::SleepingKingStudios.
   class Configuration
+    # Configuration options for RSpec::SleepingKingStudios::Examples.
     class Examples
+      # Permitted options for :handle_missing_failure_message_with.
       MISSING_FAILURE_MESSAGE_HANDLERS = %w(ignore pending exception).map(&:intern)
 
+      # Gets the handler for missing failure messages when using the matcher
+      # examples, and sets to :pending if unset.
+      #
+      # @return [Symbol] The current missing message handler.
       def handle_missing_failure_message_with
         @handle_missing_failure_message_with ||= :pending
       end # method missing_failure_message
 
+      # Sets the handler for missing failure messages when using the matcher
+      # examples.
+      #
+      # @param [Symbol] value The desired handler. Must be :ignore, :pending,
+      #   or :exception.
+      #
+      # @raise ArgumentError If the handler is not one of the recognized
+      #   values.
       def handle_missing_failure_message_with= value
         unless MISSING_FAILURE_MESSAGE_HANDLERS.include?(value)
           message = "unrecognized handler value -- must be in #{MISSING_FAILURE_MESSAGE_HANDLERS.join ', '}"
@@ -20,7 +35,9 @@ module RSpec::SleepingKingStudios
         @handle_missing_failure_message_with = value
       end # message missing_failure_message=
     end # class
-    
+
+    # Get or set the configuration options for
+    # RSpec::SleepingKingStudios::Examples.
     def examples &block
       (@examples ||= RSpec::SleepingKingStudios::Configuration::Examples.new).tap do |config|
         if block_given?
@@ -32,6 +49,7 @@ module RSpec::SleepingKingStudios
 end # module
 
 class RSpec::Core::Configuration
+  # Get or set the configuration options for RSpec::SleepingKingStudios.
   def sleeping_king_studios &block
     (@sleeping_king_studios ||= RSpec::SleepingKingStudios::Configuration.new).tap do |config|
       if block_given?

data/lib/rspec/sleeping_king_studios/examples/property_examples.rb

@@ -1,14 +1,20 @@
 # lib/rspec/sleeping_king_studios/examples/property_examples.rb
 
+require 'rspec/sleeping_king_studios/concerns/shared_example_group'
 require 'rspec/sleeping_king_studios/examples'
-require 'rspec/sleeping_king_studios/examples/shared_example_group'
 require 'rspec/sleeping_king_studios/matchers/core/have_reader'
 require 'rspec/sleeping_king_studios/matchers/core/have_writer'
 require 'sleeping_king_studios/tools/object_tools'
 
+# Pregenerated example groups for testing the presence and value of reader and
+# writer methods.
 module RSpec::SleepingKingStudios::Examples::PropertyExamples
-  extend RSpec::SleepingKingStudios::Examples::SharedExampleGroup
+  extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
+  # @api private
+  #
+  # Internal object used to differentiate a nil expectation from a default
+  # value expectation.
   UNDEFINED_PROPERTY_EXPECTATION = Object.new.freeze
 
   shared_examples 'has reader' do |property, expected_value = UNDEFINED_PROPERTY_EXPECTATION|

data/lib/rspec/sleeping_king_studios/examples/rspec_matcher_examples.rb

@@ -1,11 +1,12 @@
 # lib/rspec/sleeping_king_studios/examples/rspec_matcher_examples.rb
 
+require 'rspec/sleeping_king_studios/concerns/shared_example_group'
 require 'rspec/sleeping_king_studios/examples'
-require 'rspec/sleeping_king_studios/examples/shared_example_group'
 require 'rspec/sleeping_king_studios/matchers/base_matcher'
 
+# Pregenerated example groups for testing RSpec matchers.
 module RSpec::SleepingKingStudios::Examples::RSpecMatcherExamples
-  extend RSpec::SleepingKingStudios::Examples::SharedExampleGroup
+  extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
   shared_examples 'passes with a positive expectation' do
     let(:matcher_being_examined) { defined?(instance) ? instance : subject }

data/lib/rspec/sleeping_king_studios/matchers/active_model/have_errors/error_expectation.rb

@@ -2,41 +2,42 @@
 
 require 'rspec/sleeping_king_studios/matchers/active_model/have_errors/message_expectation'
 
+# Helper objects for the ActiveModel::HaveErrorsMatcher.
 module RSpec::SleepingKingStudios::Matchers::ActiveModel::HaveErrors
   # Stores an expectation of receiving an error for a specified attribute, as
   # well as zero or more message expectations.
-  # 
+  #
   # @since 1.0.0
   #
   # @see MessageExpectation
   class ErrorExpectation < Struct.new :attribute, :expected, :received
     # Extra instance methods for the :messages array.
-    # 
-    # @private
+    #
+    # @api private
     module MessagesMethods
-      # @return [Array<MessageExpectation>] messages that are expected
+      # @return [Array<MessageExpectation>] Messages that are expected.
       def expected
         select { |message| message.expected }
       end # method expected
 
-      # @return [Array<MessageExpectation>] messages that are expected but have
-      #   not been received
+      # @return [Array<MessageExpectation>] Messages that are expected but have
+      #   not been received.
       def missing
         select { |message| message.expected && !message.received }
       end # method missing
 
-      # @return [Array<MessageExpectation>] messages that have been received
+      # @return [Array<MessageExpectation>] Messages that have been received.
       def received
         select { |message| message.received }
       end # method received
     end # module
 
-    # @param [String, Symbol] attribute the attribute for which an error is
-    #   expected to be or has been received
-    # @param [Boolean] expected whether an error is expected for the specified
-    #   attribute
-    # @param [Boolean] received whether an error has been received for the
-    #   specified attribute
+    # @param [String, Symbol] attribute The attribute for which an error is
+    #   expected to be or has been received.
+    # @param [Boolean] expected Whether an error is expected for the specified
+    #   attribute.
+    # @param [Boolean] received Whether an error has been received for the
+    #   specified attribute.
     def initialize attribute, expected = true, received = false
       super attribute.intern, expected, received
 
@@ -48,9 +49,9 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel::HaveErrors
 
     # The message expectations for the specified attribute. The returned array
     # supports several additional methods: #expected, #missing, and #received.
-    # 
+    #
     # @return [Array<MessageExpectation>]
-    # 
+    #
     # @see MessagesMethods#expected
     # @see MessagesMethods#missing
     # @see MessagesMethods#received

data/lib/rspec/sleeping_king_studios/matchers/active_model/have_errors/message_expectation.rb

@@ -5,10 +5,10 @@ require 'rspec/sleeping_king_studios/matchers/active_model'
 module RSpec::SleepingKingStudios::Matchers::ActiveModel::HaveErrors
   # Stores an expectation of receiving a specified error message.
   class MessageExpectation < Struct.new :message, :expected, :received
-    # @param [String] message the message which is expected to be or has been
-    #   received
-    # @param [Boolean] expected whether the message is expected
-    # @param [Boolean] received whether the message has been received
+    # @param [String] message The message which is expected to be or has been
+    #   received.
+    # @param [Boolean] expected Whether the message is expected.
+    # @param [Boolean] received Whether the message has been received.
     def initialize message, expected = true, received = false
       super message, expected, received
     end # constructor

data/lib/rspec/sleeping_king_studios/matchers/active_model/have_errors.rb

@@ -18,14 +18,12 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel
     def initialize
       super
 
-      # The error and message expectations set up through #on and
+      # The error and message expectations are set up through #on and
       # #with_message.
       @error_expectations = []
     end # constructor
 
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       message = 'have errors'
 
@@ -51,11 +49,11 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel
     # checks the errors on the object against the expected errors and messages
     # from #on and #with_message, if any.
     #
-    # @param [Object] actual the object to test against the matcher
+    # @param [Object] actual The object to test against the matcher.
     #
-    # @return [Boolean] true if the object responds to :valid? and is valid
+    # @return [Boolean] True if the object responds to :valid? and is valid
     #   or object.errors does not match the specified errors and messages (if
-    #   any); otherwise false
+    #   any); otherwise false.
     #
     # @see #matches?
     def does_not_match? actual
@@ -70,11 +68,12 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel
     # checks the errors on the object against the expected errors and messages
     # from #on and #with_message, if any.
     #
-    # @param [Object] actual the object to test against the matcher
+    # @param [Object] actual The object to test against the matcher.
     #
-    # @return [Boolean] true if the object responds to :valid?, is not valid,
+    # @return [Boolean] True if the object responds to :valid?, is not valid,
     #   and object.errors matches the specified errors and messages (if any);
-    #   otherwise false
+    #   otherwise false.
+    #
     # @see RSpec::SleepingKingStudios::Matchers::BaseMatcher#matches?
     def matches? actual
       super
@@ -103,11 +102,11 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel
     # If the actual object does not have an error on the that attribute with
     # the specified message, #matches? will return false.
     #
-    # @param [String, Regexp] message the expected error message. If a string,
+    # @param [String, Regexp] message The expected error message. If a string,
     #   matcher will check for an exact match; if a regular expression, matcher
-    #   will check if the message matches the regexp
+    #   will check if the message matches the regexp.
     #
-    # @raise [ArgumentError] if no error attribute has been added
+    # @raise [ArgumentError] If no error attribute has been added.
     #
     # @return [HaveErrorsMatcher] self
     #
@@ -137,7 +136,7 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel
     end # method with_message
     alias_method :with, :with_messages
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       # Failure cases:
       # * object is not a model ("to respond to valid")
@@ -154,7 +153,7 @@ module RSpec::SleepingKingStudios::Matchers::ActiveModel
       end # if-elsif-else
     end # method failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       # Failure cases:
       # * object is not a model ("to respond to valid")

data/lib/rspec/sleeping_king_studios/matchers/base_matcher.rb

@@ -4,16 +4,15 @@ require 'rspec/sleeping_king_studios/matchers'
 
 module RSpec::SleepingKingStudios::Matchers
   # Minimal implementation of the RSpec matcher interface.
-  # 
+  #
   # @since 1.0.0
   class BaseMatcher
     include RSpec::Matchers::Pretty
 
     attr_reader :actual
 
-    # A short string that describes the purpose of the matcher. Borrowed from
-    # RSpec::Matchers::BuiltIn::BaseMatcher.
-    # 
+    # A short string that describes the purpose of the matcher.
+    #
     # @return [String] the matcher description
     def description
       return name_to_sentence unless defined?(@expected)
@@ -23,9 +22,9 @@ module RSpec::SleepingKingStudios::Matchers
     # Inverse of #matches? method.
     #
     # @param [Object] actual the object to test against the matcher
-    # 
+    #
     # @return [Boolean] false if the object matches, otherwise true
-    # 
+    #
     # @see #matches?
     def does_not_match? actual
       !matches?(actual)
@@ -35,7 +34,7 @@ module RSpec::SleepingKingStudios::Matchers
     # Invoked by RSpec expectations.
     #
     # @param [Object] actual the object to test against the matcher
-    # 
+    #
     # @return [Boolean] true if the object matches, otherwise false
     def matches? actual
       @actual = actual

data/lib/rspec/sleeping_king_studios/matchers/built_in/be_kind_of.rb

@@ -4,12 +4,11 @@ require 'rspec/sleeping_king_studios/matchers/built_in'
 require 'sleeping_king_studios/tools/enumerable_tools'
 
 module RSpec::SleepingKingStudios::Matchers::BuiltIn
+  # Extensions to the built-in RSpec #be_kind_of matcher.
   class BeAKindOfMatcher < RSpec::Matchers::BuiltIn::BeAKindOf
     include SleepingKingStudios::Tools::EnumerableTools
 
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       message = "be #{type_string}"
     end # method description
@@ -18,22 +17,22 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     # expected value of nil as a shortcut for expecting an instance of
     # NilClass.
     #
-    # @param [Module, nil, Array<Module, nil>] expected the type or types to
-    #   check the object against
-    # @param [Object] actual the object to check
+    # @param [Module, nil, Array<Module, nil>] expected The type or types to
+    #   check the object against.
+    # @param [Object] actual The object to check.
     #
-    # @return [Boolean] true if the object matches one of the specified types,
-    #   otherwise false
+    # @return [Boolean] True if the object matches one of the specified types,
+    #   otherwise false.
     def match expected, actual
       match_type? expected
     end # method match
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       "expected #{@actual.inspect} to be #{type_string}"
     end # method failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       "expected #{@actual.inspect} not to be #{type_string}"
     end # method failure_message_when_negated

data/lib/rspec/sleeping_king_studios/matchers/built_in/include.rb

@@ -3,22 +3,25 @@
 require 'rspec/sleeping_king_studios/matchers/built_in'
 
 module RSpec::SleepingKingStudios::Matchers::BuiltIn
+  # Extensions to the built-in RSpec #include matcher.
   class IncludeMatcher < RSpec::Matchers::BuiltIn::Include
     # @param [Array<Hash, Proc, Object>] expected the items expected to be
     #   matched by the actual object
     #
-    # @yield if a block is provided, the block is converted to a proc and
-    #   appended to the item expectations
-    # @yieldparam [Object] item an item from the actual object; yield(item)
+    # @yield If a block is provided, the block is converted to a proc and
+    #   appended to the item expectations.
+    # @yieldparam [Object] item An item from the actual object; yield(item)
     #   should return true if and only if the item matches the desired
-    #    predicate
+    #   predicate.
     def initialize *expected, &block
       expected << block if block_given?
 
       super *expected
     end # constructor
 
-    # @private
+    # @api private
+    #
+    # Converts the expected item to a human-readable string.
     def to_word expected_item
       case
       when is_matcher_with_description?(expected_item)
@@ -30,7 +33,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       end # case
     end # method to_word
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       message = super
 
@@ -39,7 +42,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       message
     end # method failure_message_for_should
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       message = super
 

data/lib/rspec/sleeping_king_studios/matchers/built_in/respond_to.rb

@@ -7,6 +7,7 @@ require 'sleeping_king_studios/tools/enumerable_tools'
 require 'sleeping_king_studios/tools/string_tools'
 
 module RSpec::SleepingKingStudios::Matchers::BuiltIn
+  # Extensions to the built-in RSpec #respond_to matcher.
   class RespondToMatcher < RSpec::Matchers::BuiltIn::RespondTo
     include RSpec::SleepingKingStudios::Matchers::Shared::MatchParameters
     include SleepingKingStudios::Tools::EnumerableTools
@@ -18,14 +19,15 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       super(*expected)
     end # constructor
 
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       expected_message = format_expected_arguments
       "respond to #{pp_names}#{expected_message.empty? ? '' : " with #{expected_message}"}"
     end # method description
 
+    # Adds a parameter count expectation and/or one or more keyword
+    # expectations.
+    #
     # @overload with count
     #   Adds a parameter count expectation.
     #
@@ -34,7 +36,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     #
     #   @return [RespondToMatcher] self
     # @overload with *keywords
-    #   Adds one or more keyword expectations (Ruby 2.0 only).
+    #   Adds one or more keyword expectations.
     #
     #   @param [Array<String, Symbol>] keywords List of keyword arguments
     #     accepted by the method.
@@ -42,7 +44,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     #   @return [RespondToMatcher] self
     # @overload with count, *keywords
     #   Adds a parameter count expectation and one or more keyword
-    #   expectations (Ruby 2.0 only).
+    #   expectations.
     #
     #   @param [Integer, Range, nil] count (optional) The number of expected
     #     parameters.
@@ -65,8 +67,9 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       @expected_block = true
       self
     end # method with_a_block
+    alias_method :and_a_block, :with_a_block
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       @failing_method_names ||= []
       methods, messages = @failing_method_names, []
@@ -82,7 +85,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       messages.join "\n"
     end # method failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       @failing_method_names ||= []
       methods, messages = @failing_method_names, []

data/lib/rspec/sleeping_king_studios/matchers/built_in.rb

@@ -3,5 +3,6 @@
 require 'rspec/sleeping_king_studios/matchers'
 
 module RSpec::SleepingKingStudios::Matchers
+  # Extensions to the built-in RSpec matchers.
   module BuiltIn; end
 end # module

data/lib/rspec/sleeping_king_studios/matchers/core/be_boolean.rb

@@ -8,30 +8,28 @@ module RSpec::SleepingKingStudios::Matchers::Core
   #
   # @since 1.0.0
   class BeBooleanMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       'be true or false'
     end # method description
 
     # Checks if the object is true or false.
     #
-    # @param [Object] actual the object to check
+    # @param [Object] actual The object to check.
     #
-    # @return [Boolean] true if the object is true or false, otherwise false
+    # @return [Boolean] True if the object is true or false, otherwise false.
     def matches? actual
       super
 
       true === actual || false === actual
     end # method matches?
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       "expected #{@actual.inspect} to be true or false"
     end # method failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       "expected #{@actual.inspect} not to be true or false"
     end # method failure_message_when_negated

data/lib/rspec/sleeping_king_studios/matchers/core/construct.rb

@@ -16,9 +16,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
     include SleepingKingStudios::Tools::EnumerableTools
     include SleepingKingStudios::Tools::StringTools
 
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       expected_message = format_expected_arguments
       "construct#{expected_message.empty? ? '' : " with #{expected_message}"}"
@@ -28,10 +26,10 @@ module RSpec::SleepingKingStudios::Matchers::Core
     # checks the parameters expected by #initialize against the expected
     # parameters, if any.
     #
-    # @param [Object] actual the object to check
+    # @param [Object] actual The object to check.
     #
-    # @return [Boolean] true if the object responds to :new and accepts the
-    #   specified parameters for #initialize; otherwise false
+    # @return [Boolean] True if the object responds to :new and accepts the
+    #   specified parameters for #initialize; otherwise false.
     def matches? actual
       @actual = actual
       @failing_method_reasons = {}
@@ -40,30 +38,33 @@ module RSpec::SleepingKingStudios::Matchers::Core
         matches_keywords?(actual)
     end # method matches?
 
+    # Adds a parameter count expectation and/or one or more keyword
+    # expectations.
+    #
     # @overload with(count)
-    #   Adds a parameter count expectation and removes any keyword expectations
-    #   (Ruby 2.0+ only).
+    #   Adds a parameter count expectation and removes any keyword
+    #   expectations.
     #
-    #   @param [Integer, Range] count the number of expected parameters
+    #   @param [Integer, Range] count The number of expected parameters.
     #
     #   @return [ConstructMatcher] self
     #
     # @overload with(count, *keywords)
-    #   Adds a parameter count expectation and one or more keyword expectations
-    #   (Ruby 2.0 only).
+    #   Adds a parameter count expectation and one or more keyword
+    #   expectations.
     #
-    #   @param [Integer, Range] count the number of expected parameters
-    #   @param [Array<String, Symbol>] keywords list of keyword arguments
-    #     accepted by the method
+    #   @param [Integer, Range] count The number of expected parameters.
+    #   @param [Array<String, Symbol>] keywords List of keyword arguments
+    #     accepted by the method.
     #
     #   @return [ConstructMatcher] self
     #
     # @overload with(*keywords)
     #   Removes a parameter count expectation (if any) and adds one or more
-    #   keyword expectations (Ruby 2.0 only).
+    #   keyword expectations.
     #
-    #   @param [Array<String, Symbol>] keywords list of keyword arguments
-    #     accepted by the method
+    #   @param [Array<String, Symbol>] keywords List of keyword arguments
+    #     accepted by the method.
     #
     #   @return [ConstructMatcher] self
     def with *keywords
@@ -82,14 +83,14 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method argument
     alias_method :arguments, :argument
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       message = "expected #{@actual.inspect} to construct"
       message << " with arguments:\n#{format_errors}" if @actual.respond_to?(:new)
       message
     end # method failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       message = "expected #{@actual.inspect} not to construct"
       unless (formatted = format_expected_arguments).empty?

data/lib/rspec/sleeping_king_studios/matchers/core/have_property.rb

@@ -6,41 +6,40 @@ require 'rspec/sleeping_king_studios/matchers/shared/match_property'
 
 module RSpec::SleepingKingStudios::Matchers::Core
   # Matcher for testing whether an object has a specific property, e.g.
-  # responds to :property and :property= and :property= updates the value of
-  # :property.
+  # responds to #property and #property= and has the specified value for
+  # #property.
   #
   # @since 1.0.0
   class HavePropertyMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
     include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
 
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       value_message = value_to_string
       "have property :#{@expected}#{@value_set ? " with value #{value_message}" : ''}"
     end # method description
 
-    # @param [String, Symbol] expected the property to check for on the actual
-    #   object
+    # @param [String, Symbol] expected The property to check for on the actual
+    #   object.
     def initialize expected
       @expected = expected.intern
     end # method initialize
 
+    # (see BaseMatcher#does_not_match?)
     def does_not_match? actual
       super
 
       matches_property?(:none?)
     end # method does_not_match?
 
-    # Checks if the object responds to :expected and :expected=. Additionally,
+    # Checks if the object responds to #expected and #expected=. Additionally,
     # if a value expectation is set, compares the result of calling :expected
     # to the value.
     #
-    # @param [Object] actual the object to check
+    # @param [Object] actual The object to check.
     #
-    # @return [Boolean] true if the object responds to :expected and
-    #   :expected= and matches the value expectation (if any); otherwise false
+    # @return [Boolean] true If the object responds to #expected and
+    #   #expected= and matches the value expectation (if any); otherwise false.
     def matches? actual
       super
 
@@ -48,9 +47,9 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method matches?
 
     # Sets a value expectation. The matcher will compare the value to the
-    # result of calling :property.
+    # result of calling #property.
     #
-    # @param [Object] value the value to set and then compare
+    # @param [Object] value The value to set and then compare.
     #
     # @return [HavePropertyMatcher] self
     def with value
@@ -60,7 +59,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method with
     alias_method :with_value, :with
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       methods = []
       methods << ":#{@expected}"  unless @matches_reader
@@ -77,7 +76,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
       message
     end # failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       methods = []
       methods << ":#{@expected}"  if @matches_reader

data/lib/rspec/sleeping_king_studios/matchers/core/have_reader.rb

@@ -12,28 +12,26 @@ module RSpec::SleepingKingStudios::Matchers::Core
   class HaveReaderMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
     include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
 
-    # Generates a description of the matcher expectation.
-    #
-    # @return [String] The matcher description.
+    # (see BaseMatcher#description)
     def description
       value_message = value_to_string
       "have reader :#{@expected}#{@value_set ? " with value #{value_message}" : ''}"
     end # method description
 
-    # @param [String, Symbol] expected the property to check for on the actual
-    #   object
+    # @param [String, Symbol] expected The property to check for on the actual
+    #   object.
     def initialize expected
       @expected = expected.intern
     end # method initialize
 
-    # Checks if the object responds to :expected. Additionally, if a value
-    # expectation is set, compares the value of :expected to the specified
+    # Checks if the object responds to #expected. Additionally, if a value
+    # expectation is set, compares the value of #expected to the specified
     # value.
     #
-    # @param [Object] actual the object to check
+    # @param [Object] actual The object to check.
     #
-    # @return [Boolean] true if the object responds to :expected and matches
-    #    the value expectation (if any); otherwise false
+    # @return [Boolean] true If the object responds to #expected and matches
+    #    the value expectation (if any); otherwise false.
     def matches? actual
       super
 
@@ -41,9 +39,9 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method matches?
 
     # Sets a value expectation. The matcher will compare the value from
-    # :property with the specified value.
+    # #property with the specified value.
     #
-    # @param [Object] value the value to compare
+    # @param [Object] value The value to compare.
     #
     # @return [HaveReaderMatcher] self
     def with value
@@ -53,7 +51,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method with
     alias_method :with_value, :with
 
-    # @see BaseMatcher#failure_message
+    # (see BaseMatcher#failure_message)
     def failure_message
       message = "expected #{@actual} to respond to :#{@expected}"
       message << " and return #{value_to_string}" if @value_set
@@ -67,7 +65,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
       message
     end # method failure_message
 
-    # @see BaseMatcher#failure_message_when_negated
+    # (see BaseMatcher#failure_message_when_negated)
     def failure_message_when_negated
       message = "expected #{@actual} not to respond to :#{@expected}"
       message << " and return #{value_to_string}" if @value_set

data/lib/rspec/sleeping_king_studios/matchers/core.rb

@@ -3,5 +3,6 @@
 require 'rspec/sleeping_king_studios/matchers'
 
 module RSpec::SleepingKingStudios::Matchers
+  # All-purpose matchers for use with objects and built-in types.
   module Core; end
 end # module

data/lib/rspec/sleeping_king_studios/version.rb

@@ -3,13 +3,23 @@
 module RSpec
   module SleepingKingStudios
     # @api private
+    #
+    # The current version of the gem.
+    #
+    # @see http://semver.org/
     module Version
+      # Major version.
       MAJOR = 2
+      # Minor version.
       MINOR = 0
+      # Patch version.
       PATCH = 0
-      PRERELEASE = 'beta'
-      BUILD = 2
+      # Prerelease version.
+      PRERELEASE = 'rc'
+      # Build metatada.
+      BUILD = 0
 
+      # Generates the gem version string from the Version constants.
       def self.to_gem_version
         str = "#{MAJOR}.#{MINOR}.#{PATCH}"
 

data/lib/rspec/sleeping_king_studios.rb

@@ -3,6 +3,7 @@
 require 'rspec/core'
 
 module RSpec
+  # Hic Iacet Arthurus, Rex Quondam, Rexque Futurus.
   module SleepingKingStudios; end
 end # module
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.2
+  version: 2.0.0.rc.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tools
   requirement: !ruby/object:Gem::Requirement
@@ -122,12 +122,14 @@ files:
 - README.md
 - lib/rspec/sleeping_king_studios.rb
 - 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/shared_example_group.rb
 - lib/rspec/sleeping_king_studios/configuration.rb
 - lib/rspec/sleeping_king_studios/examples.rb
 - lib/rspec/sleeping_king_studios/examples/all.rb
 - lib/rspec/sleeping_king_studios/examples/property_examples.rb
 - lib/rspec/sleeping_king_studios/examples/rspec_matcher_examples.rb
-- lib/rspec/sleeping_king_studios/examples/shared_example_group.rb
 - lib/rspec/sleeping_king_studios/matchers.rb
 - lib/rspec/sleeping_king_studios/matchers/active_model.rb
 - lib/rspec/sleeping_king_studios/matchers/active_model/all.rb
@@ -171,8 +173,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A collection of RSpec patches and custom matchers.
 test_files: []
+has_rdoc: