super_diff 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3338e91a7e03a6c0447a56b0c612653bd8f56f27a95ebeba081546dea8fdc7da
-  data.tar.gz: c840b79a7dd98e31cce823df4bdb67b704dec07ae340c889c86d38bae735ea41
+  metadata.gz: '08f4b984e0530c5c4ca5e1ba34b98b380a76712009a1b552a5e21106975293aa'
+  data.tar.gz: 12b49818665c952553c0b052e3fe8166de0c45a5eac7f9862c317560e0a06763
 SHA512:
-  metadata.gz: 78535779a6e462100afb0ec019ea0b1241e5f6710c40005150d3d8784d34227dc0b549de20fe3dbbc453b6563903df78fc21925701f8d5c7f0d3d466c8345641
-  data.tar.gz: 5a049b0606ae5ff5ac18978e8591ede3edcdcecf6e48eb58ced6655527b481bf2f4a17623c981b902c5ea86295e3dc9bd633905502113edbc162724edd475389
+  metadata.gz: c6df90629d86a0c50680b10803cd1839ba0c94828627775fa840e1726fc70b57c6b13be7614ff35c00af960f3ea05530af6ba2d7dc7a3b9f9670fa8d17f75c72
+  data.tar.gz: 56015f9b40eb6f8b03be2c7b02dc641ea7493db0d7d4a8dae929753f7bf94d9a925f0678b8f68c1c2bf7eb705e2c019b3b38f7bfafb805379d8b37b9016f453d

data/README.md

@@ -2,7 +2,7 @@
 
 [version-badge]: http://img.shields.io/gem/v/super_diff.svg
 [rubygems]: http://rubygems.org/gems/super_diff
-[gh-actions-badge]: http://img.shields.io/github/workflow/status/mcmire/super_diff/SuperDiff/master
+[gh-actions-badge]: https://img.shields.io/github/actions/workflow/status/mcmire/super_diff/super_diff.yml?branch=master
 [downloads-badge]: http://img.shields.io/gem/dtv/super_diff.svg
 [hound]: https://houndci.com
 [issuehunt-badge]: https://img.shields.io/badge/sponsored_through-IssueHunt-2EC28C
@@ -36,7 +36,7 @@ the output it produces leaves much to be desired.
 For instance,
 let's say you wanted to compare these two hashes:
 
-``` ruby
+```ruby
 actual = {
   customer: {
     person: SuperDiff::Test::Person.new(name: "Marty McFly, Jr.", age: 17),
@@ -48,11 +48,7 @@ actual = {
     }
   },
   items: [
-    {
-      name: "Fender Stratocaster",
-      cost: 100_000,
-      options: ["red", "blue", "green"]
-    },
+    { name: "Fender Stratocaster", cost: 100_000, options: %w[red blue green] },
     { name: "Mattel Hoverboard" }
   ]
 }
@@ -68,11 +64,7 @@ expected = {
     }
   },
   items: [
-    {
-      name: "Fender Stratocaster",
-      cost: 100_000,
-      options: ["red", "blue", "green"]
-    },
+    { name: "Fender Stratocaster", cost: 100_000, options: %w[red blue green] },
     { name: "Chevy 4x4" }
   ]
 }
@@ -80,7 +72,7 @@ expected = {
 
 If, somewhere in a test, you were to say:
 
-``` ruby
+```ruby
 expect(actual).to eq(expected)
 ```
 
@@ -107,7 +99,7 @@ depending on your type of project.
 If you're developing a Rails app,
 add the following to your Gemfile:
 
-``` ruby
+```ruby
 group :test do
   gem "super_diff"
 end
@@ -116,7 +108,7 @@ end
 After running `bundle install`,
 add the following to your `rails_helper`:
 
-``` ruby
+```ruby
 require "super_diff/rspec-rails"
 ```
 
@@ -126,14 +118,14 @@ If you're developing an app using Hanami or Sinatra,
 or merely using a part of Rails such as ActiveModel,
 add the following to your Gemfile where appropriate:
 
-``` ruby
+```ruby
 gem "super_diff"
 ```
 
 After running `bundle install`,
 add the following to your `spec_helper`:
 
-``` ruby
+```ruby
 require "super_diff/rspec"
 require "super_diff/active_support"
 ```
@@ -143,13 +135,13 @@ require "super_diff/active_support"
 If you're developing a gem,
 add the following to your gemspec:
 
-``` ruby
+```ruby
 spec.add_development_dependency "super_diff"
 ```
 
 Now add the following to your `spec_helper`:
 
-``` ruby
+```ruby
 require "super_diff/rspec"
 ```
 
@@ -161,7 +153,7 @@ to your test helper file
 (`rails_helper` or `spec_helper`)
 which looks something like this:
 
-``` ruby
+```ruby
 SuperDiff.configure do |config|
   # ...
 end
@@ -172,7 +164,7 @@ end
 If you don't like the colors that SuperDiff uses,
 you can change them like this:
 
-``` ruby
+```ruby
 SuperDiff.configure do |config|
   config.actual_color = :green
   config.expected_color = :red
@@ -184,6 +176,53 @@ end
 See [eight_bit_color.rb](lib/super_diff/csi/eight_bit_color.rb)
 for the list of available colors.
 
+You can also completely disable colorized output.
+
+<!-- prettier-ignore-start -->
+```ruby
+SuperDiff.configure do |config|
+  config.color_enabled = false
+  end
+```
+<!-- prettier-ignore-end -->
+
+### Disabling the key
+
+You can disable the key by changing the following config (default: true):
+
+<!-- prettier-ignore-start -->
+```ruby
+SuperDiff.configure do |config|
+  config.key_enabled = false
+end
+```
+<!-- prettier-ignore-end -->
+
+### Hiding unimportant lines
+
+When looking at a large diff for which many of the lines do not change,
+it can be difficult to locate the lines which do. Text-oriented
+diffs such as those you get from a conventional version control system
+solve this problem by removing those unchanged lines from the diff
+entirely. The same can be done in SuperDiff.
+
+```ruby
+SuperDiff.configure do |config|
+  config.diff_elision_enabled = false
+  config.diff_elision_maximum = 3
+end
+```
+
+- `diff_elision_enabled` — The elision logic is disabled by default so
+  as not to surprise people, so setting this to `true` will turn it on.
+- `diff_elision_maximum` — This number controls what happens to
+  unchanged lines (i.e. lines that are neither "insert" lines nor
+  "delete" lines) that are in between changed lines. If a section of
+  unchanged lines is beyond this number, the gem will elide (a fancy
+  word for remove) the data structures within that section as much as
+  possible until the limit is reached or it cannot go further. Elided
+  lines are replaced with a `# ...` marker.
+
 ### Diffing custom objects
 
 If you are comparing two data structures
@@ -197,7 +236,7 @@ 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
+```ruby
 SuperDiff.configure do |config|
   config.add_extra_differ_class(YourDiffer)
   config.add_extra_operation_tree_builder_class(YourOperationTreeBuilder)
@@ -231,9 +270,9 @@ I'll get notified right away!
 ## Compatibility
 
 `super_diff` is [tested][gh-actions] to work with
-Ruby >= 2.5.x,
+Ruby >= 3.x,
 RSpec 3.x,
-and Rails >= 5.x.
+and Rails >= 6.x.
 
 [gh-actions]: https://github.com/mcmire/super_diff/actions?query=workflow%3ASuperDiff
 
@@ -242,10 +281,10 @@ and Rails >= 5.x.
 In developing this gem
 I made use of or was heavily inspired by these libraries:
 
-* [Diff::LCS][diff-lcs],
+- [Diff::LCS][diff-lcs],
   the library I started with in the [original version of this gem][original-version]
   (made in 2011!)
-* The pretty-printing algorithms and API within [PrettyPrinter][pretty-printer] and [AwesomePrint][awesome-print],
+- The pretty-printing algorithms and API within [PrettyPrinter][pretty-printer] and [AwesomePrint][awesome-print],
   from which I borrowed ideas to develop the [inspectors][inspection-tree].
 
 Thank you to the authors of these libraries!

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

@@ -3,8 +3,7 @@ module SuperDiff
     module Differs
       class ActiveRecordRelation < SuperDiff::Differs::Base
         def self.applies_to?(expected, actual)
-          expected.is_a?(::Array) &&
-            actual.is_a?(::ActiveRecord::Relation)
+          expected.is_a?(::Array) && actual.is_a?(::ActiveRecord::Relation)
         end
 
         protected

data/lib/super_diff/active_record/differs.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module Differs
       autoload(
         :ActiveRecordRelation,
-        "super_diff/active_record/differs/active_record_relation",
+        "super_diff/active_record/differs/active_record_relation"
       )
     end
   end

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

@@ -8,35 +8,39 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text do |object|
-                  "#<#{object.class} "
-                end
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<#{object.class} "
 
-                when_rendering_to_lines do
-                  add_text "{"
+                # stree-ignore
+                t2.when_rendering_to_lines do |t3|
+                  t3.add_text "{"
                 end
               end
 
-              nested do |object|
-                insert_separated_list(
-                  ["id"] + (object.attributes.keys.sort - ["id"]),
-                ) do |name|
-                  as_prefix_when_rendering_to_lines do
-                    add_text "#{name}: "
+              t1.nested do |t2|
+                t2.insert_separated_list(
+                  ["id"] + (object.attributes.keys.sort - ["id"])
+                ) do |t3, name|
+                  t3.as_prefix_when_rendering_to_lines do |t4|
+                    t4.add_text "#{name}: "
                   end
 
-                  add_inspection_of object.read_attribute(name)
+                  t3.add_inspection_of object.read_attribute(name)
                 end
               end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                when_rendering_to_lines do
-                  add_text "}"
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                # stree-ignore
+                t2.when_rendering_to_lines do |t3|
+                  t3.add_text "}"
                 end
 
-                add_text ">"
+                t2.add_text ">"
               end
             end
           end

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

@@ -8,17 +8,24 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<ActiveRecord::Relation ["
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<ActiveRecord::Relation ["
               end
 
-              nested do |array|
-                insert_array_inspection_of(array)
+              # stree-ignore
+              t1.nested do |t2|
+                t2.insert_array_inspection_of(object)
               end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text "]>"
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text "]>"
               end
             end
           end

data/lib/super_diff/active_record/object_inspection/inspection_tree_builders.rb

@@ -4,11 +4,11 @@ module SuperDiff
       module InspectionTreeBuilders
         autoload(
           :ActiveRecordModel,
-          "super_diff/active_record/object_inspection/inspection_tree_builders/active_record_model",
+          "super_diff/active_record/object_inspection/inspection_tree_builders/active_record_model"
         )
         autoload(
           :ActiveRecordRelation,
-          "super_diff/active_record/object_inspection/inspection_tree_builders/active_record_relation",
+          "super_diff/active_record/object_inspection/inspection_tree_builders/active_record_relation"
         )
       end
     end

data/lib/super_diff/active_record/object_inspection.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module ObjectInspection
       autoload(
         :InspectionTreeBuilders,
-        "super_diff/active_record/object_inspection/inspection_tree_builders",
+        "super_diff/active_record/object_inspection/inspection_tree_builders"
       )
     end
   end

data/lib/super_diff/active_record/operation_tree_builders/active_record_model.rb

@@ -4,8 +4,7 @@ module SuperDiff
       class ActiveRecordModel < SuperDiff::OperationTreeBuilders::CustomObject
         def self.applies_to?(expected, actual)
           expected.is_a?(::ActiveRecord::Base) &&
-            actual.is_a?(::ActiveRecord::Base) &&
-            expected.class == actual.class
+            actual.is_a?(::ActiveRecord::Base) && expected.class == actual.class
         end
 
         protected

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

@@ -3,8 +3,7 @@ module SuperDiff
     module OperationTreeBuilders
       class ActiveRecordRelation < SuperDiff::OperationTreeBuilders::Array
         def self.applies_to?(expected, actual)
-          expected.is_a?(::Array) &&
-            actual.is_a?(::ActiveRecord::Relation)
+          expected.is_a?(::Array) && actual.is_a?(::ActiveRecord::Relation)
         end
 
         def initialize(actual:, **rest)

data/lib/super_diff/active_record/operation_tree_builders.rb

@@ -3,11 +3,11 @@ module SuperDiff
     module OperationTreeBuilders
       autoload(
         :ActiveRecordModel,
-        "super_diff/active_record/operation_tree_builders/active_record_model",
+        "super_diff/active_record/operation_tree_builders/active_record_model"
       )
       autoload(
         :ActiveRecordRelation,
-        "super_diff/active_record/operation_tree_builders/active_record_relation",
+        "super_diff/active_record/operation_tree_builders/active_record_relation"
       )
     end
   end

data/lib/super_diff/active_record/operation_tree_flatteners.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module OperationTreeFlatteners
       autoload(
         :ActiveRecordRelation,
-        "super_diff/active_record/operation_tree_flatteners/active_record_relation",
+        "super_diff/active_record/operation_tree_flatteners/active_record_relation"
       )
     end
   end

data/lib/super_diff/active_record/operation_trees.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module OperationTrees
       autoload(
         :ActiveRecordRelation,
-        "super_diff/active_record/operation_trees/active_record_relation",
+        "super_diff/active_record/operation_trees/active_record_relation"
       )
     end
   end

data/lib/super_diff/active_record.rb

@@ -3,34 +3,26 @@ require "super_diff/active_support"
 module SuperDiff
   module ActiveRecord
     autoload :Differs, "super_diff/active_record/differs"
-    autoload(
-      :ObjectInspection,
-      "super_diff/active_record/object_inspection",
-    )
-    autoload(
-      :OperationTrees,
-      "super_diff/active_record/operation_trees",
-    )
+    autoload(:ObjectInspection, "super_diff/active_record/object_inspection")
+    autoload(:OperationTrees, "super_diff/active_record/operation_trees")
     autoload(
       :OperationTreeBuilders,
-      "super_diff/active_record/operation_tree_builders",
+      "super_diff/active_record/operation_tree_builders"
     )
     autoload(
       :OperationTreeFlatteners,
-      "super_diff/active_record/operation_tree_flatteners",
+      "super_diff/active_record/operation_tree_flatteners"
     )
 
     SuperDiff.configure do |config|
-      config.add_extra_differ_classes(
-        Differs::ActiveRecordRelation,
-      )
+      config.add_extra_differ_classes(Differs::ActiveRecordRelation)
       config.add_extra_operation_tree_builder_classes(
         OperationTreeBuilders::ActiveRecordModel,
-        OperationTreeBuilders::ActiveRecordRelation,
+        OperationTreeBuilders::ActiveRecordRelation
       )
       config.add_extra_inspection_tree_builder_classes(
         ObjectInspection::InspectionTreeBuilders::ActiveRecordModel,
-        ObjectInspection::InspectionTreeBuilders::ActiveRecordRelation,
+        ObjectInspection::InspectionTreeBuilders::ActiveRecordRelation
       )
     end
   end

data/lib/super_diff/active_support/differs/hash_with_indifferent_access.rb

@@ -4,13 +4,12 @@ module SuperDiff
       class HashWithIndifferentAccess < SuperDiff::Differs::Hash
         def self.applies_to?(expected, actual)
           (
-            expected.is_a?(::HashWithIndifferentAccess) &&
-              actual.is_a?(::Hash)
+            expected.is_a?(::HashWithIndifferentAccess) && actual.is_a?(::Hash)
           ) ||
-          (
-            expected.is_a?(::Hash) &&
-              actual.is_a?(::HashWithIndifferentAccess)
-          )
+            (
+              expected.is_a?(::Hash) &&
+                actual.is_a?(::HashWithIndifferentAccess)
+            )
         end
 
         protected

data/lib/super_diff/active_support/differs.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module Differs
       autoload(
         :HashWithIndifferentAccess,
-        "super_diff/active_support/differs/hash_with_indifferent_access",
+        "super_diff/active_support/differs/hash_with_indifferent_access"
       )
     end
   end

data/lib/super_diff/active_support/object_inspection/inspection_tree_builders/hash_with_indifferent_access.rb

@@ -8,25 +8,34 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<HashWithIndifferentAccess {"
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<HashWithIndifferentAccess {"
               end
 
-              when_rendering_to_string do
-                add_text " "
+              # stree-ignore
+              t1.when_rendering_to_string do |t2|
+                t2.add_text " "
               end
 
-              nested do |hash|
-                insert_hash_inspection_of(hash)
+              # stree-ignore
+              t1.nested do |t2|
+                t2.insert_hash_inspection_of(object)
               end
 
-              when_rendering_to_string do
-                add_text " "
+              # stree-ignore
+              t1.when_rendering_to_string do |t2|
+                t2.add_text " "
               end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text "}>"
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text "}>"
               end
             end
           end

data/lib/super_diff/active_support/object_inspection/inspection_tree_builders/ordered_options.rb

@@ -0,0 +1,46 @@
+module SuperDiff
+  module ActiveSupport
+    module ObjectInspection
+      module InspectionTreeBuilders
+        class OrderedOptions < SuperDiff::ObjectInspection::InspectionTreeBuilders::Hash
+          def self.applies_to?(value)
+            value.is_a?(::ActiveSupport::OrderedOptions)
+          end
+
+          def call
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<OrderedOptions {"
+              end
+
+              # stree-ignore
+              t1.when_rendering_to_string do |t2|
+                t2.add_text " "
+              end
+
+              # stree-ignore
+              t1.nested do |t2|
+                t2.insert_hash_inspection_of(object.to_hash)
+              end
+
+              # stree-ignore
+              t1.when_rendering_to_string do |t2|
+                t2.add_text " "
+              end
+
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text "}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/active_support/object_inspection/inspection_tree_builders.rb

@@ -4,7 +4,11 @@ module SuperDiff
       module InspectionTreeBuilders
         autoload(
           :HashWithIndifferentAccess,
-          "super_diff/active_support/object_inspection/inspection_tree_builders/hash_with_indifferent_access",
+          "super_diff/active_support/object_inspection/inspection_tree_builders/hash_with_indifferent_access"
+        )
+        autoload(
+          :OrderedOptions,
+          "super_diff/active_support/object_inspection/inspection_tree_builders/ordered_options"
         )
       end
     end

data/lib/super_diff/active_support/object_inspection.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module ObjectInspection
       autoload(
         :InspectionTreeBuilders,
-        "super_diff/active_support/object_inspection/inspection_tree_builders",
+        "super_diff/active_support/object_inspection/inspection_tree_builders"
       )
     end
   end

data/lib/super_diff/active_support/operation_tree_builders/hash_with_indifferent_access.rb

@@ -4,13 +4,12 @@ module SuperDiff
       class HashWithIndifferentAccess < SuperDiff::OperationTreeBuilders::Hash
         def self.applies_to?(expected, actual)
           (
-            expected.is_a?(::HashWithIndifferentAccess) &&
-              actual.is_a?(::Hash)
+            expected.is_a?(::HashWithIndifferentAccess) && actual.is_a?(::Hash)
           ) ||
-          (
-            expected.is_a?(::Hash) &&
-              actual.is_a?(::HashWithIndifferentAccess)
-          )
+            (
+              expected.is_a?(::Hash) &&
+                actual.is_a?(::HashWithIndifferentAccess)
+            )
         end
 
         def initialize(expected:, actual:, **rest)

data/lib/super_diff/active_support/operation_tree_builders.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module OperationTreeBuilders
       autoload(
         :HashWithIndifferentAccess,
-        "super_diff/active_support/operation_tree_builders/hash_with_indifferent_access",
+        "super_diff/active_support/operation_tree_builders/hash_with_indifferent_access"
       )
     end
   end

data/lib/super_diff/active_support/operation_tree_flatteners.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module OperationTreeFlatteners
       autoload(
         :HashWithIndifferentAccess,
-        "super_diff/active_support/operation_tree_flatteners/hash_with_indifferent_access",
+        "super_diff/active_support/operation_tree_flatteners/hash_with_indifferent_access"
       )
     end
   end

data/lib/super_diff/active_support/operation_trees.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module OperationTrees
       autoload(
         :HashWithIndifferentAccess,
-        "super_diff/active_support/operation_trees/hash_with_indifferent_access",
+        "super_diff/active_support/operation_trees/hash_with_indifferent_access"
       )
     end
   end