acb 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e3c77997c9ede024d51be4db16615292e55b6014482f31f7688d7a9762acb3d
-  data.tar.gz: 88b9d179edbc54240d77b4625f1386f519284c8fa07a98b024e0be4dd1790c12
+  metadata.gz: 4f0a4f449bc6b7884f180b1dc1c863b5d5d7dba9636570db7be46d99f28d7e4f
+  data.tar.gz: 20889f756838c11b412c3bf4083a4f6f2b518fc9dd025ef1a2b590fa1cc4d849
 SHA512:
-  metadata.gz: 246cf3749a975639a8086ac4d7e96f3f3e1545e8ef3ade4caa853952e9310c89f90cf0b2bdff4da888814d836e344e3e89727a32d190b2c62457bc513aec68cb
-  data.tar.gz: 7c3eda99c5133d3367fd4f19bf36b8d68a8788175074d3eedf88cdfad65df3c2c7a0a8dcf137c204bf4330f2c6f403b78a668062aae8983c75e6487b9521b03c
+  metadata.gz: 4e26032a44ad895d6314f13ab83f6fd7a01d5b122976da2a36ad544e548f33feedecbd5741012d65b537f355cde0468a78927f7cac376cd9088288f16ffe6935
+  data.tar.gz: ddd21a6ca44b268aabd2c8f37d62a1d74e809cba29c1ea7f763a18f6889348e2167494bd175b49c31b88e2312853c0e98e291137657694a1bf2e2aa4f0a1162a

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
   Exclude:
     - 'gemfiles/*'
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 Gemspec/RequireMFA:
   Enabled: false
 
@@ -30,3 +33,6 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/README.md

@@ -60,7 +60,24 @@ class PostCsvBuilder
   end
 end
 
-PostCsvBuilder.new(user_id).content_string
+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/acb.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/acb/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'acb'
+  spec.version = Acb::VERSION
+  spec.authors = ['Akito Hikasa']
+  spec.email = ['wetsand.wfs@gmail.com']
+
+  spec.summary = %(ActiveRecord CSV Builder)
+  spec.description = %(ActiveRecord CSV Builder)
+  spec.homepage = 'https://github.com/kakubin/acb'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata["changelog_uri"] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 6.0.0'
+
+  spec.add_development_dependency 'activerecord', '>= 6.0.0'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/acb/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Acb
+  module Base
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      include Columns
+    end
+
+    def to_csv(**options)
+      CSV.generate(**options) do |csv|
+        csv << self.class.header
+        data.each do |row|
+          csv << summarize(row)
+        end
+      end
+    end
+    alias content_string to_csv
+
+    def load_from(relations)
+      @data = relations
+    end
+
+    private
+
+    def data
+      @data = @data.preload(relations) if respond_to?(:relations)
+      @data.find_each
+    end
+
+    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.4'
+  VERSION = '0.2.0'
 end

data/lib/acb.rb

@@ -7,34 +7,12 @@ require 'csv'
 module Acb
   extend ActiveSupport::Concern
 
+  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'
 
-  class_methods do
-    def columns
-      @columns ||= Columns.new
-    end
-
-    def add_column(name:, **options)
-      columns.push(name, **options)
-    end
-  end
-
-  def data
-    @data = @data.preload(relations) if respond_to?(:relations)
-    @data.find_each
-  end
-
-  def get_data_from(row)
-    self.class.columns.get_data(row)
-  end
-
-  def content_string(**options)
-    CSV.generate(**options) do |csv|
-      csv << self.class.columns.header
-      data.each do |row|
-        csv << get_data_from(row)
-      end
-    end
-  end
+  include Base
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acb
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -82,12 +82,17 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- acb.gemspec
 - gemfiles/rails_6.0_stable.gemfile
 - gemfiles/rails_6.1_stable.gemfile
 - gemfiles/rails_7.0_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
@@ -111,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: ActiveRecord CSV Builder