csv_step_importer 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce93ec4d94777ed496b6b960ef9595f02877c443e8dbe4f59cda91d364fc150
-  data.tar.gz: c8ec16e08626f8f0aaa75a1431964b7d05e171f284b1c86299641dcadd65df4c
+  metadata.gz: 5334af91a76293f6cc7b57226bbfd80cb6fdd28a4577f25189cb922ed002647e
+  data.tar.gz: 6e2166c2764d07b088b7f11ee94d030f42692553635cc9b38aa4a427528d8ef1
 SHA512:
-  metadata.gz: 3fe14e9e45884304b0880a0dd02c05a2b812c78a7ecaa6c2f975b75ac93de85db3bfb5e2f0f90355765f98d48d781d09232f7c9ac869f9119e568c260f661233
-  data.tar.gz: aa0babcbb53d823f3d3fa97f340956d9b2c8ad30274421bf72f82f9eb8ec52689e8f754e6a5d4f5b3b33a040eaaa3e6b0a3b1697cb66844edbf21bf06f6f320b
+  metadata.gz: 90b7fca64a184012605cb7e4963425d3e77add0c17798af72466a08ff5aa9140b45f4c413e29848472a19629a90d1ad0f35338f9ab3d30aaaebcfab449251119
+  data.tar.gz: 48a5f1ebdd26df973c272a5a5262cb69fdad6f69b6bc4bb231003f035acb059ea291165999ba158474112666fff7383a75b0a5e3f9807dcf0f1976bbe4ec8f72

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+
+### Changed
+
+## 2018-08-22 Version 0.9.0
+### Added
+- Add csv_option headers_mode
+
+```
+  headers_mode is a enum with which you can control how headers will be transformed during the file read.
+
+  Note, that this option will be applied, after the csv_option headers is processed.
+
+  The following values are allowed:
+    case_sensitive_symbols:
+      "A z" becomes :A_z
+
+    case_insensitive_symbols:
+      "A z" becomes :a_z
+
+    symbols:
+      "A z" becomes :"A z"
+
+    preserve:
+      "A z" will stay "A z"
+```
+
+### Changed
+- Deprecated csv_option case_sensitive_headers

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv_step_importer (0.8.1)
+    csv_step_importer (0.9.0)
       activemodel
       activerecord-import
       activesupport
@@ -10,28 +10,28 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
       arel (>= 9.0)
-    activerecord-import (0.24.0)
+    activerecord-import (0.25.0)
       activerecord (>= 3.2)
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -43,7 +43,7 @@ GEM
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.7.1)
-    i18n (1.0.1)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     loofah (2.2.2)
@@ -52,56 +52,59 @@ GEM
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nokogiri (1.8.3)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
-    parser (2.5.1.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     rack (2.0.5)
-    rack-test (1.0.0)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
+      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.57.2)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.58.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rails (1.4.1)
+    rubocop-rails (1.5.0)
       railties (>= 3.0)
       rubocop (~> 0.53)
-    rubocop-rspec (1.27.0)
-      rubocop (>= 0.56.0)
-    ruby-progressbar (1.9.0)
-    smarter_csv (1.2.3)
+    rubocop-rails_config (0.2.3)
+      railties (>= 3.0)
+      rubocop (~> 0.56)
+    rubocop-rspec (1.28.0)
+      rubocop (>= 0.58.0)
+    ruby-progressbar (1.10.0)
+    smarter_csv (1.2.4)
     thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -117,6 +120,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop-rails
+  rubocop-rails_config
   rubocop-rspec
 
 BUNDLED WITH

data/csv_step_importer.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-rails_config"
   spec.add_development_dependency "rubocop-rails"
   spec.add_development_dependency "rubocop-rspec"
 

data/lib/csv_step_importer/file.rb

@@ -73,17 +73,6 @@ module CSVStepImporter
       }
     end
 
-    def keys_as_symbols(case_sensitive: false)
-      if case_sensitive
-        Proc.new { |headers|
-          headers.map { |x| x.strip.gsub(%r{"}, '').gsub(/(\s|\-)+/, '_').to_sym }
-        }
-      else
-        # use existing helper
-        :keys_as_symbols
-      end
-    end
-
     def precompile_csv_options!
       # set default options
       self.csv_options = {
@@ -92,19 +81,53 @@ module CSVStepImporter
       }.merge(csv_options)
 
       # easier specification of headers, including case case sensitive headers
-      if csv_options[:headers] || csv_options[:case_sensitive_headers]
+      if csv_options[:headers] || csv_options[:headers_mode] || csv_options[:case_sensitive_headers]
         if csv_options[:header_transformations]
           raise "either use header_transformations or headers (and case_sensitive_headers optionally)"
         end
 
         csv_options[:header_transformations] = [ :none ]
         csv_options[:header_transformations] << { key_mapping: csv_options.delete(:headers) } if csv_options[:headers]
-        csv_options[:header_transformations] << keys_as_symbols(case_sensitive: csv_options.delete(:case_sensitive_headers))
+        csv_options[:header_transformations] << header_mode_transformer
       end
 
       # retrieve headers from CSV
       csv_options[:header_transformations] ||= []
       csv_options[:header_transformations] << header_proc
     end
+
+    def header_mode_transformer
+      case headers_mode
+      when :case_sensitive_symbols
+        Proc.new { |headers|
+          headers.map { |x| x.strip.gsub(%r{"}, "").gsub(/(\s|\-)+/, "_").to_sym }
+        }
+      when :case_insensitive_symbols
+        # use existing helper
+        :keys_as_symbols
+      when :preserve
+        Proc.new { |headers| headers }
+      else
+        raise "unknown headers_mode #{headers_mode}"
+      end
+    end
+
+    def headers_mode
+      if csv_options[:case_sensitive_headers]
+        ActiveSupport::Deprecation.warn(
+          "Key `:case_sensitive_headers` is deprecated, please use `:headers_mode` with a value of" +
+          " `:case_sensitive_symbols` instead"
+        )
+
+        if csv_options[:headers_mode]
+          raise "Key `:case_sensitive_headers` is deprecated, and will be ignored, since headers_mode is specified"
+        end
+
+        csv_options.delete(:case_sensitive_headers)
+        csv_options[:headers_mode] = :case_sensitive_symbols
+      end
+
+      csv_options[:headers_mode] || :preserve
+    end
   end
 end

data/lib/csv_step_importer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CSVStepImporter
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_step_importer
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Christian-Manuel Butzke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +161,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock