table_structure 0.3.16 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8794a66493988290a6ddeea36604322559a519ba3f0f261af4243fd56687663
-  data.tar.gz: 57f9279940767cc9c0612a9ffda469711ac070d086a8780aeef4a23c8dafef7d
+  metadata.gz: 15d536a6af5a6f759f6e2460568aa1822edc3b15812b4d84c821a5d9750e4275
+  data.tar.gz: d12f7463aa3b5ee12cfe8023ef77f0ef0ccf1f2d59692f392696ceeef47dc948
 SHA512:
-  metadata.gz: e906e4e3bdb277218db13fc90b028470f794ae9f346de456a84c524219aeaf63a184d9a8e4802ed3cc0dab55f7891fe0b6a5012144b236d6da1f3a02c3abebe0
-  data.tar.gz: c68e1178bce24e496b77ab1b3cb3674120129b86b1e352ef6233f29504b11e7355d93a4975c3e3445fd88e03ed19ac1bf05f4f86dc38331a8e256a2d273356f2
+  metadata.gz: 5f8008644303fdea9135a1d1a6d7e26cac50c388062982723c7e9564589c96d3eb70346a2a12a216c2fc2c13abe52e4f0d8b7860fbc652ff1878cce70b505b74
+  data.tar.gz: 719615ac3af76a63c0fa616f4fc2e8195d806dd4e773987ce0f4274eff58647ddab6b460b6a13fbfb72d7709d93e26ca30f427202132e8ab4ddd13cedf7f9c3d

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.3.17
+Changes:
+- `TableStructure::Schema`
+  - `:row` option for `column_converter` DSL has been deprecated. Use `:body` option instead.
+  - `:result_type` option of `create_table` method has been deprecated. Use `:row_type` option instead.
+- `TableStructure::Schema::Table`
+  - `rows` method has been deprecated. Use `body` method instead.
+- `TableStructure::Writer`
+  - `:result_type` option has been deprecated. Use `:row_type` option instead.
+- `TableStructure::Iterator`
+  - `:result_type` option has been deprecated. Use `:row_type` option instead.
+
 # 0.3.16
 Changes:
 - `TableStructure::Schema`
@@ -12,11 +24,11 @@ Changes:
 
 # 0.3.14
 Changes:
-  - Support Ruby 2.7.
+- Support Ruby 2.7.
 
 # 0.3.13
 Changes:
-  - Minor improvements.
+- Minor improvements.
 
 # 0.3.12
 Changes:
@@ -67,7 +79,7 @@ Changes:
     - `column_converter`
       - Add `:header` and `:row` options.
         - If `header: false`, the converter is not applied to header values.
-        - If `row: false`, the converter is not applied to row values.
+        - If `row: false`, the converter is not applied to body values.
         - Both options default to `true`, which is same behavior as before.
 
 # 0.3.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_structure (0.3.16)
+    table_structure (0.3.17)
 
 GEM
   remote: https://rubygems.org/
@@ -12,15 +12,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -5,9 +5,9 @@
 - `TableStructure::Schema`
   - Defines columns of a table using DSL.
 - `TableStructure::Writer`
-  - Converts data with the schema, and outputs it.
+  - Converts data with the schema, and outputs table structured data.
 - `TableStructure::Iterator`
-  - Converts data with the schema, and enumerates it.
+  - Converts data with the schema, and enumerates table structured data.
 
 ## Installation
 
@@ -129,6 +129,15 @@ end
 ```
 [Sample with docker](https://github.com/jsmmr/ruby_table_structure_sample)
 
+You can also convert CSV character code:
+```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
+```
+
 You can also use `TableStructure::CSV::Writer` instead:
 ```ruby
 writer = TableStructure::CSV::Writer.new(schema)
@@ -138,7 +147,7 @@ end
 ```
 
 #### TableStructure::Iterator
-Specifying `result_type: :hash` option works well.
+Specifying `row_type: :hash` option works well.
 To use this option, define `column(s)` with `:key`.
 
 Define a schema:
@@ -167,9 +176,7 @@ class SampleTableSchema
 
   ## If the schemas are nested, :key must be unique in parent and child schemas.
   ## This can also be avoided by specifying :key_prefix or :key_suffix option.
-  # columns ->(table) { NestedSchema.new(context: table, key_prefix: 'foo_', key_suffix: '_bar') }
-
-  column_converter :to_s, ->(val, *) { val.to_s }
+  # columns ->(table) { NestedTableSchema.new(context: table, key_prefix: 'foo_', key_suffix: '_bar') }
 end
 ```
 
@@ -184,7 +191,7 @@ context = {
 }
 
 schema = SampleTableSchema.new(context: context)
-iterator = TableStructure::Iterator.new(schema, result_type: :hash, header_omitted: true)
+iterator = TableStructure::Iterator.new(schema, row_type: :hash, header_omitted: true)
 ```
 
 Enumerate the items converted by the schema:
@@ -220,9 +227,26 @@ enum.lazy.select { |item| item[:q1] == '⭕️' }.take(1).force
 
 ### Advanced
 
+You can add definitions when initializing the schema.
+```ruby
+class UserTableSchema
+  include TableStructure::Schema
+
+  column  name: 'ID',
+          value: ->(row, *) { row[:id] }
+
+  column  name: 'Name',
+          value: ->(row, *) { row[:name] }
+end
+
+schema = UserTableSchema.new do
+  column_converter :to_s, ->(val, *) { val.to_s }
+end
+```
+
 You can also omit columns by defining `:omitted`.
 ```ruby
-class SampleTableSchema
+class UserTableSchema
   include TableStructure::Schema
 
   column  name: 'ID',
@@ -238,7 +262,7 @@ end
 
 context = { admin: true }
 
-schema = SampleTableSchema.new(context: context)
+schema = UserTableSchema.new(context: context)
 ```
 
 You can also omit columns by specifying `nil_definitions_ignored: true`.
@@ -268,25 +292,18 @@ context = { pet_num: 0 }
 schema = SampleTableSchema.new(context: context, nil_definitions_ignored: true)
 ```
 
-You can add definitions when initializing the schema.
+You can also nest the schemas.
 ```ruby
 class UserTableSchema
   include TableStructure::Schema
 
   column  name: 'ID',
-          value: ->(row, _table) { row[:id] }
+          value: ->(row, *) { row[:id] }
 
   column  name: 'Name',
           value: ->(row, *) { row[:name] }
 end
 
-schema = UserTableSchema.new do
-  column_converter :to_s, ->(val, *) { val.to_s }
-end
-```
-
-You can also nest the schemas.
-```ruby
 class PetTableSchema
   include TableStructure::Schema
 
@@ -307,14 +324,12 @@ class QuestionTableSchema
   }
 end
 
-class UserTableSchema
+class SampleTableSchema
   include TableStructure::Schema
 
-  column  name: 'ID',
-          value: ->(row, *) { row[:id] }
-
-  column  name: 'Name',
-          value: ->(row, *) { row[:name] }
+  columns ->(table) { UserTableSchema.new(context: table) }
+  ## or
+  # columns UserTableSchema
 
   columns ->(table) { PetTableSchema.new(context: table) }
   ## or
@@ -333,7 +348,7 @@ context = {
   ]
 }
 
-schema = UserTableSchema.new(context: context)
+schema = SampleTableSchema.new(context: context)
 ```
 
 You can also concatenate or merge the schema classes.
@@ -349,7 +364,7 @@ class UserTableSchema
   include TableStructure::Schema
 
   column  name: 'ID',
-          value: ->(row, _table) { row[:id] }
+          value: ->(row, *) { row[:id] }
 
   column  name: 'Name',
           value: ->(row, *) { row[:name] }
@@ -429,18 +444,9 @@ class SampleTableSchema
 end
 ```
 
-If you want to convert CSV character code, you can do so in a block of `write` method.
-```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
-```
-
-You can also use only `TableStructure::Schema`.
+You can also use only `TableStructure::Schema` instance.
 ```erb
-<% @schema.create_table(result_type: :array) do |table| %>
+<% @schema.create_table(row_type: :array) do |table| %>
   <table>
     <thead>
       <tr>
@@ -451,7 +457,7 @@ You can also use only `TableStructure::Schema`.
     </thead>
 
     <tbody>
-      <% table.rows(@items).each do |row| %>
+      <% table.body(@items).each do |row| %>
         <tr>
           <% row.each do |val| %>
             <td><%= val %></td>

data/lib/table_structure.rb

@@ -4,25 +4,30 @@ module TableStructure
   class Error < StandardError; end
 
   require 'table_structure/version'
-
+  require 'forwardable'
   require 'table_structure/schema'
   require 'table_structure/schema/class_methods'
   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/option'
-  require 'table_structure/schema/dsl/result_builder'
+  require 'table_structure/schema/dsl/row_builder'
+  require 'table_structure/schema/definition/column_converter'
+  require 'table_structure/schema/definition/context_builder'
+  require 'table_structure/schema/definition/row_builder'
+  require 'table_structure/schema/definition/columns/compiler'
+  require 'table_structure/schema/definition/columns/error'
+  require 'table_structure/schema/definition/columns/validator'
+  require 'table_structure/schema/definition/columns/attributes'
+  require 'table_structure/schema/definition/columns/schema_class'
+  require 'table_structure/schema/definition/columns/schema_instance'
   require 'table_structure/schema/column_converters'
   require 'table_structure/schema/context_builders'
-  require 'table_structure/schema/result_builders'
+  require 'table_structure/schema/row_builders'
   require 'table_structure/schema/table'
-  require 'table_structure/schema/table/key_decorator'
-  require 'table_structure/schema/column/attrs'
-  require 'table_structure/schema/column/schema'
-  require 'table_structure/schema/column/factory'
-  require 'table_structure/schema/column/definition/compiler'
-  require 'table_structure/schema/column/definition/error'
-  require 'table_structure/schema/column/definition/validator'
+  require 'table_structure/schema/keys_generator'
+  require 'table_structure/schema/columns/attributes'
+  require 'table_structure/schema/columns/schema'
   require 'table_structure/schema/utils'
   require 'table_structure/writer'
   require 'table_structure/csv/writer'

data/lib/table_structure/schema.rb

@@ -7,7 +7,7 @@ module TableStructure
       klass.extend(DSL::ColumnDefinition)
       klass.extend(DSL::ContextBuilder)
       klass.extend(DSL::Option)
-      klass.extend(DSL::ResultBuilder)
+      klass.extend(DSL::RowBuilder)
       klass.extend(ClassMethods)
     end
 
@@ -21,13 +21,12 @@ module TableStructure
       end
     end
 
-    Definition = Struct.new(
-      'Definition',
+    MyDefinition = Struct.new(
       :name,
       :columns,
       :context_builders,
       :column_converters,
-      :result_builders,
+      :row_builders,
       :context,
       :options
     )
@@ -72,24 +71,26 @@ module TableStructure
         schema_classes.map(&:column_converters).reduce({}, &:merge!)
       )
 
-      result_builders = ResultBuilders.new(
-        schema_classes.map(&:result_builders).reduce({}, &:merge!)
+      row_builders = RowBuilders.new(
+        schema_classes.map(&:row_builders).reduce({}, &:merge!)
       )
 
-      columns = Column::Factory.create(
-        name,
-        schema_classes.map(&:column_definitions).reduce([], &:concat),
-        context_builders.build_for_table(context),
-        options
-      )
+      columns =
+        Definition::Columns::Compiler
+        .new(
+          name,
+          schema_classes.map(&:column_definitions).reduce([], &:concat),
+          options
+        )
+        .compile(context_builders.build_for_table(context))
 
       @_definition_ =
-        Definition.new(
+        MyDefinition.new(
           name,
           columns,
           context_builders,
           column_converters,
-          result_builders,
+          row_builders,
           context,
           options
         )
@@ -99,26 +100,46 @@ module TableStructure
     def create_table(**options)
       options = @_definition_.options.merge(options)
 
+      if options.key?(:result_type)
+        warn '[TableStructure] `:result_type` option has been deprecated. Use `:row_type` option instead.'
+        options[:row_type] = options[:result_type]
+      end
+
+      keys_generator_options = {
+        prefix: options[:key_prefix],
+        suffix: options[:key_suffix]
+      }
+
+      keys_generator = KeysGenerator.new(
+        **keys_generator_options
+      )
+
       table = Table.new(
-        @_definition_.columns,
-        @_definition_.context,
-        options
+        columns: @_definition_.columns,
+        context: @_definition_.context,
+        keys_generator: keys_generator
       )
 
-      @_definition_.context_builders.extend_methods_for(table)
+      @_definition_
+        .context_builders
+        .extend_methods_for(table)
 
       column_converters_options = {
         name_prefix: options[:name_prefix],
         name_suffix: options[:name_suffix]
       }
 
-      @_definition_.column_converters.extend_methods_for(table, **column_converters_options)
+      @_definition_
+        .column_converters
+        .extend_methods_for(table, **column_converters_options)
 
-      result_builders_options = {
-        result_type: options[:result_type]
+      row_builders_options = {
+        row_type: options[:row_type]
       }
 
-      @_definition_.result_builders.extend_methods_for(table, **result_builders_options)
+      @_definition_
+        .row_builders
+        .extend_methods_for(table, **row_builders_options)
 
       if block_given?
         yield table

data/lib/table_structure/schema/class_methods.rb

@@ -41,9 +41,9 @@ module TableStructure
             .map(&:column_converters)
             .reduce({}, &:merge!)
 
-          @__result_builders__ =
+          @__row_builders__ =
             schema_classes
-            .map(&:result_builders)
+            .map(&:row_builders)
             .reduce({}, &:merge!)
         end
       end

data/lib/table_structure/schema/column_converters.rb

@@ -4,70 +4,66 @@ module TableStructure
   module Schema
     class ColumnConverters
       def initialize(converters)
-        @header_converters = select_converters_for(:header, converters)
-        @row_converters = select_converters_for(:row, converters)
+        @header_converters = converters.select { |_k, v| v.applicable_to_header? }
+        @body_converterss = converters.select { |_k, v| v.applicable_to_body? }
       end
 
       def extend_methods_for(table, name_prefix:, name_suffix:)
         table_context = table.instance_variable_get(:@context)
 
-        header_converters = @header_converters.merge(
-          optional_header_converters(name_prefix: name_prefix, name_suffix: name_suffix)
-        )
-        row_converters = @row_converters
+        header_converters =
+          @header_converters
+          .merge(
+            _prepend_prefix_: create_prepender(name_prefix),
+            _append_suffix_: create_appender(name_suffix)
+          )
+          .reject { |_k, v| v.nil? }
 
-        methods = {}
-        unless header_converters.empty?
-          methods[:header] = create_method(header_converters, table_context)
-        end
-        unless row_converters.empty?
-          methods[:row] = create_method(row_converters, table_context)
-        end
+        body_converterss = @body_converterss
+
+        methods =
+          {
+            header: create_method(header_converters, table_context),
+            data: create_method(body_converterss, table_context)
+          }
+          .reject { |_k, v| v.nil? }
 
         return if methods.empty?
 
-        table.extend ColumnConverter.new(methods)
+        table.extend ColumnConvertible.new(methods)
       end
 
       private
 
-      def select_converters_for(method, converters)
-        converters
-          .select { |_k, v| v[:options][method] }
-          .map { |k, v| [k, v[:callable]] }
-          .to_h
-      end
-
-      def optional_header_converters(name_prefix:, name_suffix:)
-        converters = {}
-        if name_prefix
-          converters[:_prepend_prefix_] =
-            create_prefix_converter(name_prefix)
-        end
-        if name_suffix
-          converters[:_append_suffix_] =
-            create_suffix_converter(name_suffix)
-        end
+      def create_prepender(prefix)
+        return unless prefix
 
-        converters
+        Definition::ColumnConverter.new(
+          lambda { |val, *|
+            val.nil? ? val : "#{prefix}#{val}"
+          },
+          header: true,
+          body: false
+        )
       end
 
-      def create_prefix_converter(prefix)
-        lambda { |val, *|
-          val.nil? ? val : "#{prefix}#{val}"
-        }
-      end
+      def create_appender(suffix)
+        return unless suffix
 
-      def create_suffix_converter(suffix)
-        lambda { |val, *|
-          val.nil? ? val : "#{val}#{suffix}"
-        }
+        Definition::ColumnConverter.new(
+          lambda { |val, *|
+            val.nil? ? val : "#{val}#{suffix}"
+          },
+          header: true,
+          body: false
+        )
       end
 
       def create_method(converters, table_context)
+        return if converters.empty?
+
         proc do |context: nil|
-          values = super(context: context)
-          values.map do |val|
+          super(context: context).map do |val|
             converters.reduce(val) do |val, (_, converter)|
               converter.call(val, context, table_context)
             end
@@ -76,7 +72,7 @@ module TableStructure
       end
     end
 
-    class ColumnConverter < Module
+    class ColumnConvertible < Module
       def initialize(methods)
         methods.each do |name, method|
           define_method(name, &method)