super_diff 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a490a3241bf9e0d7c6086d13d1b60b02054839edbcf3bd1516db488cafab1449
-  data.tar.gz: da592d721f010fefa021348aefa832e05c07cecc4fdae7588c6bcb4696e45263
+  metadata.gz: 31484b874ef6086f57dd96cf538d32692040bcfe20df0b5a03ffb2d37528e178
+  data.tar.gz: ffe9ee2546b907b77018edfc856b207384c111f8d59dcdae54c6148cf1cf6cec
 SHA512:
-  metadata.gz: 0df2d46d7863e1cae93aa6f1760b4de7b45d34a333570a82ef39278bfd7b49ea8d2dd4d21e3d19dfdd427ffd42486a32c96400cf3755c196382358ed638d06ec
-  data.tar.gz: d86b0ac244443fa75f3ab51c6377818dc942bc9fe2b44b14be78a9595da9267e94b20cd0571cde296ef140ad4fd81f915656330e45c3429c256c13e6298ab932
+  metadata.gz: 7f3a9f593e712569fac26dfc8ae395be685006d641576e317dfbc4aee773c506c833142b76f430b22e3089aa8ad2c8be3aabecb6d50992834db15e5ad4968fd0
+  data.tar.gz: b308ffce611c4bc457115247a9f1a5fb7bf310a78bc9a478fb5c99e6ca2d6fd40070013177d99e372554f0a25615278b094a262226c0460fcc127402aed27f71

data/README.md

@@ -1,31 +1,40 @@
-# 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 Ruby gem that intelligently displays the differences between two
-data structures of any type.
+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.2.0)][changelog].**
+📢 **[See what's changed in the latest version (0.4.2)][changelog].**
 
 [changelog]: CHANGELOG.md
 
 ## Introduction
 
-The primary motivation behind this gem is to replace RSpec's built-in diffing
-capabilities. Sometimes, whenever you use a matcher such as `eq`, `match`,
-`include`, or `have_attributes`, you will get a diff of the two data structures
-you are trying to match against. This is really helpful for strings, but not so
-helpful for other, more "real world" kinds of values, such as arrays, hashes,
-and full-scale objects. The reason this doesn't work is because [all RSpec does
-is run your `expected` and `actual` values through Ruby's PrettyPrinter
-library][rspec-differ-fail] and then perform a diff of these strings.
+The primary motivation behind this gem
+is to vastly improve upon RSpec's built-in diffing capabilities.
 
-For instance, let's say you wanted to compare these two hashes:
+Sometimes, whenever you use a matcher such as `eq`, `match`, `include`, or `have_attributes`,
+you will get a diff of the two data structures you are trying to match against.
+This is great if all you want to do is compare multi-line strings.
+But if you want to compare other, more "real world" kinds of values,
+such as what you might work with when developing API endpoints
+or testing methods that make database calls and return a set of model objects,
+then you are out of luck.
+Since [RSpec merely runs your `expected` and `actual` values through Ruby's PrettyPrinter library][rspec-differ-fail]
+and then performs a diff of these strings,
+the output it produces leaves much to be desired.
+
+[rspec-differ-fail]: https://github.com/rspec/rspec-support/blob/c69a231d7369dd165ad7ce4742e1a2e21e3462b5/lib/rspec/support/differ.rb#L178
+
+For instance,
+let's say you wanted to compare these two hashes:
 
 ``` ruby
 actual = {
@@ -75,44 +84,64 @@ If, somewhere in a test, you were to say:
 expect(actual).to eq(expected)
 ```
 
-You would get output that looks like:
-
-![Before super_diff](doc/before_super_diff.png)
+You would get output that looks like this:
 
-Not great.
+![Before super_diff](docs/before.png)
 
-This library provides a diff engine that knows how to figure out the differences
-between any two data structures and display them in a sensible way. Using the
-example above, you'd get this instead:
+What this library does
+is to provide a diff engine
+that knows how to figure out the differences between any two data structures
+and display them in a sensible way.
+So, using the example above,
+you'd get this instead:
 
-![After super_diff](doc/after_super_diff.png)
-
-[rspec-differ-fail]: https://github.com/rspec/rspec-support/blob/c69a231d7369dd165ad7ce4742e1a2e21e3462b5/lib/rspec/support/differ.rb#L178
+![After super_diff](docs/after.png)
 
 ## Installation
 
-Want to try out this gem for yourself? As with most development-related gems,
-there are a couple ways depending on your type of project:
+There are a few different ways to install `super_diff`
+depending on your type of project.
 
 ### Rails apps
 
-If you're developing a Rails app, add the following to your Gemfile:
+If you're developing a Rails app,
+add the following to your Gemfile:
 
 ``` ruby
-gem "super_diff"
+group :test do
+  gem "super_diff"
+end
 ```
 
-After running `bundle install`, add the following to your `rails_helper`:
+After running `bundle install`,
+add the following to your `rails_helper`:
 
 ``` ruby
 require "super_diff/rspec-rails"
 ```
 
-You're done!
+### Projects using some part of Rails (e.g. ActiveModel)
 
-### Libraries
+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:
 
-If you're developing a library, add the following to your gemspec:
+``` ruby
+gem "super_diff"
+```
+
+After running `bundle install`,
+add the following to your `spec_helper`:
+
+``` ruby
+require "super_diff/rspec"
+require "super_diff/active_support"
+```
+
+### Gems
+
+If you're developing a gem,
+add the following to your gemspec:
 
 ``` ruby
 spec.add_development_dependency "super_diff"
@@ -124,72 +153,76 @@ Now add the following to your `spec_helper`:
 require "super_diff/rspec"
 ```
 
-You're done!
-
 ## Configuration
 
-As capable as this library is, it doesn't know how to deal with every kind of
-object out there. You might find it necessary to instruct the gem on how to diff
-your object. To do this, you can use a configuration block. Simply add this to
-your test helper file (either `rails_helper` or `spec_helper`):
+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`):
 
 ``` 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. Also explanations on what these are.)*
-
-## Contributing
-
-If you encounter a bug or have an idea for how this could be better, feel free
-to [create an issue](https://github.com/mcmire/super_diff/issues).
+*(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.)*
 
-If you'd like to submit a PR instead, here's how to get started. First, fork
-this repo. Then, when you've cloned your fork, run:
+## Support
 
-```
-bundle install
-```
+My goal for this library is to improve your development experience.
+If this is not the case,
+and you encounter a bug or have a suggestion,
+feel free to [create an issue][issues-list].
+I'll try to respond to it as soon as I can!
 
-This will install various dependencies. After this, you can run all of the
-tests: 
+[issues-list]: https://github.com/mcmire/super_diff/issues
 
-```
-bundle exec rake
-```
+## Contributing
 
-Or a single test:
+Any code contributions to improve this library are welcome!
+Please see the [contributing](./CONTRIBUTING.md) document for more on how to do that.
 
-```
-bundle exec rspec spec/acceptance/...
-bundle exec rspec spec/unit/...
-```
+## Sponsoring
 
-Finally, submit your PR and I'll take a look at it when I get a chance.
+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 Ruby >= 2.4.x, RSpec 3.x, and
-Rails >= 5.x.
+`super_diff` is [tested][travis] to work with
+Ruby >= 2.4.x,
+RSpec 3.x,
+and Rails >= 5.x.
 
 [travis]: http://travis-ci.org/mcmire/super_diff
 
 ## Inspiration/Thanks
 
-In developing this gem I made use of or was heavily inspired by these libraries:
+In developing this gem
+I made use of or was heavily inspired by these libraries:
 
-* [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], from which I borrowed ideas to develop
-  the [inspectors][inspection-tree].
+* [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],
+  from which I borrowed ideas to develop the [inspectors][inspection-tree].
 
-Thank you so much!
+Thank you to the authors of these libraries!
 
 [original-version]: https://github.com/mcmire/super_diff/tree/old-master
 [diff-lcs]: https://github.com/halostatue/diff-lcs
@@ -197,6 +230,7 @@ Thank you so much!
 [awesome-print]: https://github.com/awesome-print/awesome_print
 [inspection-tree]: https://github.com/mcmire/super_diff/blob/master/lib/super_diff/object_inspection/inspection_tree.rb
 
-## Copyright/License
+## Author/License
 
-© 2018-2019 Elliot Winkler, released under the [MIT license](LICENSE).
+`super_diff` was created and is maintained by Elliot Winkler.
+It is released under the [MIT license](LICENSE).

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,33 +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
 
-SuperDiff::ObjectInspection.map.prepend(
-  SuperDiff::ActiveRecord::ObjectInspection::MapExtension,
-)
+require "super_diff/active_record/monkey_patches"

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/monkey_patches.rb

@@ -0,0 +1,9 @@
+# rubocop:disable Style/BracesAroundHashParameters, Style/ClassAndModuleChildren
+class ActiveRecord::Base
+  def attributes_for_super_diff
+    (attributes.keys.sort - ["id"]).reduce({ id: id }) do |hash, key|
+      hash.merge(key.to_sym => attributes[key])
+    end
+  end
+end
+# rubocop:enable Style/BracesAroundHashParameters, Style/ClassAndModuleChildren

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