table_structure 0.3.21 → 0.3.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d52660a94da1c1fbcc8a14a8332214c32ba1627a50239ee72f9916e12c8502
-  data.tar.gz: 2156f6ebaa0ee6fd88dfb282a3c339e20101da8bf33cd250355eff7557915921
+  metadata.gz: ae9b604db5214e4001824da3583481ad03b93e22785b6c7819874cd546b65025
+  data.tar.gz: 5883b75571629c06eb71f7b06ffb0923c1ce2660113f9804eaeaf0ecd8d94ce6
 SHA512:
-  metadata.gz: 9e5091c8a9c362a09b563e608cf78b74fddb53526ebd53ef30700f4c975429689c5ab8e27f72918d7c4fbdcd798b7911f20dd70593a313fe59bdb88d5deb8e35
-  data.tar.gz: 6ae2d481a839d63271009435173250f929009bd2273a59f3aaa974cc14e7612d7cb55258c82c2fe189f304277249d298e0eaaa7d15d1d20b6acc53cee3bb02f9
+  metadata.gz: 2839f25ac4d152627f70dd733a01f49b92a8c07bfcdf43c0b67fcc2891a105f136570e272c93580c5f68c869b20808c92edc56bb4c5aa836f07288dea9eac75a
+  data.tar.gz: 1e49f3a7400bb993eafd7c24fa2622ece9aa1edb480b921179c92d4579f65e5316579c9606f522d9cdfc7d8e9f38b4e71693fd9edc52788996b8ba9f24af2122

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.3.22
+Changes:
+- `TableStructure::Schema`
+  - DSL
+    - `column_converter`
+      - Using `lambda` has been deprecated. Use `block` instead.
+    - `context_builder`
+      - Using `lambda` has been deprecated. Use `block` instead.
+
 # 0.3.21
 Changes:
 - Add `TableStructure::Table`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_structure (0.3.21)
+    table_structure (0.3.22)
 
 GEM
   remote: https://rubygems.org/
@@ -14,7 +14,7 @@ GEM
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.1)
       rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)

data/README.md

@@ -56,7 +56,9 @@ class SampleTableSchema
     end
   }
 
-  column_converter :to_s, ->(val, _row, _table) { val.to_s }
+  column_converter :to_s do |val, _row, _table|
+    val.to_s
+  end
 end
 ```
 
@@ -124,6 +126,7 @@ Write the items converted by the schema to stream as CSV with Rails:
 response.headers['Cache-Control'] = 'no-cache'
 response.headers['Content-Type'] = 'text/csv'
 response.headers['Content-Disposition'] = 'attachment; filename="sample.csv"'
+response.headers['Last-Modified'] = Time.now.ctime.to_s # Required if Rack >= 2.2.0
 response_body = Enumerator.new do |y|
   # y << "\uFEFF" # BOM (Prevent garbled characters for Excel)
   writer.write(items, to: CSV.new(y))
@@ -133,8 +136,8 @@ end
 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) }
+  writer.write(items, to: CSV.new(f)) do |row|
+    row.map { |val| val.to_s.encode('Shift_JIS', invalid: :replace, undef: :replace) }
   end
 end
 ```
@@ -178,10 +181,6 @@ class SampleTableSchema
       }
     end
   }
-
-  ## If the schemas are nested, :key must be unique in parent and child schemas.
-  ## This can also be avoided by using :key_prefix or :key_suffix option.
-  # columns ->(table) { NestedTableSchema.new(context: table, key_prefix: 'foo_', key_suffix: '_bar') }
 end
 ```
 
@@ -272,7 +271,9 @@ class UserTableSchema
 end
 
 schema = UserTableSchema.new do
-  column_converter :to_s, ->(val, *) { val.to_s }
+  column_converter :to_s do |val, *|
+    val.to_s
+  end
 end
 ```
 
@@ -324,53 +325,91 @@ context = { pet_num: 0 }
 schema = SampleTableSchema.new(context: context, nil_definitions_ignored: true)
 ```
 
-You can also nest the schemas.
+You can also use `context_builder` to change the context object that the `lambda` receives.
 ```ruby
-class UserTableSchema
+class SampleTableSchema
   include TableStructure::Schema
 
+  TableContext = Struct.new(:questions, keyword_init: true)
+
+  RowContext = Struct.new(:id, :name, :pets, :answers, keyword_init: true) do
+    def increase_pets
+      pets + pets
+    end
+  end
+
+  context_builder :table do |context|
+    TableContext.new(**context)
+  end
+
+  context_builder :row, :value do |context|
+    RowContext.new(**context)
+  end
+
   column  name: 'ID',
-          value: ->(row, *) { row[:id] }
+          value: ->(row, *) { row.id }
 
   column  name: 'Name',
-          value: ->(row, *) { row[:name] }
-end
-
-class PetTableSchema
-  include TableStructure::Schema
+          value: ->(row, *) { row.name }
 
   columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
-          value: ->(row, *) { row[:pets] }
-end
-
-class QuestionTableSchema
-  include TableStructure::Schema
+          value: ->(row, *) { row.increase_pets }
 
   columns ->(table) {
-    table[:questions].map do |question|
+    table.questions.map do |question|
       {
         name: question[:id],
-        value: ->(row, *) { row[:answers][question[:id]] }
+        value: ->(row, *) { row.answers[question[:id]] }
       }
     end
   }
 end
+```
+
+You can also nest the schemas.
+If you nest the schemas and use `row_type: :hash`, `:key` must be unique in the schemas.
+You can also use `:key_prefix` or `:key_suffix` option to keep uniqueness of the keys.
+
+```ruby
+class UserTableSchema
+  include TableStructure::Schema
+
+  column  name: 'ID',
+          key: :id,
+          value: ->(row, *) { row[:id] }
+
+  column  name: 'Name',
+          key: :name,
+          value: ->(row, *) { row[:name] }
+end
 
 class SampleTableSchema
   include TableStructure::Schema
 
   columns UserTableSchema
-  ## or
-  # columns ->(table) { UserTableSchema.new(context: table) }
-
-  columns PetTableSchema
-  ## or
-  # columns ->(table) { PetTableSchema.new(context: table) }
 
-  columns QuestionTableSchema
-  ## or
-  # columns ->(table) { QuestionTableSchema.new(context: table) }
+  columns ->(table) {
+    UserTableSchema.new(context: table, name_prefix: 'Friend ', key_prefix: 'friend_') do
+      context_builder :row do |context|
+        context[:friend]
+      end
+    end
+  }
 end
+
+items = [
+  {
+    id: 1,
+    name: 'Taro',
+    friend: {
+      id: 2,
+      name: 'Hanako'
+    }
+  }
+]
+
+schema = SampleTableSchema.new(context: {})
+TableStructure::Iterator.new(schema, row_type: :hash).iterate(items)
 ```
 
 You can also concatenate or merge the schema classes.
@@ -398,7 +437,9 @@ class PetTableSchema
   columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
           value: ->(row, *) { row[:pets] }
 
-  column_converter :same_name, ->(val, *) { "pet: #{val}" }
+  column_converter :same_name do |val, *|
+    "pet: #{val}"
+  end
 end
 
 class QuestionTableSchema
@@ -413,7 +454,9 @@ class QuestionTableSchema
     end
   }
 
-  column_converter :same_name, ->(val, *) { "question: #{val}" }
+  column_converter :same_name do |val, *|
+    "question: #{val}"
+  end
 end
 
 context = {
@@ -429,43 +472,6 @@ concatenated_schema = (UserTableSchema + PetTableSchema + QuestionTableSchema).n
 merged_schema = UserTableSchema.merge(PetTableSchema, QuestionTableSchema).new(context: context)
 ```
 
-You can also use `context_builder`.
-This may be useful if `column(s)` 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) do
-    def more_pets
-      pets + pets
-    end
-  end
-
-  context_builder :table, ->(context) { TableContext.new(**context) }
-  context_builder :row, ->(context) { RowContext.new(**context) }
-
-  column  name: 'ID',
-          value: ->(row, *) { 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
-  }
-end
-```
-
 ## Sample with docker
 
 https://github.com/jsmmr/ruby_table_structure_sample

data/lib/table_structure/schema/column_converter.rb

@@ -27,20 +27,18 @@ module TableStructure
 
         def create_prepender(string, **options)
           Definition::ColumnConverter.new(
-            lambda { |val, *|
-              val.nil? ? val : "#{string}#{val}"
-            },
             **options
-          )
+          ) do |val, *|
+            val.nil? ? val : "#{string}#{val}"
+          end
         end
 
         def create_appender(string, **options)
           Definition::ColumnConverter.new(
-            lambda { |val, *|
-              val.nil? ? val : "#{val}#{string}"
-            },
             **options
-          )
+          ) do |val, *|
+            val.nil? ? val : "#{val}#{string}"
+          end
         end
       end
     end

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

@@ -9,13 +9,13 @@ module TableStructure
         def_delegator :@callable, :call
 
         def initialize(
-          callable,
           header: true,
-          body: true
+          body: true,
+          &block
         )
-          @callable = callable
           @applicable_to_header = header
           @applicable_to_body = body
+          @callable = block
         end
 
         def applicable_to_header?

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

@@ -8,8 +8,8 @@ module TableStructure
 
         def_delegator :@callable, :call
 
-        def initialize(callable)
-          @callable = callable
+        def initialize(&block)
+          @callable = block
         end
       end
     end

data/lib/table_structure/schema/definition/row_builder.rb

@@ -9,11 +9,11 @@ module TableStructure
         def_delegator :@callable, :call
 
         def initialize(
-          callable,
-          enabled_row_types: %i[array hash]
+          enabled_row_types: %i[array hash],
+          &block
         )
-          @callable = callable
           @enabled_row_types = [enabled_row_types].flatten
+          @callable = block
         end
 
         def enabled?(row_type)

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

@@ -6,21 +6,28 @@ module TableStructure
       module ColumnConverter
         def column_converter(
           name,
-          callable,
+          callable = nil,
           header: true,
           body: true,
-          **deprecated_options
+          **deprecated_options,
+          &block
         )
           if deprecated_options.key?(:row)
             warn '[TableStructure] `:row` option has been deprecated. Use `:body` option instead.'
             body = deprecated_options[:row]
           end
 
+          if callable
+            warn "[TableStructure] Use `block` instead of #{callable}."
+          end
+
+          block ||= callable
+
           column_converters[name] =
             ::TableStructure::Schema::Definition::ColumnConverter.new(
-              callable,
               header: header,
-              body: body
+              body: body,
+              &block
             )
           nil
         end

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

@@ -4,10 +4,17 @@ module TableStructure
   module Schema
     module DSL
       module ContextBuilder
-        def context_builder(name, callable)
+        # TODO: Change definition style
+        def context_builder(name, callable = nil, &block)
+          if callable
+            warn "[TableStructure] Use `block` instead of #{callable}."
+          end
+
+          block ||= callable
+
           context_builders[name] =
             ::TableStructure::Schema::Definition::ContextBuilder.new(
-              callable
+              &block
             )
           nil
         end

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

@@ -6,13 +6,20 @@ module TableStructure
       module RowBuilder
         def row_builder(
           name,
-          callable,
-          enabled_row_types: %i[array hash]
+          callable = nil,
+          enabled_row_types: %i[array hash],
+          &block
         )
+          if callable
+            warn "[TableStructure] Use `block` instead of #{callable}."
+          end
+
+          block ||= callable
+
           row_builders[name] =
             ::TableStructure::Schema::Definition::RowBuilder.new(
-              callable,
-              enabled_row_types: enabled_row_types
+              enabled_row_types: enabled_row_types,
+              &block
             )
           nil
         end

data/lib/table_structure/schema/row_builder.rb

@@ -5,11 +5,10 @@ module TableStructure
     module RowBuilder
       DEFAULT_ROW_BUILDERS = {
         _to_hash_: Definition::RowBuilder.new(
-          lambda { |values, keys, *|
-            keys.map.with_index { |key, i| [key || i, values[i]] }.to_h
-          },
           enabled_row_types: [:hash]
-        )
+        ) do |values, keys, *|
+          keys.map.with_index { |key, i| [key || i, values[i]] }.to_h
+        end
       }.freeze
 
       class << self

data/lib/table_structure/table/context_builder.rb

@@ -19,7 +19,7 @@ module TableStructure
       )
         return if builders.empty?
 
-        header_builder = builders[:header] # will remove
+        header_builder = builders[:header] # TODO: Change not to use keyword of `header`
         row_builder = builders[:row]
 
         methods = {}

data/lib/table_structure/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TableStructure
-  VERSION = '0.3.21'
+  VERSION = '0.3.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_structure
 version: !ruby/object:Gem::Version
-  version: 0.3.21
+  version: 0.3.22
 platform: ruby
 authors:
 - jsmmr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler