super_diff 0.10.0 → 0.12.0

data/lib/super_diff/operation_tree_flatteners/collection.rb

@@ -1,136 +0,0 @@
-module SuperDiff
-  module OperationTreeFlatteners
-    class Collection < Base
-      protected
-
-      def build_tiered_lines
-        [
-          Line.new(
-            type: :noop,
-            indentation_level: indentation_level,
-            value: open_token,
-            collection_bookend: :open
-          ),
-          *inner_lines,
-          Line.new(
-            type: :noop,
-            indentation_level: indentation_level,
-            value: close_token,
-            collection_bookend: :close
-          )
-        ]
-      end
-
-      def inner_lines
-        @_inner_lines ||=
-          operation_tree.flat_map do |operation|
-            lines =
-              if operation.name == :change
-                build_lines_for_change_operation(operation)
-              else
-                build_lines_for_non_change_operation(operation)
-              end
-
-            maybe_add_prefix_at_beginning_of_lines(
-              maybe_add_comma_at_end_of_lines(lines, operation),
-              operation
-            )
-          end
-      end
-
-      def maybe_add_prefix_at_beginning_of_lines(lines, operation)
-        if add_prefix_at_beginning_of_lines?(operation)
-          add_prefix_at_beginning_of_lines(lines, operation)
-        else
-          lines
-        end
-      end
-
-      def add_prefix_at_beginning_of_lines?(operation)
-        !!item_prefix_for(operation)
-      end
-
-      def add_prefix_at_beginning_of_lines(lines, operation)
-        [lines[0].prefixed_with(item_prefix_for(operation))] + lines[1..-1]
-      end
-
-      def maybe_add_comma_at_end_of_lines(lines, operation)
-        if last_item_in_collection?(operation)
-          lines
-        else
-          add_comma_at_end_of_lines(lines)
-        end
-      end
-
-      def last_item_in_collection?(operation)
-        if operation.name == :change
-          operation.left_index == operation.left_collection.size - 1 &&
-            operation.right_index == operation.right_collection.size - 1
-        else
-          operation.index == operation.collection.size - 1
-        end
-      end
-
-      def add_comma_at_end_of_lines(lines)
-        lines[0..-2] + [lines[-1].with_comma]
-      end
-
-      def build_lines_for_change_operation(operation)
-        SuperDiff::RecursionGuard.guarding_recursion_of(
-          operation.left_collection,
-          operation.right_collection
-        ) do |already_seen|
-          if already_seen
-            raise InfiniteRecursionError
-          else
-            operation.children.flatten(indentation_level: indentation_level + 1)
-          end
-        end
-      end
-
-      def build_lines_for_non_change_operation(operation)
-        indentation_level = @indentation_level + 1
-
-        if recursive_operation?(operation)
-          [
-            Line.new(
-              type: operation.name,
-              indentation_level: indentation_level,
-              value: SuperDiff::RecursionGuard::PLACEHOLDER
-            )
-          ]
-        else
-          build_lines_from_inspection_of(
-            operation.value,
-            type: operation.name,
-            indentation_level: indentation_level
-          )
-        end
-      end
-
-      def recursive_operation?(operation)
-        operation.value.equal?(operation.collection) ||
-          SuperDiff::RecursionGuard.already_seen?(operation.value)
-      end
-
-      def item_prefix_for(_operation)
-        ""
-      end
-
-      def build_lines_from_inspection_of(value, type:, indentation_level:)
-        SuperDiff.inspect_object(
-          value,
-          as_lines: true,
-          type: type,
-          indentation_level: indentation_level
-        )
-      end
-
-      class InfiniteRecursionError < StandardError
-        def initialize(_message = nil)
-          super("Unhandled recursive data structure encountered!")
-        end
-      end
-    end
-  end
-end

data/lib/super_diff/operation_tree_flatteners/custom_object.rb

@@ -1,28 +0,0 @@
-module SuperDiff
-  module OperationTreeFlatteners
-    class CustomObject < Collection
-      protected
-
-      def open_token
-        "#<%<class>s {" % { class: operation_tree.underlying_object.class }
-      end
-
-      def close_token
-        "}>"
-      end
-
-      def item_prefix_for(operation)
-        key =
-          # Note: We could have used the right_key here too, they're both the
-          # same keys
-          if operation.respond_to?(:left_key)
-            operation.left_key
-          else
-            operation.key
-          end
-
-        "#{key}: "
-      end
-    end
-  end
-end

data/lib/super_diff/operation_tree_flatteners/default_object.rb

@@ -1,31 +0,0 @@
-module SuperDiff
-  module OperationTreeFlatteners
-    class DefaultObject < Collection
-      protected
-
-      def open_token
-        "#<#{operation_tree.underlying_object.class.name}:" +
-          SuperDiff::Helpers.object_address_for(
-            operation_tree.underlying_object
-          ) + " {"
-      end
-
-      def close_token
-        "}>"
-      end
-
-      def item_prefix_for(operation)
-        key =
-          # Note: We could have used the right_key here too, they're both the
-          # same keys
-          if operation.respond_to?(:left_key)
-            operation.left_key
-          else
-            operation.key
-          end
-
-        "@#{key}="
-      end
-    end
-  end
-end

data/lib/super_diff/operation_tree_flatteners/hash.rb

@@ -1,33 +0,0 @@
-module SuperDiff
-  module OperationTreeFlatteners
-    class Hash < Collection
-      protected
-
-      def open_token
-        "{"
-      end
-
-      def close_token
-        "}"
-      end
-
-      def item_prefix_for(operation)
-        key = key_for(operation)
-
-        format_keys_as_kwargs? ? "#{key}: " : "#{key.inspect} => "
-      end
-
-      private
-
-      def format_keys_as_kwargs?
-        operation_tree.all? { |operation| key_for(operation).is_a?(Symbol) }
-      end
-
-      def key_for(operation)
-        # Note: We could have used the right_key here too, they're both the
-        # same keys
-        operation.respond_to?(:left_key) ? operation.left_key : operation.key
-      end
-    end
-  end
-end

data/lib/super_diff/operation_tree_flatteners/multiline_string.rb

@@ -1,18 +0,0 @@
-module SuperDiff
-  module OperationTreeFlatteners
-    class MultilineString < Base
-      def build_tiered_lines
-        operation_tree.map do |operation|
-          Line.new(
-            type: operation.name,
-            indentation_level: indentation_level,
-            # TODO: Test that quotes and things don't get escaped but escape
-            # characters do
-            value:
-              operation.value.inspect[1..-2].gsub(/\\"/, '"').gsub(/\\'/, "'")
-          )
-        end
-      end
-    end
-  end
-end

data/lib/super_diff/operation_trees/array.rb

@@ -1,15 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    class Array < Base
-      def self.applies_to?(value)
-        value.is_a?(::Array)
-      end
-
-      protected
-
-      def operation_tree_flattener_class
-        OperationTreeFlatteners::Array
-      end
-    end
-  end
-end

data/lib/super_diff/operation_trees/custom_object.rb

@@ -1,15 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    class CustomObject < DefaultObject
-      def self.applies_to?(value)
-        value.respond_to?(:attributes_for_super_diff)
-      end
-
-      protected
-
-      def operation_tree_flattener_class
-        OperationTreeFlatteners::CustomObject
-      end
-    end
-  end
-end

data/lib/super_diff/operation_trees/default_object.rb

@@ -1,40 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    class DefaultObject < Base
-      def self.applies_to?(*)
-        true
-      end
-
-      attr_reader :underlying_object
-
-      def initialize(operations, underlying_object:)
-        super(operations)
-        @underlying_object = underlying_object
-      end
-
-      def pretty_print(pp)
-        pp.text "#<#{self.class.name} "
-        pp.nest(1) do
-          pp.breakable
-          pp.text ":operations=>"
-          pp.group(1, "[", "]") do
-            pp.breakable
-            pp.seplist(self) { |value| pp.pp value }
-          end
-          pp.comma_breakable
-          pp.text ":underlying_object=>"
-          pp.object_address_group underlying_object do
-            # do nothing
-          end
-        end
-        pp.text ">"
-      end
-
-      protected
-
-      def operation_tree_flattener_class
-        OperationTreeFlatteners::DefaultObject
-      end
-    end
-  end
-end

data/lib/super_diff/operation_trees/defaults.rb

@@ -1,5 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    DEFAULTS = [Array, Hash, CustomObject, DefaultObject].freeze
-  end
-end

data/lib/super_diff/operation_trees/hash.rb

@@ -1,15 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    class Hash < Base
-      def self.applies_to?(value)
-        value.is_a?(::Hash)
-      end
-
-      protected
-
-      def operation_tree_flattener_class
-        OperationTreeFlatteners::Hash
-      end
-    end
-  end
-end

data/lib/super_diff/operation_trees/main.rb

@@ -1,35 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    class Main
-      extend AttrExtras.mixin
-
-      method_object :value
-
-      def call
-        if resolved_class
-          begin
-            resolved_class.new([], underlying_object: value)
-          rescue ArgumentError
-            resolved_class.new([])
-          end
-        else
-          raise Errors::NoOperationalSequenceAvailableError.create(value)
-        end
-      end
-
-      private
-
-      def resolved_class
-        if value.respond_to?(:attributes_for_super_diff)
-          CustomObject
-        else
-          available_classes.find { |klass| klass.applies_to?(value) }
-        end
-      end
-
-      def available_classes
-        SuperDiff.configuration.extra_operation_tree_classes + DEFAULTS
-      end
-    end
-  end
-end

data/lib/super_diff/operation_trees/multiline_string.rb

@@ -1,15 +0,0 @@
-module SuperDiff
-  module OperationTrees
-    class MultilineString < Base
-      def self.applies_to?(value)
-        value.is_a?(::String) && value.is_a?(::String)
-      end
-
-      protected
-
-      def operation_tree_flattener_class
-        OperationTreeFlatteners::MultilineString
-      end
-    end
-  end
-end

data/lib/super_diff/recursion_guard.rb

@@ -1,50 +0,0 @@
-require "set"
-
-module SuperDiff
-  module RecursionGuard
-    RECURSION_GUARD_KEY = "super_diff_recursion_guard_key".freeze
-    PLACEHOLDER = "∙∙∙".freeze
-
-    def self.guarding_recursion_of(*objects, &block)
-      already_seen_objects, first_seen_objects =
-        objects.partition do |object|
-          !SuperDiff.primitive?(object) && already_seen?(object)
-        end
-
-      first_seen_objects.each do |object|
-        already_seen_object_ids.add(object.object_id)
-      end
-
-      result =
-        if block.arity > 0
-          block.call(already_seen_objects.any?)
-        else
-          block.call
-        end
-
-      first_seen_objects.each do |object|
-        already_seen_object_ids.delete(object.object_id)
-      end
-
-      result
-    end
-
-    def self.substituting_recursion_of(*objects)
-      guarding_recursion_of(*objects) do |already_seen|
-        if already_seen
-          PLACEHOLDER
-        else
-          yield
-        end
-      end
-    end
-
-    def self.already_seen?(object)
-      already_seen_object_ids.include?(object.object_id)
-    end
-
-    def self.already_seen_object_ids
-      Thread.current[RECURSION_GUARD_KEY] ||= Set.new
-    end
-  end
-end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/collection_containing_exactly.rb

@@ -1,29 +0,0 @@
-module SuperDiff
-  module RSpec
-    module ObjectInspection
-      module InspectionTreeBuilders
-        class CollectionContainingExactly < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
-          def self.applies_to?(value)
-            SuperDiff::RSpec.a_collection_containing_exactly_something?(value)
-          end
-
-          def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<a collection containing exactly ("
-              end
-
-              nested do |aliased_matcher|
-                insert_array_inspection_of(aliased_matcher.expected)
-              end
-
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/collection_including.rb

@@ -1,36 +0,0 @@
-module SuperDiff
-  module RSpec
-    module ObjectInspection
-      module InspectionTreeBuilders
-        class CollectionIncluding < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
-          def self.applies_to?(value)
-            SuperDiff::RSpec.a_collection_including_something?(value) ||
-              SuperDiff::RSpec.array_including_something?(value)
-          end
-
-          def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<a collection including ("
-              end
-
-              nested do |value|
-                array =
-                  if SuperDiff::RSpec.a_collection_including_something?(value)
-                    value.expecteds
-                  else
-                    value.instance_variable_get(:@expected)
-                  end
-                insert_array_inspection_of(array)
-              end
-
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/double.rb

@@ -1,98 +0,0 @@
-module SuperDiff
-  module RSpec
-    module ObjectInspection
-      module InspectionTreeBuilders
-        class Double < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
-          def self.applies_to?(value)
-            value.is_a?(::RSpec::Mocks::Double)
-          end
-
-          def call
-            builder = self
-            empty = -> { empty? }
-            nonempty = -> { !empty? }
-
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              only_when empty do
-                as_lines_when_rendering_to_lines do
-                  add_text do |object|
-                    inspected_class = builder.inspected_class
-                    inspected_name = builder.inspected_name
-                    "#<#{inspected_class} #{inspected_name}>"
-                  end
-                end
-              end
-
-              only_when nonempty do
-                as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                  add_text do |object|
-                    inspected_class = builder.inspected_class
-                    inspected_name = builder.inspected_name
-                    "#<#{inspected_class} #{inspected_name}"
-                  end
-
-                  when_rendering_to_lines { add_text " {" }
-                end
-
-                when_rendering_to_string { add_text " " }
-
-                nested do |object|
-                  insert_hash_inspection_of(builder.doubled_methods)
-                end
-
-                as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                  when_rendering_to_lines { add_text "}" }
-
-                  add_text ">"
-                end
-              end
-            end
-          end
-
-          def empty?
-            doubled_methods.empty?
-          end
-
-          def nonempty?
-            !empty?
-          end
-
-          def inspected_class
-            case object
-            when ::RSpec::Mocks::InstanceVerifyingDouble
-              "InstanceDouble"
-            when ::RSpec::Mocks::ClassVerifyingDouble
-              "ClassDouble"
-            when ::RSpec::Mocks::ObjectVerifyingDouble
-              "ObjectDouble"
-            else
-              "Double"
-            end
-          end
-
-          def inspected_name
-            if object.instance_variable_get("@name")
-              object.instance_variable_get("@name").inspect
-            else
-              "(anonymous)"
-            end
-          end
-
-          def doubled_methods
-            @_doubled_methods ||=
-              doubled_method_names.reduce({}) do |hash, key|
-                hash.merge(key => object.public_send(key))
-              end
-          end
-
-          def doubled_method_names
-            object
-              .__send__(:__mock_proxy)
-              .instance_variable_get("@method_doubles")
-              .keys
-          end
-        end
-      end
-    end
-  end
-end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/hash_including.rb

@@ -1,37 +0,0 @@
-module SuperDiff
-  module RSpec
-    module ObjectInspection
-      module InspectionTreeBuilders
-        class HashIncluding < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
-          def self.applies_to?(value)
-            SuperDiff::RSpec.a_hash_including_something?(value) ||
-              SuperDiff::RSpec.hash_including_something?(value)
-          end
-
-          def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<a hash including ("
-              end
-
-              nested do |value|
-                hash =
-                  if SuperDiff::RSpec.a_hash_including_something?(value)
-                    value.expecteds.first
-                  else
-                    value.instance_variable_get(:@expected)
-                  end
-
-                insert_hash_inspection_of(hash)
-              end
-
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/instance_of.rb

@@ -1,28 +0,0 @@
-module SuperDiff
-  module RSpec
-    module ObjectInspection
-      module InspectionTreeBuilders
-        class InstanceOf < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
-          def self.applies_to?(value)
-            SuperDiff::RSpec.an_instance_of_something?(value) ||
-              SuperDiff::RSpec.instance_of_something?(value)
-          end
-
-          def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              add_text do |value|
-                klass =
-                  if SuperDiff::RSpec.an_instance_of_something?(value)
-                    value.expected
-                  else
-                    value.instance_variable_get(:@klass)
-                  end
-                "#<an instance of #{klass}>"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end