specdiff 0.1.1 → 0.3.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 888c68bf9d22b79bcd5453f24049e375026f150ec28a96fee5610432246a480c
-  data.tar.gz: 82d74700d65c9e0564862d6ae4b615f25381735e2378d0f1a6236b1b945b1c4b
+  metadata.gz: 68cf98631e494fb5f016c0b3632cce58f616dad54ba11c782b37e3de4f2b36c9
+  data.tar.gz: b97fee8a8e586b383a71bf0dcdcb32be7cf1c135356a90ec2ae7488fc2082071
 SHA512:
-  metadata.gz: dbe9750778a84629cabee0b1a70936e471d180d71f38a585d056ca8e723b9b04925591ce4de9536a2b0855e03b1c73ccff10a4716b63358b7c233ee1f80443c8
-  data.tar.gz: a115665ae50487b6decb6ebdddab0d840093702ab2c06d7f5b14536cbbd90ca81d3017c32deb390c325a2572a1e8aa13b9f828fcfa7846b7b5e288efef47a431
+  metadata.gz: b374cadd1aa564cf8252c4b3d6c4ca2be952b147891cdbec9f0799383349bf5bcf61a1ef94979bc2b1f7dbe4d850e586d4c11f1271c74a14dc9be09cffc4e184
+  data.tar.gz: 8379b0c263ae20900ec31b63ea9600e3c15cef8fe9b597c1e1349a708c323d03ee8bfaa46d6f6eeb666e2af0ee751e7ef2cd47917e927eeceb48a7f076a1e126

data/CHANGELOG.md

@@ -1,5 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
+## [0.3.0-rc1]
+
+### Added
+
+- Add rspec integration. `require "specdiff/rspec"` The rspec integration will cause rspec's differ to be replaced entirely with specdiff. It will also cause rspec's inspect (object formatter) to be replaced with Specdiff's inspect.
+- Add `Specdiff.diff_inspect` method, which is a wrapper for `#inspect` with some extra logic to make diffs look better.
+- Add `Specdiff.hashprint` method, which prints hashes/arrays recursively in a way that is friendly to a text differ.
+
+### Changed
+
+- Improve contrast for some elements of the text differ
+- Improve hash diffing. Introduce heuristic that decides whether a text diff of the hashes or the hashdiff gem's output is better for the situation.
+- No longer produces a text diff of booleans
+- No longer produces a text diff if both strings are a single line. (This would be useless since the diff is line-based.)
+
+## [0.2.0] - 2023-12-04
+
+### Changed
+
+- Stop using thread locals ([#1](https://github.com/odinhb/specdiff/pull/1))
+
 ## [0.1.1] - 2023-12-04
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    specdiff (0.1.1)
+    specdiff (0.3.0.pre.rc1)
       diff-lcs (~> 1.5)
       hashdiff (~> 1.0)
 

data/README.md

@@ -11,7 +11,24 @@ dropping the content type requirement.
 Specdiff automagically detects the types of provided data and prints a suitable
 diff between them.
 
-Check out the examples directory to see what it might look like.
+## Cool, what does it look like?
+
+When specdiff is enabled, webmock will produce a generic text diff using
+[`Diff::LCS`](https://github.com/halostatue/diff-lcs) (basically the same
+diff as rspec uses):
+
+![webmock_text_with_specdiff](./assets/webmock_text_with_specdiff.png)
+
+It will also produce a json [hashdiff](https://github.com/liufengyun/hashdiff),
+even if the request did not have the content type header:
+
+![d](./assets/webmock_json_with_specdiff.png)
+
+(The output of the json diff is experimental, feedback would be great!)
+
+You might also check out the `examples/` directory to play with it:
+
+`$ cd examples/webmock && bundle install`
 
 ## Installation
 
@@ -47,8 +64,10 @@ Specdiff.configure do |config|
 end
 ```
 
-The webmock patch should make webmock show diffs from the specdiff gem when
-stubs mismatch.
+### WebMock
+
+The webmock patch should make webmock show request body diffs by using the
+specdiff gem when stubs mismatch. It only applies to request bodies.
 
 ### Direct usage
 
@@ -71,10 +90,13 @@ Specdiff.load!(:json)
 Specdiff.load!(MyCustomType)
 ```
 
-Check out the [source code](./lib/specdiff/plugins/json.rb) to learn the plugin interface.
+[Check out the source code](./lib/specdiff/plugins/json.rb) to learn the plugin interface.
 
 ## Development
 
+Check out the [glossary](./glossary.txt) to make sure you (and I) are using the
+same words for things ;)
+
 Install the software versions specified in `.tool-versions`.
 
 Run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests and linter and make sure they're green before starting to make your changes.
@@ -83,8 +105,43 @@ Run `bundle exec rake -AD` for a full list of all the available tasks you may us
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment with the gem code loaded.
 
+Remember to update the unreleased section of the [changelog](./CHANGELOG.md) before you submit your pull request.
+
+## How it works/"Architecture"
+
+High level description of the heuristic specdiff implements
+
+  1. receive 2 pieces of data: `a` and `b`
+  2. determine types for `a` and `b`
+      1. test against plugin types
+      2. test against built in types
+      3. fall back to the `:unknown` type
+  3. determine which differ is appropriate for the types
+      1. test against plugin differs
+      2. test against built in differs
+      3. fall back to the null differ (`NotFound`)
+  7. run the selected differ with a and b
+  8. package it into a `::Specdiff::Diff` which records the detected types
+
+  \<time passes>
+
+  6. at some point later when `#to_s` is invoked, stringify the diff using the differ's `#stringify`
+
 ## Releasing
 
+### Release procedure
+
+  - [ ] unit tests are passing (`$ bundle exec rake test`)
+  - [ ] linter is happy (`$ bundle exec rake lint`)
+  - [ ] `examples/` look good
+  - [ ] update the version number in `version.rb`
+  - [ ] make sure the `examples/` `Gemfile.lock` files are updated (run bundle install)
+  - [ ] make sure `Gemfile.lock` is updated (run bundle install)
+  - [ ] move unreleased changes to the next version in the [changelog](./CHANGELOG.md)
+  - [ ] commit in the form "vX.X.X" and push
+  - [ ] make sure the pipeline is green
+  - [ ] `$ bundle exec rake release`
+
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
@@ -94,3 +151,12 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/odinhb
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TODO
+
+This documents potential improvements/issues I know about or have thought about.
+
+- [ ] test the webmock monkey-patch. currently there is an empty webmock_spec.rb (should we do this using rspec?) and the examples/ directory contains a few webmock examples (which are a good idea to run before releasing) but it would be nice to have the pipeline fail if it doesn't work for whatever reason
+- [ ] finalize plugin interface (are the methods named intuitively? should we split type detector definitions and differ definitions?)
+- [ ] document how to define a plugin properly (instead of just linking to the source code)
+- [ ] is the stringification of hashdiff's output really better than pretty print? or just more wordy? (the colors are definitely nice)

data/examples/rspec/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--require spec_helper

data/examples/rspec/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "rspec"
+gem "debug"
+gem "specdiff", path: "../../"
+
+# gem "activesupport"
+gem "bigdecimal"

data/examples/rspec/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: ../..
+  specs:
+    specdiff (0.3.0.pre.rc1)
+      diff-lcs (~> 1.5)
+      hashdiff (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bigdecimal (3.1.7)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    hashdiff (1.1.0)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    psych (5.1.2)
+      stringio
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    reline (0.4.3)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    stringio (3.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bigdecimal
+  debug
+  rspec
+  specdiff!
+
+BUNDLED WITH
+   2.3.5