csvbuilder-exporter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b636a01ab30a230a59c72e0a97d9e49fe55f2b8f1f6ad85f650da19753661f6
-  data.tar.gz: cc4b6106cd367791dab849dc3aff21483660d422b7f3c2bbe0efc191f82cddc8
+  metadata.gz: 0db04d170e72816077bcbf51535b13ae0ddcda9b22288d6c89762de3e1d76b9b
+  data.tar.gz: a0f15a63bb1ff5ab9517ef571d7c4c7041939d7f4762b856ec668981ee7061b6
 SHA512:
-  metadata.gz: a3aae022a479da56e93c72188ce1d0ad56a13773d373214324120bc07c9ba8528fa36e1156d1e7739e10f00edf1e4c3c63207563bdc3f1ac02aab3fc49ee8567
-  data.tar.gz: 72679673d413200bbe89726d2c6f02606e6bf3f3ea6d01773a3c4a15b7931e91598411cd0013a206bebacea7eed3b91e05c06f883f880ac464a2745e4c4b62e9
+  metadata.gz: 875fdf3f17d83012bf0a2d3b05f2176eff3112ebb533de968d132a065b2873da34c1cbe50c2300061d5fbdbd490108b5e3734262d3ca44a1b803bf75f11b8109
+  data.tar.gz: 8ebc6669f9bf4503d093904f88f1a410e9934551d4e4d5c5bc2299c1d40da61a2366f4740041e5aff81d8a6442979f56b36509d810bfc625f08dfa9778d37295

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/.tool-versions

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

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.1] - 2025-02-26
+
+- Fix .gemspec
+
 ## [0.1.0] - 2022-12-20
 
 - Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -1,77 +1,105 @@
 PATH
   remote: .
   specs:
-    csvbuilder-exporter (0.1.0)
-      activemodel (>= 5.2, < 8)
-      activesupport (>= 5.2, < 8)
+    csvbuilder-exporter (0.1.1)
+      activemodel (>= 5.2)
+      activesupport (>= 5.2)
+      csv
       csvbuilder-core
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.8.1)
-      activesupport (= 5.2.8.1)
-    activesupport (5.2.8.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activesupport (8.0.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)
+      uri (>= 0.13.1)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    csvbuilder-core (0.1.0)
-      activesupport (= 5.2.8.1)
-    diff-lcs (1.5.0)
-    i18n (1.12.0)
+    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
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    minitest (5.16.3)
-    parallel (1.22.1)
-    parser (3.1.3.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.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)
+    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.12.0)
-    rspec-mocks (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.40.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.1.2.1)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.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.1)
-      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)
-    thread_safe (0.3.6)
-    tzinfo (1.2.10)
-      thread_safe (~> 0.1)
-    unicode-display_width (2.3.0)
+      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)
+    uri (1.0.2)
 
 PLATFORMS
-  arm64-darwin-21
+  arm64-darwin-24
+  ruby
 
 DEPENDENCIES
   csvbuilder-exporter!
@@ -83,4 +111,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.3.22
+   2.6.2

data/README.md

@@ -1,11 +1,12 @@
 # Csvbuilder::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/exporter`. To experiment with that code, run `bin/console` for an interactive prompt.
+[Csvbuilder::Exporter](https://github.com/joel/csvbuilder-exporter) is part of the [csvbuilder-collection](https://github.com/joel/csvbuilder)
 
-TODO: Delete this and the text above, and describe your gem
+The exporter contains the implementation for exporting a collection of objects as a CSV file.
 
 ## Installation
 
+The gem doesn't need [csvbuilder-collection](https://github.com/joel/csvbuilder) and can be installed alone.
 Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add csvbuilder-exporter
@@ -16,7 +17,46 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+Exporting is straightforward; a `CsvRowModel` is needed to map the Ruby Object. Often an `ActiveRecord` Object. A `CsvExportModel` is required to carry the specifics of exporting.
+
+```ruby
+class UserCsvRowModel
+  include Csvbuilder::Model
+
+  column :first_name
+  column :last_name
+end
+```
+
+NOTE: If shipping is the only need, both classes can be merged.
+
+```ruby
+class UserCsvExportModel
+  include Csvbuilder::Model
+  include Csvbuilder::Export
+
+  column :first_name
+  column :last_name
+end
+```
+
+You need to provide both object collection and exporter class as follow:
+
+```ruby
+collection = User.all
+
+exporter = Csvbuilder::Export::File.new(UserCsvExportModel, context = {})
+
+exporter.headers
+# => "First Name", "Last Name"
+
+exporter.generate do |csv|
+  collection.each do |user|
+    csv.append_model(user, another_context: true)
+  end
+end
+# => "First Name,Last Name\nJohn,Doe\n"
+```
 
 ## Development
 

data/gemfiles/Gemfile.7.0._gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Runtime dependencies
+gem "activemodel", "~> 7.0"
+gem "activerecord", "~> 7.0"
+gem "activesupport", "~> 7.0"
+
+# Libraries dependencies
+gem "csvbuilder-core"
+gem "csv"
+
+# Development dependencies
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/gemfiles/Gemfile.8.0._gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Runtime dependencies
+gem "activemodel", "~> 8.0"
+gem "activerecord", "~> 8.0"
+gem "activesupport", "~> 8.0"
+
+# Libraries dependencies
+gem "csvbuilder-core"
+gem "csv"
+
+# Development dependencies
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/lib/csvbuilder/exporter/concerns/export/base.rb

@@ -7,13 +7,14 @@ module Csvbuilder
 
       included do
         attr_reader :source_model
-        # validates :source_model, presence: true
       end
 
       # @param [Model] source_model object to export to CSV
       # @param [Hash]  context
       def initialize(source_model = nil, context = {})
         @source_model = source_model
+        raise ArgumentError, "source_model must be provided" unless source_model
+
         super(context: context)
       end
 

data/lib/csvbuilder/exporter/public/export/file.rb

@@ -55,8 +55,8 @@ module Csvbuilder
           @file = file
         end
 
-        def append_model(*args)
-          @file.append_model(*args)
+        def append_model(*)
+          @file.append_model(*)
         end
         alias << append_model
       end

data/lib/csvbuilder/exporter/public/export.rb

@@ -11,8 +11,6 @@ module Csvbuilder
 
     include Csvbuilder::Model
 
-    # include ActiveModel::Validations
-
     include Base
     include Attributes
   end

data/lib/csvbuilder/exporter/version.rb

@@ -2,6 +2,6 @@
 
 module Csvbuilder
   module Exporter
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/csvbuilder/exporter.rb

@@ -4,10 +4,10 @@ require "csvbuilder/exporter/version"
 
 require "csv"
 require "ostruct"
-# require "active_model"
 
 require "active_support"
 require "active_support/dependencies/autoload"
+
 require "active_support/core_ext/object"
 require "active_support/core_ext/string"
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-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-21 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -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,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +30,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
@@ -47,9 +37,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: '8'
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: csvbuilder-core
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +75,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -81,6 +83,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/Gemfile.7.0._gemfile
+- gemfiles/Gemfile.8.0._gemfile
 - lib/csvbuilder/exporter.rb
 - lib/csvbuilder/exporter/concerns/export/attributes.rb
 - lib/csvbuilder/exporter/concerns/export/base.rb
@@ -89,15 +93,14 @@ files:
 - lib/csvbuilder/exporter/public/export/file.rb
 - lib/csvbuilder/exporter/version.rb
 - sig/csvbuilder/exporter.rbs
-homepage: https://github.com/joel/csvbuilder-expoter
+homepage: https://github.com/joel/csvbuilder-exporter
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/joel/csvbuilder-expoter
-  source_code_uri: https://github.com/joel/csvbuilder-expoter
-  changelog_uri: https://github.com/joel/csvbuilder-expoter/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/joel/csvbuilder-exporter
+  source_code_uri: https://github.com/joel/csvbuilder-exporter
+  changelog_uri: https://github.com/joel/csvbuilder-exporter/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,15 +108,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 Exporter contain the components to handle CSV exporting
 test_files: []