cevennes 0.10.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8fcfbf02c5a728c9a6364a0fe67a61003fa18fa
-  data.tar.gz: 72361059d05b8c7cca589fa099d4e92a58ca704d
+SHA256:
+  metadata.gz: '0885436a7e993e83fcef22afb0605648f92405916461a1fdc3d36c144c67530d'
+  data.tar.gz: dd03ef25ed11cea3be74301d4bc147da9108e91e477066d4790f3906e819f67b
 SHA512:
-  metadata.gz: fd04c1d5c12954d091a75b55ccb0078757a35bfc1d7d7dc6fcf2cf3d23ecb6929ec47d05adbfc13be1646a4ca6040a05135b9ce4664a5f5947b5413e01bf4fd0
-  data.tar.gz: ee72cda27967a186dfea52a61ef67256b69f3d56ec95c0c3d0e61bc1084a74a35a59e3025a8a5666e29e7ebfc649c8c6d48a16dda7a64bc4919fbeee255252ee
+  metadata.gz: 9a9c66767526700a4c699fc61f3c938e8724a86dbc8662548bd611fb0b02fcddf1ec10c6e7a8acfcb24bd04659dc5eb20b3872a81f0866475d6c20a6ab1eb815
+  data.tar.gz: 14e19d5de67104106a904e58c4678a5243dce467e7b26388c9e95d7fd2d4ef8821ae5c4f0c8b3ba488081d8819d2919d3ec418ca523304c95a2a10d82fb7340c

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 # CHANGELOG.md
 
 
+## 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
+
+
 ## cevennes 0.10.0  released 2018-09-03
 
 - Weave in additions at the right spot

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

@@ -4,14 +4,14 @@ require 'csv'
 
 module Cevennes
 
-  VERSION = '0.10.0'
+  VERSION = '1.1.0'
 
   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)
@@ -36,20 +36,40 @@ module Cevennes
           d.insert(i, [ '+', -1, nil, lnum, line ]) }
 
       s = d.inject({}) { |h, (a, _, _)| h[a] = (h[a] || 0) + 1; h }
-      s['l0'] = h0.length - 1
-      s['l1'] = h1.length - 1
+      s['l0'] = h0.length
+      s['l1'] = h1.length
 
-      [ [ '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_IF_POSSIBLE =
+      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_IF_POSSIBLE : IDENTITY
 
       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] == id } }
+
+      fail ::IndexError.new("id #{id.inspect} not found in #{version} CSV") \
+        if csva.empty?
+
+      csva[0][1] =
+        opts[:ignore_key_case] ?
+        csva[0][1].collect { |c| DOWNCASE_IF_POSSIBLE[c] } :
+        csva[0][1]
 
       idi = csva[0][1].index(id)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cevennes
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-03 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,11 +38,15 @@ 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
+  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:
@@ -58,8 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: CSV diff library