portable 1.0.0.pre.alpha.5 → 1.0.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b9fa7e8020098fb9dd2d9e2c9c984e0d71ff0aa02d4f568879bb013ae65b8d4
-  data.tar.gz: 1e01f15d35797f4954b5a4861b6a8d44e54f3571fc81cd73c5ff2c08ac8ef550
+  metadata.gz: ab583e6beab687062935129db41650e353f23ec7ca2af9c610f49d8ac60a4811
+  data.tar.gz: 5999aab0a2a8bb37337d0923a2c06bffe9876dd8e8b4b879b799112090b4f393
 SHA512:
-  metadata.gz: 97d59eb7d25b5ea806d908995f8978c8f711d280bd9c8b1e2dd0c09ca173f1c2fcf132f828e2218c17f3637fc6d92e8f7e12b827212ae404c153b2c5722cbbeb
-  data.tar.gz: 3878dc2b2f38b9de6cc90c6644e3913379cecefd21adef98b35adf9cbcce3bf0fae4832491de6f3a063477b2d64416778c55e4f0383820cdfc75970d0ece5152
+  metadata.gz: b485fead56c787bc169135b0c084289fcc690c49a9bface4f5d394c5494ed1139096ea5da5916001a2a845a1817c057f40d8d498d005288958e1792ebfa96b72
+  data.tar.gz: 93a3912588240c7c3172e06f47d8226627e50016ab9444a43c4d60aa536919542e8cbf35cb6e7369a226e15796b1b25e9af77e168dcb16a3c1a8a6193a8b481b

data/.travis.yml

@@ -2,8 +2,6 @@ env:
   global:
     - CC_TEST_REPORTER_ID=f40f0e6f9946420b05b247f1640b2f5fcef181ca86659a2e71c747f790fcecdd
 language: ruby
-services:
-  - mysql
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
   - 2.5.8

data/lib/portable.rb

@@ -17,7 +17,7 @@ require 'realize'
 require 'time'
 
 # Shared modules/classes
-require_relative 'portable/uniqueness'
+require_relative 'portable/util'
 
 # Main implementation points
 require_relative 'portable/data'

data/lib/portable/data/provider.rb

@@ -14,11 +14,10 @@ module Portable
     # Container of data sources that is inputted into a writer alongside a document.
     # It contains all the data sources the writer will use to render a document.
     class Provider
-      include Uniqueness
+      include Util::Pivotable
+      include Util::Uniqueness
       acts_as_hashable
 
-      DEFAULT_NAME = ''
-
       def initialize(data_sources: [])
         sources               = Source.array(data_sources)
         @data_sources_by_name = pivot_by_name(sources)
@@ -28,24 +27,16 @@ module Portable
         freeze
       end
 
-      # Use exact name if possible, if not then use the "default" one (noted by a blank name).
       # Fail hard if we cannot identify which data source to use.  This should help prevent
       # possible configuration issues (i.e. typos.)
       def data_source(name)
         data_sources_by_name[name.to_s] ||
-          data_sources_by_name[DEFAULT_NAME] ||
           raise(ArgumentError, "data source: '#{name}' cannot be found.")
       end
 
       private
 
       attr_reader :data_sources_by_name
-
-      def pivot_by_name(data_sources)
-        data_sources.each_with_object({}) do |data_source, memo|
-          memo[data_source.name] = data_source
-        end
-      end
     end
   end
 end

data/lib/portable/document.rb

@@ -13,19 +13,37 @@ require_relative 'modeling/sheet'
 module Portable
   # Top-level object model for a renderable document.
   class Document
-    include Uniqueness
+    include Util::Pivotable
+    include Util::Uniqueness
     acts_as_hashable
 
-    attr_reader :sheets, :options
+    attr_reader :options
 
     def initialize(sheets: [], options: {})
-      @sheets = Modeling::Sheet.array(sheets)
-      @sheets << Modeling::Sheet.new if @sheets.empty?
-      @options = Modeling::Options.make(options)
-
-      assert_no_duplicate_names(@sheets)
+      @sheets_by_name = make_unique_sheets_by_name(sheets)
+      @options        = Modeling::Options.make(options, nullable: false)
 
       freeze
     end
+
+    def sheet(name)
+      sheets_by_name.fetch(name.to_s)
+    end
+
+    def sheets
+      sheets_by_name.values
+    end
+
+    private
+
+    attr_reader :sheets_by_name
+
+    def make_unique_sheets_by_name(sheets)
+      sheets = Modeling::Sheet.array(sheets)
+      sheets << Modeling::Sheet.new if sheets.empty?
+
+      assert_no_duplicate_names(sheets)
+      pivot_by_name(sheets)
+    end
   end
 end

data/lib/portable/modeling/data_table.rb

@@ -16,10 +16,15 @@ module Portable
     class DataTable
       acts_as_hashable
 
-      attr_reader :columns
+      attr_reader :auto, :columns, :include_headers
 
-      def initialize(columns: [])
-        @columns = Column.array(columns)
+      alias include_headers? include_headers
+      alias auto? auto
+
+      def initialize(auto: true, columns: [], include_headers: true)
+        @auto            = auto || false
+        @columns         = Column.array(columns)
+        @include_headers = include_headers || false
 
         freeze
       end

data/lib/portable/modeling/sheet.rb

@@ -17,31 +17,45 @@ module Portable
     # one file.
     class Sheet
       acts_as_hashable
+      extend Forwardable
 
-      attr_reader :data_table,
+      def_delegators :data_table,
+                     :auto?,
+                     :columns,
+                     :include_headers?
+
+      attr_reader :data_source_name,
+                  :data_table,
                   :footer_rows,
                   :header_rows,
-                  :name,
-                  :include_headers
+                  :name
 
       def initialize(
+        data_source_name: '',
         data_table: nil,
         footer_rows: [],
         header_rows: [],
-        name: '',
-        include_headers: true
+        name: ''
       )
-        @name            = name.to_s
-        @data_table      = DataTable.make(data_table)
-        @footer_rows     = footer_rows || []
-        @header_rows     = header_rows || []
-        @include_headers = include_headers || false
+        @data_source_name = decide_data_source_name(data_source_name, name)
+        @name             = name.to_s
+        @data_table       = DataTable.make(data_table, nullable: false)
+        @footer_rows      = footer_rows || []
+        @header_rows      = header_rows || []
 
         freeze
       end
 
-      def include_headers?
-        include_headers
+      # Use exact name if possible, if not then use the sheet name or else use the
+      # "default" one (noted by a blank name).
+      def decide_data_source_name(data_source_name, sheet_name)
+        if !data_source_name.to_s.empty?
+          data_source_name.to_s
+        elsif !sheet_name.to_s.empty?
+          sheet_name.to_s
+        else
+          ''
+        end
       end
     end
   end

data/lib/portable/rendering/row.rb

@@ -12,9 +12,11 @@ module Portable
     # Internal intermediary class that knows how to combine columns specification
     # instances with their respective Realize pipelines.
     class Row # :nodoc: all
-      attr_reader :column_pipelines
+      attr_reader :column_pipelines, :resolver
 
       def initialize(columns, resolver: Objectable.resolver)
+        @resolver = resolver
+
         @column_pipelines = columns.each_with_object({}) do |column, memo|
           memo[column] = Realize::Pipeline.new(column.transformers, resolver: resolver)
         end
@@ -35,6 +37,10 @@ module Portable
       def headers
         columns.map(&:header)
       end
+
+      def merge(other)
+        self.class.new(columns + other.columns, resolver: resolver)
+      end
     end
   end
 end

data/lib/portable/rendering/sheet.rb

@@ -21,27 +21,32 @@ module Portable
         @resolver = resolver
 
         @row_renderers = @document.sheets.each_with_object({}) do |sheet, memo|
-          next unless sheet.data_table
-
-          memo[sheet.name] = Row.new(sheet.data_table.columns, resolver: resolver)
+          memo[sheet.name] = Row.new(sheet.columns, resolver: resolver)
         end
 
         freeze
       end
 
       def row_renderer(sheet_name, fields)
-        row_renderers.fetch(sheet_name, dynamic_row_renderer(fields))
+        sheet        = document.sheet(sheet_name)
+        row_renderer = row_renderers.fetch(sheet_name.to_s)
+
+        return row_renderer unless sheet.auto?
+
+        dynamic_row_renderer(fields).merge(row_renderer)
       end
 
       private
 
       attr_reader :row_renderers
 
-      def dynamic_row_renderer(fields)
-        fields  = (fields || []).map { |f| { header: f.to_s } }
-        columns = Modeling::Column.array(fields)
+      def fields_to_columns(fields)
+        fields = (fields || []).map { |f| { header: f.to_s } }
+        Modeling::Column.array(fields)
+      end
 
-        Row.new(columns, resolver: resolver)
+      def dynamic_row_renderer(fields)
+        Row.new(fields_to_columns(fields), resolver: resolver)
       end
     end
   end

data/lib/portable/util.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'util/pivotable'
+require_relative 'util/uniqueness'

data/lib/portable/util/pivotable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Portable
+  module Util # :nodoc: all
+    # Mixes in helpers for asserting uniqueness across collections
+    module Pivotable
+      def pivot_by_name(array)
+        array.each_with_object({}) { |object, memo| memo[object.name] = object }
+      end
+    end
+  end
+end

data/lib/portable/util/uniqueness.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Portable
+  module Util # :nodoc: all
+    # Mixes in helpers for asserting uniqueness across collections
+    module Uniqueness
+      class DuplicateNameError < StandardError; end
+
+      def assert_no_duplicate_names(array)
+        names = array.map { |a| a.name.downcase }
+
+        return if names.uniq.length == array.length
+
+        raise DuplicateNameError, "cannot contain duplicate names: #{names}"
+      end
+    end
+  end
+end

data/lib/portable/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Portable
-  VERSION = '1.0.0-alpha.5'
+  VERSION = '1.0.0-alpha.6'
 end

data/lib/portable/writers/csv.rb

@@ -22,7 +22,7 @@ module Portable
         sheet_filenames = extrapolate_filenames(filename, document.sheets.length)
 
         document.sheets.map.with_index do |sheet, index|
-          data_source    = data_provider.data_source(sheet.name)
+          data_source    = data_provider.data_source(sheet.data_source_name)
           sheet_filename = sheet_filenames[index]
 
           time_in_seconds = Benchmark.measure do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portable
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.5
+  version: 1.0.0.pre.alpha.6
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -185,7 +185,9 @@ files:
 - lib/portable/rendering.rb
 - lib/portable/rendering/row.rb
 - lib/portable/rendering/sheet.rb
-- lib/portable/uniqueness.rb
+- lib/portable/util.rb
+- lib/portable/util/pivotable.rb
+- lib/portable/util/uniqueness.rb
 - lib/portable/version.rb
 - lib/portable/writers.rb
 - lib/portable/writers/base.rb

data/lib/portable/uniqueness.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Copyright (c) 2020-present, Blue Marble Payroll, LLC
-#
-# This source code is licensed under the MIT license found in the
-# LICENSE file in the root directory of this source tree.
-#
-
-module Portable
-  # Mixes in helpers for asserting uniqueness across collections
-  module Uniqueness
-    class DuplicateNameError < StandardError; end
-
-    def assert_no_duplicate_names(array)
-      names = array.map { |a| a.name.downcase }
-
-      return if names.uniq.length == array.length
-
-      raise DuplicateNameError, "cannot contain duplicate names: #{names}"
-    end
-  end
-end