csvbuilder-dynamic-columns-core 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286cc68dc88a8b1e34d6c35178197a18baaf87325413eb21cf3f85a988a189f2
-  data.tar.gz: 2c67f25a060145b14c161fa14ec6cc1ae48f2c8176868f15b2c1b8f1900f7854
+  metadata.gz: 5fdfc267670291ff9caefe6dfee13d22561acaac5286f31eee8124f980b32936
+  data.tar.gz: e1308d57584b7bfc37ab11e125e0cc3f4bc4bab28a9da0eac62ba4f85c7a2642
 SHA512:
-  metadata.gz: b978378d072890a66da304afc010f0eeabe18e204927c4f9ccc18888ab497acc3cb1cf22f6fe8812423bedaabd4bd9a2b3b2920c1c52a35244e1006b794304b6
-  data.tar.gz: 642a379dc4ed3a6eee45846994fd856015f7b24d9a15f5e07f2438d1287e4242a01324c03bca5de492eee1ef7461556e6d94b42cb76e9fcf107635504ba94e01
+  metadata.gz: bff40a5481025d39c46822f193b49e2df35ad946c6c60cb1c8f366767d4e1915cddb92f82962af36a4c832c99c48e38eb8c4756edf1594d4f537ca4d312b1078
+  data.tar.gz: 50346320272ecf16a63b4736a3736b9c9c5621a6a403c720e29ea284c3431be07389ef67dcbaa0cd6d05e6eb2ecd8f71713d51a47f67b82390d0dd6e210c4d86

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.1.1] - 2022-12-21
+
+Change the option :header_models_context_key to :as
+Fix the call of process_cell_method_name with the correct name
+
 ## [0.1.0] - 2022-12-21
 
 - Initial release

data/Gemfile.lock

@@ -55,7 +55,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.1)
+    rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)

data/README.md

@@ -1,22 +1,115 @@
-# Csvbuilder::Dynamic::Columns
+# Csvbuilder::Dynamic::Columns::Core
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/csvbuilder/dynamic/columns`. To experiment with that code, run `bin/console` for an interactive prompt.
+[Csvbuilder::Dynamic::Columns::Core](https://github.com/joel/csvbuilder-dynamic-columns-core) is part of the [csvbuilder-collection](https://github.com/joel/csvbuilder)
 
-TODO: Delete this and the text above, and describe your gem
+The Dynamic Columns Core contains the shared components used and extended by the Dynamic Columns Exporter and the Dynamic Columns Importer. It carries the architecture for the Dynamic Columns feature, and it can’t be used alone.
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add csvbuilder-dynamic-columns
+    $ bundle add csvbuilder-dynamic-columns-core
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install csvbuilder-dynamic-columns
+    $ gem install csvbuilder-dynamic-columns-core
 
 ## Usage
 
-TODO: Write usage instructions here
+The Dynamic Columns Core adds a new entry into the
+DSL of the Model:
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :first_name
+  column :last_name
+
+  dynamic_column :skills
+end
+```
+
+Here we indicate we will have length variable headers about skills in the CSV file. Important notes, only one dynamic column can be defined per model, and it must be placed after the regular headers!
+
+The Dynamic Columns add two new methods to the Model:
+
+```ruby
+class BasicRowModel
+  include Csvbuilder::Model
+
+  class << self
+
+    # Safe to override. Method applied to each dynamic_column attribute
+    #
+    # @param cells [Array] Array of values
+    # @param column_name [Symbol] Dynamic column name
+    def format_dynamic_column_cells(cells, _column_name, _context)
+      cells
+    end
+
+    # Safe to override
+    #
+    # @return [String] formatted header
+    def format_dynamic_column_header(header_model, _column_name, _context)
+      header_model
+    end
+  end
+end
+```
+
+The collection of Objects is expected to be provided through the context with a key of the same name as the declared dynamic_column.
+
+## Aliasing
+
+When the Dynamic Column is defined, it can be aliased to another name if needed:
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :name
+
+  dynamic_column :skills, as: :abilities
+
+  def ability(cell_value, header)
+    # logic comes here
+  end
+end
+```
+
+## Formatted Headers
+
+Formatting can be applied to the headers as follow:
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :name
+
+  dynamic_column :skills
+
+  class << self
+    def format_dynamic_column_header(header_model, column_name, _context)
+      "#{column_name}: [#{header_model}]"
+    end
+  end
+end
+```
+
+For simple cases, the shorter way can be used instead:
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :name
+
+  dynamic_column :skills, header: ->(name) { "skills: [#{name}]" }
+end
+```
+
 
 ## Development
 
@@ -26,7 +119,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/csvbuilder-dynamic-columns. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/csvbuilder-dynamic-columns/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/joel/csvbuilder-dynamic-columns. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/csvbuilder-dynamic-columns/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/csvbuilder/dynamic/columns/core/concerns/dynamic_columns_base.rb

@@ -22,7 +22,11 @@ module Csvbuilder
     }.freeze
     ATTRIBUTE_METHODS.each do |method_name, attribute_method|
       define_method(method_name) do
-        super().merge! column_names_to_attribute_value(self.class.dynamic_column_names, attribute_method)
+        super().merge!(
+          column_names_to_attribute_value(
+            self.class.dynamic_column_names, attribute_method
+          )
+        )
       end
     end
 
@@ -38,7 +42,10 @@ module Csvbuilder
       # Define default attribute method for a dynamic_column
       # @param column_name [Symbol] the cell's column_name
       def define_dynamic_attribute_method(column_name)
-        define_proxy_method(column_name) { original_attribute(column_name) }
+        define_proxy_method(column_name) do
+          original_attribute(column_name)
+        end
+
         dynamic_attribute_class.define_process_cell(self, column_name)
       end
 

data/lib/csvbuilder/dynamic/columns/core/internal/concerns/dynamic_column_shared.rb

@@ -21,12 +21,26 @@ module Csvbuilder
     #
     # header models
     #
+    # return the collection given by the context
+    # i.e: skills: ["Ruby", "Python", "Javascript"]
+    # header_models => ["Ruby", "Python", "Javascript"]
+    #
+    # @return [Array] Array of values
     def header_models
       Array(context.public_send(header_models_context_key))
     end
 
+    # The name of the dynamic_column
+    #
+    # i.e: With dynamic_column :skills
+    # => :skills
+    #
+    # i.e: With dynamic_column :skills, as: :programming_languages
+    # => :programming_languages
+    #
+    # @return [Symbol] Symbol
     def header_models_context_key
-      options[:header_models_context_key] || column_name
+      options[:as] || column_name
     end
   end
 end

data/lib/csvbuilder/dynamic/columns/core/internal/dynamic_column_attribute_base.rb

@@ -7,20 +7,32 @@ module Csvbuilder
   class DynamicColumnAttributeBase < AttributeBase
     include DynamicColumnShared
 
+    # The value is the collection of cell's values
+    # @return [Array] Array of values
     def value
       @value ||= row_model_class.format_dynamic_column_cells(unformatted_value, column_name, row_model.context)
     end
 
+    # The source_cells is meant to be implemented in the concret class
+    # @return [Array] Array of values
     def formatted_cells
       source_cells.map do |cell|
         row_model_class.format_cell(cell, column_name, row_model.context)
       end
     end
 
+    def source_cells
+      raise NotImplementedError
+    end
+
+    def unformatted_value
+      raise NotImplementedError
+    end
+
     protected
 
     def process_cell_method_name
-      self.class.process_cell_method_name(column_name)
+      self.class.process_cell_method_name(header_models_context_key)
     end
 
     # Calls the process_cell to return the value of a Attribute given the args

data/lib/csvbuilder/dynamic/columns/core/version.rb

@@ -4,7 +4,7 @@ module Csvbuilder
   module Dynamic
     module Columns
       module Core
-        VERSION = "0.1.0"
+        VERSION = "0.1.1"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-dynamic-columns-core
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel Azemar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport