table_structure 0.3.18 → 0.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b76264ce64e9ba5706af0a933cda2a9bbd64d7c4f49a88ac8cf57c2c96a87d7e
-  data.tar.gz: e78fa085177724b1fc7a6a5561455588611159226d170840fb4a8ac908feb7aa
+  metadata.gz: dd4c31d4dca33325702612875d61ba8c011ffa01bc63ae34a37ef3dc5b288350
+  data.tar.gz: 126975799c4d8e7fc2e534c649e43946fb640395b9b040db5d347b2e3562bd48
 SHA512:
-  metadata.gz: a767059b75a19a19ad4eff6fb16134ac4cc345bb5dd0878f7d434db274e9ae37c0a708b73e52611eea83deb0e78edd1ed891bcccef666674726c67f43bec699c
-  data.tar.gz: 94c598813253ca9ae1d20d5853567cfb3d45ef4bb161c69b879988f144265449291b3a3130ca894c8a0aac2545eb13e77e1433ba48fa539cc6541d3cddaa7804
+  metadata.gz: 857750dbc07833cc0c137b3041c97ecb5cd1421d0e539f153f614a66c10f8cbe9c7d567c6d73a6982e4c62f9c303f33dcfa28ef850e7aa2941086b9f97371385
+  data.tar.gz: 2663d270d999ed8598b9e83d89894517c39e880e2deda23021c7ae9ac83cb24202a18d9970919eb2ad1913ab0889dff9ddd7b997d75f36d1d2293f748afa05c2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.3.19
+Changes:
+- `TableStructure::Writer`
+  - `header_omitted: true` option has been deprecated. Use `header: false` option instead.
+- `TableStructure::CSV::Writer`
+  - `header_omitted: true` option has been deprecated. Use `header: false` option instead.
+- `TableStructure::Iterator`
+  - `header_omitted: true` option has been deprecated. Use `header: false` option instead.
+
 # 0.3.18
 Changes:
 - Minor improvements.

data/Gemfile.lock

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

data/README.md

@@ -77,10 +77,10 @@ Initialize a writer with the schema:
 ```ruby
 writer = TableStructure::Writer.new(schema)
 ## To omit header, write:
-# writer = TableStructure::Writer.new(schema, header_omitted: true)
+# writer = TableStructure::Writer.new(schema, header: false)
 ```
 
-Writes the items converted by the schema to array:
+Write the items converted by the schema to array:
 ```ruby
 items = [
   {
@@ -109,14 +109,14 @@ writer.write(items, to: table)
 # => [["ID", "Name", "Pet 1", "Pet 2", "Pet 3", "Q1", "Q2", "Q3"], ["1", "Taro", "🐱", "🐶", "", "⭕️", "❌", "⭕️"], ["2", "Hanako", "🐇", "🐢", "🐿", "⭕️", "⭕️", "❌"]]
 ```
 
-Writes the items converted by the schema to file as CSV:
+Write the items converted by the schema to file as CSV:
 ```ruby
 File.open('sample.csv', 'w') do |f|
   writer.write(items, to: CSV.new(f))
 end
 ```
 
-Writes the items converted by the schema to stream as CSV with Rails:
+Write the items converted by the schema to stream as CSV with Rails:
 ```ruby
 # response.headers['X-Accel-Buffering'] = 'no' # Required if Nginx is used for reverse proxy
 response.headers['Cache-Control'] = 'no-cache'
@@ -191,7 +191,7 @@ context = {
 }
 
 schema = SampleTableSchema.new(context: context)
-iterator = TableStructure::Iterator.new(schema, row_type: :hash, header_omitted: true)
+iterator = TableStructure::Iterator.new(schema, row_type: :hash, header: false)
 ```
 
 Enumerate the items converted by the schema:
@@ -446,12 +446,12 @@ end
 
 You can also use only `TableStructure::Schema` instance.
 ```erb
-<% @schema.create_table(row_type: :array) do |table| %>
+<% @schema.create_table(row_type: :hash) do |table| %>
   <table>
     <thead>
       <tr>
-        <% table.header.each do |val| %>
-          <th><%= val %></th>
+        <% table.header.each do |key, value| %>
+          <th class="<%= key %>"><%= value %></th>
         <% end %>
       </tr>
     </thead>
@@ -459,8 +459,8 @@ You can also use only `TableStructure::Schema` instance.
     <tbody>
       <% table.body(@items).each do |row| %>
         <tr>
-          <% row.each do |val| %>
-            <td><%= val %></td>
+          <% row.each do |key, value| %>
+            <td class="<%= key %>"><%= value %></td>
           <% end %>
         </tr>
       <% end %>

data/lib/table_structure/csv/writer.rb

@@ -9,9 +9,21 @@ module TableStructure
         schema,
         bom: false,
         csv_options: {},
-        header_omitted: false,
-        header_context: nil
+        header: { context: nil },
+        **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
+        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 = {
@@ -19,8 +31,7 @@ module TableStructure
           csv_options: csv_options
         }
         @inner_options = {
-          header_omitted: header_omitted,
-          header_context: header_context
+          header: header
         }
 
         @writer = ::TableStructure::Writer.new(schema, **@inner_options)
@@ -31,13 +42,30 @@ module TableStructure
         to:,
         bom: @options[:bom],
         csv_options: @options[:csv_options],
-        header_omitted: @inner_options[:header_omitted],
-        header_context: @inner_options[:header_context],
+        **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_omitted: header_omitted,
-          header_context: header_context
+          header: header
         }
 
         to << BOM if bom

data/lib/table_structure/version.rb

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

data/lib/table_structure/writer.rb

@@ -4,12 +4,23 @@ module TableStructure
   class Writer
     def initialize(
       schema,
-      header_omitted: false,
-      header_context: nil,
+      header: { context: nil },
       method: :<<,
       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
+      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?(:result_type)
         warn '[TableStructure] `:result_type` option has been deprecated. Use `:row_type` option instead.'
         row_type = deprecated_options[:result_type]
@@ -17,8 +28,7 @@ module TableStructure
 
       @schema = schema
       @options = {
-        header_omitted: header_omitted,
-        header_context: header_context,
+        header: header,
         method: method,
         row_type: row_type
       }
@@ -28,12 +38,34 @@ module TableStructure
       items,
       to:,
       method: @options[:method],
-      header_omitted: @options[:header_omitted],
-      header_context: @options[:header_context],
-      row_type: @options[:row_type],
       **deprecated_options,
       &block
     )
+      header = @options[:header]
+      row_type = @options[:row_type]
+
+      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
+
+      if deprecated_options.key?(:row_type)
+        row_type = deprecated_options[:row_type]
+        warn '[TableStructure] Specify :row_type option as an argument for 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]
@@ -41,13 +73,6 @@ module TableStructure
 
       items = enumerize(items)
 
-      header_options =
-        if header_omitted
-          false
-        else
-          { context: header_context }
-        end
-
       @schema.create_table(row_type: row_type) do |table|
         output = Output.new(to, method: method)
 
@@ -55,7 +80,7 @@ module TableStructure
           Table::Iterator
           .new(
             table,
-            header: header_options
+            header: header
           )
           .iterate(items)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_structure
 version: !ruby/object:Gem::Version
-  version: 0.3.18
+  version: 0.3.19
 platform: ruby
 authors:
 - jsmmr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler