csvbuilder-dynamic-columns-exporter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d6adf64db2e5a0d9c8dc5fb555489ff195bd00c3cebba5736a0ea6fcfb37b11
-  data.tar.gz: f084c0dc4f1b0df1547e47d7ff285ab7ab597e6f4838d0a926645e09a9a8da61
+  metadata.gz: a9f1c37c6d462524857d49238849c63136b1b498f9ed759aefa4023a441ebc40
+  data.tar.gz: 7d502c386ee64eee159cf191fdedad76f774402e863fd55904e841c15ee125e2
 SHA512:
-  metadata.gz: 32a3f92953ef63f35d3b30f88d64c72dfba217077e6fb5ffd51ef9d32695098aeb42925acb0fa7e3bbd8336d4691b15d10113a751a8a213d1aa948a8c9823806
-  data.tar.gz: 2349dcb6730b77a227f3e6340ffb7b2e753bb2f7d880d8f4fb2b3ad678d69bf1e402c0b059f56e805d3ddc353b38a88430b5c76a0c912404b8507c5b68694970
+  metadata.gz: c3acac4c4f22ef9f8339f820dcacb2ac7d220e1b6005bd0cff597c9c0254d5016cb2844002f429eb4a509016854caa8fc67f514f469f72a01d2581e7b7483c12
+  data.tar.gz: 5763118e03eaecac46af5ee840e02c222b2039ad322a15287e388b42b60370b53cc03f66499928e2c5794735651897f9da7c0951ec750b0dc3e6746c0b0b9925

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.1] - 2022-12-30
+
+Do not apply double formatting to the cells. The method `unformatted_value` should get the raw values from `source_cells`, not the value already formatted by row_model.format_cell.
+
 ## [0.1.0] - 2022-12-21
 
 - Initial release

data/Gemfile

@@ -14,3 +14,5 @@ gem "rubocop"
 gem "rubocop-performance"
 gem "rubocop-rake"
 gem "rubocop-rspec"
+
+# gem "csvbuilder-dynamic-columns-core", path: "../csvbuilder-dynamic-columns-core"

data/README.md

@@ -1,22 +1,107 @@
-# Csvbuilder::Dynamic::Columns
+# Csvbuilder::Dynamic::Columns::Exporter
 
-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::Exporter](https://github.com/joel/csvbuilder-dynamic-columns-exporter) 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 Exporter contains the implementation for exporting a collection of objects within a variable group as a CSV file.
+
+For instance, any object belonging to categories.
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add csvbuilder-dynamic-columns
+    $ bundle add csvbuilder-dynamic-columns-exporter
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install csvbuilder-dynamic-columns
+    $ gem install csvbuilder-dynamic-columns-exporter
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's consider a Developer with languages skill.
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+  include Csvbuilder::Export
+
+  column :name, header: "Developer"
+
+  dynamic_column :skills
+
+  def skill(skill_name)
+    source_model.skills.where(name: skill_name).exists? ? "1" : "0"
+  end
+end
+```
+
+For each Row, a method called by the singular version name of the declared Dynamic Columns will be called to determine the cell's value. In our example: `skill` must be implemented in the Exporter Model.
+
+The `source_model` is provided and accessible within this method. In our example, it is the `User`. The File Exporter appends this object to the Row.
+
+The dynamic part of the headers must be provided through the context under the same key name as the declared Dynamic Columns, here `skills`.
+
+```ruby
+context = { skills: ["Ruby", "Python", "Javascript"] }
+
+exporter  = Csvbuilder::Export::File.new(UserCsvExportModel, context)
+
+exporter.headers
+# => ["Developer", "Ruby", "Python", "Javascript"]
+
+sub_context = {} # it merged to the context
+
+exporter.generate do |csv|
+  User.all.each do |user|
+    csv.append_model(user, sub_context) # user here is the source_model.
+  end
+end
+
+exporter.to_s
+# => "Developer,Ruby,Python,Javascript\Bob,1,0,0\n"
+```
+
+## Format Dynamic Columns
+
+Instead of taking care of the formatting directly in the dynamic cell method, here `skill`, it can be delegated to `format_dynamic_column_cells.`
+
+Consider the following rewrite:
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :name, header: "Developer"
+
+  dynamic_column :skills
+end
+```
+
+```ruby
+class UserCsvExportModel < UserCsvRowModel
+  include Csvbuilder::Export
+
+  def skill(skill_name)
+    source_model.skills.where(name: skill_name).exists?
+  end
+
+  class << self
+    def format_dynamic_column_cells(cells, _column_name, _context)
+      cells.map do |cell|
+        case cell
+        when true
+          "1"
+        when false
+          "0"
+        else
+          "N/A"
+        end
+      end
+    end
+  end
+
+end
+```
 
 ## Development
 
@@ -26,7 +111,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/exporter/internal/export/dynamic_column_attribute.rb

@@ -6,7 +6,7 @@ module Csvbuilder
   module Export
     class DynamicColumnAttribute < Csvbuilder::DynamicColumnAttributeBase
       def unformatted_value
-        formatted_cells
+        source_cells
       end
 
       def source_cells

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-dynamic-columns-exporter
 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-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,44 +34,44 @@ dependencies:
   name: csvbuilder-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: csvbuilder-dynamic-columns-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: csvbuilder-exporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: Help handle CSVs in a more efficient way
 email:
 - joel.azemar@gmail.com