csv_row_model 0.3.10 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c16a446fafcc7457fffac11919745acfa9f283cd
-  data.tar.gz: ea6cdbed5009681cc3a8b92452f5b94bfc722640
+  metadata.gz: d13ce436eddba3a6cd5ad084cbd534098637279b
+  data.tar.gz: c0132db76eb2855b4fc0eddbe288a54e741e0544
 SHA512:
-  metadata.gz: 6d3e8e9b72a3614bfe036917d2f724802ed8c1f9f42b0013273f761a6b9d850075ff52c2744c520b5a9159410fc99f9d87be15c12d4d614b9938feabf47c0dcf
-  data.tar.gz: 49ab3a6bfbb1b34c293fb309b1f5cea4ea694ec667884ce39334e9d247dad7f51a867f728a1abe451c0b25f3de5a8d6625b2a602d35ba6e08d4afd9f5dd80d23
+  metadata.gz: 92c5b48c05ca65a73f997061a0db142b9cb684940b6adca4dee691d33b00b0bb115d4db05d6375da7e7b870c5334c667f95f4b7d5525d6c74c4eee44042d08a1
+  data.tar.gz: 4885e9fc4282bc8974ed6fe3f7db11c4f39875b142a0e0daca002341aff015c5f68d25017727072369592f6b6a7f50ad460c6d86cbdb7839dedad8bcf0442366

data/README.md

@@ -8,8 +8,10 @@ First define your schema:
 class ProjectRowModel
   include CsvRowModel::Model
 
-  column :id
+  column :id, options
   column :name
+  
+  merge_options :id, more_options # optional
 end
 ```
 

data/lib/csv_row_model/concerns/inherited_class_var.rb

@@ -4,10 +4,7 @@ module CsvRowModel
   module Concerns
     module InheritedClassVar
       extend ActiveSupport::Concern
-
-      included do
-        include InvalidOptions
-      end
+      include InvalidOptions
 
       class_methods do
         # Clears the cache for a variable

data/lib/csv_row_model/export.rb

@@ -1,39 +1,17 @@
+require 'csv_row_model/export/base'
 require 'csv_row_model/export/dynamic_columns'
 require 'csv_row_model/export/attributes'
+require 'csv_row_model/model/comparison'
 
 module CsvRowModel
   # Include this to with {Model} to have a RowModel for exporting to CSVs.
   module Export
     extend ActiveSupport::Concern
 
-    included do
-      include Attributes
-      include DynamicColumns
+    include Base
+    include Attributes
+    include DynamicColumns
 
-      attr_reader :source_model, :context
-      validates :source_model, presence: true
-    end
-
-    # @param [Model] source_model object to export to CSV
-    # @param [Hash]  context
-    def initialize(source_model, context={})
-      @source_model = source_model
-      @context      = OpenStruct.new(context)
-    end
-
-    def to_rows
-      [to_row]
-    end
-
-    # @return [Array] an array of public_send(column_name) of the CSV model
-    def to_row
-      formatted_attributes.values
-    end
-
-    class_methods do
-      def setup(csv, context={}, with_headers: true)
-        csv << headers(context) if with_headers
-      end
-    end
+    include Model::Comparison # can't be added on Model module because Model does not have attributes implemented
   end
 end

data/lib/csv_row_model/export/attributes.rb

@@ -1,12 +1,9 @@
-require 'csv_row_model/model/comparison'
-
 module CsvRowModel
   module Export
     module Attributes
       extend ActiveSupport::Concern
 
       included do
-        include Model::Comparison
         self.column_names.each { |*args| define_attribute_method(*args) }
       end
 
@@ -32,6 +29,14 @@ module CsvRowModel
       end
 
       class_methods do
+        # Safe to override. Method applied to each cell by default
+        #
+        # @param cell [Object] the cell's value
+        def format_cell(cell, column_name, column_index, context={})
+          cell
+        end
+
+        protected
         # See {Model#column}
         def column(column_name, options={})
           super
@@ -41,16 +46,8 @@ module CsvRowModel
         # Define default attribute method for a column
         # @param column_name [Symbol] the cell's column_name
         def define_attribute_method(column_name)
-          define_method(column_name) do
-            source_model.public_send(column_name)
-          end
-        end
-
-        # Safe to override. Method applied to each cell by default
-        #
-        # @param cell [Object] the cell's value
-        def format_cell(cell, column_name, column_index, context={})
-          cell
+          return if method_defined? column_name
+          define_method(column_name) { source_model.public_send(column_name) }
         end
       end
     end

data/lib/csv_row_model/export/base.rb

@@ -0,0 +1,34 @@
+module CsvRowModel
+  module Export
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :source_model, :context
+        validates :source_model, presence: true
+      end
+
+      # @param [Model] source_model object to export to CSV
+      # @param [Hash]  context
+      def initialize(source_model, context={})
+        @source_model = source_model
+        @context      = OpenStruct.new(context)
+      end
+
+      def to_rows
+        [to_row]
+      end
+
+      # @return [Array] an array of public_send(column_name) of the CSV model
+      def to_row
+        formatted_attributes.values
+      end
+
+      class_methods do
+        def setup(csv, context={}, with_headers: true)
+          csv << headers(context) if with_headers
+        end
+      end
+    end
+  end
+end

data/lib/csv_row_model/import.rb

@@ -1,148 +1,19 @@
+require 'csv_row_model/import/base'
 require 'csv_row_model/import/attributes'
-require 'csv_row_model/import/presenter'
 require 'csv_row_model/import/dynamic_columns'
+require 'csv_row_model/model/comparison'
 
 module CsvRowModel
   # Include this to with {Model} to have a RowModel for importing csvs.
   module Import
     extend ActiveSupport::Concern
 
-    included do
-      include Concerns::Inspect
-      include Attributes
-      include DynamicColumns
+    include Concerns::Inspect
 
-      attr_reader :source_header, :source_row, :context, :index, :previous
+    include Base
+    include Attributes
+    include DynamicColumns
 
-      self.column_names.each { |*args| define_attribute_method(*args) }
-
-      validates :source_row, presence: true
-    end
-
-    # @param [Array] source_row the csv row
-    # @param options [Hash]
-    # @option options [Integer] :index index in the CSV file
-    # @option options [Hash] :context extra data you want to work with the model
-    # @option options [Array] :source_header the csv header row
-    # @option options [CsvRowModel::Import] :previous the previous row model
-    # @option options [CsvRowModel::Import] :parent if the instance is a child, pass the parent
-    def initialize(source_row, options={})
-      options = options.symbolize_keys.reverse_merge(context: {})
-      @source_row, @context = source_row, OpenStruct.new(options[:context])
-      @index, @source_header, @previous = options[:index], options[:source_header], options[:previous].try(:dup)
-
-      previous.try(:free_previous)
-      super(source_row, options)
-    end
-
-    # @return [Hash] a map of `column_name => source_row[index_of_column_name]`
-    def mapped_row
-      return {} unless source_row
-      @mapped_row ||= self.class.column_names.zip(source_row).to_h
-    end
-
-    # Free `previous` from memory to avoid making a linked list
-    def free_previous
-      @previous = nil
-    end
-
-    # @return [Presenter] the presenter of self
-    def presenter
-      @presenter ||= self.class.presenter_class.new(self)
-    end
-
-    # @return [Model::CsvStringModel] a model with validations related to Model::csv_string_model (values are from format_cell)
-    def csv_string_model
-      @csv_string_model ||= begin
-        if source_row
-          column_names = self.class.column_names
-          hash = column_names.zip(
-            column_names.map.with_index do |column_name, index|
-              self.class.format_cell(source_row[index], column_name, index, context)
-            end
-          ).to_h
-        else
-          hash = {}
-        end
-
-        self.class.csv_string_model_class.new(hash)
-      end
-    end
-
-    # Safe to override.
-    #
-    # @return [Boolean] returns true, if this instance should be skipped
-    def skip?
-      !valid? || presenter.skip?
-    end
-
-    # Safe to override.
-    #
-    # @return [Boolean] returns true, if the entire csv file should stop reading
-    def abort?
-      presenter.abort?
-    end
-
-    def valid?(*args)
-      super
-
-      proc = -> do
-        csv_string_model.valid?(*args)
-        errors.messages.merge!(csv_string_model.errors.messages.reject {|k, v| v.empty? })
-        errors.empty?
-      end
-
-      if using_warnings?
-        csv_string_model.using_warnings(&proc)
-      else
-        proc.call
-      end
-    end
-
-    class_methods do
-      # See {Model#column}
-      def column(column_name, options={})
-        super
-        define_attribute_method(column_name)
-      end
-
-      # @param [Import::Csv] csv to read from
-      # @param [Hash] context extra data you want to work with the model
-      # @param [Import] prevuous the previous row model
-      # @return [Import] the next model instance from the csv
-      def next(csv, source_header, context={}, previous=nil)
-        csv.skip_header
-        row_model = nil
-
-        loop do # loop until the next parent or end_of_file? (need to read children rows)
-          csv.read_row
-          row_model ||= new(csv.current_row,
-                            index: csv.index,
-                            source_header: source_header,
-                            context: context,
-                            previous: previous)
-
-          return row_model if csv.end_of_file?
-
-          next_row_is_parent = !row_model.append_child(csv.next_row)
-          return row_model if next_row_is_parent
-        end
-      end
-
-      # @return [Class] the Class of the Presenter
-      def presenter_class
-        @presenter_class ||= inherited_custom_class(:presenter_class, Presenter)
-      end
-
-      protected
-      def inspect_methods
-        @inspect_methods ||= %i[mapped_row initialized_at parent context previous].freeze
-      end
-
-      # Call to define the presenter
-      def presenter(&block)
-        presenter_class.class_eval(&block)
-      end
-    end
+    include Model::Comparison # can't be added on Model module because Model does not have attributes implemented
   end
 end

data/lib/csv_row_model/import/attributes.rb

@@ -1,5 +1,4 @@
 require 'csv_row_model/validators/boolean_format'
-require 'csv_row_model/model/comparison'
 
 module CsvRowModel
   module Import
@@ -7,7 +6,7 @@ module CsvRowModel
       extend ActiveSupport::Concern
 
       included do
-        include Model::Comparison
+        self.column_names.each { |*args| define_attribute_method(*args) }
       end
 
       # Classes with a validations associated with them in csv_row_model/validators
@@ -90,9 +89,22 @@ module CsvRowModel
         end
 
         protected
+        # See {Model#column}
+        def column(column_name, options={})
+          super
+          define_attribute_method(column_name)
+        end
+
+        def merge_options(column_name, options={})
+          original_options = options(column_name)
+          add_type_validation(column_name) if !original_options[:validate_type] && options[:validate_type]
+          super
+        end
+
         # Define default attribute method for a column
         # @param column_name [Symbol] the cell's column_name
         def define_attribute_method(column_name)
+          return if method_defined? column_name
           add_type_validation(column_name)
           define_method(column_name) { original_attribute(column_name) }
         end

data/lib/csv_row_model/import/base.rb

@@ -0,0 +1,136 @@
+require 'csv_row_model/import/presenter'
+
+module CsvRowModel
+  module Import
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :source_header, :source_row, :context, :index, :previous
+
+        validates :source_row, presence: true
+      end
+
+
+      # @param [Array] source_row the csv row
+      # @param options [Hash]
+      # @option options [Integer] :index index in the CSV file
+      # @option options [Hash] :context extra data you want to work with the model
+      # @option options [Array] :source_header the csv header row
+      # @option options [CsvRowModel::Import] :previous the previous row model
+      # @option options [CsvRowModel::Import] :parent if the instance is a child, pass the parent
+      def initialize(source_row, options={})
+        options = options.symbolize_keys.reverse_merge(context: {})
+        @source_row, @context = source_row, OpenStruct.new(options[:context])
+        @index, @source_header, @previous = options[:index], options[:source_header], options[:previous].try(:dup)
+
+        previous.try(:free_previous)
+        super(source_row, options)
+      end
+
+      # @return [Hash] a map of `column_name => source_row[index_of_column_name]`
+      def mapped_row
+        return {} unless source_row
+        @mapped_row ||= self.class.column_names.zip(source_row).to_h
+      end
+
+      # Free `previous` from memory to avoid making a linked list
+      def free_previous
+        @previous = nil
+      end
+
+      # @return [Presenter] the presenter of self
+      def presenter
+        @presenter ||= self.class.presenter_class.new(self)
+      end
+
+      # @return [Model::CsvStringModel] a model with validations related to Model::csv_string_model (values are from format_cell)
+      def csv_string_model
+        @csv_string_model ||= begin
+          if source_row
+            column_names = self.class.column_names
+            hash = column_names.zip(
+              column_names.map.with_index do |column_name, index|
+                self.class.format_cell(source_row[index], column_name, index, context)
+              end
+            ).to_h
+          else
+            hash = {}
+          end
+
+          self.class.csv_string_model_class.new(hash)
+        end
+      end
+
+      # Safe to override.
+      #
+      # @return [Boolean] returns true, if this instance should be skipped
+      def skip?
+        !valid? || presenter.skip?
+      end
+
+      # Safe to override.
+      #
+      # @return [Boolean] returns true, if the entire csv file should stop reading
+      def abort?
+        presenter.abort?
+      end
+
+      def valid?(*args)
+        super
+
+        proc = -> do
+          csv_string_model.valid?(*args)
+          errors.messages.merge!(csv_string_model.errors.messages.reject {|k, v| v.empty? })
+          errors.empty?
+        end
+
+        if using_warnings?
+          csv_string_model.using_warnings(&proc)
+        else
+          proc.call
+        end
+      end
+
+      class_methods do
+        # @param [Import::Csv] csv to read from
+        # @param [Hash] context extra data you want to work with the model
+        # @param [Import] prevuous the previous row model
+        # @return [Import] the next model instance from the csv
+        def next(csv, source_header, context={}, previous=nil)
+          csv.skip_header
+          row_model = nil
+
+          loop do # loop until the next parent or end_of_file? (need to read children rows)
+            csv.read_row
+            row_model ||= new(csv.current_row,
+                              index: csv.index,
+                              source_header: source_header,
+                              context: context,
+                              previous: previous)
+
+            return row_model if csv.end_of_file?
+
+            next_row_is_parent = !row_model.append_child(csv.next_row)
+            return row_model if next_row_is_parent
+          end
+        end
+
+        # @return [Class] the Class of the Presenter
+        def presenter_class
+          @presenter_class ||= inherited_custom_class(:presenter_class, Presenter)
+        end
+
+        protected
+        def inspect_methods
+          @inspect_methods ||= %i[mapped_row initialized_at parent context previous].freeze
+        end
+
+        # Call to define the presenter
+        def presenter(&block)
+          presenter_class.class_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/csv_row_model/import/file/validations.rb

@@ -4,10 +4,10 @@ module CsvRowModel
       module Validations
         extend ActiveSupport::Concern
 
-        included do
-          include ActiveModel::Validations
-          include Validators::ValidateAttributes
+        include ActiveModel::Validations
+        include Validators::ValidateAttributes
 
+        included do
           validate_attributes :csv
         end
 

data/lib/csv_row_model/model.rb

@@ -1,5 +1,6 @@
 require 'csv_row_model/model/csv_string_model'
 
+require 'csv_row_model/model/base'
 require 'csv_row_model/model/columns'
 require 'csv_row_model/model/children'
 require 'csv_row_model/model/dynamic_columns'
@@ -9,58 +10,15 @@ module CsvRowModel
   module Model
     extend ActiveSupport::Concern
 
-    included do
-      include Concerns::InheritedClassVar
+    include Concerns::InheritedClassVar
 
-      include ActiveWarnings
-      include Validators::ValidateAttributes
+    include ActiveWarnings
+    include Validators::ValidateAttributes
 
-      include Columns
-      include Children
-      include DynamicColumns
+    include Base
 
-      # @return [Model] return the parent, if this instance is a child
-      attr_reader :parent
-
-      # @return [DateTime] return when self has been intialized
-      attr_reader :initialized_at
-
-      validate_attributes :parent
-    end
-
-    # @param [NilClass] source not used here, see {Input}
-    # @param [Hash] options
-    # @option options [String] :parent if the instance is a child, pass the parent
-    def initialize(source=nil, options={})
-      @initialized_at = DateTime.now
-      @parent = options[:parent]
-    end
-
-    # Safe to override.
-    #
-    # @return [Boolean] returns true, if this instance should be skipped
-    def skip?
-      !valid?
-    end
-
-    # Safe to override.
-    #
-    # @return [Boolean] returns true, if the entire csv file should stop reading
-    def abort?
-      false
-    end
-
-    class_methods do
-      # @return [Class] the Class with validations of the csv_string_model
-      def csv_string_model_class
-        @csv_string_model_class ||= inherited_custom_class(:csv_string_model_class, CsvStringModel)
-      end
-
-      protected
-      # Called to add validations to the csv_string_model_class
-      def csv_string_model(&block)
-        csv_string_model_class.class_eval(&block)
-      end
-    end
+    include Columns
+    include Children
+    include DynamicColumns
   end
 end

data/lib/csv_row_model/model/base.rb

@@ -0,0 +1,52 @@
+module CsvRowModel
+  module Model
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        # @return [Model] return the parent, if this instance is a child
+        attr_reader :parent
+
+        # @return [DateTime] return when self has been intialized
+        attr_reader :initialized_at
+
+        validate_attributes :parent
+      end
+
+      # @param [NilClass] source not used here, see {Input}
+      # @param [Hash] options
+      # @option options [String] :parent if the instance is a child, pass the parent
+      def initialize(source=nil, options={})
+        @initialized_at = DateTime.now
+        @parent = options[:parent]
+      end
+
+      # Safe to override.
+      #
+      # @return [Boolean] returns true, if this instance should be skipped
+      def skip?
+        !valid?
+      end
+
+      # Safe to override.
+      #
+      # @return [Boolean] returns true, if the entire csv file should stop reading
+      def abort?
+        false
+      end
+
+      class_methods do
+        # @return [Class] the Class with validations of the csv_string_model
+        def csv_string_model_class
+          @csv_string_model_class ||= inherited_custom_class(:csv_string_model_class, CsvStringModel)
+        end
+
+        protected
+        # Called to add validations to the csv_string_model_class
+        def csv_string_model(&block)
+          csv_string_model_class.class_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/csv_row_model/model/columns.rb

@@ -87,12 +87,18 @@ module CsvRowModel
         # @option options [String] :header human friendly string of the column name, by default format_header(column_name)
         # @option options [Hash] :header_matchs array with string to match cell to find in the row, by default column name
         def column(column_name, options={})
+          column_name = column_name.to_sym
+
           extra_keys = options.keys - VALID_OPTIONS_KEYS
           raise ArgumentError.new("invalid options #{extra_keys}") unless extra_keys.empty?
 
-          merge_columns(column_name.to_sym => options)
+          merge_columns(column_name => options)
+        end
+
+        def merge_options(column_name, options={})
+          column_name = column_name.to_sym
+          column(column_name, (options(column_name) || {}).merge(options))
         end
-        # alias_method :row, :column
       end
     end
   end

data/lib/csv_row_model/model/dynamic_columns.rb

@@ -2,7 +2,6 @@ module CsvRowModel
   module Model
     module DynamicColumns
       extend ActiveSupport::Concern
-
       included do
         inherited_class_hash :dynamic_columns
       end

data/lib/csv_row_model/model/file_model.rb

@@ -4,7 +4,6 @@ module CsvRowModel
       extend ActiveSupport::Concern
 
       included do
-
         class << self
           alias_method :row_names, :column_names
           alias_method :rows, :columns

data/lib/csv_row_model/version.rb

@@ -1,3 +1,3 @@
 module CsvRowModel
-  VERSION = "0.3.10"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_row_model
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.4.0
 platform: ruby
 authors:
 - Steve Chung
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,11 +66,13 @@ files:
 - lib/csv_row_model/engine.rb
 - lib/csv_row_model/export.rb
 - lib/csv_row_model/export/attributes.rb
+- lib/csv_row_model/export/base.rb
 - lib/csv_row_model/export/dynamic_columns.rb
 - lib/csv_row_model/export/file.rb
 - lib/csv_row_model/export/file_model.rb
 - lib/csv_row_model/import.rb
 - lib/csv_row_model/import/attributes.rb
+- lib/csv_row_model/import/base.rb
 - lib/csv_row_model/import/csv.rb
 - lib/csv_row_model/import/dynamic_columns.rb
 - lib/csv_row_model/import/file.rb
@@ -79,6 +81,7 @@ files:
 - lib/csv_row_model/import/file_model.rb
 - lib/csv_row_model/import/presenter.rb
 - lib/csv_row_model/model.rb
+- lib/csv_row_model/model/base.rb
 - lib/csv_row_model/model/children.rb
 - lib/csv_row_model/model/columns.rb
 - lib/csv_row_model/model/comparison.rb