table_structure 0.3.21 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d52660a94da1c1fbcc8a14a8332214c32ba1627a50239ee72f9916e12c8502
-  data.tar.gz: 2156f6ebaa0ee6fd88dfb282a3c339e20101da8bf33cd250355eff7557915921
+  metadata.gz: 06f36abaa1bc4478901ea51a27e0e22b00ecf70ecbfd18b4c785c2e86e08ca1d
+  data.tar.gz: 26990e2f8ac30764a3d571dbf8a35e422ce163989f9eda5e92aa3c2b9e5cf498
 SHA512:
-  metadata.gz: 9e5091c8a9c362a09b563e608cf78b74fddb53526ebd53ef30700f4c975429689c5ab8e27f72918d7c4fbdcd798b7911f20dd70593a313fe59bdb88d5deb8e35
-  data.tar.gz: 6ae2d481a839d63271009435173250f929009bd2273a59f3aaa974cc14e7612d7cb55258c82c2fe189f304277249d298e0eaaa7d15d1d20b6acc53cee3bb02f9
+  metadata.gz: 288ea6944e5efa303a3c39e4502dce7b0d2994504796a7de0b69b28d8b0cd91f878670db9846a51cbb57d16797bb8124e50f2162db00ec89b49d83de3a345030
+  data.tar.gz: 72d983aef1de40282befe38d230806b1fb3deec4ecf08801822867d43ea656a6a307ad53c46ae87f2661bcc90ef5c6f0b3d8c5ea515eb80ddeb78e559b552585

data/.travis.yml

@@ -8,4 +8,4 @@ rvm:
   - 2.5
   - 2.4
   - 2.3
-before_install: gem install bundler:2.1.2
+before_install: gem install bundler:2.1.4

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+# 0.4.2
+Changes:
+- `TableStructure::Schema`
+  - Improve performance.
+- `TableStructure::Iterator`
+- `TableStructure::Writer`
+- `TableStructure::CSV::Writer`
+  - Add validation for `header: { step: n }` option.
+    - `n` is allowed positive number or `nil`(default).
+
+# 0.4.1
+Changes:
+- `TableStructure::Iterator`
+- `TableStructure::Writer`
+- `TableStructure::CSV::Writer`
+  - Add `header: { step: n }` option. Header rows are output at intervals of step number.
+    - e.g. `TableStructure::Iterator.new(schema, header: { step: 10 })`
+
+# 0.4.0
+Changes:
+- Remove deprecated methods, arguments and options.
+- It is recommended that you update to `0.3.23` first. If you get warnings or errors, fix them and then update to `0.4.0`.
+
+# 0.3.23
+Changes:
+- `TableStructure::CSV::Writer`
+  - Fix not to output wrong warning.
+
+# 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,26 +1,26 @@
 PATH
   remote: .
   specs:
-    table_structure (0.3.21)
+    table_structure (0.4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
 
 PLATFORMS
   ruby
@@ -32,4 +32,4 @@ DEPENDENCIES
   table_structure!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

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
 ```
 
@@ -104,10 +106,10 @@ items = [
 ## or
 # items = Enumerator.new { |y| Item.find_each { |item| y << item } }
 
-table = []
-writer.write(items, to: table)
+array = []
+writer.write(items, to: array)
 
-# table
+# array
 # => [["ID", "Name", "Pet 1", "Pet 2", "Pet 3", "Q1", "Q2", "Q3"], ["1", "Taro", "🐱", "🐶", "", "⭕️", "❌", "⭕️"], ["2", "Hanako", "🐇", "🐢", "🐿", "⭕️", "⭕️", "❌"]]
 ```
 
@@ -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
 ```
 
@@ -257,6 +256,10 @@ Initialize a table with the schema and render the table:
 <% end %>
 ```
 
+### Sample with docker
+
+https://github.com/jsmmr/ruby_table_structure_sample
+
 ### Advanced
 
 You can add definitions when initializing the schema.
@@ -272,7 +275,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 +329,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 +441,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 +458,9 @@ class QuestionTableSchema
     end
   }
 
-  column_converter :same_name, ->(val, *) { "question: #{val}" }
+  column_converter :same_name do |val, *|
+    "question: #{val}"
+  end
 end
 
 context = {
@@ -429,47 +476,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
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jsmmr/ruby_table_structure.

data/lib/table_structure.rb

@@ -5,33 +5,27 @@ module TableStructure
 
   require 'table_structure/version'
   require 'forwardable'
+  require 'table_structure/utils'
   require 'table_structure/schema'
   require 'table_structure/schema/class_methods'
-  require 'table_structure/schema/dsl/column_converter'
+  require 'table_structure/schema/composite_class'
+  require 'table_structure/schema/dsl/column_builder'
   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/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_converter'
-  require 'table_structure/schema/row_builder'
-  require 'table_structure/schema/key_converter'
+  require 'table_structure/schema/column_builder_factory'
+  require 'table_structure/schema/keys_builder'
+  require 'table_structure/schema/row_context_builder_factory'
   require 'table_structure/schema/columns/attributes'
   require 'table_structure/schema/columns/schema'
   require 'table_structure/schema/utils'
   require 'table_structure/table'
-  require 'table_structure/table/column_converter'
-  require 'table_structure/table/context_builder'
-  require 'table_structure/table/row_builder'
-  require 'table_structure/table/iterator'
   require 'table_structure/writer'
   require 'table_structure/csv/writer'
   require 'table_structure/iterator'

data/lib/table_structure/csv/writer.rb

@@ -9,32 +9,19 @@ module TableStructure
         schema,
         bom: false,
         csv_options: {},
-        header: { context: nil },
-        **deprecated_options
+        header: { context: nil, step: nil }
       )
-        if deprecated_options.key?(:header_omitted)
-          header_omitted = deprecated_options[:header_omitted]
-          warn "[TableStructure] `header_omitted: #{!!header_omitted}` option has been deprecated. Use `header: #{!header_omitted}` option instead."
-          header = !header_omitted
-        end
-
-        if deprecated_options.key?(:header_context)
-          header_context = deprecated_options[:header_context]
-          warn '[TableStructure] `:header_context` option has been deprecated. Use `header: { context: ... }` option instead.'
-          header = { context: header_context }
-        end
-
         require 'csv'
 
         @options = {
           bom: bom,
           csv_options: csv_options
         }
-        @inner_options = {
+        inner_options = {
           header: header
         }
 
-        @writer = ::TableStructure::Writer.new(schema, **@inner_options)
+        @writer = ::TableStructure::Writer.new(schema, **inner_options)
       end
 
       def write(
@@ -42,36 +29,12 @@ module TableStructure
         to:,
         bom: @options[:bom],
         csv_options: @options[:csv_options],
-        **deprecated_options,
         &block
       )
-        header = @inner_options[:header]
-
-        if deprecated_options.key?(:header)
-          header = deprecated_options[:header]
-          warn '[TableStructure] Specify :header option as an argument for initialize method.'
-        end
-
-        if deprecated_options.key?(:header_omitted)
-          header_omitted = deprecated_options[:header_omitted]
-          warn "[TableStructure] `header_omitted: #{!!header_omitted}` option has been deprecated. Use `header: #{!header_omitted}` option instead."
-          header = !header_omitted
-        end
-
-        if deprecated_options.key?(:header_context)
-          header_context = deprecated_options[:header_context]
-          warn '[TableStructure] `:header_context` option has been deprecated. Use `header: { context: ... }` option instead.'
-          header = { context: header_context }
-        end
-
-        inner_options = {
-          header: header
-        }
-
         to << BOM if bom
 
         csv = ::CSV.new(to, **csv_options)
-        @writer.write(items, to: csv, **inner_options, &block)
+        @writer.write(items, to: csv, &block)
       end
     end
   end