csvbuilder-core 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66d6db396e9e5218f7a22b363d047317e4d2992a38491bc0378b2214b130e27c
-  data.tar.gz: 5cbd8d0429b26bf6388ef32673e9e23cfbbb91f71a33952da1f5be8a9982adb9
+  metadata.gz: bebbe955151405fc7bd5fed00c2e89c7138751d51c9bc60da989eef55bc11249
+  data.tar.gz: 0af4007a61548b597e3f51e742eb6f687a4ee0978bbb66867079c75895f514a6
 SHA512:
-  metadata.gz: c6338d0f2b49f91d63586536abb1f9e021a273ef739925e5dae00350cd4792b8b60ab957bfa7a9bb0a249d156571ee5d00ff115d617caec1a5fa7612632a6cb7
-  data.tar.gz: 3999ccceef910ee15c10ab438ef93dcce3dfd7b76c22d86053c6d50b32014dd549dc29e28bc211b250ec6fae36e825fa3e1efafa232e76d7731a49be9ee84e8d
+  metadata.gz: 41b04fe27507ac07e996d0fdd8e75e13dea278e65151095eb1223d588def3dd1b3b62ca7e066e2c43a9b4b9d2a56a32f3412a0e01ecd39cab0c45fea523cadcf
+  data.tar.gz: f3bb2943717a98ca9d93dc357842ed78f2072fc54e9ec730d5fbedae648f770c21faf5500c7644fc57fde4455345eda0b848f4747abcecc55585d774c2e8d822

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.2
 
 Style/StringLiterals:
   Enabled: true
@@ -16,6 +16,3 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-12-16 10:22:17 UTC using RuboCop version 1.39.0.
+# on 2023-09-05 09:08:13 UTC using RuboCop version 1.56.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
@@ -8,29 +8,21 @@
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
 Layout/LineLength:
   Max: 147
-  Exclude:
-    - 'lib/csvbuilder/core/concerns/attributes_base.rb'
 
-# Offense count: 1
-# Configuration parameters: CountAsOne.
-RSpec/ExampleLength:
-  Max: 6
+# Offense count: 2
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/csvbuilder/core/concerns/proxy_spec.rb'
 
-# Offense count: 4
+# Offense count: 2
 RSpec/MultipleExpectations:
   Max: 3
 
-# Offense count: 1
-# Configuration parameters: AllowedPatterns.
-# AllowedPatterns: ^expect_, ^assert_
-RSpec/NoExpectationExample:
-  Exclude:
-    - 'spec/support/shared_examples/methods/define_attribute_method.rb'
-
 # Offense count: 7
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
@@ -50,4 +42,4 @@ Style/OpenStructUse:
   Exclude:
     - 'lib/csvbuilder/core/concerns/model/base.rb'
     - 'lib/csvbuilder/core/internal/model/header.rb'
-    - 'spec/support/fixtures/concerns/basic_attributes.rb'
+    - 'spec/support/fixtures/concerns/basic_attributes.rb'

data/.tool-versions

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

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 ## [Unreleased]
 
+## [0.1.4] - 2025-02-26
+
+- Adding Csvbuilder::Model::Attributes#column_header by [Michael Keene](https://github.com/Michaelkeene)
+
+## [0.1.3] - 2023-03-03
+
+Add Header default formatting
+
+```ruby
+class BasicRowModel
+  include Csvbuilder::Model
+
+  column :alpha
+end
+
+BasicRowModel.headers
+# => ["Alpha"]
+```
+
+Basic Proc Capability
+
+```ruby
+class BasicRowModel
+  include Csvbuilder::Model
+
+  column :alpha, header: ->(column_name, context) { "#{context.inspect} #{column_name.to_s.humanize}" }
+end
+
+BasicRowModel.headers({ foo: :bar }) }
+# => ["#<OpenStruct foo=:bar> Alpha"] }
+```
+
 ## [0.1.0] - 2022-12-15
 
 - Initial release

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    csvbuilder-core (0.1.4)
+      activesupport (>= 5.2)
+      csv
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+    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.72.2)
+      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-core!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.6.2

data/README.md

@@ -1,8 +1,12 @@
 # Csvbuilder::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/core`. To experiment with that code, run `bin/console` for an interactive prompt.
+[Csvbuilder::Core](https://github.com/joel/csvbuilder-core) is part of the [csvbuilder-collection](https://github.com/joel/csvbuilder)
 
-TODO: Delete this and the text above, and describe your gem
+The core contains the shared components used and extended by the exporter and the importer. It is the foundation of the gem [csvbuilder](https://github.com/joel/csvbuilder) and carries the library's architecture, and it is not meant to be used alone.
+
+See:
+ - [Csvbuilder::Exporter](https://github.com/joel/csvbuilder-exporter)
+ - [Csvbuilder::Importer](https://github.com/joel/csvbuilder-importer)
 
 ## Installation
 
@@ -14,9 +18,122 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install csvbuilder-core
 
-## Usage
+# Architecture
+
+It is organized into three sections, the public, internal and mixins.
+
+<img width="215" alt="Screenshot 2022-12-28 at 12 53 59 PM" src="https://user-images.githubusercontent.com/5789/209835572-01d1a7e5-3175-490c-a166-1b9b74908390.png">
+
+# Public
+
+The public exposes the API meant to be used by the other components. The concrete implementation is mainly lying in the Mixins, though.
+
+# Base Attributes
+
+It represents a `CSV` row in `Csvbuilder`. At the core, it defines the standard behaviour, and those behaviours are specialized in `Export` and `Import` gems.
+
+In `core/concerns/attributes_base`, it exposes three main methods:
+
+1. `original_attributes`
+2. `formatted_attributes`
+3. `source_attributes`
+
+Those methods are collections called on `Attribute`—for instance, `original_attributes` call `Attribute#value` under the hood for the current row.
+
+# Model Attributes
+
+In `core/concerns/model/attributes`, we can find the DSL where columns with the options are defined and stored.
+
+```ruby
+class BasicRowModel
+  include Csvbuilder::Model
+
+  column :alpha
+  column :beta
+end
+```
+
+It also carries the headers and the two methods helping with the formatting.
+
+```ruby
+class BasicRowModel
+  include Csvbuilder::Model
+
+  class << self
+
+    # Used by Csvbuilder::AttributeBase#formatted_value
+    def format_cell(value, column_name, context)
+      "- || * #{column_name} * || -"
+    end
+
+    # Used by Csvbuilder::Model::Header#formatted_header
+    def format_header(column_name, context)
+      "~ #{column_name} ~"
+    end
+  end
+end
+
+header = "Alpha"
+value  = "alpha one"
+
+AttributeBase.new.formatted_value
+# => "- || * alpha one * || -"
+
+AttributeBase.new.value # It can carry some logic.
+# => "- || * alpha one * || -"
+
+AttributeBase.new.source_value # Will be always the raw value
+# => "alpha one"
+
+Header.new.formatted_header
+# => ~ Alpha ~
+```
+
+Internally calling respectively:
+
+```ruby
+module Csvbuilder
+  module Model
+    class Header
+
+      def formatted_header
+        row_model_class.format_header(column_name, context)
+      end
+
+    end
+  end
+end
+
+```
+
+and
+
+```ruby
+module Csvbuilder
+  class AttributeBase
+
+    def formatted_value
+      @formatted_value ||= row_model_class.format_cell(source_value, column_name, row_model.context)
+    end
+
+  end
+end
+
+```
+
+# Attribute
+
+Represent the cell value.
+
+Can be found here: `core/internal/attribute_base`.
+
+It can represent the value through the three following methods:
+
+1.  `source_value` unchanged value
+2.  `value` often the formatted_value, but some logic can be added.
+3.  `formatted_value`
 
-TODO: Write usage instructions here
+<img width="725" alt="Screenshot 2022-12-28 at 3 23 34 PM" src="https://user-images.githubusercontent.com/5789/209835649-373ebaad-ed53-420d-8a7a-1b93c782d066.png">
 
 ## Development
 
@@ -26,7 +143,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-core. 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-core/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/joel/csvbuilder-core. 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-core/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/gemfiles/Gemfile.7.0._gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 # Runtime dependencies
 gem "activesupport", "~> 7.0"
+gem "csv"
 
 # Development dependencies
 gem "rake"

data/gemfiles/{Gemfile.5.2._gemfile → Gemfile.8.0._gemfile}

@@ -3,7 +3,8 @@
 source "https://rubygems.org"
 
 # Runtime dependencies
-gem "activesupport", "~> 5.2"
+gem "activesupport", "~> 8.0"
+gem "csv"
 
 # Development dependencies
 gem "rake"

data/lib/csvbuilder/core/concerns/attributes_base.rb

@@ -56,8 +56,8 @@ module Csvbuilder
       array_to_block_hash(column_names) { |column_name| attribute_objects[column_name].public_send(attribute_method) }
     end
 
-    def array_to_block_hash(array, &block)
-      array.zip(array.map(&block)).to_h
+    def array_to_block_hash(array, &)
+      array.zip(array.map(&)).to_h
     end
 
     class_methods do
@@ -69,10 +69,10 @@ module Csvbuilder
 
       # Define default attribute method for a column
       # @param column_name [Symbol] the cell's column_name
-      def define_attribute_method(column_name, &block)
+      def define_attribute_method(column_name, &)
         return if method_defined? column_name
 
-        define_proxy_method(column_name, &block)
+        define_proxy_method(column_name, &)
       end
 
       def ensure_attribute_method

data/lib/csvbuilder/core/concerns/model/attributes.rb

@@ -15,6 +15,10 @@ module Csvbuilder
         self.class.headers(context)
       end
 
+      def column_header(column_header)
+        self.class.column_header(column_header, context)
+      end
+
       class_methods do
         # @return [Array<Symbol>] column names for the row model
         def column_names
@@ -30,7 +34,7 @@ module Csvbuilder
         # @param [Hash, OpenStruct] context name of column to check
         # @return [Array] column headers for the row model
         def headers(context = {})
-          column_names.map { |column_name| Header.new(column_name, self, context).value }
+          column_names.map { |column_name| column_header(column_name, context) }
         end
 
         # Safe to override
@@ -52,6 +56,13 @@ module Csvbuilder
           self._columns ||= {}
         end
 
+        # @param context [Hash, OpenStruct] name of column to check
+        # @param column_name [Symbol] the cell's column_name
+        # @return [String] column header
+        def column_header(column_name, context = {})
+          Header.new(column_name, self, context).value
+        end
+
         protected
 
         # Adds column to the row model

data/lib/csvbuilder/core/concerns/proxy.rb

@@ -9,8 +9,8 @@ module Csvbuilder
         @proxy ||= Module.new.tap { |mod| include mod }
       end
 
-      def define_proxy_method(*args, &block)
-        proxy.send(:define_method, *args, &block)
+      def define_proxy_method(*, &)
+        proxy.send(:define_method, *, &)
       end
     end
   end

data/lib/csvbuilder/core/internal/attribute_base.rb

@@ -13,10 +13,23 @@ module Csvbuilder
       @row_model   = row_model
     end
 
+    # @return [Object] the value with formatting applied
     def formatted_value
       @formatted_value ||= row_model_class.format_cell(source_value, column_name, row_model.context)
     end
 
+    # @return [Object] the value
+    def value
+      raise NotImplementedError
+    end
+
+    # @return [Object] the unchanged value from the source
+    def source_value
+      raise NotImplementedError
+    end
+
+    protected
+
     def row_model_class
       row_model.class
     end

data/lib/csvbuilder/core/internal/model/header.rb

@@ -16,11 +16,18 @@ module Csvbuilder
       end
 
       def value
-        options[:header] || formatted_header
+        case options[:header]
+        when Proc
+          return options[:header].call(column_name, context)
+        when String
+          return options[:header]
+        end
+
+        formatted_header(column_name.to_s.humanize)
       end
 
-      def formatted_header
-        row_model_class.format_header(column_name, context)
+      def formatted_header(header_name)
+        row_model_class.format_header(header_name, context)
       end
     end
   end

data/lib/csvbuilder/core/version.rb

@@ -2,6 +2,6 @@
 
 module Csvbuilder
   module Core
-    VERSION = "0.1.2"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Joel Azemar
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '0'
 description: Help handle CSVs in a more efficient way
 email:
 - joel.azemar@gmail.com
@@ -40,15 +47,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/csvbuilder/core.rb
 - lib/csvbuilder/core/concerns/attributes_base.rb
 - lib/csvbuilder/core/concerns/model/attributes.rb
@@ -68,7 +76,6 @@ metadata:
   source_code_uri: https://github.com/joel/csvbuilder-core
   changelog_uri: https://github.com/joel/csvbuilder-core/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,15 +83,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 Core contain the shared components of Csvbuilder
 test_files: []

data/gemfiles/Gemfile.6.1._gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Runtime dependencies
-gem "activesupport", "~> 6.1"
-
-# Development dependencies
-gem "rake"
-gem "rspec"
-gem "rubocop"
-gem "rubocop-performance"
-gem "rubocop-rake"
-gem "rubocop-rspec"