acb 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70841480cde94d2576aef69df161eb518f54408da050458d1078674aa02b2812
-  data.tar.gz: f10c1ee92974a7d97baa779e73bfc90cf7d4d30637587f7b6475c6565f1f1bb9
+  metadata.gz: 8a8d54b873e3285ef684d8270c40cfb6af19958adf9c585ec6be198c9a865024
+  data.tar.gz: 1a69e9e082921b7a2462474479ec140b2bf43db9e307ab4f040ce6b1726620db
 SHA512:
-  metadata.gz: aebf88bf60738a19583b02be227a150a787552c4381736a1ff9e99c0d56d0201ec8e452ea4bc8c8a971640e3b211b1c6fed141a8a3c915f617b64fea15e030f7
-  data.tar.gz: 65c6fad9dcd3f0c0d516c236ac53e0ffba381592ebf785ad1d3c0a540354232d0779775ff8458911c3ef58407e1c8fffa97c80836c3b2cb79e996848bcc2a6ea
+  metadata.gz: 7203b2e35507032d117559c320e35157ced64eaf944bd66d76d75a83cd78a37c291dc3ad178fafdd9e886f99e931c58a9dbb6bab04c81b3ea17bf2131d9ec62c
+  data.tar.gz: 2db38718731c3e491dfa37f3205d173238ee8bc2c6e77784871ed635a1f6c71eb8e5465922ee9e72b6156a525e44e7205b4718b0fbf22af13c8eb4b3bb6d7ab9

data/.rubocop.yml

@@ -33,3 +33,6 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/Appraisals

@@ -14,3 +14,8 @@ appraise 'rails-7.0-stable' do
   gem 'activerecord', '~> 7.0.0'
   gem 'activesupport', '~> 7.0.0'
 end
+
+appraise 'rails-7.1-stable' do
+  gem 'activerecord', '~> 7.1.0'
+  gem 'activesupport', '~> 7.1.0'
+end

data/README.md

@@ -61,6 +61,23 @@ class PostCsvBuilder
 end
 
 PostCsvBuilder.new(user_id).to_csv
+
+# or
+
+class PostCsvBuilder
+  include Acb
+
+  add_column name: 'id'
+  add_column name: 'User Name', index: 'user.name'
+  add_column name: 'created_at', format: '%Y-%m-%d'
+  add_column name: 'Comment Amount', index: 'comments.size'
+  add_column name: 'First Comment', index: ->(post) { post.comments.first&.content }
+end
+
+builder = PostCsvBuilder.new
+relations = Post.where(user_id: user_id).preload(:user, :comments)
+builder.load_from(relations)
+builder.to_csv
 ```
 
 ## Code of Conduct

data/gemfiles/rails_7.1_stable.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "activerecord", "~> 7.1.0"
+gem "activesupport", "~> 7.1.0"
+
+gemspec path: "../"

data/lib/acb/base.rb

@@ -4,26 +4,24 @@ module Acb
   module Base
     extend ActiveSupport::Concern
 
-    class_methods do
-      def columns
-        @columns ||= Columns.new
-      end
-
-      def add_column(name:, **options)
-        columns.push(name, **options)
-      end
+    module ClassMethods
+      include Columns
     end
 
     def to_csv(**options)
       CSV.generate(**options) do |csv|
-        csv << self.class.columns.header
+        csv << self.class.header
         data.each do |row|
-          csv << get_data_from(row)
+          csv << summarize(row)
         end
       end
     end
     alias content_string to_csv
 
+    def load_from(relations)
+      @data = relations
+    end
+
     private
 
     def data
@@ -31,8 +29,8 @@ module Acb
       @data.find_each
     end
 
-    def get_data_from(row)
-      self.class.columns.get_data(row)
+    def summarize(row)
+      self.class.summarize(row)
     end
   end
 end

data/lib/acb/columns.rb

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
 
 module Acb
-  class Columns
-    def initialize
-      @columns = []
+  module Columns
+    def columns
+      @_columns ||= []
     end
 
-    def push(name, **options)
-      @columns.push(Column.new(name, **options))
+    def add_column(column = nil, name: nil, **options)
+      column ||= Column.new(name, **options)
+      columns.push(column)
     end
 
     def header
-      @columns.map(&:name)
+      columns.map(&:name)
     end
 
-    def get_data(row)
-      @columns.map { |column| column.digest(row) }
+    def summarize(data)
+      columns.map { |column| column.digest(data) }
     end
   end
 end

data/lib/acb/custom.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Acb
+  module Custom
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :registry, instance_accessor: false, instance_predicate: false, default: Registry.new
+    end
+
+    module ClassMethods
+      def add_master_column(key:, **options)
+        registry.push(MasterColumn.new(key, **options))
+      end
+
+      def use(columns)
+        klass = Class.new do
+          include Acb::Base
+        end
+
+        columns.each do |column|
+          master_column = registry.lookup(column[:key])
+          klass.add_column(master_column.to_column(column[:name]))
+        end
+
+        klass
+      end
+    end
+  end
+end

data/lib/acb/master_column.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Acb
+  class MasterColumn
+    attr_reader :key
+
+    def initialize(key, **options)
+      @key = key
+      @options = options
+    end
+
+    def to_column(name)
+      Column.new(name, **@options)
+    end
+  end
+end

data/lib/acb/registry.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Acb
+  class Registry
+    class ColumnNotFound < StandardError; end
+
+    def initialize
+      @registrations = []
+    end
+
+    def push(master_column)
+      @registrations.push(master_column)
+    end
+
+    def lookup(key)
+      @registrations.find { |registration| registration.key == key } or raise ColumnNotFound
+    end
+  end
+end

data/lib/acb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Acb
-  VERSION = '0.1.5'
+  VERSION = '0.2.1'
 end

data/lib/acb.rb

@@ -10,6 +10,9 @@ module Acb
   autoload :Base, 'acb/base'
   autoload :Column, 'acb/column'
   autoload :Columns, 'acb/columns'
+  autoload :Custom, 'acb/custom'
+  autoload :MasterColumn, 'acb/master_column'
+  autoload :Registry, 'acb/registry'
 
   include Base
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acb
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,10 +86,14 @@ files:
 - gemfiles/rails_6.0_stable.gemfile
 - gemfiles/rails_6.1_stable.gemfile
 - gemfiles/rails_7.0_stable.gemfile
+- gemfiles/rails_7.1_stable.gemfile
 - lib/acb.rb
 - lib/acb/base.rb
 - lib/acb/column.rb
 - lib/acb/columns.rb
+- lib/acb/custom.rb
+- lib/acb/master_column.rb
+- lib/acb/registry.rb
 - lib/acb/version.rb
 - sig/acb.rbs
 homepage: https://github.com/kakubin/acb