portable 1.0.0.pre.alpha.2 → 1.0.0.pre.alpha.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe43368608c03ce86c76422bdd7cdaba14cc7df66452780ff8af6aedc3c3c411
-  data.tar.gz: d90e21a8382237941ec558890ccd5b731734a4548baa054b78832989102141eb
+  metadata.gz: e9a80aeca8e54c0e02bf414ee6c79b6e110e126a57fc64a3a9d3f8990481f940
+  data.tar.gz: 7ee0c481c4d15148857726d3644230a76a52f8ae178425c5e1c5defbc485c81b
 SHA512:
-  metadata.gz: 076c5e70d9ef53d132dfea0691917afc5776bc5e9322ee50d56284f22eb37e7ce035d09218def74b7a702dcf5cea312e8cbab960932dcfe09a70fad9e52c534d
-  data.tar.gz: a726ceb297e8109de9996d2a9dde20561e843a83fc2a8ea9393acfe780eddc3e2c42ede6cb373c84e246292342655083bea6698ccd37c3b31a779fbe69db0863
+  metadata.gz: 2e45f20154ff8471104bcdbd5fbbc32d8cf3c892606c077f418b3d29456c8221c080bc7ae2719f63920e54a8f139ad62b2104ecfee1a39699d54467134f6a9be
+  data.tar.gz: d11bdfc431b996f82b8f6b14f53862ff98236ad08f6c7e79d87fdd3153137c42bc71687506bf2bfa544a9c1a62e745ba9658a8e1ded37eba3e9e705cb173ed49

data/.rubocop.yml

@@ -20,7 +20,7 @@ Metrics/MethodLength:
   Max: 30
 
 Metrics/AbcSize:
-  Max: 17
+  Max: 20
 
 Metrics/ClassLength:
   Max: 125

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

@@ -8,6 +8,7 @@
 #
 
 require 'acts_as_hashable'
+require 'benchmark'
 require 'csv'
 require 'fileutils'
 require 'forwardable'
@@ -15,6 +16,10 @@ require 'objectable'
 require 'realize'
 require 'time'
 
+# Shared modules/classes
+require_relative 'portable/util'
+
+# Main implementation points
 require_relative 'portable/data'
 require_relative 'portable/document'
 require_relative 'portable/rendering'

data/lib/portable/data/provider.rb

@@ -14,27 +14,29 @@ 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 Util::Pivotable
+      include Util::Uniqueness
       acts_as_hashable
 
       def initialize(data_sources: [])
-        @data_sources_by_name = pivot_by_name(Source.array(data_sources))
+        sources               = Source.array(data_sources)
+        @data_sources_by_name = pivot_by_name(sources)
+
+        assert_no_duplicate_names(sources)
 
         freeze
       end
 
+      # 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.fetch(name.to_s, Source.new)
+        data_sources_by_name[name.to_s] ||
+          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,16 +13,37 @@ require_relative 'modeling/sheet'
 module Portable
   # Top-level object model for a renderable document.
   class Document
+    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)
+      @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/column.rb

@@ -0,0 +1,31 @@
+# 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 Rendering
+    class Column # :nodoc: all
+      extend Forwardable
+
+      attr_reader :column, :pipeline
+
+      def_delegators :column, :header
+
+      def_delegators :pipeline, :transform
+
+      def initialize(column, resolver: Objectable.resolver)
+        raise ArgumentError, 'column is required' unless column
+
+        @column   = column
+        @pipeline = Realize::Pipeline.new(column.transformers, resolver: resolver)
+
+        freeze
+      end
+    end
+  end
+end

data/lib/portable/rendering/row.rb

@@ -7,34 +7,37 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'column'
+
 module Portable
   module Rendering
     # 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 :columns, :resolver
 
       def initialize(columns, resolver: Objectable.resolver)
-        @column_pipelines = columns.each_with_object({}) do |column, memo|
-          memo[column] = Realize::Pipeline.new(column.transformers, resolver: resolver)
-        end
+        @resolver = resolver
+        @columns  = columns.map { |column| Column.new(column, resolver: resolver) }
 
         freeze
       end
 
       def render(object, time)
-        column_pipelines.each_with_object({}) do |(column, pipeline), memo|
-          memo[column.header] = pipeline.transform(object, time)
-        end
-      end
-
-      def columns
-        column_pipelines.keys
+        columns.map { |column| column.transform(object, time) }
       end
 
       def headers
         columns.map(&:header)
       end
+
+      def model_columns
+        columns.map(&:column)
+      end
+
+      def merge(other)
+        self.class.new(model_columns + other.model_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.2'
+  VERSION = '1.0.0-alpha.7'
 end

data/lib/portable/writers/base.rb

@@ -20,6 +20,14 @@ module Portable
 
         freeze
       end
+
+      private
+
+      def ensure_directory_exists(filename)
+        path = File.dirname(filename)
+
+        FileUtils.mkdir_p(path) unless File.exist?(path)
+      end
     end
   end
 end

data/lib/portable/writers/csv.rb

@@ -8,6 +8,7 @@
 #
 
 require_relative 'base'
+require_relative 'result'
 
 module Portable
   module Writers
@@ -18,16 +19,18 @@ module Portable
 
         ensure_directory_exists(filename)
 
-        sheet_filenames = extrapolate_filenames(filename)
+        sheet_filenames = extrapolate_filenames(filename, document.sheets.length)
 
-        document.sheets.each do |sheet|
-          data_source    = data_provider.data_source(sheet.name)
-          sheet_filename = sheet_filenames[sheet.name]
+        document.sheets.map.with_index do |sheet, index|
+          data_source    = data_provider.data_source(sheet.data_source_name)
+          sheet_filename = sheet_filenames[index]
 
-          write_sheet(sheet_filename, sheet, data_source, time)
-        end
+          time_in_seconds = Benchmark.measure do
+            write_sheet(sheet_filename, sheet, data_source, time)
+          end.real
 
-        sheet_filenames.values
+          Result.new(sheet_filename, time_in_seconds)
+        end
       end
 
       private
@@ -54,7 +57,7 @@ module Portable
         csv << row_renderer.headers if sheet.include_headers?
 
         data_source.data_rows.each do |row|
-          csv << row_renderer.render(row, time).values
+          csv << row_renderer.render(row, time)
         end
       end
 
@@ -64,27 +67,17 @@ module Portable
         sheet.footer_rows.each { |row| csv << row }
       end
 
-      def ensure_directory_exists(filename)
-        path = File.dirname(filename)
-
-        FileUtils.mkdir_p(path) unless File.exist?(path)
-      end
-
-      def extrapolate_filenames(filename)
-        index    = 0
+      def extrapolate_filenames(filename, count)
         dir      = File.dirname(filename)
         ext      = File.extname(filename)
         basename = File.basename(filename, ext)
 
-        document.sheets.each_with_object({}) do |sheet, memo|
-          memo[sheet.name] =
-            if index.positive?
-              File.join(dir, "#{basename}.#{index}#{ext}")
-            else
-              filename
-            end
-
-          index += 1
+        (0..count).map do |index|
+          if index.positive?
+            File.join(dir, "#{basename}.#{index}#{ext}")
+          else
+            filename
+          end
         end
       end
     end

data/lib/portable/writers/result.rb

@@ -0,0 +1,24 @@
+# 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 Writers
+    # Result return object from a Writer#write! call.
+    class Result
+      attr_reader :filename, :time_in_seconds
+
+      def initialize(filename, time_in_seconds)
+        @filename        = filename
+        @time_in_seconds = time_in_seconds
+
+        freeze
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portable
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.2
+  version: 1.0.0.pre.alpha.7
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -183,12 +183,17 @@ files:
 - lib/portable/modeling/options.rb
 - lib/portable/modeling/sheet.rb
 - lib/portable/rendering.rb
+- lib/portable/rendering/column.rb
 - lib/portable/rendering/row.rb
 - lib/portable/rendering/sheet.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
 - lib/portable/writers/csv.rb
+- lib/portable/writers/result.rb
 - portable.gemspec
 homepage: https://github.com/bluemarblepayroll/portable
 licenses: