csvbuilder-dynamic-columns-exporter 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d6adf64db2e5a0d9c8dc5fb555489ff195bd00c3cebba5736a0ea6fcfb37b11
-  data.tar.gz: f084c0dc4f1b0df1547e47d7ff285ab7ab597e6f4838d0a926645e09a9a8da61
+  metadata.gz: 213815125b6c74652b53bdce18b4fac186feef9668568612509ea63f05842df0
+  data.tar.gz: ba70e3d2daaf49b7a6a03a75906c9292eda8615c1eb23b928c96fa39a8344762
 SHA512:
-  metadata.gz: 32a3f92953ef63f35d3b30f88d64c72dfba217077e6fb5ffd51ef9d32695098aeb42925acb0fa7e3bbd8336d4691b15d10113a751a8a213d1aa948a8c9823806
-  data.tar.gz: 2349dcb6730b77a227f3e6340ffb7b2e753bb2f7d880d8f4fb2b3ad678d69bf1e402c0b059f56e805d3ddc353b38a88430b5c76a0c912404b8507c5b68694970
+  metadata.gz: 1f1d33dca1976f18350c035cc954c375f73ffc27a5099371a0c0923b1b958ea65708eb1214f9f84cdb8bf5dbc21f09c523bbf48b122cc93d478bc9b4bcd487ce
+  data.tar.gz: a59f949990ab6d0e87531fb590192cd66166622b00a331a386b9129f429cff93f8f37ca2fffaf744ff5f09e63dfbd69042a0e63f567e773cbf52dd4b612243ce

data/.rubocop.yml

@@ -1,13 +1,13 @@
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.4
 
 Style/StringLiterals:
   Enabled: true

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-12-23 11:40:53 UTC using RuboCop version 1.41.1.
+# on 2025-02-27 05:00:38 UTC using RuboCop version 1.73.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -28,6 +28,12 @@ RSpec/RepeatedDescription:
   Exclude:
     - 'spec/csvbuilder/dynamic/columns/exporter/concerns/export/dynamic_columns_spec.rb'
 
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/csvbuilder/dynamic/columns/exporter/internal/export/dynamic_column_attribute_spec.rb'
+
 # Offense count: 2
 # Configuration parameters: AllowedConstants.
 Style/Documentation:

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-02-27
+
+- Update Ruby 3.4 and Relax Rails Constraint
+
+## [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/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    csvbuilder-dynamic-columns-exporter (0.1.2)
+      activesupport (>= 5.2, < 8)
+      csvbuilder-core (~> 0.1)
+      csvbuilder-dynamic-columns-core (~> 0.1)
+      csvbuilder-exporter (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.2.2.1)
+      activesupport (= 7.2.2.1)
+    activesupport (7.2.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    csv (3.3.2)
+    csvbuilder-core (0.1.4)
+      activesupport (>= 5.2)
+      csv
+    csvbuilder-dynamic-columns-core (0.1.1)
+      activesupport (>= 5.2, < 8)
+      csvbuilder-core
+    csvbuilder-exporter (0.1.1)
+      activemodel (>= 5.2)
+      activesupport (>= 5.2)
+      csv
+      csvbuilder-core
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.73.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  csvbuilder-dynamic-columns-exporter!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.6.2

data/README.md

@@ -1,22 +1,150 @@
-# 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
+```
+
+### Propagate default formatting
+
+If a default formatting is defined, it will not automatically be propagated to the dynamic cells, which could cause edge cases.
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :name
+
+  dynamic_column :skills
+
+  class << self
+
+    def format_cell(cell, _column_name, _context)
+      "- #{cell} -"
+    end
+
+  end
+end
+```
+
+To propagate it, recall the default formatting in dynamic columns formatting as follow:
+
+```ruby
+class UserCsvExportModel < UserCsvRowModel
+  include Csvbuilder::Export
+
+  def skill(skill_name)
+    source_model.skills.where(name: skill_name).exists? ? "1" : "0"
+  end
+
+  class << self
+    def format_dynamic_column_cells(cells, _column_name, _context)
+      cells.map do |cell|
+        format_cell(cell, _column_name, _context)
+      end
+    end
+  end
+
+end
+```
 
 ## Development
 
@@ -26,7 +154,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/gemfiles/{Gemfile.5.2._gemfile → Gemfile.8.0._gemfile}

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 # Runtime dependencies
-gem "activesupport", "~> 5.2"
+gem "activemodel", "~> 7.0"
 
 # Libraries dependencies
 gem "csvbuilder-core"

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.2"
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-dynamic-columns-exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Joel Azemar
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,44 +33,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
@@ -83,15 +82,16 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/Gemfile.5.2._gemfile
-- gemfiles/Gemfile.6.1._gemfile
 - gemfiles/Gemfile.7.0._gemfile
+- gemfiles/Gemfile.8.0._gemfile
 - lib/.DS_Store
 - lib/csvbuilder/.DS_Store
 - lib/csvbuilder/dynamic/.DS_Store
@@ -113,7 +113,6 @@ metadata:
   source_code_uri: https://github.com/joel/csvbuilder-dynamic-columns-exporter
   changelog_uri: https://github.com/joel/csvbuilder-dynamic-columns-exporter/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,15 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Csvbuilder Dynamic Columns contain the components to handle CSV dynamic columns
 test_files: []

data/gemfiles/Gemfile.6.1._gemfile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Runtime dependencies
-gem "activesupport", "~> 6.1"
-
-# Libraries dependencies
-gem "csvbuilder-core"
-gem "csvbuilder-dynamic-columns-core"
-gem "csvbuilder-exporter"
-
-# Development dependencies
-gem "rake"
-gem "rspec"
-gem "rubocop"
-gem "rubocop-performance"
-gem "rubocop-rake"
-gem "rubocop-rspec"