smarter_csv 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8862baa01aeee087fce216ba9517d301d4deb70b8cf0c8d2a2b3c7bab81c693a
-  data.tar.gz: bd5afb4bdcd925e5196beee967c70b60ef240a945d770554bc8b17f269c26ee4
+  metadata.gz: 79279f7e51fa65451092db03404d4c2b32e6fdf15107c931d35b6c8db094f68a
+  data.tar.gz: 6f930523b5c6e1bdc3e7d8a78d49bcbcc244437bd4e51d44d104768a4b3bb1c8
 SHA512:
-  metadata.gz: f4e3080e4134aa9b59b729d4f4053426472a980d19c47d157a7175189e74f6cef6acde136f17c3be2a33e558dd9a6f85e5f7c62f35df4efffad64c9cabef2fee
-  data.tar.gz: 11df1ee0862b61424187c30a0edef94186b656415fccfa4182c3fba09067c11a239b89bd302c03e97d984646fa3359281572254017cdc6f45c0a693e6c4d5130
+  metadata.gz: 93630aba89f0d6cbf7e311e3abbca51c5677edd3f653d978e98b54c2d251483dbf7951a5892dcaca7ca0d4d449eb5071fca35fac3f361bdf9bebfddbf7682673
+  data.tar.gz: 27164e53008600af9873c255bcde5f471ee41c3e6c808a1ed8087ab24a9008a5850dde3f57edac901a562cbb505c634132470827c55662ed7440612ce766f22b

data/.travis.yml

@@ -6,10 +6,16 @@ before_install:
 
 matrix:
   include:
-    - rvm: 2.2.8
-    - rvm: 2.3.5
-    - rvm: 2.4.2
-    - rvm: jruby-9.1.15.0
+    - rvm: 2.2.10
+    - rvm: 2.3.8
+    - rvm: 2.4.10
+    - rvm: 2.5.8
+    - rvm: 2.6.9
+    - rvm: 2.7.5
+    - rvm: 3.0.3
+    - rvm: 3.1.0
+    - rvm: jruby-9.2.19.0
+    - rvm: jruby-9.3.3.0
       env:
         - JRUBY_OPTS="--server -Xcompile.invokedynamic=false -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-noverify -J-Xms512m -J-Xmx1024m"
     - rvm: ruby-head

data/Gemfile

@@ -3,7 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in smarter_csv.gemspec
 gemspec
 
-
 gem "rake", "< 11"
 gem 'pry'
 

data/README.md

@@ -324,6 +324,26 @@ Planned in the next releases:
 
 ## Changes
 
+#### 1.3.0 (2022-01-06) Breaking code change if you used `--key_mappings`
+ * fix bug for key_mappings (issue #181)   
+   The values of the `key_mappings` hash will now be used "as is", and no longer forced to be symbols
+
+   **Users with existing code with `--key_mappings` need to change their code** to 
+     * either use symbols in the `key_mapping` hash
+     * or change the expected keys from symbols to strings
+
+#### 1.2.9 (2021-11-22) (PULLED)
+ * fix bug for key_mappings (issue #181)
+   The values of the `key_mappings` hash will now be used "as is", and no longer forced to be symbols
+
+#### 1.2.8 (2020-02-04)
+ * fix deprecation warnings on Ruby 2.7 (thank to Diego Salido)
+
+#### 1.2.7 (2020-02-03)
+
+#### 1.2.6 (2018-11-13)
+ * fixing error caused by calling f.close when we do not hand in a file
+
 #### 1.2.5 (2018-09-16)
  * fixing issue #136 with comments in CSV files
  * fixing error class hierarchy
@@ -505,6 +525,7 @@ And a special thanks to those who contributed pull requests:
  * [Rohit Amarnath](https://github.com/ramarnat)
  * [Joshua Smith](https://github.com/enviable)
  * [Colin Petruno](https://github.com/colinpetruno)
+ * [Diego Salido](https://github.com/salidux)
 
 
 ## Contributing

data/lib/smarter_csv/smarter_csv.rb

@@ -53,7 +53,7 @@ module SmarterCSV
 
         if (header =~ %r{#{options[:quote_char]}}) and (! options[:force_simple_split])
           file_headerA = begin
-            CSV.parse( header, csv_options ).flatten.collect!{|x| x.nil? ? '' : x} # to deal with nil values from CSV.parse
+            CSV.parse( header, **csv_options ).flatten.collect!{|x| x.nil? ? '' : x} # to deal with nil values from CSV.parse
           rescue CSV::MalformedCSVError => e
             raise $!, "#{$!} [SmarterCSV: csv line #{csv_line_count}]", $!.backtrace
           end
@@ -92,7 +92,7 @@ module SmarterCSV
         # do some key mapping on the keys in the file header
         #   if you want to completely delete a key, then map it to nil or to ''
         if ! key_mappingH.nil? && key_mappingH.class == Hash && key_mappingH.keys.size > 0
-          headerA.map!{|x| key_mappingH.has_key?(x) ? (key_mappingH[x].nil? ? nil : key_mappingH[x].to_sym) : (options[:remove_unmapped_keys] ? nil : x)}
+          headerA.map!{|x| key_mappingH.has_key?(x) ? (key_mappingH[x].nil? ? nil : key_mappingH[x]) : (options[:remove_unmapped_keys] ? nil : x)}
         end
       end
 
@@ -149,7 +149,7 @@ module SmarterCSV
 
         if (line =~ %r{#{options[:quote_char]}}) and (! options[:force_simple_split])
           dataA = begin
-            CSV.parse( line, csv_options ).flatten.collect!{|x| x.nil? ? '' : x} # to deal with nil values from CSV.parse
+            CSV.parse( line, **csv_options ).flatten.collect!{|x| x.nil? ? '' : x} # to deal with nil values from CSV.parse
           rescue CSV::MalformedCSVError => e
             raise $!, "#{$!} [SmarterCSV: csv line #{csv_line_count}]", $!.backtrace
           end
@@ -248,7 +248,7 @@ module SmarterCSV
       end
     ensure
       $/ = old_row_sep   # make sure this stupid global variable is always reset to it's previous value after we're done!
-      f.close
+      f.close if f.respond_to?(:close)
     end
     if block_given?
       return chunk_count  # when we do processing through a block we only care how many chunks we processed

data/lib/smarter_csv/version.rb

@@ -1,3 +1,3 @@
 module SmarterCSV
-  VERSION = "1.2.5"
+  VERSION = "1.3.0"
 end

data/smarter_csv.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.requirements  = ['csv'] # for CSV.parse() only needed in case we have quoted fields
   gem.version       = SmarterCSV::VERSION
-  gem.licenses      = ['MIT','GPL-2']
+  gem.licenses      = ['MIT','GPL-2'] # pick either of these licenses - only that license applies to you
   gem.add_development_dependency "rspec"
 #  gem.add_development_dependency "guard-rspec"
 end

data/spec/fixtures/key_mapping.csv

@@ -0,0 +1,2 @@
+THIS,THAT,other
+this,that,other

data/spec/smarter_csv/key_mapping_spec.rb

@@ -22,4 +22,35 @@ describe 'be_able_to' do
     end
   end
 
+  describe 'when keep_original_headers' do
+    it 'without key mapping' do
+      options = {:keep_original_headers => true}
+      data = SmarterCSV.process("#{fixture_path}/key_mapping.csv", options)
+      data.size.should == 1
+      data.first.keys.should == ['THIS', 'THAT', 'other']
+    end
+
+    it 'sets key_mapping to a symbol' do
+      options = {:keep_original_headers => true, :key_mapping => {'other' => :other}}
+      data = SmarterCSV.process("#{fixture_path}/key_mapping.csv", options)
+      data.size.should == 1
+      data.first.keys.should == ['THIS', 'THAT', :other]
+    end
+
+    # this previously would set the key to a symbol :OTHER, which was a bug!
+    it 'sets key_mapping to a string' do
+      options = {:keep_original_headers => true, :key_mapping => {'other' => 'OTHER'}}
+      data = SmarterCSV.process("#{fixture_path}/key_mapping.csv", options)
+      data.size.should == 1
+      data.first.keys.should == ['THIS', 'THAT', 'OTHER']
+    end
+
+    # users now have to explicitly set this to a symbol, or change the expected keys to be strings.
+    it 'sets key_mapping to a symbol' do
+      options = {:keep_original_headers => true, :key_mapping => {'other' => :OTHER}}
+      data = SmarterCSV.process("#{fixture_path}/key_mapping.csv", options)
+      data.size.should == 1
+      data.first.keys.should == ['THIS', 'THAT', :OTHER]
+    end
+  end
 end

data/spec/smarter_csv/malformed_spec.rb

@@ -8,14 +8,10 @@ describe 'malformed_csv' do
   context "malformed header" do
     let(:csv_path) { "#{fixture_path}/malformed_header.csv" }
     it { should raise_error(CSV::MalformedCSVError) }
-    it { should raise_error(/(Missing or stray quote in line 1|CSV::MalformedCSVError)/) }
-    it { should raise_error(CSV::MalformedCSVError) }
   end
 
   context "malformed content" do
     let(:csv_path) { "#{fixture_path}/malformed.csv" }
     it { should raise_error(CSV::MalformedCSVError) }
-    it { should raise_error(/(Missing or stray quote in line 1|CSV::MalformedCSVError)/) }
-    it { should raise_error(CSV::MalformedCSVError) }
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: smarter_csv
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - 'Tilo Sloboda
 
-'
-autorequire: 
+  '
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,7 +32,7 @@ description: Ruby Gem for smarter importing of CSV Files as Array(s) of Hashes,
 email:
 - 'tilo.sloboda@gmail.com
 
-'
+  '
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -60,6 +60,7 @@ files:
 - spec/fixtures/empty.csv
 - spec/fixtures/ignore_comments.csv
 - spec/fixtures/ignore_comments2.csv
+- spec/fixtures/key_mapping.csv
 - spec/fixtures/line_endings_n.csv
 - spec/fixtures/line_endings_r.csv
 - spec/fixtures/line_endings_rn.csv
@@ -120,7 +121,7 @@ licenses:
 - MIT
 - GPL-2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - csv
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby Gem for smarter importing of CSV Files (and CSV-like files), with lots
   of optional features, e.g. chunked processing for huge CSV files
@@ -154,6 +154,7 @@ test_files:
 - spec/fixtures/empty.csv
 - spec/fixtures/ignore_comments.csv
 - spec/fixtures/ignore_comments2.csv
+- spec/fixtures/key_mapping.csv
 - spec/fixtures/line_endings_n.csv
 - spec/fixtures/line_endings_r.csv
 - spec/fixtures/line_endings_rn.csv