table_structure 0.3.22 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae9b604db5214e4001824da3583481ad03b93e22785b6c7819874cd546b65025
-  data.tar.gz: 5883b75571629c06eb71f7b06ffb0923c1ce2660113f9804eaeaf0ecd8d94ce6
+  metadata.gz: bebf267d2cae044dd2f493b213950954c88b384d2b3e6dd15c09b7947b104eb7
+  data.tar.gz: cbe61559035246eb4dc80edf4e34b1b67a0e1f8db16749368e81d23e48bd2b81
 SHA512:
-  metadata.gz: 2839f25ac4d152627f70dd733a01f49b92a8c07bfcdf43c0b67fcc2891a105f136570e272c93580c5f68c869b20808c92edc56bb4c5aa836f07288dea9eac75a
-  data.tar.gz: 1e49f3a7400bb993eafd7c24fa2622ece9aa1edb480b921179c92d4579f65e5316579c9606f522d9cdfc7d8e9f38b4e71693fd9edc52788996b8ba9f24af2122
+  metadata.gz: cd6f1e4299eda55eb1959c38248911c9fc052dee5cb541cc3b1517cb00947f069e5896ca9d69e792fa2258f6bb636aaee251efedb11af96cd55241cf44ab3dd1
+  data.tar.gz: 0e52a02afa1dc1c669233edc2e900cdfae5e5085bd6138bd2055aa57f4fadfdf0c587228f5eb560b5ba857555d34bbdc4477c1128fd193f144625e8f099a2cf7

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,36 @@
+# 0.4.3
+Changes:
+- `TableStructure::Schema`
+  - Change to be able to use a block with `columns` DSL.
+
+# 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`

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    table_structure (0.3.22)
+    table_structure (0.4.3)
 
 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.1)
+    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

@@ -44,19 +44,19 @@ class SampleTableSchema
   column  name: 'Name',
           value: ->(row, *) { row[:name] }
 
-  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+  column  name: ['Pet 1', 'Pet 2', 'Pet 3'],
           value: ->(row, *) { row[:pets] }
 
-  columns ->(table) {
+  columns do |table|
     table[:questions].map do |question|
       {
         name: question[:id],
         value: ->(row, *) { row[:answers][question[:id]] }
       }
     end
-  }
+  end
 
-  column_converter :to_s do |val, _row, _table|
+  column_builder :to_s do |val, _row, _table|
     val.to_s
   end
 end
@@ -106,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", "🐇", "🐢", "🐿", "⭕️", "⭕️", "❌"]]
 ```
 
@@ -159,7 +159,6 @@ Define a schema:
 class SampleTableSchema
   include TableStructure::Schema
 
-  # If `:header` is set to `false`, `:name` is optional.
   column  name: 'ID',
           key: :id,
           value: ->(row, *) { row[:id] }
@@ -168,11 +167,11 @@ class SampleTableSchema
           key: :name,
           value: ->(row, *) { row[:name] }
 
-  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+  column  name: ['Pet 1', 'Pet 2', 'Pet 3'],
           key: %i[pet1 pet2 pet3],
           value: ->(row, *) { row[:pets] }
 
-  columns ->(table) {
+  columns do |table|
     table[:questions].map do |question|
       {
         name: question[:id],
@@ -180,7 +179,7 @@ class SampleTableSchema
         value: ->(row, *) { row[:answers][question[:id]] }
       }
     end
-  }
+  end
 end
 ```
 
@@ -256,6 +255,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.
@@ -271,7 +274,7 @@ class UserTableSchema
 end
 
 schema = UserTableSchema.new do
-  column_converter :to_s do |val, *|
+  column_builder :to_s do |val|
     val.to_s
   end
 end
@@ -310,14 +313,14 @@ class SampleTableSchema
   column  name: 'Name',
           value: ->(row, *) { row[:name] }
 
-  columns ->(table) {
+  columns do |table|
     if table[:pet_num].positive?
       {
         name: (1..table[:pet_num]).map { |num| "Pet #{num}" },
         value: ->(row, *) { row[:pets] }
       }
     end
-  }
+  end
 end
 
 context = { pet_num: 0 }
@@ -342,7 +345,7 @@ class SampleTableSchema
     TableContext.new(**context)
   end
 
-  context_builder :row, :value do |context|
+  context_builder :row do |context|
     RowContext.new(**context)
   end
 
@@ -352,17 +355,17 @@ class SampleTableSchema
   column  name: 'Name',
           value: ->(row, *) { row.name }
 
-  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+  column  name: ['Pet 1', 'Pet 2', 'Pet 3'],
           value: ->(row, *) { row.increase_pets }
 
-  columns ->(table) {
+  columns do |table|
     table.questions.map do |question|
       {
         name: question[:id],
         value: ->(row, *) { row.answers[question[:id]] }
       }
     end
-  }
+  end
 end
 ```
 
@@ -388,13 +391,13 @@ class SampleTableSchema
 
   columns UserTableSchema
 
-  columns ->(table) {
+  columns do |table|
     UserTableSchema.new(context: table, name_prefix: 'Friend ', key_prefix: 'friend_') do
       context_builder :row do |context|
         context[:friend]
       end
     end
-  }
+  end
 end
 
 items = [
@@ -416,9 +419,9 @@ You can also concatenate or merge the schema classes.
 Both create a schema class, with a few differences.
 - `+`
   - Similar to nesting the schemas.
-    `column_converter` works only to columns in the schema that they was defined.
+    `column_builder` works only to columns in the schema that they was defined.
 - `merge`
-  - If there are some definitions of `column_converter` with the same name in the schemas to be merged, the one in the schema that is merged last will work to all columns.
+  - If there are some definitions of `column_builder` with the same name in the schemas to be merged, the one in the schema that is merged last will work to all columns.
 
 ```ruby
 class UserTableSchema
@@ -434,10 +437,10 @@ end
 class PetTableSchema
   include TableStructure::Schema
 
-  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+  column  name: ['Pet 1', 'Pet 2', 'Pet 3'],
           value: ->(row, *) { row[:pets] }
 
-  column_converter :same_name do |val, *|
+  column_builder :same_name do |val|
     "pet: #{val}"
   end
 end
@@ -445,16 +448,16 @@ end
 class QuestionTableSchema
   include TableStructure::Schema
 
-  columns ->(table) {
+  columns do |table|
     table[:questions].map do |question|
       {
         name: question[:id],
         value: ->(row, *) { row[:answers][question[:id]] }
       }
     end
-  }
+  end
 
-  column_converter :same_name do |val, *|
+  column_builder :same_name do |val|
     "question: #{val}"
   end
 end
@@ -472,10 +475,6 @@ concatenated_schema = (UserTableSchema + PetTableSchema + QuestionTableSchema).n
 merged_schema = UserTableSchema.merge(PetTableSchema, QuestionTableSchema).new(context: context)
 ```
 
-## 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

data/lib/table_structure/iterator.rb

@@ -2,106 +2,65 @@
 
 module TableStructure
   class Iterator
-    def initialize(
-      schema,
-      header: { context: nil },
-      row_type: :array,
-      **deprecated_options
-    )
-      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
+    class HeaderOptions
+      attr_reader :enabled, :context, :step
+      alias enabled? enabled
+
+      def initialize(options)
+        @enabled = !!options
+        if options.is_a?(Hash)
+          @context = options[:context]
+          @step = options[:step]
+        end
+
+        validate
       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
+      private
 
-      if deprecated_options.key?(:result_type)
-        warn '[TableStructure] `:result_type` option has been deprecated. Use `:row_type` option instead.'
-        row_type = deprecated_options[:result_type]
+      def validate
+        if @step
+          raise ::TableStructure::Error, ':step must be numeric.' unless @step.is_a?(Numeric)
+          raise ::TableStructure::Error, ':step must be positive number.' unless @step.positive?
+        end
       end
-
-      unless schema.is_a?(Schema)
-        raise ::TableStructure::Error, "Must be use Schema. #{schema}"
-      end
-
-      @schema = schema
-      @options = {
-        header: header,
-        row_type: row_type
-      }
     end
 
-    def iterate(
-      items,
-      **deprecated_options,
-      &block
+    def initialize(
+      schema,
+      header: { context: nil, step: nil },
+      row_type: :array
     )
-      header = @options[:header]
-      row_type = @options[:row_type]
-
-      if deprecated_options.key?(:header)
-        header = deprecated_options[:header]
-        warn '[TableStructure] Use :header option on 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
-
-      if deprecated_options.key?(:row_type)
-        row_type = deprecated_options[:row_type]
-        warn '[TableStructure] Use :row_type option on initialize method.'
-      end
-
-      if deprecated_options.key?(:result_type)
-        warn '[TableStructure] `:result_type` option has been deprecated. Use `:row_type` option instead.'
-        row_type = deprecated_options[:result_type]
-      end
-
-      items = enumerize(items)
-
-      enum =
-        Table::Iterator
-        .new(
-          Table.new(@schema, row_type: row_type),
-          header: header
-        )
-        .iterate(items)
+      @table = Table.new(schema, row_type: row_type)
+      @header_options = HeaderOptions.new(header)
+    end
 
-      if block_given?
-        enum =
-          enum
-          .lazy
-          .map { |row| block.call(row) }
+    def iterate(items, &block)
+      raise ::TableStructure::Error, "Must be enumerable. #{items}" unless items.respond_to?(:each)
+
+      table_enum = ::Enumerator.new do |y|
+        body_enum = @table.body(items)
+
+        if @header_options.enabled?
+          header_row = @table.header(context: @header_options.context)
+          y << header_row
+
+          if @header_options.step
+            loop do
+              @header_options.step.times { y << body_enum.next }
+              y << header_row
+            end
+          else
+            body_enum.each { |row| y << row }
+          end
+        else
+          body_enum.each { |row| y << row }
+        end
       end
 
-      enum
-    end
-
-    private
+      table_enum = table_enum.lazy.map(&block) if block_given?
 
-    def enumerize(items)
-      if items.respond_to?(:each)
-        items
-      elsif items.respond_to?(:call)
-        warn "[TableStructure] Use `Enumerator` to wrap items instead of `lambda`. The use of `lambda` has been deprecated. #{items}"
-        Enumerator.new { |y| items.call(y) }
-      else
-        raise ::TableStructure::Error, "Must be enumerable. #{items}"
-      end
+      table_enum
     end
   end
 end