csv-importer 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 204d73b513134e022dd8e3529869e8f9c63602d7
-  data.tar.gz: 46b7b9e27dab7add3abfd117959f8919f71b5f22
+SHA256:
+  metadata.gz: 5e17c85aa62e6f2774f1cb86dcea9d7743622b73690fb896228d1bf7ce54951e
+  data.tar.gz: acfd22bf68c1c228a0afecba046cf3cb7231311192ee1ee5c88828a56a51f429
 SHA512:
-  metadata.gz: 586def4222cccb61d571e4904d76d1f055537e25529be90552aad206fa527845f6de0ee99ba8fccea786817c961d3b7366e3fc64456df32cefdc25a44e8bd730
-  data.tar.gz: ae9443c1998169329c5c432b9df9b7480206c32bcc2da4cd733cd1351a4586823bf0b05b205e74a7a5645308e5e39016930a537fa30ccd45bb1b7d6e708c3f07
+  metadata.gz: c5c8894e68eaa33418761a9cad3ab8f0ddfea0eeaa3e62101ab1105a40978b7c206dc7448a4b536f9efc06c06b952935146efe9b4ae010c9a3f98428f649b641
+  data.tar.gz: 66f498dc9d2e62bf413ba35ac362b03fa557640c724cafb8cc38686bfe825334455d936c1c8a4e79b97fc4ec0355887cb0f6dee178b0f3893d0b37c6dc043b09

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.7.0] - 2019-11-29
+
+### Added
+
+* Improve algorithm to detect separators. [#88][] by [@brain-geek][]
+* `to:` accepts anything that responds to `#call` (lambda, procs,
+  classes etc). [#72][] by [@pcreux][] inspired by [#71][] by [@macfanatic][].
+
+### Fixed
+
+* `valid_header?` returns `false` when the CSV is malformed instead of
+  raising an exception. [#85][] by [@mltsy][]
+* Header infos (ex: `extra_columns`) aren't discarded after running an
+  import. [#83][] by [@mltsy][]
+
+
 ## [0.6.0] - 2018-05-22
 
 ### Added
@@ -166,19 +182,27 @@ report object instead of raising an exception.
 * Initial Release
 
 <!--- The following link definition list is generated by PimpMyChangelog --->
-[#26]: https://github.com/BrewhouseTeam/csv-importer/issues/26
-[#38]: https://github.com/BrewhouseTeam/csv-importer/issues/38
-[#47]: https://github.com/BrewhouseTeam/csv-importer/issues/47
-[#52]: https://github.com/BrewhouseTeam/csv-importer/issues/52
-[#63]: https://github.com/BrewhouseTeam/csv-importer/issues/63
-[#68]: https://github.com/BrewhouseTeam/csv-importer/issues/68
-[#69]: https://github.com/BrewhouseTeam/csv-importer/issues/69
-[#73]: https://github.com/BrewhouseTeam/csv-importer/issues/73
+[#26]: https://github.com/pcreux/csv-importer/issues/26
+[#38]: https://github.com/pcreux/csv-importer/issues/38
+[#47]: https://github.com/pcreux/csv-importer/issues/47
+[#52]: https://github.com/pcreux/csv-importer/issues/52
+[#63]: https://github.com/pcreux/csv-importer/issues/63
+[#68]: https://github.com/pcreux/csv-importer/issues/68
+[#69]: https://github.com/pcreux/csv-importer/issues/69
+[#71]: https://github.com/pcreux/csv-importer/issues/71
+[#72]: https://github.com/pcreux/csv-importer/issues/72
+[#73]: https://github.com/pcreux/csv-importer/issues/73
+[#83]: https://github.com/pcreux/csv-importer/issues/83
+[#85]: https://github.com/pcreux/csv-importer/issues/85
+[#88]: https://github.com/pcreux/csv-importer/issues/88
+[@brain-geek]: https://github.com/brain-geek
 [@danielweinmann]: https://github.com/danielweinmann
 [@egg-chicken]: https://github.com/egg-chicken
 [@fxgallego]: https://github.com/fxgallego
 [@macfanatic]: https://github.com/macfanatic
+[@mltsy]: https://github.com/mltsy
 [@paulodeleo]: https://github.com/paulodeleo
+[@pcreux]: https://github.com/pcreux
 [@pnomolos]: https://github.com/pnomolos
 [@shvetsovdm]: https://github.com/shvetsovdm
-[@stas]: https://github.com/stas
+[@stas]: https://github.com/stas

data/README.md

@@ -187,6 +187,27 @@ Like very advanced stuff? We grant you access to the [`column`](https://github.c
   end
 ```
 
+Note that `to:` accepts anything that responds to call and take 1, 2 or
+3 arguments.
+
+```ruby
+class ImportUserCSV
+  include CSVImporter
+
+  model User
+
+  column :birth_date, to: DateTransformer
+  column :renewal_date, to: DateTransformer
+  column :next_renewal_at, to: ->(value) { Time.at(value.to_i) }
+end
+
+class DateTransformer
+  def self.call(date)
+    Date.strptime(date, '%m/%d/%y')
+  end
+end
+```
+
 Now, what if the user does not provide the email column? It's not worth
 running the import, we should just reject the CSV file right away.
 That's easy:
@@ -206,7 +227,6 @@ import.report.status # => :invalid_header
 import.report.message # => "The following columns are required: 'email'"
 ```
 
-
 ### Update or Create
 
 You often want to find-and-update-or-create when importing a CSV file.

data/lib/csv_importer.rb

@@ -85,13 +85,16 @@ module CSVImporter
     end
 
     header.valid?
+  rescue CSV::MalformedCSVError => e
+    @report = Report.new(status: :invalid_csv_file, parser_error: e.message)
+    false
   end
 
   # Run the import. Return a Report.
   def run!
     if valid_header?
       @report = Runner.call(rows: rows, when_invalid: config.when_invalid,
-                            after_save_blocks: config.after_save_blocks)
+                            after_save_blocks: config.after_save_blocks, report: @report)
     else
       @report
     end

data/lib/csv_importer/column_definition.rb

@@ -29,7 +29,7 @@ module CSVImporter
     attribute :name, Symbol
     attribute :to # Symbol or Proc
     attribute :as # Symbol, String, Regexp, Array
-    attribute :required, Boolean
+    attribute :required, Virtus::Attribute::Boolean
 
     # The model attribute that this column targets
     def attribute

data/lib/csv_importer/csv_reader.rb

@@ -53,7 +53,18 @@ module CSVImporter
     SEPARATORS = [",", ";", "\t"]
 
     def detect_separator(csv_content)
-      SEPARATORS.sort_by { |separator| csv_content.count(separator) }.last
+      SEPARATORS.min_by do |separator|
+        csv_content.count(separator)
+
+        all_lines = csv_content.lines
+        base_number = all_lines.first.count(separator)
+
+        if base_number.zero?
+          Float::MAX
+        else
+          all_lines.map{|line| line.count(separator) - base_number }.map(&:abs).inject(0) { |sum, i| sum + i }
+        end
+      end
     end
 
     # Remove trailing white spaces and ensure we always return a string

data/lib/csv_importer/report.rb

@@ -12,8 +12,8 @@ module CSVImporter
 
     attribute :status, Symbol, default: proc { :pending }
 
-    attribute :missing_columns, Array[Symbol], default: proc { [] }
-    attribute :extra_columns, Array[Symbol], default: proc { [] }
+    attribute :missing_columns, Array[String], default: proc { [] }
+    attribute :extra_columns, Array[String], default: proc { [] }
 
     attribute :parser_error, String
 

data/lib/csv_importer/row.rb

@@ -12,7 +12,7 @@ module CSVImporter
     attribute :model_klass
     attribute :identifiers # Array[Symbol] or Proc
     attribute :after_build_blocks, Array[Proc], default: []
-    attribute :skip, Boolean, default: false
+    attribute :skip, Virtus::Attribute::Boolean, default: false
 
     # The model to be persisted
     def model
@@ -52,18 +52,19 @@ module CSVImporter
     # Set the attribute using the column_definition and the csv_value
     def set_attribute(model, column, csv_value)
       column_definition = column.definition
-      if column_definition.to && column_definition.to.is_a?(Proc)
-        to_proc = column_definition.to
+      transformer = column_definition.to
+      if transformer.respond_to?(:call)
+        arity = transformer.is_a?(Proc) ? transformer.arity : transformer.method(:call).arity
 
-        case to_proc.arity
+        case arity
         when 1 # to: ->(email) { email.downcase }
-          model.public_send("#{column_definition.name}=", to_proc.call(csv_value))
+          model.public_send("#{column_definition.name}=", transformer.call(csv_value))
         when 2 # to: ->(published, post) { post.published_at = Time.now if published == "true" }
-          to_proc.call(csv_value, model)
+          transformer.call(csv_value, model)
         when 3 # to: ->(field_value, post, column) { post.hash_field[column.name] = field_value }
-          to_proc.call(csv_value, model, column)
+          transformer.call(csv_value, model, column)
         else
-          raise ArgumentError, "`to` proc can only have 1 or 2 arguments"
+          raise ArgumentError, "arity: #{transformer.arity.inspect} - `to` can only have 1, 2 or 3 arguments"
         end
       else
         attribute = column_definition.attribute

data/lib/csv_importer/version.rb

@@ -1,3 +1,3 @@
 module CSVImporter
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv-importer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Philippe Creux
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -104,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: CSV Import for humans