table_structure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8ca881e2b3849083365015064f38fc94c885548
+  data.tar.gz: 74bdef1d20a72ebcf5fa0d224d40ee05b3b8352f
+SHA512:
+  metadata.gz: 1f1072e0b87a939a86d6c36d01b0583e2ee9573b69f0080da6e6e637f22908500acb1886c940f5da5dcec5c4b513618b0c0fc015fd858eb1bc008df76a1aa18b
+  data.tar.gz: e25cd9540d0cedc13e93dcd7d80162a02975b31d63b0522160e6e07d129ae99ae62b19d5a573cf69afbed73f9ba772adfa3692d0079a1e3b8d4c74b5c4eee505

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in table_structure.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    table_structure (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  table_structure!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 　
+
+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,164 @@
+# TableStructure
+
+`TableStructure` has two major functions.
+The functions are `TableStructure::Schema` that defines the schema of a table using DSL and ` TableStructure::Writer` that converts and outputs data with that schema.
+
+`TableStructure::Writer` outputs the converted data line by line.
+This keeps the memory usage constant and is suitable for large-scale CSV output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'table_structure'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install table_structure
+
+## Usage
+
+### Basic
+
+#### TableStructure::Schema
+```ruby
+class SampleTableSchema
+  include TableStructure::Schema
+
+  column  name: 'ID',
+          value: ->(row, _table) { row[:id] }
+
+  column  name: 'Name',
+          value: ->(row, *) { row[:name] }
+
+  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+          value: ->(row, *) { row[:pets] }
+
+  columns ->(table) do
+    table[:questions].map do |question|
+      {
+        name: question[:id],
+        value: ->(row, *) { row[:answers][question[:id]] }
+      }
+    end
+  end
+
+  column_converter :to_s, ->(val, _row, _table) { val.to_s }
+end
+
+context = {
+  questions: [
+    { id: 'Q1', text: 'Do you like sushi?' },
+    { id: 'Q2', text: 'Do you like yakiniku?' },
+    { id: 'Q3', text: 'Do you like ramen?' }
+  ]
+}
+
+schema = SampleTableSchema.new(context: context)
+```
+
+#### TableStructure::Writer
+```ruby
+writer = TableStructure::Writer.new(schema)
+
+items = [
+  {
+    id: 1,
+    name: 'Taro',
+    pets: ['🐱', '🐶'],
+    answers: { 'Q1' => '⭕️', 'Q2' => '❌', 'Q3' => '⭕️' }
+  },
+  {
+    id: 2,
+    name: 'Hanako',
+    pets: ['🐇', '🐢', '🐿', '🦒'],
+    answers: { 'Q1' => '⭕️', 'Q2' => '⭕️', 'Q3' => '❌' }
+  }
+]
+
+## When using `find_each` method of Rails
+# items = ->(y) { Records.find_each {|r| y << r } }
+
+# Output to array
+table = []
+writer.write(items, to: table)
+
+# table
+# => [["ID", "Name", "Pet 1", "Pet 2", "Pet 3", "Q1", "Q2", "Q3"], ["1", "Taro", "🐱", "🐶", "", "⭕️", "❌", "⭕️"], ["2", "Hanako", "🐇", "🐢", "🐿", "⭕️", "⭕️", "❌"]]
+
+# Output to file as CSV
+File.open('sample.csv', 'w') do |f|
+  writer.write(items, to: CSV.new(f))
+end
+
+# Output to stream as CSV with Rails
+response.headers['X-Accel-Buffering'] = 'no' # When using Nginx for reverse proxy
+response.headers['Cache-Control'] = 'no-cache'
+response.headers['Content-Type'] = 'text/csv'
+response.headers['Content-Disposition'] = 'attachment; filename="sample.csv"'
+response_body = Enumerator.new { |y| writer.write(items, to: CSV.new(y)) }
+```
+
+### Advanced
+
+You can also use `context_builder`.
+This may be useful when `column` definition lambda is complicated.
+```ruby
+class SampleTableSchema
+  include TableStructure::Schema
+
+  TableContext = Struct.new(:questions, keyword_init: true)
+
+  RowContext = Struct.new(:id, :name, :pets, :answers, keyword_init: true) {
+    def more_pets
+      pets + pets
+    end
+  }
+
+  context_builder :table, ->(context) { TableContext.new(**context) }
+  context_builder :row, ->(context) { RowContext.new(**context) }
+
+  column  name: 'ID',
+          value: ->(row, _table) { row.id }
+
+  column  name: 'Name',
+          value: ->(row, *) { row.name }
+
+  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+          value: ->(row, *) { row.more_pets }
+
+  columns ->(table) {
+    table.questions.map do |question|
+      {
+        name: question[:id],
+        value: ->(row, *) { row.answers[question[:id]] }
+      }
+    end
+  }
+
+  column_converter :to_s, ->(val, *) { val.to_s }
+end
+```
+
+If you want to convert CSV character code, see the code below.
+```ruby
+File.open('sample.csv', 'w') do |f|
+  writer.write(items, to: CSV.new(f)) do |row_values|
+    row_values.map { |val| val&.to_s&.encode('Shift_JIS', invalid: :replace, undef: :replace) }
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jsmmr/ruby_table_structure.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "table_structure"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/table_structure/schema/column.rb

@@ -0,0 +1,59 @@
+module TableStructure
+  module Schema
+    class Column
+      def initialize(name: nil, key: nil, value:, size: nil)
+        @name = name
+        @key = key
+        @value = value
+        @size = specify_size(specified_size: size)
+      end
+
+      def name(header_context, table_context)
+        Utils.evaluate_callable(@name, header_context, table_context)
+      end
+
+      def key
+        @key
+      end
+
+      def value(row_context, table_context)
+        val = Utils.evaluate_callable(@value, row_context, table_context)
+        optimize_size(val)
+      end
+
+      private
+
+        def specify_size(specified_size:)
+          if @name.kind_of?(Array)
+            @name.size
+          elsif @name.respond_to?(:call)
+            unless specified_size
+              raise ::TableStructure::Error.new(
+                ":size must be specified when :name is lambda, because columns size is ambiguous."
+              )
+            end
+            specified_size
+          else
+            1
+          end
+        end
+
+        def multiple?
+          @size > 1
+        end
+
+        def optimize_size(value)
+          return value unless multiple?
+          values = value.kind_of?(Array) ? value : [value]
+          actual_size = values.size
+          if actual_size > @size
+            values[0, @size]
+          elsif actual_size < @size
+            [].concat(values).fill(nil, actual_size, (@size - actual_size))
+          else
+            values
+          end
+        end
+    end
+  end
+end

data/lib/table_structure/schema/dsl/column_converter.rb

@@ -0,0 +1,16 @@
+module TableStructure
+  module Schema
+    module DSL
+      module ColumnConverter
+        def column_converter(name, callable)
+          column_converters[name] = callable
+          return
+        end
+
+        def column_converters
+          @table_structure_schema_column_converters__ ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/table_structure/schema/dsl/column_definition.rb

@@ -0,0 +1,20 @@
+module TableStructure
+  module Schema
+    module DSL
+      module ColumnDefinition
+        def column(definition)
+          column_definitions << definition
+          return
+        end
+
+        def columns(definition)
+          column(definition)
+        end
+
+        def column_definitions
+          @table_structure_schema_column_definitions__ ||= []
+        end
+      end
+    end
+  end
+end

data/lib/table_structure/schema/dsl/context_builder.rb

@@ -0,0 +1,16 @@
+module TableStructure
+  module Schema
+    module DSL
+      module ContextBuilder
+        def context_builder(name, callable)
+          context_builders[name] = callable
+          return
+        end
+
+        def context_builders
+          @table_structure_schema_context_builders__ ||= Hash.new(->(val) { val })
+        end
+      end
+    end
+  end
+end

data/lib/table_structure/schema/dsl/result_builder.rb

@@ -0,0 +1,16 @@
+module TableStructure
+  module Schema
+    module DSL
+      module ResultBuilder
+        def result_builder(name, callable)
+          result_builders[name] = callable
+          return
+        end
+
+        def result_builders
+          @table_structure_schema_result_builders__ ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/table_structure/schema/table.rb

@@ -0,0 +1,64 @@
+module TableStructure
+  module Schema
+    class Table
+
+      DEFAULT_OPTIONS = { result_type: :array }
+
+      attr_reader :column_converters, :result_builders
+
+      def initialize(column_definitions, column_converters, result_builders, context, options)
+        @context = context
+        @options = DEFAULT_OPTIONS.merge(options)
+        @columns = build_columns(column_definitions)
+        @column_converters = default_column_converters.merge(column_converters)
+        @result_builders = default_result_builders.merge(result_builders)
+      end
+
+      def header(context)
+        values(:name, context)
+      end
+
+      def row(context)
+        values(:value, context)
+      end
+
+      private
+
+        def build_columns(column_definitions)
+          column_definitions
+            .map { |column| Utils.evaluate_callable(column, @context) }
+            .flatten
+            .map { |column| Column.new(**column) }
+        end
+
+        def default_column_converters
+          {}
+        end
+
+        def default_result_builders
+          result_builders = {}
+          if @options[:result_type] == :hash
+            result_builders[:to_h] = ->(array, *) { (@keys ||= keys).zip(array).to_h }
+          end
+          result_builders
+        end
+
+        def keys
+          @columns.map(&:key).flatten
+        end
+
+        def values(method, context)
+          columns = @columns
+            .map { |column| column.send(method, context, @context) }
+            .flatten
+            .map { |val| reduce_callables(@column_converters, val, context) }
+          reduce_callables(@result_builders, columns, context)
+        end
+
+        def reduce_callables(callables, val, context)
+          callables.reduce(val) { |val, (_, callable)| callable.call(val, context, @context) }
+        end
+
+    end
+  end
+end

data/lib/table_structure/schema/utils.rb

@@ -0,0 +1,9 @@
+module TableStructure
+  module Schema
+    module Utils
+      def self.evaluate_callable(val, *params)
+        val.respond_to?(:call) ? val.call(*params) : val
+      end
+    end
+  end
+end

data/lib/table_structure/schema.rb

@@ -0,0 +1,39 @@
+module TableStructure
+  module Schema
+    def self.included(klass)
+      klass.extend(DSL::ColumnConverter)
+      klass.extend(DSL::ColumnDefinition)
+      klass.extend(DSL::ContextBuilder)
+      klass.extend(DSL::ResultBuilder)
+    end
+
+    def initialize(context: nil, **options)
+      column_definitions = self.class.column_definitions
+      column_converters = self.class.column_converters
+      result_builders = self.class.result_builders
+      context = self.class.context_builders[:table].call(context)
+      @table_structure_schema_table_ =
+        Table.new(
+          column_definitions,
+          column_converters,
+          result_builders,
+          context,
+          options
+        )
+    end
+
+    def header(context: nil)
+      context = self.class.context_builders[:header].call(context)
+      @table_structure_schema_table_.header(context)
+    end
+
+    def row(context: nil)
+      context = self.class.context_builders[:row].call(context)
+      @table_structure_schema_table_.row(context)
+    end
+
+    def column_converters
+      @table_structure_schema_table_.column_converters
+    end
+  end
+end

data/lib/table_structure/version.rb

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

data/lib/table_structure/writer.rb

@@ -0,0 +1,38 @@
+module TableStructure
+  class Writer
+
+    DEFAULT_OPTIONS = {
+      header_omitted: false,
+      header_context: nil,
+      method: :<<
+    }
+
+    def initialize(schema, **options)
+      @schema = schema
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def write(items, to:, **options)
+      options = @options.merge(options)
+      unless options[:header_omitted]
+        header = @schema.header(context: options[:header_context])
+        header = yield header if block_given?
+        to.send(options[:method], header)
+      end
+      to_enum(items).each do |item|
+        row = @schema.row(context: item)
+        row = yield row if block_given?
+        to.send(options[:method], row)
+      end
+      return
+    end
+
+    private
+
+      def to_enum(items)
+        items.respond_to?(:call) ?
+          Enumerator.new { |y| items.call(y) } :
+          items
+      end
+  end
+end

data/lib/table_structure.rb

@@ -0,0 +1,15 @@
+module TableStructure
+  require 'table_structure/version'
+
+  require 'table_structure/schema'
+  require 'table_structure/schema/dsl/column_converter'
+  require 'table_structure/schema/dsl/column_definition'
+  require 'table_structure/schema/dsl/context_builder'
+  require 'table_structure/schema/dsl/result_builder'
+  require 'table_structure/schema/table'
+  require 'table_structure/schema/column'
+  require 'table_structure/schema/utils'
+  require 'table_structure/writer'
+
+  class Error < StandardError; end
+end

data/table_structure.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "table_structure/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "table_structure"
+  spec.version       = TableStructure::VERSION
+  spec.authors       = ["jsmmr"]
+  spec.email         = ["jsmmr@icloud.com"]
+
+  spec.summary       = %q{Create and output table structure data.}
+  spec.description   = %q{This gem creates and outputs table structure data. Useful for outputting large CSV file.}
+  spec.homepage      = "https://github.com/jsmmr/ruby_table_structure"
+  spec.license       = "MIT"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: table_structure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jsmmr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem creates and outputs table structure data. Useful for outputting
+  large CSV file.
+email:
+- jsmmr@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/table_structure.rb
+- lib/table_structure/schema.rb
+- lib/table_structure/schema/column.rb
+- lib/table_structure/schema/dsl/column_converter.rb
+- lib/table_structure/schema/dsl/column_definition.rb
+- lib/table_structure/schema/dsl/context_builder.rb
+- lib/table_structure/schema/dsl/result_builder.rb
+- lib/table_structure/schema/table.rb
+- lib/table_structure/schema/utils.rb
+- lib/table_structure/version.rb
+- lib/table_structure/writer.rb
+- table_structure.gemspec
+homepage: https://github.com/jsmmr/ruby_table_structure
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Create and output table structure data.
+test_files: []