db_fuel 1.1.0.pre.alpha → 1.2.1.pre.alpha.1

data/lib/db_fuel/library/dbee/base.rb

@@ -14,7 +14,8 @@ module DbFuel
       class Base < Burner::JobWithRegister
         attr_reader :model,
                     :provider,
-                    :query
+                    :query,
+                    :debug
 
         # Arguments:
         # - model:    Dbee Model configuration
@@ -25,13 +26,15 @@ module DbFuel
           name:,
           model: {},
           query: {},
-          register: Burner::DEFAULT_REGISTER
+          register: Burner::DEFAULT_REGISTER,
+          debug: false
         )
           super(name: name, register: register)
 
           @model    = ::Dbee::Model.make(model)
           @provider = ::Dbee::Providers::ActiveRecordProvider.new
           @query    = ::Dbee::Query.make(query)
+          @debug    = debug || false
 
           freeze
         end
@@ -47,6 +50,12 @@ module DbFuel
 
           payload[register] = records
         end
+
+        def debug_detail(output, message)
+          return unless debug
+
+          output.detail(message)
+        end
       end
     end
   end

data/lib/db_fuel/library/dbee/query.rb

@@ -18,16 +18,48 @@ module DbFuel
       # Expected Payload[register] input: nothing
       # Payload[register] output: array of objects.
       class Query < Base
+        # Arguments:
+        # - name:      Name of job.
+        # - model:     Dbee Model configuration
+        # - query:     Dbee Query configuration
+        #
+        # - register:  Name of the register to use for gathering the IN clause values and where
+        #              to store the resulting recordset.
+        #
+        # - debug:     If debug is set to true (defaults to false) then the SQL statements
+        #              will be printed in the output.  Only use this option while
+        #              debugging issues as it will fill
+        #              up the output with (potentially too much) data.
+        def initialize(
+          name:,
+          model: {},
+          query: {},
+          register: Burner::DEFAULT_REGISTER,
+          debug: false
+        )
+          super(
+            model: model,
+            name: name,
+            query: query,
+            register: register,
+            debug: debug
+          )
+        end
+
         def perform(output, payload)
-          records = execute(sql)
+          records = execute(sql(output))
 
           load_register(records, output, payload)
         end
 
         private
 
-        def sql
-          ::Dbee.sql(model, query, provider)
+        def sql(output)
+          sql_statement = ::Dbee.sql(model, query, provider)
+
+          debug_detail(output, "Query SQL: #{sql_statement}")
+
+          sql_statement
         end
       end
     end

data/lib/db_fuel/library/dbee/range.rb

@@ -32,6 +32,11 @@ module DbFuel
         # - register:  Name of the register to use for gathering the IN clause values and where
         #              to store the resulting recordset.
         # - separator: Character to use to split the key-path for nested object support.
+        #
+        # - debug:     If debug is set to true (defaults to false) then the SQL statements
+        #              will be printed in the output.  Only use this option while
+        #              debugging issues as it will fill
+        #              up the output with (potentially too much) data.
         def initialize(
           name:,
           key:,
@@ -39,7 +44,8 @@ module DbFuel
           model: {},
           query: {},
           register: Burner::DEFAULT_REGISTER,
-          separator: ''
+          separator: '',
+          debug: false
         )
           raise ArgumentError, 'key is required' if key.to_s.empty?
 
@@ -51,12 +57,13 @@ module DbFuel
             model: model,
             name: name,
             query: query,
-            register: register
+            register: register,
+            debug: debug
           )
         end
 
         def perform(output, payload)
-          records = execute(sql(payload))
+          records = execute(sql(output, payload))
 
           load_register(records, output, payload)
         end
@@ -90,8 +97,13 @@ module DbFuel
           )
         end
 
-        def sql(payload)
-          ::Dbee.sql(model, compile_dbee_query(payload), provider)
+        def sql(output, payload)
+          dbee_query = compile_dbee_query(payload)
+          sql_statement = ::Dbee.sql(model, dbee_query, provider)
+
+          debug_detail(output, "Range SQL: #{sql_statement}")
+
+          sql_statement
         end
       end
     end

data/lib/db_fuel/modeling.rb

@@ -8,3 +8,4 @@
 #
 
 require_relative 'modeling/keyed_column'
+require_relative 'modeling/attribute_renderer_set'

data/lib/db_fuel/modeling/attribute_renderer_set.rb

@@ -0,0 +1,83 @@
+# 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 DbFuel
+  module Modeling
+    # Creates attribute renderers based on attributes passed.
+    # Also constains methods to transform attribute renderers
+    # and include timestamp attributes if needed.
+    class AttributeRendererSet
+      CREATED_AT = :created_at
+      NOW_TYPE   = 'r/value/now'
+      UPDATED_AT = :updated_at
+
+      attr_reader :attribute_renderers, :resolver
+
+      def initialize(attributes: [], resolver: nil)
+        raise ArgumentError, 'resolver is required' unless resolver
+
+        @resolver            = resolver
+        @attribute_renderers = make_attribute_renderers(attributes)
+
+        freeze
+      end
+
+      # Adds the attributes for created_at and updated_at to the currrent attribute renderers.
+      def timestamp_created_attribute_renderers
+        timestamp_attributes = [created_at_timestamp_attribute, updated_at_timestamp_attribute]
+
+        timestamp_attributes.map do |a|
+          Burner::Modeling::AttributeRenderer.new(a, resolver)
+        end + attribute_renderers
+      end
+
+      # Adds the attribute for updated_at to the currrent attribute renderers.
+      def timestamp_updated_attribute_renderers
+        timestamp_attributes = [updated_at_timestamp_attribute]
+
+        timestamp_attributes.map do |a|
+          Burner::Modeling::AttributeRenderer.new(a, resolver)
+        end + attribute_renderers
+      end
+
+      def make_attribute_renderers(attributes)
+        Burner::Modeling::Attribute
+          .array(attributes)
+          .map { |a| Burner::Modeling::AttributeRenderer.new(a, resolver) }
+      end
+
+      def transform(attribute_renderers, row, time)
+        attribute_renderers.each_with_object({}) do |attribute_renderer, memo|
+          value = attribute_renderer.transform(row, time)
+
+          resolver.set(memo, attribute_renderer.key, value)
+        end
+      end
+
+      private
+
+      def created_at_timestamp_attribute
+        timestamp_attribute(CREATED_AT)
+      end
+
+      def updated_at_timestamp_attribute
+        timestamp_attribute(UPDATED_AT)
+      end
+
+      def timestamp_attribute(key)
+        Burner::Modeling::Attribute.make(
+          key: key,
+          transformers: [
+            { type: NOW_TYPE }
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/db_fuel/modeling/keyed_column.rb

@@ -9,9 +9,9 @@
 
 module DbFuel
   module Modeling
-    # Connects a hash key to a sql column.  By default if a column is not given then its
+    # Connects a hash key to a SQL column.  By default if a column is not given then its
     # key will be used for both.  The general use case for this is for mapping objects
-    # to sql and sql to objects.
+    # to SQL and SQL to objects.
     class KeyedColumn
       acts_as_hashable
 

data/lib/db_fuel/version.rb

@@ -8,5 +8,5 @@
 #
 
 module DbFuel
-  VERSION = '1.1.0-alpha'
+  VERSION = '1.2.1-alpha.1'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: db_fuel
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre.alpha
+  version: 1.2.1.pre.alpha.1
 platform: ruby
 authors:
 - Matthew Ruggio
-autorequire: 
+- John Bosko
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -162,14 +163,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +217,7 @@ description: "    This library adds database-centric jobs to the Burner library.
   does not ship with database jobs out of the box.\n"
 email:
 - mruggio@bluemarblepayroll.com
+- jbosko@bluemarblepayroll.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -224,6 +226,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -236,14 +239,19 @@ files:
 - db_fuel.gemspec
 - exe/.gitkeep
 - lib/db_fuel.rb
+- lib/db_fuel/db_provider.rb
 - lib/db_fuel/library.rb
 - lib/db_fuel/library/active_record/base.rb
+- lib/db_fuel/library/active_record/find_or_insert.rb
 - lib/db_fuel/library/active_record/insert.rb
 - lib/db_fuel/library/active_record/update.rb
+- lib/db_fuel/library/active_record/update_all.rb
+- lib/db_fuel/library/active_record/upsert.rb
 - lib/db_fuel/library/dbee/base.rb
 - lib/db_fuel/library/dbee/query.rb
 - lib/db_fuel/library/dbee/range.rb
 - lib/db_fuel/modeling.rb
+- lib/db_fuel/modeling/attribute_renderer_set.rb
 - lib/db_fuel/modeling/keyed_column.rb
 - lib/db_fuel/version.rb
 homepage: https://github.com/bluemarblepayroll/db_fuel
@@ -255,7 +263,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/db_fuel
   homepage_uri: https://github.com/bluemarblepayroll/db_fuel
   source_code_uri: https://github.com/bluemarblepayroll/db_fuel
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -271,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Dbee and ActiveRecord jobs for Burner
 test_files: []