specdiff 0.2.0 → 0.3.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d698240eae3e0f8f38c22b66df23efb1076b14879a7093c3d3e33aebddd37c9
-  data.tar.gz: 29e6198145c5a9ede875a26066a33e599561fe82277c6eb8bdb475c291304c9b
+  metadata.gz: 68cf98631e494fb5f016c0b3632cce58f616dad54ba11c782b37e3de4f2b36c9
+  data.tar.gz: b97fee8a8e586b383a71bf0dcdcb32be7cf1c135356a90ec2ae7488fc2082071
 SHA512:
-  metadata.gz: cb5b52f47732689bc8322b840436d4c27fb048dbe20e9e0d8501b3120137500b7a9230a9818c31e049aa22715c251166d807b4e01111695406470c6b314c13c5
-  data.tar.gz: 103362c058c1e260dc9a9c3f1bd06b06d39ab25c1818e001c7160eb61ceb741d549b4f9c6fb974bb27614456ab2d34dfae6732bc6d842d42346bd62abe1fc331
+  metadata.gz: b374cadd1aa564cf8252c4b3d6c4ca2be952b147891cdbec9f0799383349bf5bcf61a1ef94979bc2b1f7dbe4d850e586d4c11f1271c74a14dc9be09cffc4e184
+  data.tar.gz: 8379b0c263ae20900ec31b63ea9600e3c15cef8fe9b597c1e1349a708c323d03ee8bfaa46d6f6eeb666e2af0ee751e7ef2cd47917e927eeceb48a7f076a1e126

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    specdiff (0.2.0)
+    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
 
@@ -116,10 +133,10 @@ High level description of the heuristic specdiff implements
 
   - [ ] unit tests are passing (`$ bundle exec rake test`)
   - [ ] linter is happy (`$ bundle exec rake lint`)
-  - [ ] `$ cd examples/webmock && bundle install && bundle exec ruby json.rb` looks good
-  - [ ] `$ bundle exec ruby text.rb` looks good
+  - [ ] `examples/` look good
   - [ ] update the version number in `version.rb`
-  - [ ] make sure the `examples/` `Gemfile.lock` files are updated
+  - [ ] 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

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