super_diff 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed0200e5bbaa7abc329598fb01c4c3b7d21e3a871fccbc8c50f99a295e9cdd4
-  data.tar.gz: 392e4d85b279fb33f8c28f47394da7509095bc50787d2784f7b6b4aed34358d8
+  metadata.gz: 31484b874ef6086f57dd96cf538d32692040bcfe20df0b5a03ffb2d37528e178
+  data.tar.gz: ffe9ee2546b907b77018edfc856b207384c111f8d59dcdae54c6148cf1cf6cec
 SHA512:
-  metadata.gz: ea68e889de434c3340a8dc9ded4e6a1874056253d6af94bc7ea30cacda46e115100c40f27519c4770ec5f77bf4cd9d7925d63ccaff927a1cd50bb10a0c8fc64d
-  data.tar.gz: 2e10c9d374b7f458aa2e582faa70dbecf26f22dd5445315fd72ad47529d8d193def3fa5f6e7460afd36ed26df6f3f135931533e99cf712032496b1195099b16e
+  metadata.gz: 7f3a9f593e712569fac26dfc8ae395be685006d641576e317dfbc4aee773c506c833142b76f430b22e3089aa8ad2c8be3aabecb6d50992834db15e5ad4968fd0
+  data.tar.gz: b308ffce611c4bc457115247a9f1a5fb7bf310a78bc9a478fb5c99e6ca2d6fd40070013177d99e372554f0a25615278b094a262226c0460fcc127402aed27f71

data/README.md

@@ -1,11 +1,12 @@
-# SuperDiff [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] ![Downloads][downloads-badge] [![Hound][hound-badge]][hound]
+# SuperDiff [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] ![Downloads][downloads-badge] [![IssueHunt][issuehunt-badge]][issuehunt]
 
 [version-badge]: http://img.shields.io/gem/v/super_diff.svg
 [rubygems]: http://rubygems.org/gems/super_diff
 [travis-badge]: http://img.shields.io/travis/mcmire/super_diff/master.svg
 [downloads-badge]: http://img.shields.io/gem/dtv/super_diff.svg
-[hound-badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
 [hound]: https://houndci.com
+[issuehunt-badge]: https://img.shields.io/badge/sponsored_through-IssueHunt-2EC28C
+[issuehunt]: https://issuehunt.io/r/mcmire/super_diff
 
 SuperDiff is a gem that hooks into RSpec
 to intelligently display the differences between two data structures of any type.
@@ -85,7 +86,7 @@ expect(actual).to eq(expected)
 
 You would get output that looks like this:
 
-![Before super_diff](doc/before.png)
+![Before super_diff](docs/before.png)
 
 What this library does
 is to provide a diff engine
@@ -94,7 +95,7 @@ and display them in a sensible way.
 So, using the example above,
 you'd get this instead:
 
-![After super_diff](doc/after.png)
+![After super_diff](docs/after.png)
 
 ## Installation
 
@@ -164,14 +165,18 @@ you would add something like this to your test helper file
 (`rails_helper` or `spec_helper`):
 
 ``` ruby
-SuperDiff::RSpec.configure do |config|
+SuperDiff.configure do |config|
   config.add_extra_differ_class(YourDiffer)
-  config.add_extra_operational_sequencer_class(YourOperationalSequencer)
+  config.add_extra_operation_tree_builder_class(YourOperationTreeBuilder)
+  config.add_extra_operation_tree_class(YourOperationTree)
   config.add_extra_diff_formatter_class(YourDiffFormatter)
 end
 ```
 
-*(More info here in the future on adding a custom differ, operational sequencer, and diff formatter.
+*(More info here in the future on adding a custom differ,
+operation tree builder,
+operation tree,
+and diff formatter.
 Also explanations on what these are.)*
 
 ## Support
@@ -186,9 +191,17 @@ I'll try to respond to it as soon as I can!
 
 ## Contributing
 
-Any contributions to improve this library are welcome!
+Any code contributions to improve this library are welcome!
 Please see the [contributing](./CONTRIBUTING.md) document for more on how to do that.
 
+## Sponsoring
+
+If there's a change you want implemented, you can choose to sponsor that change!
+`super_diff` is set up on IssueHunt,
+so feel free to search for an existing issue (or make your own)
+and [add a bounty](https://issuehunt.io/r/mcmire/super_diff/issues).
+I'll get notified right away!
+
 ## Compatibility
 
 `super_diff` is [tested][travis] to work with

data/lib/super_diff.rb

@@ -7,23 +7,17 @@ module SuperDiff
     :ColorizedDocumentExtensions,
     "super_diff/colorized_document_extensions",
   )
+  autoload :Configuration, "super_diff/configuration"
   autoload :Csi, "super_diff/csi"
-  autoload :DiffFormatter, "super_diff/diff_formatter"
   autoload :DiffFormatters, "super_diff/diff_formatters"
-  autoload :Differ, "super_diff/differ"
   autoload :Differs, "super_diff/differs"
-  autoload :EqualityMatcher, "super_diff/equality_matcher"
   autoload :EqualityMatchers, "super_diff/equality_matchers"
+  autoload :Errors, "super_diff/errors"
   autoload :Helpers, "super_diff/helpers"
-  autoload :NoDifferAvailableError, "super_diff/no_differ_available_error"
-  autoload(
-    :NoOperationalSequencerAvailableError,
-    "super_diff/no_operational_sequencer_available_error",
-  )
+  autoload :ImplementationChecks, "super_diff/implementation_checks"
   autoload :ObjectInspection, "super_diff/object_inspection"
-  autoload :OperationalSequencer, "super_diff/operational_sequencer"
-  autoload :OperationalSequencers, "super_diff/operational_sequencers"
-  autoload :OperationSequences, "super_diff/operation_sequences"
+  autoload :OperationTrees, "super_diff/operation_trees"
+  autoload :OperationTreeBuilders, "super_diff/operation_tree_builders"
   autoload :Operations, "super_diff/operations"
   autoload :RecursionGuard, "super_diff/recursion_guard"
 
@@ -33,4 +27,19 @@ module SuperDiff
     border: :blue,
     header: :white,
   }.freeze
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @_configuration ||= Configuration.new
+  end
+
+  def self.time_like?(value)
+    # Check for ActiveSupport's #acts_like_time? for their time-like objects
+    # (like ActiveSupport::TimeWithZone).
+    (value.respond_to?(:acts_like_time?) && value.acts_like_time?) ||
+      value.is_a?(Time)
+  end
 end

data/lib/super_diff/active_record.rb

@@ -9,35 +9,31 @@ module SuperDiff
       "super_diff/active_record/object_inspection",
     )
     autoload(
-      :OperationSequences,
-      "super_diff/active_record/operation_sequences",
+      :OperationTrees,
+      "super_diff/active_record/operation_trees",
     )
     autoload(
-      :OperationalSequencers,
-      "super_diff/active_record/operational_sequencers",
+      :OperationTreeBuilders,
+      "super_diff/active_record/operation_tree_builders",
     )
-  end
-end
 
-if defined?(SuperDiff::RSpec)
-  SuperDiff::RSpec.configure do |config|
-    config.add_extra_differ_class(
-      SuperDiff::ActiveRecord::Differs::ActiveRecordRelation,
-    )
-    config.add_extra_operational_sequencer_class(
-      SuperDiff::ActiveRecord::OperationalSequencers::ActiveRecordModel,
-    )
-    config.add_extra_operational_sequencer_class(
-      SuperDiff::ActiveRecord::OperationalSequencers::ActiveRecordRelation,
-    )
-    config.add_extra_diff_formatter_class(
-      SuperDiff::ActiveRecord::DiffFormatters::ActiveRecordRelation,
-    )
+    SuperDiff.configure do |config|
+      config.add_extra_differ_classes(
+        Differs::ActiveRecordRelation,
+      )
+      config.add_extra_operation_tree_builder_classes(
+        OperationTreeBuilders::ActiveRecordModel,
+        OperationTreeBuilders::ActiveRecordRelation,
+      )
+      config.add_extra_diff_formatter_classes(
+        DiffFormatters::ActiveRecordRelation,
+      )
+      config.add_extra_inspector_classes(
+        ObjectInspection::Inspectors::ActiveRecordModel,
+        ObjectInspection::Inspectors::ActiveRecordRelation,
+      )
+    end
   end
 end
 
 require "super_diff/active_record/monkey_patches"
-
-SuperDiff::ObjectInspection.map.prepend(
-  SuperDiff::ActiveRecord::ObjectInspection::MapExtension,
-)

data/lib/super_diff/active_record/diff_formatters/active_record_relation.rb

@@ -2,8 +2,8 @@ module SuperDiff
   module ActiveRecord
     module DiffFormatters
       class ActiveRecordRelation < SuperDiff::DiffFormatters::Base
-        def self.applies_to?(operations)
-          operations.is_a?(OperationSequences::ActiveRecordRelation)
+        def self.applies_to?(operation_tree)
+          operation_tree.is_a?(OperationTrees::ActiveRecordRelation)
         end
 
         def call
@@ -12,7 +12,7 @@ module SuperDiff
             close_token: "]>",
             collection_prefix: collection_prefix,
             build_item_prefix: proc { "" },
-            operations: operations,
+            operation_tree: operation_tree,
             indent_level: indent_level,
             add_comma: add_comma?,
           )

data/lib/super_diff/active_record/differs/active_record_relation.rb

@@ -9,19 +9,17 @@ module SuperDiff
 
         def call
           DiffFormatters::ActiveRecordRelation.call(
-            operations,
+            operation_tree,
             indent_level: indent_level,
           )
         end
 
         private
 
-        def operations
-          OperationalSequencers::ActiveRecordRelation.call(
+        def operation_tree
+          OperationTreeBuilders::ActiveRecordRelation.call(
             expected: expected,
             actual: actual,
-            extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-            extra_diff_formatter_classes: extra_diff_formatter_classes,
           )
         end
       end

data/lib/super_diff/active_record/object_inspection/inspectors/active_record_model.rb

@@ -2,35 +2,45 @@ module SuperDiff
   module ActiveRecord
     module ObjectInspection
       module Inspectors
-        ActiveRecordModel = SuperDiff::ObjectInspection::InspectionTree.new do
-          add_text do |object|
-            "#<#{object.class} "
+        class ActiveRecordModel < SuperDiff::ObjectInspection::Inspectors::Base
+          def self.applies_to?(value)
+            value.is_a?(::ActiveRecord::Base)
           end
 
-          when_multiline do
-            add_text "{"
-          end
+          protected
 
-          nested do |object|
-            add_break
+          def inspection_tree
+            SuperDiff::ObjectInspection::InspectionTree.new do
+              add_text do |object|
+                "#<#{object.class} "
+              end
 
-            insert_separated_list(
-              ["id"] + (object.attributes.keys.sort - ["id"]),
-              separator: ",",
-            ) do |name|
-              add_text name
-              add_text ": "
-              add_inspection_of object.read_attribute(name)
-            end
-          end
+              when_multiline do
+                add_text "{"
+              end
 
-          add_break
+              nested do |object|
+                add_break
 
-          when_multiline do
-            add_text "}"
-          end
+                insert_separated_list(
+                  ["id"] + (object.attributes.keys.sort - ["id"]),
+                  separator: ",",
+                ) do |name|
+                  add_text name
+                  add_text ": "
+                  add_inspection_of object.read_attribute(name)
+                end
+              end
 
-          add_text ">"
+              add_break
+
+              when_multiline do
+                add_text "}"
+              end
+
+              add_text ">"
+            end
+          end
         end
       end
     end

data/lib/super_diff/active_record/object_inspection/inspectors/active_record_relation.rb

@@ -2,15 +2,25 @@ module SuperDiff
   module ActiveRecord
     module ObjectInspection
       module Inspectors
-        ActiveRecordRelation = SuperDiff::ObjectInspection::InspectionTree.new do
-          add_text "#<ActiveRecord::Relation ["
-
-          nested do |array|
-            insert_array_inspection_of(array)
+        class ActiveRecordRelation < SuperDiff::ObjectInspection::Inspectors::Base
+          def self.applies_to?(value)
+            value.is_a?(::ActiveRecord::Relation)
           end
 
-          add_break
-          add_text "]>"
+          protected
+
+          def inspection_tree
+            SuperDiff::ObjectInspection::InspectionTree.new do
+              add_text "#<ActiveRecord::Relation ["
+
+              nested do |array|
+                insert_array_inspection_of(array)
+              end
+
+              add_break
+              add_text "]>"
+            end
+          end
         end
       end
     end

data/lib/super_diff/active_record/operation_tree_builders.rb

@@ -0,0 +1,14 @@
+module SuperDiff
+  module ActiveRecord
+    module OperationTreeBuilders
+      autoload(
+        :ActiveRecordModel,
+        "super_diff/active_record/operation_tree_builders/active_record_model",
+      )
+      autoload(
+        :ActiveRecordRelation,
+        "super_diff/active_record/operation_tree_builders/active_record_relation",
+      )
+    end
+  end
+end

data/lib/super_diff/active_record/{operational_sequencers → operation_tree_builders}/active_record_model.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveRecord
-    module OperationalSequencers
-      class ActiveRecordModel < SuperDiff::OperationalSequencers::CustomObject
+    module OperationTreeBuilders
+      class ActiveRecordModel < SuperDiff::OperationTreeBuilders::CustomObject
         def self.applies_to?(expected, actual)
           expected.is_a?(::ActiveRecord::Base) &&
             actual.is_a?(::ActiveRecord::Base) &&

data/lib/super_diff/active_record/{operational_sequencers → operation_tree_builders}/active_record_relation.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveRecord
-    module OperationalSequencers
-      class ActiveRecordRelation < SuperDiff::OperationalSequencers::Array
+    module OperationTreeBuilders
+      class ActiveRecordRelation < SuperDiff::OperationTreeBuilders::Array
         def self.applies_to?(expected, actual)
           expected.is_a?(::Array) &&
             actual.is_a?(::ActiveRecord::Relation)
@@ -15,8 +15,8 @@ module SuperDiff
 
         private
 
-        def operations
-          @_operations ||= OperationSequences::ActiveRecordRelation.new([])
+        def operation_tree
+          @_operation_tree ||= OperationTrees::ActiveRecordRelation.new([])
         end
       end
     end

data/lib/super_diff/active_record/{operation_sequences.rb → operation_trees.rb}

@@ -1,9 +1,9 @@
 module SuperDiff
   module ActiveRecord
-    module OperationSequences
+    module OperationTrees
       autoload(
         :ActiveRecordRelation,
-        "super_diff/active_record/operation_sequences/active_record_relation",
+        "super_diff/active_record/operation_trees/active_record_relation",
       )
     end
   end

data/lib/super_diff/active_record/{operation_sequences → operation_trees}/active_record_relation.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveRecord
-    module OperationSequences
-      class ActiveRecordRelation < SuperDiff::OperationSequences::Array
+    module OperationTrees
+      class ActiveRecordRelation < SuperDiff::OperationTrees::Array
         def to_diff(indent_level:, collection_prefix:, add_comma:)
           DiffFormatters::ActiveRecordRelation.call(
             self,

data/lib/super_diff/active_support.rb

@@ -4,30 +4,27 @@ module SuperDiff
     autoload :Differs, "super_diff/active_support/differs"
     autoload :ObjectInspection, "super_diff/active_support/object_inspection"
     autoload(
-      :OperationalSequencers,
-      "super_diff/active_support/operational_sequencers",
+      :OperationTreeBuilders,
+      "super_diff/active_support/operation_tree_builders",
     )
     autoload(
       :OperationalSequences,
       "super_diff/active_support/operational_sequences",
     )
-  end
-end
 
-if defined?(SuperDiff::RSpec)
-  SuperDiff::RSpec.configure do |config|
-    config.add_extra_differ_class(
-      SuperDiff::ActiveSupport::Differs::HashWithIndifferentAccess,
-    )
-    config.add_extra_operational_sequencer_class(
-      SuperDiff::ActiveSupport::OperationalSequencers::HashWithIndifferentAccess,
-    )
-    config.add_extra_diff_formatter_class(
-      SuperDiff::ActiveSupport::DiffFormatters::HashWithIndifferentAccess,
-    )
+    SuperDiff.configure do |config|
+      config.add_extra_differ_classes(
+        Differs::HashWithIndifferentAccess,
+      )
+      config.add_extra_operation_tree_builder_classes(
+        OperationTreeBuilders::HashWithIndifferentAccess,
+      )
+      config.add_extra_diff_formatter_classes(
+        DiffFormatters::HashWithIndifferentAccess,
+      )
+      config.add_extra_inspector_classes(
+        ObjectInspection::Inspectors::HashWithIndifferentAccess,
+      )
+    end
   end
 end
-
-SuperDiff::ObjectInspection.map.prepend(
-  SuperDiff::ActiveSupport::ObjectInspection::MapExtension,
-)