diff_matcher 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 269ffc7ffb370219902eab20adbb33123e12de62
-  data.tar.gz: eeae047d47e866671da62f7fb2f6c5723cf9e935
+SHA256:
+  metadata.gz: ae30490620e0407789851f3b58ecdbf8c0de16b4ec6695b19a77d1809cadfe59
+  data.tar.gz: a00b708d6ded4b931c75858c41040e10fc4362d3fbeb55c2f6f63ee8eaf20164
 SHA512:
-  metadata.gz: 826869c482e6c5a60b9b6132e19dd64296be1d7aafa12d66e580d309f624806ee43724bc3cebc2ff78039eca8362e6cde7fe798eba9b351f570b26240ca206cd
-  data.tar.gz: b76a7c7ceec440089b683436969a73b88730a28e670ce0e4565dd79d0f0192f116fae79c4f3bcf1d7dd0a48a5648b29a24b247c66cce5ae1f144601d954a42b3
+  metadata.gz: 35619bf1f55bdb50a50f69e90483c233236cec6bce7f721dcf8e007533653cadec5b492499d795de648af323d31c4d4142a60daac2386d37641ee41a354c7fa9
+  data.tar.gz: 47a9e874d8da2f0d5b623b5077487d1b07138a6d74d04eae2ee32c873f841332cc4ffc26e9cc61c36402176a6636ba2c0b14b56985a24136475261b709b3a9af

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v2.8.0
+
+* Add new diff-* executables for matching JSON & CSV files on the command line
+
 ### v2.7.1
 
 * Use `failure_message` from RSpec matchers in diff output. (denyago)

data/README.md

@@ -34,7 +34,7 @@ actual   = { :a=>{ :a1=>10, :a2=>12 }, :b=>[ 21     ], :c=>'3' , :d=>4     , :e=
 puts DiffMatcher::difference(expected, actual, :color_scheme=>:white_background)
 ```
 
-![example output](https://raw.github.com/playup/diff_matcher/master/doc/diff_matcher.gif)
+![example output](https://raw.github.com/diff-matcher/diff_matcher/master/doc/diff_matcher.gif)
 
 
 Installation
@@ -437,6 +437,75 @@ Finished in 0.00601 seconds
 ```
 
 
+Comparing to built-in rspec matcher
+---
+RSpec 3 now has a built-in complex matcher:
+``` ruby
+RSpec.describe "a complex example" do
+  let(:response) {{person: {first_name: "Noel", last_name: "Rappin"},
+                  company: {name: "Table XI", url: "www.tablexi.com"}}}
+
+  it "gets the right response" do
+    expect(response).to match({
+      person: {first_name: "Avdi", last_name: "Grim"},
+      company: {name: "ShipRise", url: a_string_matching(/tablexi/)}
+    })
+  end
+end
+```
+
+With `--color` set, will result in:
+
+![built-in complex matcher](https://raw.github.com/diff-matcher/diff_matcher/master/doc/builtin_complex_matcher.png)
+
+
+But using `diff_matcher`:
+``` ruby
+require "diff_matcher/rspec_3"
+
+RSpec.describe "a complex example" do
+  let(:response) {{person: {first_name: "Noel", last_name: "Rappin"},
+                  company: {name: "Table XI", url: "www.tablexi.com"}}}
+
+  it "gets the right response" do
+    expect(response).to be_matching({
+      person: {first_name: "Avdi", last_name: "Grim"},
+      company: {name: "ShipRise", url: /tablexi/}
+    }).with_options(quiet: false)
+  end
+end
+```
+
+With `--color` set, will result in:
+
+![diff-matcher](https://raw.github.com/diff-matcher/diff_matcher/master/doc/diff_matcher.png)
+
+ie. by making these changes:
+``` diff
+--- more_tapas_spec.rb  2017-03-02 19:51:26.000000000 +1100
++++ even_more_tapas_spec.rb 2017-03-02 20:41:52.000000000 +1100
+@@ -1,11 +1,13 @@
++require "diff_matcher/rspec_3"
++
+ RSpec.describe "a complex example" do
+   let(:response) {{person: {first_name: "Noel", last_name: "Rappin"},
+                   company: {name: "Table XI", url: "www.tablexi.com"}}}
+
+   it "gets the right response" do
+-    expect(response).to match({
++    expect(response).to be_matching({
+       person: {first_name: "Avdi", last_name: "Grim"},
+-      company: {name: "ShipRise", url: a_string_matching(/tablexi/)}
+-    })
++      company: {name: "ShipRise", url: /tablexi/}
++    }).with_options(quiet: false)
+   end
+ end
+```
+
+NB. Its not as easy to see with RSpec's built-in complex matcher that the url actually matched in the above example.
+
+
 Contributing
 ---
 

data/TODO.txt

@@ -12,3 +12,7 @@ ie. by matching `actual` against an `expected` value/pattern/class/proc.
 Wed Dec 14 2011
 - underline
 - string diff
+
+
+Sat Nov 14 2020
+- add tests for exe/diff-* executables

data/diff_matcher.gemspec

@@ -22,4 +22,6 @@ EOF
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^#{s.bindir}/}) { |f| File.basename(f) }
 end

data/doc/even_more_tapas_spec.rb

@@ -0,0 +1,13 @@
+require "diff_matcher/rspec_3"
+
+RSpec.describe "a complex example" do
+  let(:response) {{person: {first_name: "Noel", last_name: "Rappin"},
+                  company: {name: "Table XI", url: "www.tablexi.com"}}}
+
+  it "gets the right response" do
+    expect(response).to be_matching({
+      person: {first_name: "Avdi", last_name: "Grim"},
+      company: {name: "ShipRise", url: /tablexi/}
+    }).with_options(quiet: false)
+  end
+end

data/doc/more_tapas_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe "a complex example" do
+  let(:response) {{person: {first_name: "Noel", last_name: "Rappin"},
+                  company: {name: "Table XI", url: "www.tablexi.com"}}}
+
+  it "gets the right response" do
+    expect(response).to match({
+      person: {first_name: "Avdi", last_name: "Grim"},
+      company: {name: "ShipRise", url: a_string_matching(/tablexi/)}
+    })
+  end
+end

data/exe/diff-csv

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Given:
+#   --- languages-v1.tsv ---
+#   id	name	author	first_appeared	stable_release
+#   1	ruby	Yukihiro Matsumoto	1995	2.7.1
+#   2	python	Guido van Rossum	1991	3.9.0
+#   3	jq	Stephen Dolan	2013	1.6
+#   --- languages-v1.tsv ---
+#
+#   --- languages-v2.tsv ---
+#   id	name	author	first_appeared	stable_release
+#   1	ruby	Yukihiro Matsumoto	1995	2.7.2
+#   2	python	Guido van Rossum	1991	3.9.0
+#   3	jq	Stephen Dolan	2013	1.6
+#   --- languages-v2.tsv ---
+#
+# Examples:
+#   > diff-csv languages-v1.tsv languages-v2.tsv
+#   {
+#     1=>{
+#       "stable_release"=>- "2.7.1"+ "2.7.2"
+#     }
+#   }
+#   Where, - 1 missing, + 1 additional
+#
+#   > VERBOSE=1 diff-csv languages-v{1,2}.tsv
+#   {
+#     1=>{
+#       "name"=>"ruby",
+#       "author"=>"Yukihiro Matsumoto",
+#       "first_appeared"=>1995,
+#       "stable_release"=>- "2.7.1"+ "2.7.2"
+#     },
+#     2=>{
+#       "name"=>"python",
+#       "author"=>"Guido van Rossum",
+#       "first_appeared"=>1991,
+#       "stable_release"=>"3.9.0"
+#     },
+#     3=>{
+#       "name"=>"jq",
+#       "author"=>"Stephen Dolan",
+#       "first_appeared"=>2013,
+#       "stable_release"=>1.6
+#     }
+#   }
+#   Where, - 1 missing, + 1 additional
+#
+#   > KEY=name diff-csv languages-v{1,2}.tsv
+#   {
+#     "ruby"=>{
+#       "stable_release"=>- "2.7.1"+ "2.7.2"
+#     }
+#   }
+#   Where, - 1 missing, + 1 additional
+
+require 'csv'
+require 'diff_matcher'
+
+COL_SEP=ENV.fetch("COL_SEP", "\t")
+KEY=ENV.fetch("KEY", "id")
+
+
+def fix_nulls(h)
+  h.each { |k, v| h[k] = (v == 'NULL' ? nil : v) }
+end
+
+def records(file, key=KEY, col_sep=COL_SEP)
+  CSV(file, col_sep: COL_SEP, headers: true, converters: :all).inject({}) do |h, row|
+    data = fix_nulls(row.to_hash)
+    h.update(data.delete(key)=> data)
+  end
+end
+
+data0 = records(File.open(ARGV[0]))
+data1 = records(File.open(ARGV[1]))
+
+diff_opts = {
+  color_enabled: true,
+  ignore_additional: ENV['IGNORE_ADDITIONAL'],
+  quiet: !ENV['VERBOSE']
+}
+
+diff=DiffMatcher.difference(data0, data1, diff_opts)
+
+if diff
+  puts diff
+  exit 1
+end

data/exe/diff-json

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'diff_matcher'
+require 'json'
+
+expected, actual = ARGV.first(2).map do |f|
+  JSON.parse(File.read(f))
+end
+
+diff=DiffMatcher.difference(expected, actual, color_scheme: :default)
+
+if diff
+  puts diff
+  exit 1
+end

data/exe/diff-mysql

@@ -0,0 +1,93 @@
+#!/bin/bash -e
+# Examples:
+#   # Show diff between the TABLES in two databases
+#   TABLES="languages" diff-mysql database1 database2
+#
+#   # Show diff between languages TABLES skipping any output containing 'python'
+#   FILTER_CMD='grep -v python' TABLES=languages diff-mysql database{1,2}
+#
+#   # Filter at the database level instead
+#   FILTER_SQL="WHERE languages.name = 'python'" TABLES=languages diff-mysql database{1,2}
+#
+set -eo pipefail
+
+DB_USERNAME=${DB_USERNAME:-root}
+DB_PASSWORD=${DB_PASSWORD:-password}
+DB_HOST=${DB_HOST:-localhost}
+
+MAX_ROW_COUNT=${MAX_ROW_COUNT:-100}
+SKIP=${SKIP:-messages}
+
+DB_NAME1=$1
+DB_NAME2=$2
+
+puts() { local color=$1; local prefix=$2; local msg=$3
+  echo -e "[$(date +%Y%m%d%H%M%S)] [${color};1m${prefix}:[${color}m $msg" 1>&2
+}
+
+info()    { local msg=$*; puts 34 INFO "$msg"   ; }
+success() { local msg=$*; puts 32 SUCCESS "$msg"; }
+error()   { local msg=$*; puts 31 ERROR "$msg"  ; }
+
+skip() { local name=$1
+  for skip_name in $SKIP; do
+    [ "$skip_name" == "$name" ] && return 0
+  done
+  return 1
+}
+
+do_mysql() { local db_name="$1"; shift
+  mysql "$@" --user="$DB_USERNAME" --password="$DB_PASSWORD" --host="$DB_HOST" "$db_name" 2> /dev/null
+}
+
+do_mysql_silent() { local db_name=$1
+  do_mysql "$db_name" --silent
+}
+
+tables() { local db_name=$1
+  info "Fetching table names from database $db_name (host '$DB_HOST') ..."
+  echo "show tables" |
+  do_mysql_silent "$db_name"
+}
+TABLES=${TABLES:-$(tables "$DB_NAME1")}
+
+count_rows() { local table=$1; local db_name=$2
+  echo "select count(id) from $table" |
+  do_mysql_silent "$db_name"
+}
+
+diff_cmd() {
+  #diff -u $@
+  COLOR_ENABLED=1 ${DIFF_CMD:-diff-csv} "$@"
+}
+
+filter_cmd() {
+  ${FILTER_CMD:-cat}
+}
+
+dump_table() { local table=$1; local db_name=$2
+  echo "$(echo 'SELECT *') FROM $table ${FILTER_SQL}" |
+  do_mysql "$db_name" |
+  filter_cmd
+}
+
+table_diff() { local table="$1"
+  info "Diffing $table ($DB_NAME1 vs $DB_NAME2)"
+  diff_cmd <(dump_table "$table" {"$DB_NAME1","$DB_NAME2"})
+}
+
+
+exit_code=0
+for table in $TABLES; do
+  row_count=$(count_rows "$table" "$DB_NAME1")
+  if [ $row_count -lt $MAX_ROW_COUNT ]; then
+    if skip "$table"; then
+      info "Skipping $table (as it was referenced in SKIP)"
+    else
+      table_diff "$table" || exit_code=$?
+    fi
+  else
+    info "Skipping $table (as row count exceeds MAX_ROW_COUNT, $row_count > $MAX_ROW_COUNT)"
+  fi
+done
+exit $exit_code

data/lib/diff_matcher/version.rb

@@ -1,3 +1,3 @@
 module DiffMatcher
-  VERSION = "2.7.1"
+  VERSION = "2.8.0"
 end

metadata

@@ -1,21 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: diff_matcher
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - locochris
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies: []
 description: |
   DiffMatcher matches input data (eg. from a JSON API) against values,
   ranges, classes, regexes, procs, custom matchers and/or easily composed,
   nested combinations thereof to produce an easy to read diff string.
 email: chris@locomote.com.au
-executables: []
+executables:
+- diff-csv
+- diff-json
+- diff-mysql
 extensions: []
 extra_rdoc_files: []
 files:
@@ -28,8 +31,15 @@ files:
 - Rakefile
 - TODO.txt
 - diff_matcher.gemspec
+- doc/builtin_complex_matcher.png
 - doc/diff_matcher.gif
+- doc/diff_matcher.png
+- doc/even_more_tapas_spec.rb
 - doc/example_output.png
+- doc/more_tapas_spec.rb
+- exe/diff-csv
+- exe/diff-json
+- exe/diff-mysql
 - lib/diff_matcher.rb
 - lib/diff_matcher/difference.rb
 - lib/diff_matcher/escape_to_html.rb
@@ -66,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Generates a diff by matching against user-defined matchers written in ruby.
@@ -74,4 +84,3 @@ test_files:
 - spec/diff_matcher/difference_spec.rb
 - spec/diff_matcher/rspec/matchers/diff_matcher_spec.rb
 - spec/spec_helper.rb
-has_rdoc: