csv_serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8bba76706d52efc7cce1caa94b6553eda5a272c6573c74c629b5d4f20b0fb07
+  data.tar.gz: 5b7285367e093d88dc1a6fc93dfc10ddf157b47c8747412db481a06d28558b1a
+SHA512:
+  metadata.gz: 1402ccb3fb4b465bd71d24b415e2c36e7810633e9130ff89c55a569e2d3bd21101cb1a843679a836f085661be3c6a8e091c0db925095bbad9205623354c7724e
+  data.tar.gz: 60a3dceccb1c5442683c754d355cba4d57cfab597181d9cc2b505cf160294b7f60e9e05a112c1cb8fcb0bb69b1af073a637f173fe62f050b73438b7e7412a6df

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Yudai Tanaka
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# CsvSerializer
+Adds easy CSV generation functionality to `ActiveRecord`.
+
+## Usage
+Suppose Person model is defined.
+```ruby
+class Person < ApplicationRecord
+  # In schema.rb, columns are defined as below definition.
+  # create_table "people", force: :cascade do |t|
+  #   t.string "name"
+  #   t.integer "age"
+  #   t.integer "tall"
+  #   t.integer "weight"
+  #   t.datetime "created_at", precision: 6, null: false
+  #   t.datetime "updated_at", precision: 6, null: false
+  # end
+end
+```
+
+`to_csv` returns csv as string.
+
+```ruby
+Person.to_csv
+# => id,name,age,tall,weight,created_at,updated_at
+#    1,sample1,1,128,34,2020-01-01 10:02:39 UTC,2020-01-01 11:02:39 UTC
+#    2,sample2,2,130,32,2020-01-01 12:02:39 UTC,2020-01-01 14:02:39 UTC
+````
+
+If attribute names is passed, CSV string only contains the specified attributes will be returned.
+```ruby
+Person.to_csv(:id, :name)
+# => id,name
+#    1,sample1
+#    2,sample2
+```
+
+Containing the value gained by processing the record is supported.
+```ruby
+Person.to_csv(
+  "long name": ->(user) { user.name * 2 },
+  "short name": ->(user) { user.name[-2..] }
+)
+# => long name,short name
+#    sample1sample1,e1
+#    sample2sample2,e2
+```
+
+Same named columns can be specified with arrays of a column name and a producer function.
+```ruby
+Person.all.to_csv(
+  ["long name", ->(user) { user.name * 2 }],
+  ["long name", ->(user) { user.name * 3 }]
+)
+# => Long name,Long name
+#    sample1sample1,sample1sample1sample1
+```
+
+### Output to files
+```ruby
+io = Tempfile.new
+Person.all.to_csv_stream(io)
+# Below lines are written to tempfile.
+# id,name,age,tall,weight,created_at,updated_at
+# 1,sample1,1,128,34,2020-01-01 10:02:39 UTC,2020-01-01 11:02:39 UTC
+# 2,sample2,2,130,32,2020-01-01 12:02:39 UTC,2020-01-01 14:02:39 UTC
+
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csv_serializer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install csv_serializer
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/csv_serializer.rb

@@ -0,0 +1,15 @@
+require "csv_serializer/version"
+require "csv_serializer/railtie"
+require "csv_serializer/methods"
+require "csv_serializer/serializer"
+require "csv_serializer/definition"
+require "csv_serializer/definition/all_column"
+require "csv_serializer/definition/function_array"
+require "csv_serializer/definition/symbol_array"
+require "csv_serializer/definition/function_hash"
+
+module CsvSerializer; end
+
+ActiveSupport.on_load(:active_record) do
+  include CsvSerializer::Methods
+end

data/lib/csv_serializer/definition.rb

@@ -0,0 +1,39 @@
+module CsvSerializer
+  # Represents definition of csv columns.
+  class Definition
+    attr_reader :records
+
+    def self.build(array, hash, records)
+      if array.blank? && hash.blank?
+        AllColumn.new(records)
+      elsif array.blank?
+        FunctionHash.new(records, hash)
+      elsif array.all?(Symbol)
+        SymbolArray.new(records, array)
+      else
+        FunctionArray.new(records, array)
+      end
+    end
+
+    def initialize(records, array_or_hash = nil)
+      @records = records
+      @array_or_hash = array_or_hash
+    end
+
+    def definitions
+      @array_or_hash
+    end
+
+    def serializer
+      Serializer.new(self)
+    end
+
+    def target_records
+      records.all
+    end
+
+    def header
+      column_names.map { records.human_attribute_name(_1) }
+    end
+  end
+end

data/lib/csv_serializer/definition/all_column.rb

@@ -0,0 +1,21 @@
+module CsvSerializer
+  class Definition
+    class AllColumn < CsvSerializer::Definition
+      def column_names
+        records.attribute_names
+      end
+
+      def target_records
+        records.pluck(*column_names)
+      end
+
+      def producers
+        definitions.map(&:last)
+      end
+
+      def process(record)
+        record
+      end
+    end
+  end
+end

data/lib/csv_serializer/definition/function_array.rb

@@ -0,0 +1,17 @@
+module CsvSerializer
+  class Definition::FunctionArray < CsvSerializer::Definition
+    def column_names
+      definitions.map(&:first)
+    end
+
+    def process(record)
+      producers.map do |func|
+        func.call record
+      end
+    end
+
+    def producers
+      definitions.map(&:last)
+    end
+  end
+end

data/lib/csv_serializer/definition/function_hash.rb

@@ -0,0 +1,15 @@
+class CsvSerializer::Definition::FunctionHash < CsvSerializer::Definition
+  def column_names
+    definitions.keys
+  end
+
+  def process(record)
+    producers.map do |func|
+      func.call record
+    end
+  end
+
+  def producers
+    definitions.values
+  end
+end

data/lib/csv_serializer/definition/symbol_array.rb

@@ -0,0 +1,21 @@
+class CsvSerializer::Definition::SymbolArray < CsvSerializer::Definition
+  def column_names
+    definitions
+  end
+
+  def process(record)
+    if definitions.size <= 1
+      [record]
+    else
+      record
+    end
+  end
+
+  def producers
+    definitions
+  end
+
+  def target_records
+    records.pluck(*column_names)
+  end
+end

data/lib/csv_serializer/methods.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CsvSerializer
+  # Provides methods available on ActiveRecords.
+  module Methods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def to_csv(*array, **hash)
+        serializer = Definition.build(array, hash, self).serializer
+        serializer.serialize
+      end
+
+      def to_csv_stream(io, *array, **hash)
+        serializer = Definition.build(array, hash, self).serializer
+        Thread.new do
+          serializer.serialize_to(io)
+        end
+      end
+    end
+  end
+end

data/lib/csv_serializer/railtie.rb

@@ -0,0 +1,4 @@
+module CsvSerializer
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/csv_serializer/serializer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require "csv"
+
+module CsvSerializer
+  # Provides functions to generate csv string and file from column definition object.
+  class Serializer
+    attr_reader :definitions, :records
+
+    def initialize(definitions)
+      @definitions = definitions
+    end
+
+    def serialize
+      CSV.generate do |csv|
+        csv << definitions.header
+        definitions.target_records.each do |record|
+          csv << definitions.process(record)
+        end
+      end
+    end
+
+    def serialize_to(io)
+      io << CSV.generate_line(definitions.header)
+      definitions.target_records.each do |record|
+        io << CSV.generate_line(definitions.process(record))
+      end
+    end
+
+  end
+end

data/lib/csv_serializer/version.rb

@@ -0,0 +1,3 @@
+module CsvSerializer
+  VERSION = "0.1.0"
+end

data/lib/tasks/csv_serializer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :csv_serializer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: csv_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Tanaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+description: Description of CsvSerializer.
+email:
+- ytnk531@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/csv_serializer.rb
+- lib/csv_serializer/definition.rb
+- lib/csv_serializer/definition/all_column.rb
+- lib/csv_serializer/definition/function_array.rb
+- lib/csv_serializer/definition/function_hash.rb
+- lib/csv_serializer/definition/symbol_array.rb
+- lib/csv_serializer/methods.rb
+- lib/csv_serializer/railtie.rb
+- lib/csv_serializer/serializer.rb
+- lib/csv_serializer/version.rb
+- lib/tasks/csv_serializer_tasks.rake
+homepage: https://ytana.work/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://ytana.work/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Summary of CsvSerializer.
+test_files: []