rspec-support 3.5.0.beta2 → 3.5.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7636681b4e17a1765852cbe17a55590690fda3df
-  data.tar.gz: c340715fbaea1731f1c8e78d264cbb2a9c080eaa
+  metadata.gz: d159591f4da601722c04e7443c888b74e6def234
+  data.tar.gz: 81984c1aed88ed161165bcee99627e9a4903e6d2
 SHA512:
-  metadata.gz: 4400cd6c8b0dba274d279addd3c553051469c595f032fd3e867a1732e698d30c0567188efcce13ad674b36bbb8687ec82d32b96874c461b1c43c603ca17caff9
-  data.tar.gz: 8bdf0429715765f0ec796b282e0c825907b0ef65cffc2dcc4b511b4a0a5d0f4865386952a76b9a470ae5eccd2da726038b0a3cef6c23827199abfafae79aa2b6
+  metadata.gz: 0650cc39b1439e2f7309fecf5feb528c4b3c35bf17b6e3ee58019d79cf0b26fcac1fe6eb1a580690e029ef5027f3ed20b7439872c56b02a0774e3adbc839084f
+  data.tar.gz: a966de2f00b14b2a3952f1bc930421692f966027e4b6dcd843321ae476319c6a743d0920e5b73ba96ab7db53dcf98e8b7b0c4ece15cbd4fcb3b02294e6b32ef8

data/Changelog.md

@@ -1,6 +1,14 @@
 ### Development
 [Full Changelog](http://github.com/rspec/rspec-support/compare/v3.5.0.beta1...master)
 
+Bug Fixes:
+
+* Fix `ObjectFormatter` so that formatting objects that don't respond to
+  `#inspect` (such as `BasicObject`) does not cause `NoMethodError`.
+  (Yuji Nakayama, #269)
+* Fix `ObjectFormatter` so that formatting recursive array or hash does not
+  cause `SystemStackError`. (Yuji Nakayama, #270, #272)
+
 ### 3.5.0.beta1 / 2016-02-06
 [Full Changelog](http://github.com/rspec/rspec-support/compare/v3.4.1...v3.5.0.beta1)
 

data/lib/rspec/support/encoded_string.rb

@@ -47,8 +47,18 @@ module RSpec
         @string << matching_encoding(string)
       end
 
-      def split(regex_or_string)
-        @string.split(matching_encoding(regex_or_string))
+      if Ruby.jruby?
+        def split(regex_or_string)
+          @string.split(matching_encoding(regex_or_string))
+        rescue ArgumentError
+          # JRuby raises an ArgumentError when splitting a source string that
+          # contains invalid bytes.
+          remove_invalid_bytes(@string).split regex_or_string
+        end
+      else
+        def split(regex_or_string)
+          @string.split(matching_encoding(regex_or_string))
+        end
       end
 
       def to_s

data/lib/rspec/support/object_formatter.rb

@@ -1,20 +1,33 @@
+RSpec::Support.require_rspec_support 'matcher_definition'
+
 module RSpec
   module Support
     # Provide additional output details beyond what `inspect` provides when
     # printing Time, DateTime, or BigDecimal
     # @api private
-    class ObjectFormatter
-      attr_accessor :max_formatted_output_length
+    class ObjectFormatter # rubocop:disable Style/ClassLength
+      ELLIPSIS = "..."
 
-      def initialize(max_formatted_output_length=200)
-        @max_formatted_output_length = max_formatted_output_length
-      end
+      attr_accessor :max_formatted_output_length
 
       # Methods are deferred to a default instance of the class to maintain the interface
       # For example, calling ObjectFormatter.format is still possible
-      @default_instance = new(200)
+      def self.default_instance
+        @default_instance ||= new
+      end
 
-      ELLIPSIS = "..."
+      def self.format(object)
+        default_instance.format(object)
+      end
+
+      def self.prepare_for_inspection(object)
+        default_instance.prepare_for_inspection(object)
+      end
+
+      def initialize(max_formatted_output_length=200)
+        @max_formatted_output_length = max_formatted_output_length
+        @current_structure_stack = []
+      end
 
       def format(object)
         if max_formatted_output_length.nil?
@@ -31,12 +44,6 @@ module RSpec
         end
       end
 
-      def self.format(object)
-        @default_instance.format(object)
-      end
-
-      # rubocop:disable MethodLength
-
       # Prepares the provided object to be formatted by wrapping it as needed
       # in something that, when `inspect` is called on it, will produce the
       # desired output.
@@ -49,96 +56,194 @@ module RSpec
       def prepare_for_inspection(object)
         case object
         when Array
-          return object.map { |o| prepare_for_inspection(o) }
+          prepare_array(object)
         when Hash
-          return prepare_hash(object)
-        when Time
-          inspection = format_time(object)
+          prepare_hash(object)
         else
-          if defined?(DateTime) && DateTime === object
-            inspection = format_date_time(object)
-          elsif defined?(BigDecimal) && BigDecimal === object
-            inspection = "#{object.to_s 'F'} (#{object.inspect})"
-          elsif RSpec::Support.is_a_matcher?(object) && object.respond_to?(:description)
-            inspection = object.description
-          else
-            return DelegatingInspector.new(object)
+          inspector_class = INSPECTOR_CLASSES.find { |inspector| inspector.can_inspect?(object) }
+          inspector_class.new(object, self)
+        end
+      end
+
+      def prepare_array(array)
+        with_entering_structure(array) do
+          array.map { |element| prepare_element(element) }
+        end
+      end
+
+      def prepare_hash(input_hash)
+        with_entering_structure(input_hash) do
+          input_hash.inject({}) do |output_hash, key_and_value|
+            key, value = key_and_value.map { |element| prepare_element(element) }
+            output_hash[key] = value
+            output_hash
           end
         end
+      end
 
-        InspectableItem.new(inspection)
+      def prepare_element(element)
+        if recursive_structure?(element)
+          case element
+          when Array then InspectableItem.new('[...]')
+          when Hash then InspectableItem.new('{...}')
+          else raise # This won't happen
+          end
+        else
+          prepare_for_inspection(element)
+        end
       end
-      # rubocop:enable MethodLength
 
-      def self.prepare_for_inspection(object)
-        @default_instance.prepare_for_inspection(object)
+      def with_entering_structure(structure)
+        @current_structure_stack.push(structure)
+        return_value = yield
+        @current_structure_stack.pop
+        return_value
       end
 
-      def prepare_hash(input)
-        input.inject({}) do |hash, (k, v)|
-          hash[prepare_for_inspection(k)] = prepare_for_inspection(v)
-          hash
+      def recursive_structure?(object)
+        @current_structure_stack.any? { |seen_structure| seen_structure.equal?(object) }
+      end
+
+      InspectableItem = Struct.new(:text) do
+        def inspect
+          text
+        end
+
+        def pretty_print(pp)
+          pp.text(text)
         end
       end
 
-      def self.prepare_hash(input)
-        @default_instance.prepare_hash(input)
+      BaseInspector = Struct.new(:object, :formatter) do
+        def self.can_inspect?(_object)
+          raise NotImplementedError
+        end
+
+        def inspect
+          raise NotImplementedError
+        end
+
+        def pretty_print(pp)
+          pp.text(inspect)
+        end
       end
 
-      TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+      class TimeInspector < BaseInspector
+        FORMAT = "%Y-%m-%d %H:%M:%S"
 
-      if Time.method_defined?(:nsec)
-        def format_time(time)
-          time.strftime("#{TIME_FORMAT}.#{"%09d" % time.nsec} %z")
+        def self.can_inspect?(object)
+          Time === object
         end
-      else # for 1.8.7
-        def format_time(time)
-          time.strftime("#{TIME_FORMAT}.#{"%06d" % time.usec} %z")
+
+        if Time.method_defined?(:nsec)
+          def inspect
+            object.strftime("#{FORMAT}.#{"%09d" % object.nsec} %z")
+          end
+        else # for 1.8.7
+          def inspect
+            object.strftime("#{FORMAT}.#{"%06d" % object.usec} %z")
+          end
         end
       end
 
-      def self.format_time(time)
-        @default_instance.format_time(time)
+      class DateTimeInspector < BaseInspector
+        FORMAT = "%a, %d %b %Y %H:%M:%S.%N %z"
+
+        def self.can_inspect?(object)
+          defined?(DateTime) && DateTime === object
+        end
+
+        # ActiveSupport sometimes overrides inspect. If `ActiveSupport` is
+        # defined use a custom format string that includes more time precision.
+        def inspect
+          if defined?(ActiveSupport)
+            object.strftime(FORMAT)
+          else
+            object.inspect
+          end
+        end
       end
 
-      DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S.%N %z"
-      # ActiveSupport sometimes overrides inspect. If `ActiveSupport` is
-      # defined use a custom format string that includes more time precision.
-      def format_date_time(date_time)
-        if defined?(ActiveSupport)
-          date_time.strftime(DATE_TIME_FORMAT)
-        else
-          date_time.inspect
+      class BigDecimalInspector < BaseInspector
+        def self.can_inspect?(object)
+          defined?(BigDecimal) && BigDecimal === object
+        end
+
+        def inspect
+          "#{object.to_s('F')} (#{object.inspect})"
         end
       end
 
-      def self.format_date_time(date_time)
-        @default_instance.format_date_time(date_time)
+      class DescribableMatcherInspector < BaseInspector
+        def self.can_inspect?(object)
+          Support.is_a_matcher?(object) && object.respond_to?(:description)
+        end
+
+        def inspect
+          object.description
+        end
       end
 
-      InspectableItem = Struct.new(:inspection) do
+      class UninspectableObjectInspector < BaseInspector
+        OBJECT_ID_FORMAT = '%#016x'
+
+        def self.can_inspect?(object)
+          object.inspect
+          false
+        rescue NoMethodError
+          true
+        end
+
         def inspect
-          inspection
+          "#<#{klass}:#{native_object_id}>"
         end
 
-        def pretty_print(pp)
-          pp.text inspection
+        def klass
+          singleton_class = class << object; self; end
+          singleton_class.ancestors.find { |ancestor| !ancestor.equal?(singleton_class) }
+        end
+
+        # http://stackoverflow.com/a/2818916
+        def native_object_id
+          OBJECT_ID_FORMAT % (object.__id__ << 1)
+        rescue NoMethodError
+          # In Ruby 1.9.2, BasicObject responds to none of #__id__, #object_id, #id...
+          '-'
         end
       end
 
-      DelegatingInspector = Struct.new(:object) do
+      class DelegatorInspector < BaseInspector
+        def self.can_inspect?(object)
+          defined?(Delegator) && Delegator === object
+        end
+
         def inspect
-          if defined?(::Delegator) && ::Delegator === object
-            "#<#{object.class}(#{ObjectFormatter.format(object.__getobj__)})>"
-          else
-            object.inspect
-          end
+          "#<#{object.class}(#{formatter.format(object.__getobj__)})>"
+        end
+      end
+
+      class InspectableObjectInspector < BaseInspector
+        def self.can_inspect?(object)
+          object.inspect
+          true
+        rescue NoMethodError
+          false
         end
 
-        def pretty_print(pp)
-          pp.text inspect
+        def inspect
+          object.inspect
         end
       end
+
+      INSPECTOR_CLASSES = [
+        TimeInspector,
+        DateTimeInspector,
+        BigDecimalInspector,
+        UninspectableObjectInspector,
+        DescribableMatcherInspector,
+        DelegatorInspector,
+        InspectableObjectInspector
+      ]
     end
   end
 end

data/lib/rspec/support/spec.rb

@@ -31,8 +31,8 @@ RSpec.configure do |c|
     c.default_formatter = 'doc'
   end
 
-  c.filter_run :focus
-  c.run_all_when_everything_filtered = true
+  c.filter_run_when_matching :focus
+
   c.example_status_persistence_file_path = "./spec/examples.txt"
 
   c.define_derived_metadata :failing_on_appveyor do |meta|

data/lib/rspec/support/version.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Support
     module Version
-      STRING = '3.5.0.beta2'
+      STRING = '3.5.0.beta3'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-support
 version: !ruby/object:Gem::Version
-  version: 3.5.0.beta2
+  version: 3.5.0.beta3
 platform: ruby
 authors:
 - David Chelimsky
@@ -48,7 +48,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: rspec-support-3.5.0.beta2
+summary: rspec-support-3.5.0.beta3
 test_files: []