rspec-sleeping_king_studios 2.3.0 → 2.4.0.rc.0

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

@@ -26,7 +26,9 @@ module RSpec::SleepingKingStudios::Examples
           end # if-else
         end # it
       end # shared_examples
+      alias_shared_examples 'defines constant', 'should have constant'
       alias_shared_examples 'has constant', 'should have constant'
+      alias_shared_examples 'should define constant', 'should have constant'
 
       shared_examples 'should have immutable constant' do |constant_name, expected_value = UNDEFINED_VALUE_EXPECTATION|
         it "should have immutable constant :#{constant_name}" do
@@ -45,7 +47,13 @@ module RSpec::SleepingKingStudios::Examples
           end # if-else
         end # it
       end # shared_examples
+      alias_shared_examples 'defines frozen constant', 'should have immutable constant'
+      alias_shared_examples 'defines immutable constant', 'should have immutable constant'
+      alias_shared_examples 'has frozen constant', 'should have immutable constant'
       alias_shared_examples 'has immutable constant', 'should have immutable constant'
+      alias_shared_examples 'should define frozen constant', 'should have immutable constant'
+      alias_shared_examples 'should define immutable constant', 'should have immutable constant'
+      alias_shared_examples 'should have frozen constant', 'should have immutable constant'
     end # module
   end # module
 end # module

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

@@ -9,20 +9,24 @@ module RSpec::SleepingKingStudios::Examples
     module Predicates
       extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
-      shared_examples 'should have predicate' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION|
-        it "should have predicate :#{property}?" do
+      shared_examples 'should have predicate' do |property_name, expected_value = UNDEFINED_VALUE_EXPECTATION|
+        property_name = property_name.to_s.sub(/\?\z/, '')
+
+        it "should have predicate :#{property_name}?" do
           object = defined?(instance) ? instance : subject
 
           if expected_value == UNDEFINED_VALUE_EXPECTATION
-            expect(object).to have_predicate(property)
+            expect(object).to have_predicate(property_name)
           else
             expected_value = format_expected_value(expected_value)
 
-            expect(object).to have_predicate(property).with_value(expected_value)
+            expect(object).to have_predicate(property_name).with_value(expected_value)
           end # if-else
         end # it
       end # shared_examples
+      alias_shared_examples 'defines predicate', 'should have predicate'
       alias_shared_examples 'has predicate', 'should have predicate'
+      alias_shared_examples 'should define predicate', 'should have predicate'
     end # module
   end # module
 end # module

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

@@ -8,23 +8,47 @@ module RSpec::SleepingKingStudios::Examples
     module PrivateProperties
       extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
+      shared_examples 'should have private property' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION|
+        writer_name = :"#{property.to_s.sub(/=\z/, '')}="
+
+        it "should have private property :#{property}" do
+          object  = defined?(instance) ? instance : subject
+          matcher = have_property(property, :allow_private => true)
+
+          expect(object).not_to respond_to(property)
+          expect(object).not_to respond_to(writer_name)
+
+          if expected_value == UNDEFINED_VALUE_EXPECTATION
+            expect(object).to have_property(property, allow_private: true)
+          else
+            expected_value = format_expected_value(expected_value)
+
+            expect(object).to have_property(property, allow_private: true).with_value(expected_value)
+          end # if-else
+        end # it
+      end # shared_examples
+      alias_shared_examples 'defines private property', 'should have private property'
+      alias_shared_examples 'has private property', 'should have private property'
+      alias_shared_examples 'should define private property', 'should have private property'
+
       shared_examples 'should have private reader' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION|
         it "should have private reader :#{property}" do
           object  = defined?(instance) ? instance : subject
-          matcher = have_reader(property, :allow_private => true)
 
           expect(object).not_to respond_to(property)
 
           if expected_value == UNDEFINED_VALUE_EXPECTATION
-            expect(object).to matcher
+            expect(object).to have_reader(property, allow_private: true)
           else
             expected_value = format_expected_value(expected_value)
 
-            expect(object).to matcher.with_value(expected_value)
+            expect(object).to have_reader(property, allow_private: true).with_value(expected_value)
           end # if-else
         end # it
       end # shared_examples
+      alias_shared_examples 'defines private reader', 'should have private reader'
       alias_shared_examples 'has private reader', 'should have private reader'
+      alias_shared_examples 'should define private reader', 'should have private reader'
 
       shared_examples 'should have private writer' do |property|
         writer_name = :"#{property.to_s.sub(/=\z/, '')}="
@@ -37,28 +61,9 @@ module RSpec::SleepingKingStudios::Examples
           expect(object).to have_writer(writer_name, :allow_private => true)
         end # it
       end # shared_examples
+      alias_shared_examples 'defines private writer', 'should have private writer'
       alias_shared_examples 'has private writer', 'should have private writer'
-
-      shared_examples 'should have private property' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION|
-        writer_name = :"#{property.to_s.sub(/=\z/, '')}="
-
-        it "should have private property :#{property}" do
-          object  = defined?(instance) ? instance : subject
-          matcher = have_property(property, :allow_private => true)
-
-          expect(object).not_to respond_to(property)
-          expect(object).not_to respond_to(writer_name)
-
-          if expected_value == UNDEFINED_VALUE_EXPECTATION
-            expect(object).to matcher
-          else
-            expected_value = format_expected_value(expected_value)
-
-            expect(object).to matcher.with_value(expected_value)
-          end # if-else
-        end # it
-      end # shared_examples
-      alias_shared_examples 'has private property', 'should have private property'
+      alias_shared_examples 'should define private writer', 'should have private writer'
     end # module
   end # module
 end # module

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

@@ -11,30 +11,56 @@ module RSpec::SleepingKingStudios::Examples
     module Properties
       extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
-      shared_examples 'should have reader' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION, allow_private: false|
-        it "should have reader :#{property}" do
+      shared_examples 'should have property' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION, allow_private: false|
+        it "should have property :#{property}" do
           object  = defined?(instance) ? instance : subject
-          matcher = have_reader(property, :allow_private => allow_private)
+          matcher = have_property(property, :allow_private => allow_private)
 
           if expected_value == UNDEFINED_VALUE_EXPECTATION
-            expect(object).to matcher
+            if allow_private
+              expect(object).to have_property(property, allow_private: true)
+            else
+              expect(object).to have_property(property)
+            end
           else
             expected_value = format_expected_value(expected_value)
 
-            expect(object).to matcher.with_value(expected_value)
+            if allow_private
+              expect(object).to have_property(property, allow_private: true).with_value(expected_value)
+            else
+              expect(object).to have_property(property).with_value(expected_value)
+            end
           end # if-else
         end # it
       end # shared_examples
-      alias_shared_examples 'has reader', 'should have reader'
+      alias_shared_examples 'defines property', 'should have property'
+      alias_shared_examples 'has property', 'should have property'
+      alias_shared_examples 'should define property', 'should have property'
 
-      shared_examples 'should not have reader' do |property, allow_private: false|
-        it "should not have reader :#{property}" do
-          object = defined?(instance) ? instance : subject
+      shared_examples 'should have reader' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION, allow_private: false|
+        it "should have reader :#{property}" do
+          object  = defined?(instance) ? instance : subject
 
-          expect(object).not_to have_reader(property, :allow_private => allow_private)
+          if expected_value == UNDEFINED_VALUE_EXPECTATION
+            if allow_private
+              expect(object).to have_reader(property, allow_private: true)
+            else
+              expect(object).to have_reader(property)
+            end
+          else
+            expected_value = format_expected_value(expected_value)
+
+            if allow_private
+              expect(object).to have_reader(property, allow_private: true).with_value(expected_value)
+            else
+              expect(object).to have_reader(property).with_value(expected_value)
+            end
+          end # if-else
         end # it
       end # shared_examples
-      alias_shared_examples 'does not have reader', 'should not have reader'
+      alias_shared_examples 'defines reader', 'should have reader'
+      alias_shared_examples 'has reader', 'should have reader'
+      alias_shared_examples 'should define reader', 'should have reader'
 
       shared_examples 'should have writer' do |property, allow_private: false|
         writer_name = property.to_s.sub /\=\z/, ''
@@ -45,7 +71,20 @@ module RSpec::SleepingKingStudios::Examples
           expect(object).to have_writer(property, :allow_private => allow_private)
         end # it
       end # shared_examples
+      alias_shared_examples 'defines writer', 'should have writer'
       alias_shared_examples 'has writer', 'should have writer'
+      alias_shared_examples 'should define writer', 'should have writer'
+
+      shared_examples 'should not have reader' do |property, allow_private: false|
+        it "should not have reader :#{property}" do
+          object = defined?(instance) ? instance : subject
+
+          expect(object).not_to have_reader(property, :allow_private => allow_private)
+        end # it
+      end # shared_examples
+      alias_shared_examples 'does not define reader', 'should not have reader'
+      alias_shared_examples 'does not have reader', 'should not have reader'
+      alias_shared_examples 'should not define reader', 'should not have reader'
 
       shared_examples 'should not have writer' do |property, allow_private: false|
         writer_name = property.to_s.sub /\=\z/, ''
@@ -56,23 +95,9 @@ module RSpec::SleepingKingStudios::Examples
           expect(object).not_to have_writer(property, :allow_private => allow_private)
         end # it
       end # shared_examples
+      alias_shared_examples 'does not define writer', 'should not have writer'
       alias_shared_examples 'does not have writer', 'should not have writer'
-
-      shared_examples 'should have property' do |property, expected_value = UNDEFINED_VALUE_EXPECTATION, allow_private: false|
-        it "should have property :#{property}" do
-          object  = defined?(instance) ? instance : subject
-          matcher = have_property(property, :allow_private => allow_private)
-
-          if expected_value == UNDEFINED_VALUE_EXPECTATION
-            expect(object).to matcher
-          else
-            expected_value = format_expected_value(expected_value)
-
-            expect(object).to matcher.with_value(expected_value)
-          end # if-else
-        end # it
-      end # shared_examples
-      alias_shared_examples 'has property', 'should have property'
+      alias_shared_examples 'should not define writer', 'should not have writer'
     end # module
   end # module
 end # module

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

@@ -0,0 +1,16 @@
+require 'rspec/sleeping_king_studios/matchers/core/have_changed_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
+require 'rspec/sleeping_king_studios/support/value_spy'
+
+module RSpec::SleepingKingStudios::Matchers::Macros
+  # @see RSpec::SleepingKingStudios::Matchers::Core::HaveChangedMatcher#matches?
+  def have_changed
+    RSpec::SleepingKingStudios::Matchers::Core::HaveChangedMatcher.new
+  end
+
+  # @see RSpec::SleepingKingStudios::Support::ValueSpy#initialize
+  def watch_value(object = nil, method_name = nil, &block)
+    RSpec::SleepingKingStudios::Support::ValueSpy
+      .new(object, method_name, &block)
+  end
+end

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

@@ -0,0 +1,222 @@
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core'
+require 'rspec/sleeping_king_studios/support/value_spy'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  DEFAULT_VALUE = Object.new.freeze
+  private_constant :DEFAULT_VALUE
+
+  # Matcher for testing the change in a value.
+  #
+  # @since 2.4.0
+  class HaveChangedMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    def initialize
+      super
+
+      @expected_initial_value = DEFAULT_VALUE
+      @expected_current_value = DEFAULT_VALUE
+    end
+
+    # Creates an difference expectation between the initial and current values.
+    # The matcher will subtract the current value from the initial value and
+    # compare the result with the specified value.
+    #
+    # @param [Object] difference The expected difference between the initial
+    #   value and the current value.
+    #
+    # @return [HaveChangedMatcher] the matcher instance.
+    def by(difference)
+      @expected_difference = difference
+
+      self
+    end
+
+    # (see BaseMatcher#description)
+    def description
+      desc = 'have changed'
+
+      unless @expected_initial_value == DEFAULT_VALUE
+        desc << " from #{@expected_initial_value.inspect}"
+      end
+
+      if @expected_difference
+        desc << " by #{@expected_difference.inspect}"
+      end
+
+      unless @expected_current_value == DEFAULT_VALUE
+        desc << " to #{@expected_current_value.inspect}"
+      end
+
+      desc
+    end
+
+    # (see BaseMatcher#does_not_match?)
+    def does_not_match?(actual)
+      @actual = actual
+
+      unless actual.is_a?(RSpec::SleepingKingStudios::Support::ValueSpy)
+        raise ArgumentError, 'You must pass a value spy to `expect`.'
+      end
+
+      unless @expected_current_value == DEFAULT_VALUE
+        raise NotImplementedError,
+          "`expect().not_to have_changed().to()` is not supported"
+      end
+
+      if @expected_difference
+        raise NotImplementedError,
+          "`expect().not_to have_changed().by()` is not supported"
+      end
+
+      match_initial_value? && !value_has_changed?
+    end
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      unless @match_initial_value.nil? || @match_initial_value
+        return "expected #{value_spy.description} to have initially " \
+          "been #{@expected_initial_value.inspect}, but was " \
+          "#{initial_value.inspect}"
+      end
+
+      message = "expected #{value_spy.description} to have changed"
+
+      if @expected_difference
+        message << " by #{@expected_difference.inspect}"
+      end
+
+      unless @expected_current_value == DEFAULT_VALUE
+        message << " to #{@expected_current_value.inspect}"
+      end
+
+      unless @match_difference.nil? || @match_difference
+        return message << ", but was changed by #{@actual_difference.inspect}"
+      end
+
+      unless @match_current_value.nil? || @match_current_value
+        return message << ", but is now #{current_value.inspect}"
+      end
+
+      message << ", but is still #{current_value.inspect}"
+
+      message
+    end
+
+    # (see BaseMatcher#failure_message_when_negated)
+    def failure_message_when_negated
+      unless @match_initial_value.nil? || @match_initial_value
+        return "expected #{value_spy.description} to have initially " \
+          "been #{@expected_initial_value.inspect}, but was " \
+          "#{initial_value.inspect}"
+      end
+
+      message = "expected #{value_spy.description} not to have changed"
+
+      message <<
+        ", but did change from #{initial_value.inspect} to " <<
+        current_value.inspect
+
+      message
+    end
+
+    # Creates an expectation on the initial value. The matcher will compare the
+    # initial value from the value spy with the specified value.
+    #
+    # @param [Object] value The expected initial value.
+    #
+    # @return [HaveChangedMatcher] the matcher instance.
+    def from(value)
+      @expected_initial_value = value
+
+      self
+    end
+
+    # Checks if the observed value has changed.
+    #
+    # @param [RSpec::SleepingKingStudios::Support::ValueSpy] actual The
+    #   observed value.
+    #
+    # @return [Boolean] True if the observed value has changed, otherwise false.
+    #
+    # @raise ArgumentError unless the actual object is a value spy.
+    def matches?(actual)
+      super
+
+      unless actual.is_a?(RSpec::SleepingKingStudios::Support::ValueSpy)
+        raise ArgumentError, 'You must pass a value spy to `expect`.'
+      end
+
+      match_initial_value? &&
+        value_has_changed? &&
+        match_current_value? &&
+        match_difference?
+    end
+
+    # Creates an expectation on the current value. The matcher will compare the
+    # current value from the value spy with the specified value.
+    #
+    # @param [Object] value The expected current value.
+    #
+    # @return [HaveChangedMatcher] the matcher instance.
+    def to(value)
+      @expected_current_value = value
+
+      self
+    end
+
+    private
+
+    alias_method :value_spy, :actual
+
+    def current_value
+      value_spy.current_value
+    end
+
+    def initial_value
+      value_spy.initial_value
+    end
+
+    def match_current_value?
+      return @match_current_value unless @match_current_value.nil?
+
+      if @expected_current_value == DEFAULT_VALUE
+        return @match_current_value = true
+      end
+
+      @match_current_value = RSpec::Support::FuzzyMatcher.values_match?(
+        current_value,
+        @expected_current_value
+      )
+    end
+
+    def match_difference?
+      return @match_difference unless @match_difference.nil?
+
+      return @match_difference = true unless @expected_difference
+
+      @actual_difference = current_value - initial_value
+
+      @match_difference = RSpec::Support::FuzzyMatcher.values_match?(
+        @actual_difference,
+        @expected_difference
+      )
+    end
+
+    def match_initial_value?
+      return @match_initial_value unless @match_initial_value.nil?
+
+      if @expected_initial_value == DEFAULT_VALUE
+        return @match_initial_value = true
+      end
+
+      @match_initial_value = RSpec::Support::FuzzyMatcher.values_match?(
+        initial_value,
+        @expected_initial_value
+      )
+    end
+
+    def value_has_changed?
+      value_spy.changed?
+    end
+  end
+end