csv_row_model 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1875456398a0d03c7704e622ef2fb992c628d436
-  data.tar.gz: 8da58e2819b99eb9be2caa92e319ec505fa7f6b5
+  metadata.gz: 1659654bb54054a7ee93eacb161b4aeb1d6dcca7
+  data.tar.gz: b3f0d04925efa748ac1cbab7ca9445824d5b9f3d
 SHA512:
-  metadata.gz: be79b067b838f8541dc176f82ba86dab9d4719354d8c500ed93f50bafc14e0eeeb9564e528c85fa619116d1b2274de0c217d7ab4ae81d2e6a9549f3eea3ead6c
-  data.tar.gz: 09c668f2d08663000b284c91d1b1c77fea8109fc84b392143035fb39f9cca3f9ed6707084a8d0b3308d133384dfa7fc3fc517dc39d928b77f03d727599b2fccc
+  metadata.gz: 4a2576d69bb8c8ee6116a3df5041625fac583068ba9711db8caa37c2420553b0d03b2aa7fd2f84d3735b3a28a95b091398a9a5dd244b4cada34cbdab611bd7e7
+  data.tar.gz: c5cc99b9063d8529fdf6b4dc8dc507cf3df60165ca1c3e5347499f6af1baf5ee7e8a04d4d4b38cc0020240d6cb7331480a5080aa37bda2b2d337c179039b1620

data/README.md

@@ -289,7 +289,7 @@ class ProjectImportRowModel < ProjectRowModel
 
     # this is shorthand for the psuedo_code:
     # def project
-    #  return if row_model.id.invalid? || row_model.name.invalid?
+    #  return if row_model.id.blank? || row_model.name.blank?
     #
     #  # turn off memoziation with `memoize: false` option
     #  @project ||= __the_code_inside_the_block__
@@ -328,9 +328,9 @@ Also, the `attribute` defines a dynamic `#project` method that:
 
 1. Memoizes by default, turn off with `memoize: false` option
 2. All errors of `row_model` are propagated to the presenter when calling `presenter.valid?`
-3. Handles dependencies. When any of the dependencies are `invalid?`:
-  - The attribute block is not called and the attribute returns `nil`.
-  - `presenter.errors` for dependencies are cleaned. For the example above, if `row_model.id/name` are `invalid?`, then
+3. Handles dependencies:
+  - When any of the dependencies are `blank?`, the attribute block is not called and the attribute returns `nil`.
+  - When any of the dependencies are `invalid?`, `presenter.errors` for dependencies are cleaned. For the example above, if `row_model.id/name` are `invalid?`, then
 the `:project` key is removed from the errors, so: `presenter.errors.keys # => [:id, :name]`
 
 ## Import Validations
@@ -440,7 +440,8 @@ class DynamicColumnModel
 
   column :first_name
   column :last_name
-  dynamic_column :skills
+  # header is optional, below is the default_implementation
+  dynamic_column :skills, header: ->(skill_name) { skill_name } 
 end
 ```
 
@@ -465,13 +466,6 @@ class DynamicColumnExportModel < DynamicColumnModel
     # below is an override, this is the default implementation: skill_name # => "skill1", then "skill2"
     source_model.skills.include?(skill_name) ? "Yes" : "No"
   end
-
-  class << self
-    # this is an override with the default implementation
-    def skill_header(skill_name)
-      skill_name
-    end
-  end
 end
 
 # the `skills` context is mapped to generate an array

data/lib/csv_row_model/concerns/inherited_class_var.rb

@@ -1,8 +1,14 @@
+require 'csv_row_model/concerns/invalid_options'
+
 module CsvRowModel
   module Concerns
     module InheritedClassVar
       extend ActiveSupport::Concern
 
+      included do
+        include InvalidOptions
+      end
+
       class_methods do
         # Clears the cache for a variable
         # @param variable_name [Symbol] variable_name to cache against
@@ -12,9 +18,41 @@ module CsvRowModel
 
         protected
 
+        # @param variable_name [Symbol] class variable name
+        def inherited_class_hash(variable_name, options={})
+          options = check_and_merge_options(options, dependencies: [])
+
+          options[:dependencies].each do |dependency_name|
+            define_singleton_method dependency_name do
+              class_cache(hidden_variable_name(dependency_name)) do
+                send("_#{dependency_name}")
+              end
+            end
+          end
+
+          hidden_variable_name = hidden_variable_name(variable_name)
+          define_singleton_method variable_name do
+            inherited_class_var(hidden_variable_name, {}, :merge)
+          end
+          define_singleton_method "merge_#{variable_name}" do |merge_value|
+            value = instance_variable_get(hidden_variable_name) || instance_variable_set(hidden_variable_name, {})
+
+            deep_clear_class_cache(hidden_variable_name)
+            options[:dependencies].each {|dependency_name| deep_clear_class_cache(hidden_variable_name(dependency_name)) }
+
+            value.merge!(merge_value)
+          end
+        end
+
+        # @param variable_name [Symbol] class variable name based on
+        # @return [Symbol] the hidden variable name for class_cache
+        def hidden_variable_name(variable_name)
+          "@_#{variable_name}".to_sym
+        end
+
         # @param included_module [Module] module to search for
         # @return [Array<Module>] inherited_ancestors of included_module (including self)
-        def inherited_ancestors(included_module=inherited_class_module)
+        def inherited_ancestors(included_module=CsvRowModel::Concerns::InheritedClassVar)
           included_model_index = ancestors.index(included_module)
           included_model_index == 0 ? [included_module] : ancestors[0..(included_model_index - 1)]
         end

data/lib/csv_row_model/concerns/invalid_options.rb

@@ -0,0 +1,17 @@
+module CsvRowModel
+  module Concerns
+    module InvalidOptions
+      extend ActiveSupport::Concern
+
+      class_methods do
+        protected
+        def check_and_merge_options(options, default_options)
+          invalid_options = options.keys - default_options.keys
+          raise ArgumentError.new("Invalid option(s): #{invalid_options}") if invalid_options.present?
+
+          options.reverse_merge(default_options)
+        end
+      end
+    end
+  end
+end

data/lib/csv_row_model/export/attributes.rb

@@ -0,0 +1,52 @@
+module CsvRowModel
+  module Export
+    module Attributes
+      extend ActiveSupport::Concern
+
+      included do
+        self.column_names.each { |*args| define_attribute_method(*args) }
+      end
+
+      # @return [Hash] a map of `column_name => self.class.format_cell()public_send(column_name))`
+      def formatted_attributes
+        formatted_attributes_from_column_names self.class.column_names
+      end
+
+      def formatted_attribute(column_name)
+        self.class.format_cell(
+          public_send(column_name),
+          column_name,
+          self.class.index(column_name)
+        )
+      end
+
+      protected
+      def formatted_attributes_from_column_names(column_names)
+        array_to_block_hash(column_names) { |column_name| formatted_attribute(column_name) }
+      end
+
+      class_methods do
+        # See {Model#column}
+        def column(column_name, options={})
+          super
+          define_attribute_method(column_name)
+        end
+
+        # 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)
+          cell
+        end
+      end
+    end
+  end
+end

data/lib/csv_row_model/export/dynamic_columns.rb

@@ -12,6 +12,11 @@ module CsvRowModel
         super.flatten
       end
 
+      # See Model::Columns#formatted_attributes
+      def formatted_attributes
+        super.merge(formatted_attributes_from_column_names(self.class.dynamic_column_names))
+      end
+
       class_methods do
         protected
 

data/lib/csv_row_model/export/file.rb

@@ -16,10 +16,13 @@ module CsvRowModel
       # Add a row_model to the
       # @param [] source_model the source model of the export row model
       # @param [Hash] context the extra context given to the instance of the row model
+      # @return [CsvRowModel::Export] the row model appended
       def append_model(source_model, context={})
-        export_model_class.new(source_model, context.to_h.reverse_merge(self.context)).to_rows.each do |row|
+        row_model = export_model_class.new(source_model, context.reverse_merge(self.context))
+        row_model.to_rows.each do |row|
           csv << row
         end
+        row_model
       end
       alias_method :<<, :append_model
 
@@ -35,7 +38,7 @@ module CsvRowModel
         CSV.open(file.path, "wb") do |csv|
           @csv = csv
           export_model_class.setup(csv, context, with_headers: with_headers)
-          yield self
+          yield Proxy.new(self)
         end
       ensure
         @csv = nil
@@ -44,6 +47,17 @@ module CsvRowModel
       def to_s
         file.read
       end
+
+      class Proxy
+        def initialize(file)
+          @file = file
+        end
+
+        def append_model(*args)
+          @file.append_model(*args)
+        end
+        alias_method :<<, :append_model
+      end
     end
   end
 end

data/lib/csv_row_model/export.rb

@@ -1,4 +1,5 @@
 require 'csv_row_model/export/dynamic_columns'
+require 'csv_row_model/export/attributes'
 
 module CsvRowModel
   # Include this to with {Model} to have a RowModel for exporting to CSVs.
@@ -6,11 +7,10 @@ module CsvRowModel
     extend ActiveSupport::Concern
 
     included do
+      include Attributes
       include DynamicColumns
-      attr_reader :source_model, :context
-
-      self.column_names.each { |*args| define_attribute_method(*args) }
 
+      attr_reader :source_model, :context
       validates :source_model, presence: true
     end
 
@@ -27,34 +27,13 @@ module CsvRowModel
 
     # @return [Array] an array of public_send(column_name) of the CSV model
     def to_row
-      attributes.values
+      formatted_attributes.values
     end
 
     class_methods do
       def setup(csv, context={}, with_headers: true)
         csv << headers(context) if with_headers
       end
-
-      # See {Model#column}
-      def column(column_name, options={})
-        super
-        define_attribute_method(column_name)
-      end
-
-      # 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
-          self.class.format_cell(source_model.public_send(column_name), column_name, self.class.index(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)
-        cell
-      end
     end
   end
 end

data/lib/csv_row_model/import/csv.rb

@@ -102,16 +102,13 @@ module CsvRowModel
       def _read_row(skipped_rows={}, index=@index, ruby_csv=@ruby_csv)
         return unless valid?
 
-        loop do
-          row = ruby_csv.readline
+        row = ruby_csv.readline
+        raise "empty?" if row.try(:empty?)
 
-          raise "empty?" if row.try(:empty?)
-
-          index += 1 if index
+        index += 1 if index
 
-          yield row if block_given?
-          return row
-        end
+        yield row if block_given?
+        row
       rescue Exception => e
         index += 1 if index
         yield [] if block_given?

data/lib/csv_row_model/import/presenter.rb

@@ -5,6 +5,8 @@ module CsvRowModel
       include Concerns::Inspect
       include ActiveWarnings
 
+      inherited_class_hash :attributes, dependencies: %i[dependencies]
+
       attr_reader :row_model
 
       delegate :context, to: :row_model
@@ -64,15 +66,16 @@ module CsvRowModel
       end
 
       # @param [Array] Array of column_names to check
-      # @return [Boolean] if column_names are valid
-      def row_model_valid?(*column_names)
-        row_model.valid? || (row_model.errors.keys & column_names).empty?
+      # @return [Boolean] if column_names are present
+      def row_model_present?(*column_names)
+        column_names.each { |column_name| return false if row_model.public_send(column_name).blank? }
+        true
       end
 
       # @param [Symbol] attribute_name the attribute to check
       # @return [Boolean] if the dependencies are valid
       def valid_dependencies?(attribute_name)
-        row_model_valid?(*self.class.options(attribute_name)[:dependencies])
+        row_model_present?(*self.class.options(attribute_name)[:dependencies])
       end
 
       # equal to: @method_name ||= yield
@@ -84,20 +87,11 @@ module CsvRowModel
       end
 
       class << self
-        def inherited_class_module
-          Presenter
-        end
-
         # @return [Array<Symbol>] attribute names for the Presenter
         def attribute_names
           attributes.keys
         end
 
-        # @return [Hash{Symbol => Array}] map of `attribute_name => [options, block]`
-        def attributes
-          inherited_class_var :@_presenter_attributes, {}, :merge
-        end
-
         # @param [Symbol] attribute_name name of attribute to find option
         # @return [Hash] options for the attribute_name
         def options(attribute_name)
@@ -110,32 +104,23 @@ module CsvRowModel
           attributes[attribute_name].last
         end
 
+        protected
         # @return [Hash{Symbol => Array}] map of `dependency => [array of presenter attributes dependent on dependency]`
-        def dependencies
-          class_cache(:@_presenter_dependencies) do
-            dependencies = {}
-            attribute_names.each do |attribute_name|
-              options(attribute_name)[:dependencies].each do |dependency|
-                dependencies[dependency] ||= []
-                dependencies[dependency] << attribute_name
-              end
+        def _dependencies
+          dependencies = {}
+          attribute_names.each do |attribute_name|
+            options(attribute_name)[:dependencies].each do |dependency|
+              dependencies[dependency] ||= []
+              dependencies[dependency] << attribute_name
             end
-            dependencies
           end
+          dependencies
         end
 
-        protected
         def inspect_methods
           @inspect_methods ||= %i[row_model].freeze
         end
 
-        def merge_attribute(attribute_hash)
-          @_presenter_attributes ||= {}
-          deep_clear_class_cache(:@_presenter_attributes)
-          deep_clear_class_cache(:@_presenter_dependencies)
-          @_presenter_attributes.merge! attribute_hash
-        end
-
         # Adds column to the row model
         #
         # @param [Symbol] attribute_name name of attribute to add
@@ -144,13 +129,9 @@ module CsvRowModel
         # @option options [Hash] :memoize whether to memoize the attribute (default: true)
         # @option options [Hash] :dependencies the dependcies it has with the underlying row_model (default: [])
         def attribute(attribute_name, options={}, &block)
-          default_options = { memoize: true, dependencies: [] }
-          invalid_options = options.keys - default_options.keys
-          raise ArgumentError.new("Invalid option(s): #{invalid_options}") if invalid_options.present?
-
-          options = options.reverse_merge(default_options)
+          options = check_and_merge_options(options, memoize: true, dependencies: [])
 
-          merge_attribute(attribute_name.to_sym => [options, block])
+          merge_attributes(attribute_name.to_sym => [options, block])
           define_attribute_method(attribute_name)
         end
 

data/lib/csv_row_model/import.rb

@@ -12,7 +12,7 @@ module CsvRowModel
       include Attributes
       include DynamicColumns
 
-      attr_reader :attr_reader, :source_header, :source_row, :context, :index, :previous
+      attr_reader :source_header, :source_row, :context, :index, :previous
 
       self.column_names.each { |*args| define_attribute_method(*args) }
 

data/lib/csv_row_model/model/children.rb

@@ -2,6 +2,9 @@ module CsvRowModel
   module Model
     module Children
       extend ActiveSupport::Concern
+      included do
+        inherited_class_hash :has_many_relationships
+      end
 
       # @return [Boolean] returns true, if the instance is a child
       def child?
@@ -40,20 +43,6 @@ module CsvRowModel
       end
 
       class_methods do
-        # Won't work for Export right now
-        #
-        # @return [Hash] map of `relation_name => CsvRowModel::Import or CsvRowModel::Export class`
-        def has_many_relationships
-          inherited_class_var :@_has_many_relationships, {}, :merge
-        end
-
-        protected
-        def merge_has_many_relationships(relation_hash)
-          @_has_many_relationships ||= {}
-          deep_clear_class_cache(:@_has_many_relationships)
-          @_has_many_relationships.merge! relation_hash
-        end
-
         # Defines a relationship between a row model (only one relation per model for now).
         #
         # @param [Symbol] relation_name the name of the relation

data/lib/csv_row_model/model/columns.rb

@@ -2,6 +2,9 @@ module CsvRowModel
   module Model
     module Columns
       extend ActiveSupport::Concern
+      included do
+        inherited_class_hash :columns
+      end
 
       # @return [Hash] a map of `column_name => public_send(column_name)`
       def attributes
@@ -17,10 +20,16 @@ module CsvRowModel
       end
 
       protected
+
       def attributes_from_column_names(column_names)
-        column_names
-          .zip(column_names.map { |column_name| public_send(column_name) })
-          .to_h
+        array_to_block_hash(column_names) { |column_name| public_send(column_name) }
+      end
+
+      def array_to_block_hash(array, &block)
+        array
+          .zip(
+            array.map { |column_name| block.call(column_name) }
+          ).to_h
       end
 
       class_methods do
@@ -29,11 +38,6 @@ module CsvRowModel
           columns.keys
         end
 
-        # @return [Hash] column names mapped to their options
-        def columns
-          inherited_class_var(:@_columns, {}, :merge)
-        end
-
         # @param [Symbol] column_name name of column to find option
         # @return [Hash] options for the column_name
         def options(column_name)
@@ -55,7 +59,7 @@ module CsvRowModel
         # @param [Hash, OpenStruct] context name of column to check
         # @return [Array] column headers for the row model
         def headers(context={})
-          @headers ||= columns.map { |name, options| options[:header] || format_header(name) }
+          columns.map { |name, options| options[:header] || format_header(name) }
         end
 
         # Safe to override
@@ -67,12 +71,6 @@ module CsvRowModel
 
         protected
 
-        def merge_columns(column_hash)
-          @_columns ||= {}
-          deep_clear_class_cache(:@_columns)
-          @_columns.merge!(column_hash)
-        end
-
         VALID_OPTIONS_KEYS = %i[type parse validate_type default header header_matchs].freeze
 
         # Adds column to the row model

data/lib/csv_row_model/model/dynamic_columns.rb

@@ -3,6 +3,10 @@ module CsvRowModel
     module DynamicColumns
       extend ActiveSupport::Concern
 
+      included do
+        inherited_class_hash :dynamic_columns
+      end
+
       # See Model::Columns#attributes
       def attributes
         super.merge(attributes_from_column_names(self.class.dynamic_column_names))
@@ -11,9 +15,14 @@ module CsvRowModel
       class_methods do
         # See Model::Columns::headers
         def headers(context={})
-          @headers ||= super + dynamic_column_names.map do |column_name|
+          super + dynamic_column_headers(context)
+        end
+
+        def dynamic_column_headers(context={})
+          dynamic_column_names.map do |column_name|
             OpenStruct.new(context).public_send(column_name).each do |header_model|
-              public_send(header_method_name(column_name), header_model)
+              header_proc = dynamic_column_options(column_name)[:header] || ->(header_model) { header_model }
+              instance_exec(header_model, &header_proc)
             end
           end.flatten
         end
@@ -24,32 +33,22 @@ module CsvRowModel
           offset ? columns.size + offset : nil
         end
 
+        def dynamic_column_options(column_name)
+          dynamic_columns[column_name]
+        end
+
         # @return [Array<Symbol>] column names for the row model
         def dynamic_column_names
           dynamic_columns.keys
         end
 
-        # @return [Hash] column names mapped to their options
-        def dynamic_columns
-          inherited_class_var(:@_dynamic_columns, {}, :merge)
-        end
-
-        def header_method_name(column_name)
-          "#{column_name.to_s.singularize}_header"
-        end
         def singular_dynamic_attribute_method_name(column_name)
           column_name.to_s.singularize
         end
 
         protected
 
-        def merge_dynamic_columns(column_hash)
-          @_dynamic_columns ||= {}
-          deep_clear_class_cache(:@_dynamic_columns)
-          @_dynamic_columns.merge!(column_hash)
-        end
-
-        VALID_OPTIONS_KEYS = [].freeze
+        VALID_OPTIONS_KEYS = %i[header].freeze
 
         # define a dynamic_column, must be after all normal columns
         #
@@ -60,14 +59,8 @@ module CsvRowModel
           extra_keys = options.keys - VALID_OPTIONS_KEYS
           raise ArgumentError.new("invalid options #{extra_keys}") unless extra_keys.empty?
 
-          define_header_method(column_name)
-
           merge_dynamic_columns(column_name.to_sym => options)
         end
-
-        def define_header_method(column_name)
-          define_singleton_method(header_method_name(column_name)) { |header_model| header_model }
-        end
       end
     end
   end

data/lib/csv_row_model/model.rb

@@ -61,10 +61,6 @@ module CsvRowModel
       def csv_string_model(&block)
         csv_string_model_class.class_eval(&block)
       end
-
-      def inherited_class_module
-        Model
-      end
     end
   end
 end

data/lib/csv_row_model/version.rb

@@ -1,3 +1,3 @@
 module CsvRowModel
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_row_model
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Chung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -62,8 +62,10 @@ files:
 - lib/csv_row_model.rb
 - lib/csv_row_model/concerns/inherited_class_var.rb
 - lib/csv_row_model/concerns/inspect.rb
+- lib/csv_row_model/concerns/invalid_options.rb
 - lib/csv_row_model/engine.rb
 - lib/csv_row_model/export.rb
+- lib/csv_row_model/export/attributes.rb
 - lib/csv_row_model/export/dynamic_columns.rb
 - lib/csv_row_model/export/file.rb
 - lib/csv_row_model/export/file_model.rb
@@ -111,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Import and export your custom CSVs with a intuitive shared Ruby interface.