cevennes 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 598f7e128effec146dbe0acc01bd26101b689a6efdcf647c061416aa43accb53
-  data.tar.gz: b1cf17c58da5e0562100feff9fe40c1eee3cf07a2fc6fab0b724fbd792a240f9
+  metadata.gz: fca28f00b6cf84aa0856a46139b68b338509c834e2b1d274692da6e91285a47f
+  data.tar.gz: 5f3bbcc3b08ecdfa698e1ffa83b75832d938558533a9c2bff25dde682ba441e1
 SHA512:
-  metadata.gz: 9686e580322ab076d7e85506d716aaac8e2d131d9af350b31b2985539bfc8d7a01f2b40dfd23e285e78e620e82dbc2cede2d1840c5d60f72d130b22f16cf3502
-  data.tar.gz: 5bcef831927839276c9ca7f4304d5c6904f37587d4f4654ba88962250eafd59bfc7036ba1ff9f25824e898a2e8f5f87a250f3aa0317a7e1fadd696c4efe97453
+  metadata.gz: 39686c8f08786c2bd98367832b5cd08d2c40720a2cdc12dc6525dd328312a8352224c9727d62656fd0d740babc0584116ead5d284b378ef707a9b8c9d13abd59
+  data.tar.gz: 6929bc321836901230437ced040830ccdd40c10aebfad03a6383c4ee700597d4813f2e85d0a93a3eccf168181deadd85493717362fec285875b7015c25b2bd57

data/CHANGELOG.md

@@ -2,50 +2,60 @@
 # CHANGELOG.md
 
 
+## cevennes 1.4.0  released 2026-10-19
+
+* Bring in .to_pretty_s(diff)
+
+
+## cevennes 1.3.0  released 2022-07-24
+
+* Diff already parsed CSV as well
+
+
 ## cevennes 1.2.0  released 2022-07-05
 
-- Introduce `drop_equals: true`
+* Introduce `drop_equals: true`
 
 
 ## cevennes 1.1.1  released 2021-02-25
 
-- Refine UTF-8 re-encoding
-- Fix `ignore_key_case: true` :-(
-- Clarify reencode
+* Refine UTF-8 re-encoding
+* Fix `ignore_key_case: true` :-(
+* Clarify reencode
 
 
 ## cevennes 1.1.0  released 2021-02-24
 
-- Introduce `ignore_key_case: true`
+* Introduce `ignore_key_case: true`
 
 
 ## cevennes 1.0.0  released 2018-09-07
 
-- Align the "keys" entry on the =+-! entries
+* Align the "keys" entry on the =+-! entries
 
 
 ## cevennes 0.13.0  released 2018-09-07
 
-- Trim cells and keys
+* Trim cells and keys
 
 
 ## cevennes 0.12.0  released 2018-09-06
 
-- Fail with IndexError on missing id in CSV old or new
+* Fail with IndexError on missing id in CSV old or new
 
 
 ## cevennes 0.11.0  released 2018-09-06
 
-- Fix l0 and l1 stats
+* Fix l0 and l1 stats
 
 
 ## cevennes 0.10.0  released 2018-09-03
 
-- Weave in additions at the right spot
-- Indicate line numbers
+* Weave in additions at the right spot
+* Indicate line numbers
 
 
 ## cevennes 0.9.0  released 2018-09-03
 
-- Implement first version of Cevennes.diff(id, cvs0, cvs1)
+* Implement first version of Cevennes.diff(id, cvs0, cvs1)
 

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2018-2022, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2018-2026, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -1,16 +1,19 @@
 
 ## gem tasks ##
 
-NAME = \
-  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
-VERSION = \
-  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
+NAME != \
+  ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name"
+VERSION != \
+  ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version"
 
 count_lines:
 	find lib -name "*.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
 	find spec -name "*_spec.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
 cl: count_lines
 
+scan:
+	scan lib/**/*.rb
+
 gemspec_validate:
 	@echo "---"
 	ruby -e "s = eval(File.read(Dir['*.gemspec'].first)); p s.validate"
@@ -30,10 +33,14 @@ build: gemspec_validate
 push: build
 	gem push --otp "$(OTP)" pkg/$(NAME)-$(VERSION).gem
 
-spec:
-	bundle exec rspec
-test: spec
+test:
+	bundle exec proba
+spec: test
+t: test
+
+colors:
+	bundle exec ruby -rcolorato -e "Colorato.show_colours"
 
 
-.PHONY: count_lines gemspec_validate name cw build push spec
+.PHONY: count_lines scan gemspec_validate name cw build push test
 

data/README.md

@@ -56,6 +56,8 @@ The second entry is a summary of the changes, altered `!` line count, removed `-
 
 The remaining entries are the (non-)changes themselves, from line 1 to the end.
 
+Since 1.3.0, Cevennes accepts CSV strings and parsed CSV (array of arrays).
+
 
 ### drop_equals: true
 

data/cevennes.gemspec

@@ -26,6 +26,7 @@ Diffs CSVs by lines, focusing on a single ID
     'homepage_uri' =>  s.homepage,
     'source_code_uri' => s.homepage,
     #'wiki_uri' => s.homepage + '/wiki',
+    'rubygems_mfa_required' => 'true',
   }
 
   #s.files = `git ls-files`.split("\n")
@@ -39,8 +40,11 @@ Diffs CSVs by lines, focusing on a single ID
 
   #s.add_runtime_dependency 'tzinfo'
   #s.add_runtime_dependency 'raabro', '~> 1.1'
+  s.add_runtime_dependency 'csv'
+  s.add_runtime_dependency 'colorato', '~> 1.2'
 
-  s.add_development_dependency 'rspec', '~> 3.7'
+  #s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'probatio', '~> 1.6'
 
   s.require_path = 'lib'
 end

data/lib/cevennes.rb

@@ -5,14 +5,14 @@ require 'csv'
 
 module Cevennes
 
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 
   class << self
 
     def diff(id, csv0, csv1, opts={})
 
-      h0 = hash('old', id, csv0, opts)
-      h1 = hash('new', id, csv1, opts)
+      h0 = hajh('old', id, csv0, opts)
+      h1 = hajh('new', id, csv1, opts)
 
       ks0 = h0.delete(:keys)
       ks1 = h1.delete(:keys)
@@ -21,12 +21,9 @@ module Cevennes
         h0
           .collect { |k, v|
             v1 = h1[k]
-            if v1 == nil
-              [ '-', *v, -1, nil ]
-            elsif v1[1] == v[1]
-              [ '=', *v, v[0], nil ]
-            else
-              [ '!', *v, *v1 ]
+            if v1 == nil         then [ '-', *v,   -1, nil ]
+            elsif v1[1] == v[1]  then [ '=', *v, v[0], nil ]
+            else                      [ '!', *v,  *v1 ]
             end }
 
       (h1.keys - h0.keys)
@@ -45,6 +42,101 @@ module Cevennes
       [ [ 'keys', *ks0, *ks1 ], [ 'stats', s ] ] + d
     end
 
+    def to_pretty_s(diff, opts={})
+
+      fail ArgumentError.new("to_pretty_s() expects a diff array") \
+        unless is_diff_array?(diff)
+
+      drop_eq = !! (opts[:drop_equals] || opts[:drop_eq])
+
+      c =
+        opts[:no_colours] || opts[:no_colors] ||
+        opts[:no_colour] || opts[:no_color] ?
+          Colorato.no_colours :
+          Colorato.colour_if_supported
+
+      cml = opts[:cell_max_len] || opts[:cell_maxlen] || 28
+
+      _, kl0, ks0, kl1, ks1 = diff[0]
+      _, stats = diff[1]
+
+      dis = diff[2..-1]
+
+      lnl = dis
+        .inject([]) { |a, di| a << di[1].to_s.length << di[3].to_s.length; a }
+        .max
+
+      o = StringIO.new
+
+      o << c.dg << "# diff\n" << c.rs
+
+      o << "\n* length: #{diff.length}\n"
+      o << "\n"
+
+      o << c.dg << "## keys\n\n" << c.rs
+
+      o << "```\n"
+      o << "### ks0\n"
+      o << (' ' * (lnl + 3)) << "# line: #{kl0}, count: #{ks0.size}\n"
+      o << render_row(
+        #ks0, ck: true, rn: kl0, colours: c, bc: c.dark_gray, indent: lnl + 3)
+        ks0, ck: true, colours: c, bc: c.dark_gray, indent: lnl + 3, cml: cml)
+      o << "\n### ks1\n"
+      o << c.rs << (' ' * (lnl + 3)) << "# line: #{kl1}, count: #{ks1.size}\n"
+      if ks1 == ks0
+        o << c.dg << (' ' * (lnl + 3)) << "# (identical)\n" << c.rs
+      else
+        o << render_row(
+          #ks1, ck: true, rn: kl1, colours: c, indent: lnl + 3) << "\n"
+          ks1, ck: true, colours: c, indent: lnl + 3, cml: cml) << "\n"
+      end
+      o << "```\n\n"
+
+      o << c.dg << "## stats\n\n" << c.rs
+      o << "```\n  " << stats.inspect << "\n```\n\n"
+
+      o << c.dg << "## diffs\n\n"
+      o << "```\n"
+
+      diff[2..-1].each do |di|
+
+        next if drop_eq && (di[0] == '=')
+
+        bc =
+          case di[0]
+          when '+' then c.green
+          when '-' then c.red
+          else c.dg; end
+        o << bc
+
+        lnl1 = lnl + 3
+        os = { indent: lnl1, ck: true, colours: c, bc: bc, cml: cml }
+
+        r0 = di[2] ? render_row(di[2], os) : ' ' * (lnl1)
+        r1 = di[4] ? render_row(di[4], os.merge(vs: di[2])) : ' ' * (lnl1)
+
+        o << di[0] << " %#{lnl}d " % di[1] << r0.lstrip << "\n"
+        o << ' ' << " %#{lnl}d " % di[3] << r1.lstrip << "\n"
+
+        o << c.rs
+      end
+      o << "```\n"
+
+      o << c.dg << "\n## done |:." << c.rs
+
+      o.string
+    end
+
+    def is_diff_array?(x)
+
+      return false unless x.is_a?(Array)
+      return false unless x.length > 1
+      return false unless x.all? { |e| e.is_a?(Array) }
+      return false unless x[0][0] == 'keys'
+      return false unless x[1][0] == 'stats'
+      true
+    end
+
     protected
 
     def strip(row)
@@ -55,12 +147,14 @@ module Cevennes
     DOWNCASE = lambda { |x| x.respond_to?(:downcase) ? x.downcase : x }
     IDENTITY = lambda { |x| x }
 
-    def hash(version, id, csv, opts)
+    # was named "hash", but since it shadowed a core method, let's use "hajh"
+    #
+    def hajh(version, id, csv, opts)
 
       d = opts[:ignore_key_case] ? DOWNCASE : IDENTITY
       did = d[id]
 
-      csva = ::CSV.parse(reencode(csv))
+      csva = parse(csv, opts)
         .each_with_index.collect { |row, i| [ 1 + i, strip(row) ] }
         .reject { |i, row| row.compact.empty? }
         .drop_while { |i, row| ! row.find { |cell| d[cell] == did } }
@@ -84,27 +178,97 @@ module Cevennes
           h }
     end
 
-    #def deflate(row)
-    #  ::CSV.generate(encoding: 'UTF-8') { |csv| csv << row }.strip
-    #end
+    def parse(csv, opts=nil)
+
+      csv.is_a?(Array) ? csv :
+      ::CSV.parse(reencode(csv, opts))
+    end
+
+    def reencode(s, opts)
+
+      enc = opts ? opts[:encoding] : nil
+
+      (enc ? [ enc ] : [ 'UTF-8', 'Windows-1252', 'ISO-8859-1' ])
+        .each do |enc|
+          s1 = s.dup.force_encoding(enc); next unless s1.valid_encoding?
+          return s1.encode('UTF-8')
+        rescue Encoding::UndefinedConversionError
+          next
+        end
+
+      fail "failed to reencode #{(s.encoding rescue '(unknown encoding)')}"
+    end
+
+    require 'io/console'
 
-    ENCODINGS = %w[ Windows-1252 ISO-8859-1 UTF-8 ].freeze
+    def term_width
+
+      w =
+        ENV['COLUMNS'] ||
+        ($stdout.winsize[1] rescue nil) ||
+        (IO.console.winsize[1] rescue nil) ||
+        (`tput cols`.to_i rescue nil) ||
+        (`stty size`.split[1].to_i rescue nil)
+
+      w.is_a?(Integer) && w > 0 ? w : 80
+    end
 
-    def reencode(s)
+    def render_row(row, opts={})
 
-      #s = unzip(s) if s[0, 2] == 'PK'
-        # no dependency on rubyzip
+      c = opts[:colours] || Colorato.no_colours
+      bc = opts[:base_colour] || opts[:bc] || ''
 
-      #return s if s.encoding == Encoding::UTF_8
-        # NO! have to force_encoding for UTF-8 as well!
+      rs = c.reset + bc
 
-      s = s.dup if s.frozen?
+      indent = opts[:indent] || 0
+      ck = opts[:col_keys] || opts[:ck]
 
-      ENCODINGS.each do |e|
-        (return s.force_encoding(e).encode('UTF-8')) rescue nil
+      rn = opts[:row_number] || opts[:rn]
+      rn = rn.to_s if rn
+
+      cml = opts[:cml] || 28
+
+      r0 = opts[:vs]
+
+      ni = ' ' * indent
+
+      tw = term_width - 1
+      o = StringIO.new
+
+      line = ni + bc + '[ '
+      llen = Colorato.no_colour_length(line)
+        #
+      row.each_with_index do |cell, i|
+
+        id = (ck ? xelcol(1 + i) : '') + (rn ? rn : '') + (ck || rn ? ' ' : '')
+        id = c.rs + c.light_gray + id + rs if id.length > 0
+
+        t = cell.is_a?(String) ? Colorato.truncate_string(cell, cml, '…') : cell
+        ce = t.inspect
+        ce = c.rs + c.yellow + ce + rs if r0 && cell != r0[i]
+
+        cl = id + ce + ', '
+        clen = Colorato.no_colour_length(cl)
+
+        if indent + llen + clen > tw
+          o << line << "\n"
+          line = ni + '  '
+          llen = line.length
+        end
+        line += cl
+        llen += clen
       end
+      o << line << ']'
+
+      o.string
+    end
+
+    def xelcol(n)
+
+      r = []
+      while n > 0; n -= 1; r.unshift(('A'.ord + (n % 26)).chr); n /= 26; end
 
-      nil
+      r.join
     end
   end
 end

metadata

@@ -1,29 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: cevennes
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - John Mettraux
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorato
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: probatio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-  name: rspec
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.6'
 description: Diffs CSVs by lines, focusing on a single ID
 email:
 - jmettraux@gmail.com
@@ -47,7 +74,7 @@ metadata:
   bug_tracker_uri: https://github.com/jmettraux/cevennes/issues
   homepage_uri: https://github.com/jmettraux/cevennes
   source_code_uri: https://github.com/jmettraux/cevennes
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CSV diff library
 test_files: []