acb 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03c6b8de9a823ee7da1d09ba0a8c919729de19c2386ebe0f8d3d7ac0f8b290d
-  data.tar.gz: 7e4fad7a51f42efe2720a4a6b8388fc495d08bf0c58694600b0e343f967b89df
+  metadata.gz: 3f68e2938e80af9df35a5ae1994a7aa479ffb5d2b11208e35944991d82957b8d
+  data.tar.gz: 24f7f96a0635e48002f4c7a743cf112d5bd4067633264688d8a9668b0abe2e90
 SHA512:
-  metadata.gz: 13c6dfe5f3c3ef2343e5f25e61f8e0f14f268fc568124cfa00d661fde77a2f586826319fe1f2d7a24ebca9926b130d7a164d87d5b28f8a2be0f921d78c03c9bc
-  data.tar.gz: 80e9ad4bfd5e64252950251c0415e78130ebc74a22678d2d2cd164a94bff360e5dabde9c69cfbac14b1499a39787e794143c9bdb7edc148b9a3f2f025d4de90b
+  metadata.gz: 51a8387a18a49aa52e7e55608c5d5bd35267f57f8319a83970d296eb7b64ffdc01918545201650722917d7fc248e7d067f3d5eeef50a2b3814aab5060971f119
+  data.tar.gz: d3b4736088edbebc5d7ecfa372b037af409d3eb3e6a46e0ca01286ed138a5d805893e45526f4161dc8dde2bea7871bf0905fe464d0e5da74bfc220ff3bd3809b

data/.rubocop.yml

@@ -1,5 +1,12 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'gemfiles/*'
+
+Gemspec/RequireMFA:
+  Enabled: false
 
 Style/Documentation:
   Enabled: false
@@ -12,5 +19,14 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: single_quotes
 
+Style/WordArray:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - 'spec/support/seed.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/Appraisals

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+appraise 'rails-6.0-stable' do
+  gem 'activerecord', '~> 6.0.0'
+  gem 'activesupport', '~> 6.0.0'
+end
+
+appraise 'rails-6.1-stable' do
+  gem 'activerecord', '~> 6.1.0'
+  gem 'activesupport', '~> 6.1.0'
+end
+
+appraise 'rails-7.0-stable' do
+  gem 'activerecord', '~> 7.0.0'
+  gem 'activesupport', '~> 7.0.0'
+end

data/README.md

@@ -1,8 +1,6 @@
 # Acb
 
-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/acb`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Acb is a gem for formatting and outputting csv data from ActiveRecord data
 
 ## Installation
 
@@ -10,24 +8,61 @@ Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add acb
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install acb
 
 ## Usage
 
-TODO: Write usage instructions here
 
-## Development
+```ruby
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string :name
+  end
+
+  create_table :posts, force: true do |t|
+    t.integer :user_id
+    t.timestamps
+  end
+
+  create_table :comments, force: true do |t|
+    t.integer :post_id
+    t.string :content
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class PostCsvBuilder
+  include Acb
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  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 }
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  def initialize(user_id)
+    @data = Post.where(user_id: user_id)
+  end
 
-## Contributing
+  def relations
+    [:user, :comments]
+  end
+end
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/acb. 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]/acb/blob/main/CODE_OF_CONDUCT.md).
+PostCsvBuilder.new(user_id).content_string
+```
 
 ## Code of Conduct
 
-Everyone interacting in the Acb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/acb/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Acb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kakubin/acb/blob/main/CODE_OF_CONDUCT.md).

data/gemfiles/rails_6.0_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", "~> 6.0.0"
+gem "activesupport", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.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", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_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.0.0"
+gem "activesupport", "~> 7.0.0"
+
+gemspec path: "../"

data/lib/acb/column.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Acb
+  class Column
+    attr_reader :name
+
+    def initialize(name, **options)
+      @name = name
+      @index = case options[:index]
+               when Proc
+                 options[:index]
+               when String
+                 options[:index].split('.')
+               else
+                 [name]
+               end
+      @format = options[:format]
+    end
+
+    def digest(row)
+      data = _digest(row)
+      @format && data ? format(data) : data
+    end
+
+    private
+
+    def _digest(row)
+      if @index.is_a?(Array)
+        @index.reduce(row) do |acc, mthd|
+          acc.send(mthd)
+        end
+      else
+        @index.call(row)
+      end
+    end
+
+    def format(data)
+      case data
+      when Date, Time
+        data.strftime(@format)
+      else
+        @format % data
+      end
+    end
+  end
+end

data/lib/acb/columns.rb

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

data/lib/acb/version.rb

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

data/lib/acb.rb

@@ -2,108 +2,37 @@
 
 require_relative 'acb/version'
 require 'active_support'
-require 'forwardable'
+require 'csv'
 
 module Acb
   extend ActiveSupport::Concern
 
-  class Header
-    extend Forwardable
-    include Enumerable
-
-    attr_accessor :columns
-
-    def_delegator :@columns, :each
-
-    def initialize
-      @columns = []
-    end
-
-    def push(name, **options)
-      @columns.push(Column.new(name, **options))
-    end
-
-    def keys
-      @columns.map(&:name)
-    end
-
-    def get_data(row)
-      @columns.map { _1.digest(row) }
-    end
-  end
-
-  class Column
-    attr_reader :name
-
-    def initialize(name, **options)
-      @name = name
-      @index = case options[:index]
-               when Proc
-                 options[:index]
-               when String
-                 options[:index].split('.')
-               else
-                 [name]
-               end
-      @format = options[:format]
-    end
-
-    def digest(row)
-      data = _digest(row)
-      @format && data ? format(data) : data
-    end
-
-    def _digest(row)
-      if @index.is_a?(Array)
-        @index.reduce(row) do |acc, set|
-          acc.send(set)
-        end
-      else
-        @index.call(row)
-      end
-    end
-
-    def format(data)
-      case data
-      when Date, Time
-        data.strftime(@format)
-      else
-        @format % data
-      end
-    end
-  end
+  autoload :Column, 'acb/column'
+  autoload :Columns, 'acb/columns'
 
   class_methods do
-    def header
-      @header ||= Header.new
+    def columns
+      @columns ||= Columns.new
     end
 
     def add_column(name:, **options)
-      header.push(name, **options)
+      columns.push(name, **options)
     end
   end
 
-  def initialize(options = {})
-    @options = options
-  end
-
   def data
     @data = @data.preload(relations) if respond_to?(:relations)
     @data.find_each
   end
 
-  def header
-    self.class.header.keys
-  end
-
   def get_data_from(row)
-    self.class.header.get_data(row)
+    self.class.columns.get_data(row)
   end
 
-  def content_string
-    header_content = header.join(',')
+  def content_string(**options)
+    header_content = self.class.columns.header.join(',')
 
-    CSV.generate(header_content, **@options) do |csv|
+    CSV.generate(header_content, **options) do |csv|
       data.each do |row|
         csv << get_data_from(row)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2022-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,9 +16,51 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -33,13 +75,19 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- gemfiles/rails_6.0_stable.gemfile
+- gemfiles/rails_6.1_stable.gemfile
+- gemfiles/rails_7.0_stable.gemfile
 - lib/acb.rb
+- lib/acb/column.rb
+- lib/acb/columns.rb
 - lib/acb/version.rb
 - sig/acb.rbs
 homepage: https://github.com/kakubin/acb