csvbuilder-core 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66d6db396e9e5218f7a22b363d047317e4d2992a38491bc0378b2214b130e27c
-  data.tar.gz: 5cbd8d0429b26bf6388ef32673e9e23cfbbb91f71a33952da1f5be8a9982adb9
+  metadata.gz: e7be65a3637e42b4ec99f9ebc795479ac8b629fa5921fe892784c928ce788789
+  data.tar.gz: 65e07ac9fdedb085aa6850ae58cba1d1b530275b4dfe6c39edbb28b3ab8f6db5
 SHA512:
-  metadata.gz: c6338d0f2b49f91d63586536abb1f9e021a273ef739925e5dae00350cd4792b8b60ab957bfa7a9bb0a249d156571ee5d00ff115d617caec1a5fa7612632a6cb7
-  data.tar.gz: 3999ccceef910ee15c10ab438ef93dcce3dfd7b76c22d86053c6d50b32014dd549dc29e28bc211b250ec6fae36e825fa3e1efafa232e76d7731a49be9ee84e8d
+  metadata.gz: 0fb1213ba385c60faecc0f4a943ffd71328f215609bf4b876f0c641691f52d6caa545c621ba1b3ebb4df7be6a9a58c51cef2679754786abb90ada1cbd1321aab
+  data.tar.gz: e816c1c62f4e22a16d416f82abefbc502c523d2656700140fee941d84a7051e82ab65798dad21eb43e044c0c4e863339e0ae27b2d2a104d205619fce9b2eee66

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ## [Unreleased]
 
+## [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,80 @@
+PATH
+  remote: .
+  specs:
+    csvbuilder-core (0.1.3)
+      activesupport (>= 5.2, < 8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+
+DEPENDENCIES
+  csvbuilder-core!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.4.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/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.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Joel Azemar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Csvbuilder Core contain the shared components of Csvbuilder