cevennes 0.11.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d93b3bdf44f0c33cf0e90d02a2f6021c06abb58
-  data.tar.gz: c038beab1cc0a2e93079bfd27e861c78b5d50d21
+SHA256:
+  metadata.gz: f6b604ac611ad1d24fe34ce9769c5d5b34ca1f0cdbf005ff08bce1152f24976e
+  data.tar.gz: e2925852747049479ad3172780c62e1c32ec9d04958d6de7c82049a7aa8103ae
 SHA512:
-  metadata.gz: d82a5c40592be7eb8ef83df1fda403dae71fc172bd815882c1c68f8feed32e842eedb7026433e68068d2d216aa3f0a246dec790a90ebce447658cdaa9d69bb2e
-  data.tar.gz: 6b6e4edb32644166b67cef3d4d2bea2bfb57dda859b37013b132482c37f49f569047e8fcd87507cbe0a03ecd968cc88dceedfb81fb21d5d0996d7eb9787a6a0e
+  metadata.gz: 7f77f3878e80646e0ea1d0b2c67bd6927cd5c60ab7b08acdb78747c83e14c6c38752753d4a90f055fdfc797a72f675dbe069240b278110f7b402dc2992d88c42
+  data.tar.gz: b6ad6a2ab702e874bc03a6ca11c265fcd3157f77a556482a447e8d579381be5a50812e23ff1b6253032a50f9a5347af1ef849f5a37128ce7c20cc6c5d5c23e78

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 # CHANGELOG.md
 
 
+## cevennes 1.1.1  released 2021-02-25
+
+- 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`
+
+
+## cevennes 1.0.0  released 2018-09-07
+
+- Align the "keys" entry on the =+-! entries
+
+
+## cevennes 0.13.0  released 2018-09-07
+
+- Trim cells and keys
+
+
+## cevennes 0.12.0  released 2018-09-06
+
+- Fail with IndexError on missing id in CSV old or new
+
+
 ## cevennes 0.11.0  released 2018-09-06
 
 - Fix l0 and l1 stats

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2018-2018, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2018-2021, 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/README.md

@@ -6,16 +6,56 @@
 
 Diffs CSVs by lines, focusing on a single ID
 
+
 ## usage
 
-TODO
+Given two CSV strings and an identifier name (a column name), cevennes may compute a diff:
+```ruby
+require 'cevennes'
+
+cvs0 = %{
+  id,name,age
+  0,John,33
+  1,Jean-Baptiste,43
+  3,Luke,21
+}.strip + "\n"
+cvs1 = %{
+  id,name,age
+  0,John,33
+  1,Jean-Baptiste,44
+  4,Matthew,20
+}.strip + "\n"
+
+d = Cevennes.diff('id', cvs0, cvs1)
+
+#d = Cevennes.diff('id', cvs0, cvs1, ignore_key_case: true)
+  # when the key case should be ignored ("Id" == "id")
 ```
-csv0 = %{
-  }
-csv1 = %{
-  }
-pp Cevennes.diff('ISIN', csv0, csv1)
+
+`d` will yield:
+```ruby
+[
+  [ 'keys', 1, [ 'id', 'name', 'age' ],
+            1, [ 'id', 'name', 'age' ] ],
+  [ 'stats',
+    { '=' => 1, '!' => 1, '-' => 1, '+' => 1,
+      'l0' => 3, 'l1' => 3 } ],
+  [ '=',  2, [ '0', 'John', '33'],
+          2, nil ],
+  [ '!',  3, [ '1', 'Jean-Baptiste', '43' ],
+          3, [ '1', 'Jean-Baptiste', '44' ] ],
+  [ '-',  4, [ '3', 'Luke', '21'],
+         -1, nil ],
+  [ '+', -1, nil,
+          4, [ '4', 'Matthew', '20' ] ]
+]
 ```
+It's a list where the first entry is a recap of the keys used in the old and the new CSV strings (the integer is the line number (starting at 1) where the keys where found.
+
+The second entry is a summary of the changes, altered `!` line count, removed `-` line count, added `+` line count, old length `l0`, new length `l1`, and unchanged `=` line count.
+
+The remaining entries are the (non-)changes themselves, from line 1 to the end.
+
 
 ## LICENSE
 

data/cevennes.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
   s.email = [ 'jmettraux@gmail.com' ]
-  s.homepage = 'http://github.com/jmettraux/cevennes'
+  s.homepage = 'https://github.com/jmettraux/cevennes'
   s.license = 'MIT'
   s.summary = 'CSV diff library'
 
@@ -19,7 +19,13 @@ Diffs CSVs by lines, focusing on a single ID
   }.strip
 
   s.metadata = {
-    'changelog_uri' => s.homepage + '/blob/master/CHANGELOG.md'
+    'changelog_uri' => s.homepage + '/blob/master/CHANGELOG.md',
+    'documentation_uri' => s.homepage,
+    'bug_tracker_uri' => s.homepage + '/issues',
+    #'mailing_list_uri' => 'https://groups.google.com/forum/#!forum/floraison',
+    'homepage_uri' =>  s.homepage,
+    'source_code_uri' => s.homepage,
+    #'wiki_uri' => s.homepage + '/wiki',
   }
 
   #s.files = `git ls-files`.split("\n")

data/lib/cevennes.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 
 require 'csv'
 
 
 module Cevennes
 
-  VERSION = '0.11.0'
+  VERSION = '1.1.1'
 
   class << self
 
-    def diff(id, csv0, csv1)
+    def diff(id, csv0, csv1, opts={})
 
-      h0 = hash(id, csv0)
-      h1 = hash(id, csv1)
+      h0 = hash('old', id, csv0, opts)
+      h1 = hash('new', id, csv1, opts)
 
       ks0 = h0.delete(:keys)
       ks1 = h1.delete(:keys)
@@ -38,22 +39,39 @@ module Cevennes
       s = d.inject({}) { |h, (a, _, _)| h[a] = (h[a] || 0) + 1; h }
       s['l0'] = h0.length
       s['l1'] = h1.length
-      #s['ll0'] = s['='] + s['!'] + s['-']
-      #s['ll1'] = s['='] + s['!'] + s['+']
 
-      [ [ 'keys', ks0, ks1 ], [ 'stats', s ] ] + d
+      [ [ 'keys', *ks0, *ks1 ], [ 'stats', s ] ] + d
     end
 
     protected
 
-    def hash(id, csv)
+    def strip(row)
+
+      row.collect { |cell| cell.is_a?(String) ? cell.strip : cell }
+    end
+
+    DOWNCASE = lambda { |x| x.respond_to?(:downcase) ? x.downcase : x }
+    IDENTITY = lambda { |x| x }
+
+    def hash(version, id, csv, opts)
+
+      d = opts[:ignore_key_case] ? DOWNCASE : IDENTITY
+      did = d[id]
 
       csva = ::CSV.parse(reencode(csv))
-        .each_with_index.collect { |row, i| [ 1 + i, row ] }
+        .each_with_index.collect { |row, i| [ 1 + i, strip(row) ] }
         .reject { |i, row| row.compact.empty? }
-        .drop_while { |i, row| ! row.include?(id) }
+        .drop_while { |i, row| ! row.find { |cell| d[cell] == did } }
+
+      fail ::IndexError.new("id #{id.inspect} not found in #{version} CSV") \
+        if csva.empty?
 
-      idi = csva[0][1].index(id)
+      csva[0][1] =
+        opts[:ignore_key_case] ?
+        csva[0][1].collect { |c| DOWNCASE[c] } :
+        csva[0][1]
+
+      idi = csva[0][1].index(did)
 
       csva[1..-1]
         .inject({ keys: csva[0] }) { |h, (i, row)|
@@ -68,16 +86,23 @@ module Cevennes
     #  ::CSV.generate(encoding: 'UTF-8') { |csv| csv << row }.strip
     #end
 
+    ENCODINGS = %w[ Windows-1252 ISO-8859-1 UTF-8 ].freeze
+
     def reencode(s)
 
       #s = unzip(s) if s[0, 2] == 'PK'
         # no dependency on rubyzip
 
-      %w[ Windows-1252 ISO-8859-1 UTF-8 ].each do |e|
-        ss = s.force_encoding(e).encode('UTF-8') rescue nil
-        break ss if ss
-        nil
+      #return s if s.encoding == Encoding::UTF_8
+        # NO! have to force_encoding for UTF-8 as well!
+
+      s = s.dup if s.frozen?
+
+      ENCODINGS.each do |e|
+        (return s.force_encoding(e).encode('UTF-8')) rescue nil
       end
+
+      nil
     end
   end
 end

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: cevennes
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.1.1
 platform: ruby
 authors:
 - John Mettraux
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+  name: rspec
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,12 +38,16 @@ files:
 - README.md
 - cevennes.gemspec
 - lib/cevennes.rb
-homepage: http://github.com/jmettraux/cevennes
+homepage: https://github.com/jmettraux/cevennes
 licenses:
 - MIT
 metadata:
-  changelog_uri: http://github.com/jmettraux/cevennes/blob/master/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/jmettraux/cevennes/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/jmettraux/cevennes
+  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:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: CSV diff library
 test_files: []