table_structure 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d27cfdc8700ffb57706bcde59f1aee9786af31fd132478befc8081b0f7cb4c
-  data.tar.gz: 5b7e60df0bc67c276cf4f95d70aba5b13a6a5be46004d8eb974c7182ee1261e6
+  metadata.gz: 4e966906136bf9907efb5bf1ad6fc1f2181ded3e4c6bbd6f76c19750198ecadd
+  data.tar.gz: c1f11210056449c18d31c693e758872659d603b1e9d1a28013cf0e35baff8776
 SHA512:
-  metadata.gz: 228a500f8c1e842dbfed09939b95c0af27237f3ef56e2e2a4c526c0b89fafd73d8a99a9ea1b9ee64f4f3610966f9717c829c2447d2c479f69c09877929f67a65
-  data.tar.gz: 44afa3c28a9ad5260361fdea2dcf85ac57b8799735305332bec3e3963b2d770f87fe06f73614e3b2645fe68c9579cbbc1a6e4256bbd39811046d1762db5878f1
+  metadata.gz: a98e9de6bd5d32941ee5730a8f34294d459a04ebc5e22a547887225421f7f91fcbbce59b026c6af5a96fa6215e38f0be6ed03b6155e04365418576f982d15873
+  data.tar.gz: b57d5dc8e40f0937ea14c06c08fb54d720bbd3215186b9357fc0f9f28705ea905938f238157999ecb62221ae84fd41d28872c63653557919b2be92a2162bc468

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 0.3.0
+Changes:
+- `TableStructure::Schema`
+  - Add `:omitted` key for column(s) DSL.
+  - Support nested schema.
+  - Add following options for schema initialization:
+    - `:key_prefix`
+    - `:key_suffix`
+
+# 0.2.0
+Changes:
+- Add `TableStructure::Iterator`.
+
+# 0.1.0
+- First version

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/jsmmr/ruby_table_structure.svg?branch=master)](https://travis-ci.org/jsmmr/ruby_table_structure)
 
 `TableStructure` has two major functions.
-The functions are `TableStructure::Schema` that defines the schema of a table using DSL and ` TableStructure::Writer` that converts and outputs data with that schema.
+The functions are `TableStructure::Schema` that defines the schema of a table using DSL and ` TableStructure::Writer` that converts and outputs data with the schema.
 
 ## Installation
 
@@ -132,6 +132,10 @@ class SampleTableSchema
     end
   }
 
+  ## When nesting schemas, same key must not exist 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 }
 end
 
@@ -180,6 +184,76 @@ enum.lazy.select { |item| item[:q1] == '⭕️' }.take(1).force
 
 ### Advanced
 
+You can also omit columns by defining `:omitted`.
+```ruby
+class SampleTableSchema
+  include TableStructure::Schema
+
+  column  name: 'ID',
+          value: ->(row, _table) { row[:id] }
+
+  column  name: 'Name',
+          value: ->(row, *) { row[:name] }
+
+  column  name: 'Secret',
+          value: ->(row, *) { row[:secret] },
+          omitted: ->(table) { !table[:admin] }
+end
+
+context = { admin: true }
+
+schema = SampleTableSchema.new(context: context)
+```
+
+You can also nest schemas.
+```ruby
+class PetsSchema
+  include TableStructure::Schema
+
+  columns name: ['Pet 1', 'Pet 2', 'Pet 3'],
+          value: ->(row, *) { row[:pets] }
+end
+
+class QuestionsSchema
+  include TableStructure::Schema
+
+  columns ->(table) {
+    table[:questions].map do |question|
+      {
+        name: question[:id],
+        value: ->(row, *) { row[:answers][question[:id]] }
+      }
+    end
+  }
+end
+
+class SampleTableSchema
+  include TableStructure::Schema
+
+  column  name: 'ID',
+          value: ->(row, _table) { row[:id] }
+
+  column  name: 'Name',
+          value: ->(row, *) { row[:name] }
+
+  columns ->(table) { PetsSchema.new(context: table) }
+
+  columns ->(table) { QuestionsSchema.new(context: table) }
+
+  column_converter :to_s, ->(val, *) { val.to_s }
+end
+
+context = {
+  questions: [
+    { id: 'Q1', text: 'Do you like sushi?' },
+    { id: 'Q2', text: 'Do you like yakiniku?' },
+    { id: 'Q3', text: 'Do you like ramen?' }
+  ]
+}
+
+schema = SampleTableSchema.new(context: context)
+```
+
 You can also use `context_builder`.
 This may be useful when `column` definition lambda is complicated.
 ```ruby
@@ -219,7 +293,7 @@ class SampleTableSchema
 end
 ```
 
-If you want to convert CSV character code, see the code below.
+If you want to convert CSV character code, you do so within block of `write` method.
 ```ruby
 File.open('sample.csv', 'w') do |f|
   writer.write(items, to: CSV.new(f)) do |row_values|

data/lib/table_structure.rb

@@ -16,6 +16,8 @@ module TableStructure
   require 'table_structure/schema/definition/validator'
   require 'table_structure/schema/table'
   require 'table_structure/schema/column'
+  require 'table_structure/schema/column/attrs'
+  require 'table_structure/schema/column/schema'
   require 'table_structure/schema/utils'
   require 'table_structure/writer'
   require 'table_structure/iterator'

data/lib/table_structure/schema.rb

@@ -10,7 +10,11 @@ module TableStructure
       klass.extend(DSL::ResultBuilder)
     end
 
-    DEFAULT_OPTIONS = { result_type: :array }.freeze
+    DEFAULT_OPTIONS = {
+      result_type: :array,
+      key_prefix: nil,
+      key_suffix: nil
+    }.freeze
 
     def initialize(context: nil, **options)
       column_definitions = self.class.column_definitions
@@ -30,12 +34,12 @@ module TableStructure
 
     def header(context: nil)
       context = self.class.context_builders[:header].call(context)
-      @table_structure_schema_table_.header(context)
+      @table_structure_schema_table_.header_values(context)
     end
 
     def row(context: nil)
       context = self.class.context_builders[:row].call(context)
-      @table_structure_schema_table_.row(context)
+      @table_structure_schema_table_.row_values(context)
     end
 
     def column_converters

data/lib/table_structure/schema/column.rb

@@ -2,44 +2,12 @@
 
 module TableStructure
   module Schema
-    class Column
-      attr_reader :name, :key, :vlaue, :size
-
-      def initialize(name:, key:, value:, size:)
-        @name = name
-        @key = key
-        @value = value
-        @size = size
-      end
-
-      def name(header_context, table_context)
-        name = Utils.evaluate_callable(@name, header_context, table_context)
-        optimize_size(name)
-      end
-
-      def key
-        optimize_size(@key)
-      end
-
-      def value(row_context, table_context)
-        value = Utils.evaluate_callable(@value, row_context, table_context)
-        optimize_size(value)
-      end
-
-      private
-
-      def optimize_size(value)
-        return value if @size == 1 && !value.is_a?(Array)
-
-        values = [value].flatten
-        actual_size = values.size
-        expected_size = @size
-        if actual_size > expected_size
-          values[0, expected_size]
-        elsif actual_size < expected_size
-          [].concat(values).fill(nil, actual_size, (expected_size - actual_size))
+    module Column
+      def self.create(definition, options)
+        if definition.is_a?(Hash)
+          Attrs.new(definition, options)
         else
-          values
+          Schema.new(definition)
         end
       end
     end

data/lib/table_structure/schema/column/attrs.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module TableStructure
+  module Schema
+    module Column
+      class Attrs
+        attr_reader :name, :key, :vlaue, :size
+
+        def initialize(definition, options)
+          @name = definition[:name]
+          @key = definition[:key]
+          @value = definition[:value]
+          @size = definition[:size]
+          @options = options
+        end
+
+        def name(header_context, table_context)
+          name = Utils.evaluate_callable(@name, header_context, table_context)
+          optimize_size(name)
+        end
+
+        def key
+          key = optimize_size(@key)
+          decorate_key(key)
+        end
+
+        def value(row_context, table_context)
+          value = Utils.evaluate_callable(@value, row_context, table_context)
+          optimize_size(value)
+        end
+
+        private
+
+        def optimize_size(value)
+          return value if @size == 1 && !value.is_a?(Array)
+
+          values = [value].flatten
+          actual_size = values.size
+          expected_size = @size
+          if actual_size > expected_size
+            values[0, expected_size]
+          elsif actual_size < expected_size
+            [].concat(values).fill(nil, actual_size, (expected_size - actual_size))
+          else
+            values
+          end
+        end
+
+        def decorate_key(key)
+          return key unless @options[:key_prefix] || @options[:key_suffix]
+
+          [key].flatten.map do |key|
+            next key unless key
+
+            decorated_key = "#{@options[:key_prefix]}#{key}#{@options[:key_suffix]}"
+            decorated_key = decorated_key.to_sym if key.is_a?(Symbol)
+            decorated_key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/table_structure/schema/column/schema.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module TableStructure
+  module Schema
+    module Column
+      class Schema
+        attr_reader :schema
+
+        def initialize(schema)
+          @schema = schema
+        end
+
+        def name(header_context, _table_context)
+          schema.header(context: header_context)
+        end
+
+        def key
+          schema
+            .instance_variable_get(:@table_structure_schema_table_)
+            .send(:keys)
+        end
+
+        def value(row_context, _table_context)
+          schema.row(context: row_context)
+        end
+      end
+    end
+  end
+end

data/lib/table_structure/schema/definition.rb

@@ -7,7 +7,8 @@ module TableStructure
         name: nil,
         key: nil,
         value: nil,
-        size: nil
+        size: nil,
+        omitted: false
       }.freeze
 
       DEFAULT_SIZE = 1
@@ -26,13 +27,24 @@ module TableStructure
             [definition]
               .flatten
               .map do |definition|
-                definition = DEFAULT_ATTRS.merge(definition)
-                validator.validate(definition)
-                definition[:size] = determine_size(definition)
-                definition
+                if definition.is_a?(Hash)
+                  definition = DEFAULT_ATTRS.merge(definition)
+                  omitted = definition.delete(:omitted)
+                  next if Utils.evaluate_callable(omitted, context)
+
+                  validator.validate(definition)
+                  definition[:size] = determine_size(definition)
+                  definition
+                elsif Utils.schema_instance?(definition)
+                  definition
+                # elsif Utils.schema_class?(definition)
+                #   # TODO: This doesn't work as expected when result_type: :hash is specified.
+                #   definition.new(context: context, **@options)
+                end
               end
           end
           .flatten
+          .compact
       end
 
       private

data/lib/table_structure/schema/table.rb

@@ -10,23 +10,28 @@ module TableStructure
         @column_converters = default_column_converters.merge(column_converters)
         @result_builders = default_result_builders(options).merge(result_builders)
         @context = context
+        @options = options
       end
 
-      def header(context)
+      def header_values(context)
         values(:name, context)
       end
 
-      def row(context)
+      def row_values(context)
         values(:value, context)
       end
 
+      def keys
+        @columns.map(&:key).flatten
+      end
+
       private
 
       def build_columns(definitions, context, options)
         Definition
           .new(definitions, options)
           .compile(context)
-          .map { |attrs| Column.new(attrs) }
+          .map { |definition| Column.create(definition, options) }
       end
 
       def default_column_converters
@@ -41,10 +46,6 @@ module TableStructure
         result_builders
       end
 
-      def keys
-        @columns.map(&:key).flatten
-      end
-
       def values(method, context)
         columns = @columns
                   .map { |column| column.send(method, context, @context) }

data/lib/table_structure/schema/utils.rb

@@ -6,6 +6,24 @@ module TableStructure
       def self.evaluate_callable(val, *params)
         val.respond_to?(:call) ? val.call(*params) : val
       end
+
+      def self.concat_key(key, prefix, suffix)
+        case key
+        when Symbol
+          "#{prefix}#{key}#{suffix}".to_sym
+        else
+          "#{prefix}#{key}#{suffix}"
+        end
+      end
+
+      def self.schema_class?(val)
+        val.is_a?(Class) &&
+          val.included_modules.include?(::TableStructure::Schema)
+      end
+
+      def self.schema_instance?(val)
+        val.is_a?(::TableStructure::Schema)
+      end
     end
   end
 end

data/lib/table_structure/version.rb

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

data/table_structure.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['jsmmr@icloud.com']
 
   spec.summary       = 'Creates and outputs table structured data.'
-  spec.description   = 'This gem creates and outputs table structured data. Useful for creating CSV.'
+  spec.description   = 'Creates and outputs table structured data. Useful for creating CSV.'
   spec.homepage      = 'https://github.com/jsmmr/ruby_table_structure'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_structure
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - jsmmr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem creates and outputs table structured data. Useful for creating
-  CSV.
+description: Creates and outputs table structured data. Useful for creating CSV.
 email:
 - jsmmr@icloud.com
 executables: []
@@ -63,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -74,6 +74,8 @@ files:
 - lib/table_structure/iterator.rb
 - lib/table_structure/schema.rb
 - lib/table_structure/schema/column.rb
+- lib/table_structure/schema/column/attrs.rb
+- lib/table_structure/schema/column/schema.rb
 - lib/table_structure/schema/definition.rb
 - lib/table_structure/schema/definition/error.rb
 - lib/table_structure/schema/definition/validator.rb