table_structure 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f8d4a85402265ce225a8e137e2f16df3c4294fbe21037c74d799606b547fa7
-  data.tar.gz: 91db3584049011857bc704ed1be0b4d4e07e10effc1286af35ea9d3e0e90309d
+  metadata.gz: f308e4cc6c48b759e040421bb73d27582bf63555bb3a7e8cffbe9d881409873e
+  data.tar.gz: e7661a42884ac86bd894e9fd9e542433b31627355d71812d525b9e0a66bdc6d0
 SHA512:
-  metadata.gz: 57b2bb8f02703930fca0b26976e0d84469d69127b8203af4cf86976a2bb5f2f83e5f5fd282288bc9bd22e8f79be4c5a3f8559f07d4a418b2e16e9a585589dae2
-  data.tar.gz: a9bc2bf2e7cf4bb4a19c1f8a60f4ad396c8197c3c7e06f0d8e7db9102807ddfca397df3cc02642989aba4047d542e4c3e2e1184ea2cfabd2f599e94d225b9007
+  metadata.gz: 4f042133eac79798923ac099a8108d29a9bfd43e36fe68d4811f2074ea9da9e638174e0381ac8fefcaeeea71d8e29a1504a439799e9ac5638d1b45fc040239a6
+  data.tar.gz: 9578b9cd2478a440fd3b8a0b6e84ade031cd0b298ae11e7766c39529e3b795340005bd20fade907cd961879da318166db958818c0b3a38284fd0b450f13a98f0

data/.travis.yml

@@ -6,4 +6,5 @@ rvm:
   - 2.6
   - 2.5
   - 2.4
+  - 2.3
 before_install: gem install bundler -v 1.17.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_structure (0.1.1)
+    table_structure (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,9 +5,6 @@
 `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:
@@ -68,6 +65,8 @@ schema = SampleTableSchema.new(context: context)
 #### TableStructure::Writer
 ```ruby
 writer = TableStructure::Writer.new(schema)
+## When omitting header line
+# writer = TableStructure::Writer.new(schema, header_omitted: true)
 
 items = [
   {
@@ -117,11 +116,11 @@ class SampleTableSchema
 
   TableContext = Struct.new(:questions, keyword_init: true)
 
-  RowContext = Struct.new(:id, :name, :pets, :answers, keyword_init: true) {
+  RowContext = Struct.new(:id, :name, :pets, :answers, keyword_init: true) do
     def more_pets
       pets + pets
     end
-  }
+  end
 
   context_builder :table, ->(context) { TableContext.new(**context) }
   context_builder :row, ->(context) { RowContext.new(**context) }
@@ -135,14 +134,14 @@ class SampleTableSchema
   columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
           value: ->(row, *) { row.more_pets }
 
-  columns ->(table) {
+  columns ->(table) do
     table.questions.map do |question|
       {
         name: question[:id],
         value: ->(row, *) { row.answers[question[:id]] }
       }
     end
-  }
+  end
 
   column_converter :to_s, ->(val, *) { val.to_s }
 end

data/lib/table_structure/schema/column.rb

@@ -2,13 +2,34 @@ module TableStructure
   module Schema
     class Column
 
+      class Error < ::TableStructure::Error
+        attr_reader :group_index
+
+        def initialize(error_message, group_index)
+          @group_index = group_index
+          super("#{error_message} [defined position: #{group_index + 1}]")
+        end
+      end
+
+      DEFAULT_DEFINITION = {
+        name: nil,
+        key: nil,
+        value: nil,
+        size: nil
+      }
+
       DEFAULT_SIZE = 1
 
-      def initialize(name: nil, key: nil, value: nil, size: nil)
-        @name = name
-        @key = key
-        @value = value
-        @size = determine_size(specified_size: size)
+      attr_reader :size, :group_index
+
+      def initialize(definition, group_index)
+        @group_index = group_index
+        definition = DEFAULT_DEFINITION.merge(definition)
+        validate(definition)
+        @name = definition[:name]
+        @key = definition[:key]
+        @value = definition[:value]
+        @size = determine_size(definition)
       end
 
       def name(header_context, table_context)
@@ -17,7 +38,7 @@ module TableStructure
       end
 
       def key
-        @key
+        optimize_size(@key)
       end
 
       def value(row_context, table_context)
@@ -27,18 +48,23 @@ module TableStructure
 
       private
 
-        def determine_size(specified_size:)
-          if @name.respond_to?(:call) && !specified_size
-            raise ::TableStructure::Error.new('"size" must be specified, because column size cannot be determined.')
+        def validate(name:, key:, size:, **)
+          if !key && name.respond_to?(:call) && !size
+            raise Error.new('"size" must be specified, because column size cannot be determined.', @group_index)
           end
-          if specified_size
-            if specified_size < DEFAULT_SIZE
-              raise ::TableStructure::Error.new('"size" must be positive.')
-            end
-            return specified_size
+          if size && size < DEFAULT_SIZE
+            raise Error.new('"size" must be positive.', @group_index)
           end
-          if @name.kind_of?(Array)
-            return @name.empty? ? DEFAULT_SIZE : @name.size
+        end
+
+        def determine_size(name:, key:, size:, **)
+          return size if size
+          [calculate_size(name), calculate_size(key)].max
+        end
+
+        def calculate_size(val)
+          if val.kind_of?(Array)
+            return val.empty? ? DEFAULT_SIZE : val.size
           end
           DEFAULT_SIZE
         end

data/lib/table_structure/schema/table.rb

@@ -4,7 +4,7 @@ module TableStructure
 
       DEFAULT_OPTIONS = { result_type: :array }
 
-      attr_reader :column_converters, :result_builders
+      attr_reader :columns, :column_converters, :result_builders
 
       def initialize(column_definitions, column_converters, result_builders, context, options)
         @context = context
@@ -24,11 +24,15 @@ module TableStructure
 
       private
 
-        def build_columns(column_definitions)
-          column_definitions
-            .map { |column| Utils.evaluate_callable(column, @context) }
-            .flatten
-            .map { |column| Column.new(**column) }
+        def build_columns(definitions)
+          definitions
+            .map { |definition| Utils.evaluate_callable(definition, @context) }
+            .map.with_index do |definition, i|
+              [definition]
+                .flatten
+                .map { |definition| Column.new(definition, i) }
+            end
+              .flatten
         end
 
         def default_column_converters

data/lib/table_structure/version.rb

@@ -1,3 +1,3 @@
 module TableStructure
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/table_structure.rb

@@ -1,4 +1,6 @@
 module TableStructure
+  class Error < StandardError; end
+
   require 'table_structure/version'
 
   require 'table_structure/schema'
@@ -11,5 +13,4 @@ module TableStructure
   require 'table_structure/schema/utils'
   require 'table_structure/writer'
 
-  class Error < StandardError; end
 end

data/table_structure.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{This gem creates and outputs table structure data. Useful for creating CSV.}
   spec.homepage      = "https://github.com/jsmmr/ruby_table_structure"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_structure
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - jsmmr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem creates and outputs table structure data. Useful for outputting
-  large CSV file.
+description: This gem creates and outputs table structure data. Useful for creating
+  CSV.
 email:
 - jsmmr@icloud.com
 executables: []
@@ -101,7 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Create and output table structure data.