csv_party 1.0.0.rc4 → 1.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67d5895445a9fe397df95275260491ed6d9f6ce5
-  data.tar.gz: 542a1442466867afa33cf0ef883a32443777cfd5
+SHA256:
+  metadata.gz: 174fc0ba77e52795b1763e2ff29eae5e5c3cfa3bcd181973aaba886a54a79eeb
+  data.tar.gz: 7676780e13435e10bf35b7c34c849484ea0efe0a86d7889ff2a4697f312a99c6
 SHA512:
-  metadata.gz: 1035dac76f5ec71d97015a5d9c2874074c28ad4b0ff7994ab565735fd6d49e539e4292a42ee15f44d8d2de2fb356e81a06f61685019fa3ad250d12ab9c160ba8
-  data.tar.gz: 93c748026adc2fa907f3e08825c0fef8b41fed5b2945e3066aff70978a86ed4c9d47df3a98abc30e25b2fb44a597cddb91efbb519699d2a9e3b4c580b4ef1100
+  metadata.gz: ab4bc476717516d1fa2a9d674f47e60c95ef0b24541cb7cf6cf76948ca5b9ce9dad96b9b89d10edfd99f338d4a04b612fd241c38d37d746d049f6eedb8868120
+  data.tar.gz: 4041355ba68669a3cf3e6275bf099da83d3d92d759bfc328269080a41dcbee02fa9a77b9c95c3549eaf5330cfc9fbbdcfdea05f83d320d2f29b55e89553d3fea

data/ROADMAP.md

@@ -8,9 +8,13 @@ Roadmap
 - [1.5 Runtime Configuration](#15-runtime-configuration)
 - [1.6 CSV Parse Error Handling](#16-csv-parse-error-handling)
 - [Someday Features](#someday-features)
+    - [Parse Row Access](#parse-row-access)
+    - [Deferred Parsing](#deferred-parsing)
+    - [Columns Macro](#columns-macro)
     - [Column Numbers](#column-numbers)
     - [Multi-column Parsing](#multi-column-parsing)
     - [Parse Dependencies](#parse-dependencies)
+    - [Rails Generator](#rails-generator0
 
 #### 1.1 Early Return While Parsing
 
@@ -230,6 +234,68 @@ error handling API for non-parse errors. So:
 
 ## Someday Features
 
+#### Parse Row Access
+
+This feature would allow access to the `CSV::Row` object when parsing a column.
+It could work something like this:
+
+    column product do |value, row|
+      Product.find_by(name: row['Product'])
+    end
+
+In theory, the CSVParty API would cover all use cases where somebody would need
+to access the raw row data, but perhaps not. Sometimes it's nice to be able to
+cut through the stuff in your way and just get at the raw internals.
+
+Additionally, perhaps deferred parsing would allow access to parsed row values,
+which would possibly enable some of the features below, Multi Column Parsing and
+Parse Dependencies, without requiring additional code. That might look like:
+
+    column product do |value, row|
+      Product.find_by(name: row.unparsed.row)
+    end
+
+#### Deferred Parsing
+
+Currently, CSVParty parses all columns before the row import logic is executed.
+There are situations where parsing columns is expensive and you may want to
+defer parsing columns until and unless you actually need them for that a given
+row. For example, say you have an import where you are either:
+
+1. Updating a value on existing records, or
+2. Setting a value on and creating new records
+
+And when you create new records, you have to also set a bunch of other values
+and some of those values require database queries.
+
+In a situation like this, you would want to defer all of the database queries
+that need to run when creating a new record so that they aren't done in cases
+where you are updating an existing record.
+
+#### Columns Macro
+
+This feature would allow you to declare multiple columns in a single line. So,
+rather than:
+
+    column :product
+    column :price
+    column :color
+
+You could do:
+
+    columns :product, :price, :color
+
+This is probably most useful when there are a bunch of columns that should all
+be parsed as text. Though it might make sense to allow specifying parsers and
+other options:
+
+    columns product: { as: :raw }, price: { as: :decimal }
+
+It should probably also be possible to combine `columns` and `column` macros:
+
+    columns :product, :price, :color
+    column :size
+
 #### Column Numbers
 
 CSVParty is entirely oriented around a CSV file having a header. This is not
@@ -269,3 +335,21 @@ that might look like:
         customer.orders.find(order_id)
       end
     end
+
+#### Rails Generator
+
+This feature would add a generator for Rails which creates an importer file. So
+doing:
+
+    rails generate importer Product
+
+Would generate the following file at `app/importers/product_importer.rb`:
+
+    class ProductImporter
+      include CSVParty
+
+      import do |row|
+        # import logic goes here
+      end
+    end
+

data/lib/csv_party/data_preparer.rb

@@ -1,3 +1,6 @@
+require 'csv'
+require 'csv_party/errors'
+
 module CSVParty
   class DataPreparer
     def initialize(options)
@@ -15,7 +18,7 @@ module CSVParty
                @options[:content]
              end
       options = extract_csv_options.merge(headers: true)
-      CSV.new(data, options)
+      CSV.new(data, **options)
     end
 
     private

data/lib/csv_party/dsl.rb

@@ -1,3 +1,5 @@
+require 'csv_party/configuration'
+
 module CSVParty
   module DSL
     def column(column, options = {}, &block)

data/lib/csv_party/parsers.rb

@@ -1,3 +1,5 @@
+require 'bigdecimal'
+
 module CSVParty
   module Parsers
     def parse_raw(value)
@@ -25,7 +27,7 @@ module CSVParty
     end
 
     def parse_decimal(value)
-      BigDecimal.new(prepare_numeric_value(value))
+      BigDecimal(prepare_numeric_value(value))
     end
 
     def parse_date(value, format = nil)

data/lib/csv_party/row.rb

@@ -1,10 +1,11 @@
+require 'ostruct'
+
 module CSVParty
   class Row
     attr_accessor :row_number, :csv_string, :unparsed
 
-    def initialize(csv_row, config, runner)
+    def initialize(csv_row, runner)
       @csv_row = csv_row
-      @config = config
       @runner = runner
       @attributes = OpenStruct.new
       parse_row!(csv_row)
@@ -16,7 +17,7 @@ module CSVParty
       self.csv_string = csv_row.to_csv
       self.unparsed = extract_unparsed_values(csv_row)
 
-      @config.columns.each do |column, options|
+      @runner.config.columns.each do |column, options|
         header = options[:header]
         value = csv_row[header]
         @attributes[column] = parse_value(value, options)
@@ -25,7 +26,7 @@ module CSVParty
 
     def extract_unparsed_values(csv_row)
       unparsed_row = OpenStruct.new
-      config.columns.each do |column, options|
+      @runner.config.columns.each do |column, options|
         header = options[:header]
         unparsed_row[column] = csv_row[header]
       end

data/lib/csv_party/runner.rb

@@ -1,8 +1,12 @@
 require 'csv_party/parsers'
+require 'csv_party/validations'
+require 'csv_party/errors'
+require 'csv_party/row'
 
 module CSVParty
   class Runner
     include Parsers
+    include Validations
 
     attr_accessor :csv, :config, :importer
 
@@ -52,24 +56,23 @@ module CSVParty
       csv.rewind
     end
 
+    def initialize_regex_headers!
+      config.columns_with_regex_headers.each do |name, options|
+        found_header = @_headers.find do |header|
+          options[:header].match(header)
+        end
+        options[:header] = found_header || name.to_s
+      end
+    end
+
     def import_rows!
       loop do
         begin
-          row = csv.shift
-          break unless row
-          import_row!(row)
-        rescue NextRowError
-          next
-        rescue SkippedRowError => error
-          handle_skipped_row(error)
-        rescue AbortedRowError => error
-          handle_aborted_row(error)
-        rescue AbortedImportError
-          raise
+          csv_row = csv.shift
+          break unless csv_row
+          import_row!(csv_row)
         rescue CSV::MalformedCSVError
           raise
-        rescue StandardError => error
-          handle_error(error, @_current_row_number, row.to_csv)
         end
       end
 
@@ -78,9 +81,20 @@ module CSVParty
 
     def import_row!(csv_row)
       @_current_row_number += 1
-      @_current_parsed_row = Row.new(csv_row, config, self)
+      @_current_parsed_row = Row.new(csv_row, self)
       @_current_parsed_row.row_number = @_current_row_number
+
       instance_exec(@_current_parsed_row, &config.row_importer)
+    rescue NextRowError
+      return
+    rescue SkippedRowError => error
+      handle_skipped_row(error)
+    rescue AbortedRowError => error
+      handle_aborted_row(error)
+    rescue AbortedImportError
+      raise
+    rescue StandardError => error
+      handle_error(error, @_current_row_number, csv_row.to_csv)
     end
 
     def next_row!
@@ -138,38 +152,6 @@ module CSVParty
             .new(error, line_number, csv_string)
     end
 
-    def raise_unless_row_processor_is_defined!
-      return if config.row_importer
-
-      raise UndefinedRowProcessorError.new
-    end
-
-    def raise_unless_rows_have_been_imported!
-      return if @_rows_have_been_imported
-
-      raise UnimportedRowsError.new
-    end
-
-    def raise_unless_all_dependencies_are_present!
-      config.dependencies.each do |dependency|
-        next unless importer.send(dependency).nil?
-
-        raise MissingDependencyError.new(self, dependency)
-      end
-    end
-
-    # This error has to be raised at runtime because, when the class body
-    # is being executed, the parser methods won't be available unless
-    # they are defined above the column definitions in the class body
-    def raise_unless_all_named_parsers_exist!
-      config.columns_with_named_parsers.each do |name, options|
-        parser = options[:parser]
-        next if named_parsers.include? parser
-
-        raise UnknownParserError.new(name, parser, named_parsers)
-      end
-    end
-
     def named_parsers
       (methods +
        private_methods +
@@ -177,21 +159,6 @@ module CSVParty
        importer.private_methods).grep(/^parse_/)
     end
 
-    def raise_unless_csv_has_all_columns!
-      return if missing_columns.empty?
-
-      raise MissingColumnError.new(present_columns, missing_columns)
-    end
-
-    def initialize_regex_headers!
-      config.columns_with_regex_headers.each do |name, options|
-        found_header = @_headers.find do |header|
-          options[:header].match(header)
-        end
-        options[:header] = found_header || name.to_s
-      end
-    end
-
     def respond_to_missing?(method, _include_private)
       importer.respond_to?(method, true)
     end

data/lib/csv_party/validations.rb

@@ -0,0 +1,41 @@
+module CSVParty
+  module Validations
+    def raise_unless_row_processor_is_defined!
+      return if config.row_importer
+
+      raise UndefinedRowProcessorError.new
+    end
+
+    def raise_unless_rows_have_been_imported!
+      return if @_rows_have_been_imported
+
+      raise UnimportedRowsError.new
+    end
+
+    def raise_unless_all_dependencies_are_present!
+      config.dependencies.each do |dependency|
+        next unless importer.send(dependency).nil?
+
+        raise MissingDependencyError.new(self, dependency)
+      end
+    end
+
+    # This error has to be raised at runtime because, when the class body
+    # is being executed, the parser methods won't be available unless
+    # they are defined above the column definitions in the class body
+    def raise_unless_all_named_parsers_exist!
+      config.columns_with_named_parsers.each do |name, options|
+        parser = options[:parser]
+        next if named_parsers.include? parser
+
+        raise UnknownParserError.new(name, parser, named_parsers)
+      end
+    end
+
+    def raise_unless_csv_has_all_columns!
+      return if missing_columns.empty?
+
+      raise MissingColumnError.new(present_columns, missing_columns)
+    end
+  end
+end

data/lib/csv_party.rb

@@ -1,11 +1,5 @@
-require 'bigdecimal'
-require 'csv'
-require 'ostruct'
-require 'csv_party/configuration'
 require 'csv_party/dsl'
 require 'csv_party/data_preparer'
-require 'csv_party/errors'
-require 'csv_party/row'
 require 'csv_party/runner'
 
 module CSVParty

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_party
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc4
+  version: 1.0.0.rc5
 platform: ruby
 authors:
 - Rico Jones
@@ -28,6 +28,7 @@ files:
 - lib/csv_party/row.rb
 - lib/csv_party/runner.rb
 - lib/csv_party/testing.rb
+- lib/csv_party/validations.rb
 homepage: https://github.com/toasterlovin/csv_party
 licenses:
 - MIT
@@ -40,15 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: CSV Party