super_diff 0.4.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed0200e5bbaa7abc329598fb01c4c3b7d21e3a871fccbc8c50f99a295e9cdd4
-  data.tar.gz: 392e4d85b279fb33f8c28f47394da7509095bc50787d2784f7b6b4aed34358d8
+  metadata.gz: 854afb65d4337f48bd39a3e8529eb73f0ff01590a74a0a59b0df84827aff8746
+  data.tar.gz: '07356729294beab45bb4402398ed832819b8c9f5aba888b5004c251aaab97935'
 SHA512:
-  metadata.gz: ea68e889de434c3340a8dc9ded4e6a1874056253d6af94bc7ea30cacda46e115100c40f27519c4770ec5f77bf4cd9d7925d63ccaff927a1cd50bb10a0c8fc64d
-  data.tar.gz: 2e10c9d374b7f458aa2e582faa70dbecf26f22dd5445315fd72ad47529d8d193def3fa5f6e7460afd36ed26df6f3f135931533e99cf712032496b1195099b16e
+  metadata.gz: 240e383f75cd8fc6256c4951d288b16171e97b26267772e1af707c0fc33497547bccae2049647ed669d071fbfc8c2c6547c69488bdd3e3ce42a046d74e73dbe4
+  data.tar.gz: 3a3c30108caf9f15704f3c8c21c753b5e8d89ac900bdbc00cca4909a4b5a13d152cde73d0a72ea74d8a9a1b4a8775d42f87619765d22fc7b7ac00e235d70576b

data/README.md

@@ -1,16 +1,17 @@
-# 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][gh-actions-badge]][gh-actions] ![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
+[gh-actions-badge]: http://img.shields.io/github/workflow/status/mcmire/super_diff/SuperDiff/master
 [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.
 
-📢 **[See what's changed in the latest version (0.4.2)][changelog].**
+📢 **[See what's changed in recent versions.][changelog]**
 
 [changelog]: CHANGELOG.md
 
@@ -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
 
@@ -154,26 +155,57 @@ require "super_diff/rspec"
 
 ## Configuration
 
-As capable as this library is,
-it doesn't know how to deal with every kind of object out there.
-If you have a custom class,
-and instances of your class aren't appearing in diffs like you like,
-you might find it necessary to instruct the gem on how to handle them.
-In that case
-you would add something like this to your test helper file
-(`rails_helper` or `spec_helper`):
+You can customize the behavior of the gem
+by adding a configuration block
+to your test helper file
+(`rails_helper` or `spec_helper`)
+which looks something like this:
 
 ``` ruby
-SuperDiff::RSpec.configure do |config|
+SuperDiff.configure do |config|
+  # ...
+end
+```
+
+### Customizing colors
+
+If you don't like the colors that SuperDiff uses,
+you can change them like this:
+
+``` ruby
+SuperDiff.configure do |config|
+  config.actual_color = :green
+  config.expected_color = :red
+  config.border_color = :yellow
+  config.header_color = :yellow
+end
+```
+
+See [eight_bit_color.rb](lib/super_diff/csi/eight_bit_color.rb)
+for the list of available colors.
+
+### Diffing custom objects
+
+If you are comparing two data structures
+that involve a class that is specific to your project,
+the resulting diff may not look as good as diffs involving native or primitive objects.
+This happens because if SuperDiff doesn't recognize a class,
+it will fall back to a generic representation when diffing instances of that class.
+Fortunately, the gem has a pluggable interface
+that allows you to insert your own implementations
+of key pieces involved in the diffing process.
+I'll have more about how that works soon,
+but here is what such a configuration would look like:
+
+``` ruby
+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.
-Also explanations on what these are.)*
-
 ## Support
 
 My goal for this library is to improve your development experience.
@@ -186,17 +218,25 @@ 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).
+I'll get notified right away!
+
 ## Compatibility
 
-`super_diff` is [tested][travis] to work with
-Ruby >= 2.4.x,
+`super_diff` is [tested][gh-actions] to work with
+Ruby >= 2.5.x,
 RSpec 3.x,
 and Rails >= 5.x.
 
-[travis]: http://travis-ci.org/mcmire/super_diff
+[gh-actions]: https://github.com/mcmire/super_diff/actions?query=workflow%3ASuperDiff
 
 ## Inspiration/Thanks
 
@@ -219,5 +259,5 @@ Thank you to the authors of these libraries!
 
 ## Author/License
 
-`super_diff` was created and is maintained by Elliot Winkler.
+SuperDiff was created and is maintained by Elliot Winkler.
 It is released under the [MIT license](LICENSE).

data/lib/super_diff.rb

@@ -7,30 +7,33 @@ 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 :GemVersion, "super_diff/gem_version"
   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"
 
-  COLORS = {
-    alpha: :magenta,
-    beta: :yellow,
-    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