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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec22f03a9d7d5f09732805c47ffc8a31f8a366360ede468ca484e643629b146f
-  data.tar.gz: 2342697a6bbf0933c82e85a32a60de1d26d76642af6d29f6d17dee40d3ddc2d7
+  metadata.gz: 0a93b59424a5cf6866f1061785f41a0c49c1bcc707ce84a6652f481a283aab64
+  data.tar.gz: 3b7a65c38a5cc24ee844412ef6cb1bc3b2bc2a33c9afd564196e1b1f739108b7
 SHA512:
-  metadata.gz: 3016049ce85ba26c078f0d5f16cdd6aceb06765973c940bef11b250aae7d588af5204733d6ed51436d43560d31eed415f5c5d6b3b774e0f3ad41202990a69429
-  data.tar.gz: e81158e2ac4d716a6d89e8de86a5c9f5c124c5929f10b857be7eb2ac35c029d3cb6ca6acf33e001dacaf9f88432ff6465d6dc646fecb7652dc1f840eabffd6fc
+  metadata.gz: f5bc7c2644584e1f8e0412e0215bef34b6431b085e18fba822723e94ab0baea9c7a97a25d4970dc9169a2adc23f7818d618f48f8ab2f9d7ddb9f5a5914ecd356
+  data.tar.gz: 02d4f517420b8aa3331d99a69dadd39faa7b53382e89f153467eaea3d74a52141e75c000cba62c090e8e0aaa2fb2d293908160b016b242e35d483f396e37b542

data/README.md

@@ -32,8 +32,8 @@ Refer to the [Burner](https://github.com/bluemarblepayroll/burner) library for m
 
 ### Dbee Jobs
 
-* **db_fuel/dbee/query** [model, query, register]:  Pass in a [Dbee](https://github.com/bluemarblepayroll/dbee) model and query and store the results in the specified register.  Refer to the [Dbee](https://github.com/bluemarblepayroll/dbee) library directly on how to craft a model or query.
-* **db_fuel/dbee/range** [key, key_path, model, query, register, separator]: Similar to `db_fuel/dbee/query` with the addition of being able to grab a list of values from the register to use as a Dbee EQUALS/IN filter.  This helps to dynamically limit the resulting record set.  The key is used to specify where to grab the list of values, while the key_path will be used to craft the [Dbee equal's filter](https://github.com/bluemarblepayroll/dbee/blob/master/lib/dbee/query/filters/equals.rb).  Separator is exposed in case nested object support is necessary.
+* **db_fuel/dbee/query** [model, query, register, debug]:  Pass in a [Dbee](https://github.com/bluemarblepayroll/dbee) model and query and store the results in the specified register.  Refer to the [Dbee](https://github.com/bluemarblepayroll/dbee) library directly on how to craft a model or query.
+* **db_fuel/dbee/range** [key, key_path, model, query, register, separator, debug]: Similar to `db_fuel/dbee/query` with the addition of being able to grab a list of values from the register to use as a Dbee EQUALS/IN filter.  This helps to dynamically limit the resulting record set.  The key is used to specify where to grab the list of values, while the key_path will be used to craft the [Dbee equal's filter](https://github.com/bluemarblepayroll/dbee/blob/master/lib/dbee/query/filters/equals.rb).  Separator is exposed in case nested object support is necessary.
 
 ## Examples
 
@@ -98,6 +98,10 @@ If we were to inspect the contents of `payload` we should see the patient's resu
 payload['patients'] # array in form of: [ { "id" => 1, "first_name" => "Something" }, ... ]
 ````
 
+Notes
+
+* Set `debug: true` to print out SQL statement in the output (not for production use.)
+
 ### Limiting Result Sets
 
 The `db_fuel/dbee/query` does not provide a way to dynamically connect the query to existing data.  You are free to put any Dbee query filters in the query declaration, but what if you would like to further limit this based on the knowledge of a range of values?  The `db_fuel/dbee/range` job is meant to do exactly this.  On the surface it is mainly an extension of the `db_fuel/dbee/query` job.
@@ -151,6 +155,10 @@ payload['patients'] # array in form of: [ { "id" => 1, "first_name" => "Somethin
 
 The only difference between the query and range jobs should be the latter is limited based on the incoming first names.
 
+Notes
+
+* Set `debug: true` to print out SQL statement in the output (not for production use.)
+
 ### Updating the Database
 
 #### Inserting Records

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

@@ -42,7 +42,7 @@ module DbFuel
           @debug = debug || false
         end
 
-        private
+        protected
 
         def debug_detail(output, message)
           return unless debug

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_fuel
 version: !ruby/object:Gem::Version
-  version: 1.2.1.pre.alpha
+  version: 1.2.1.pre.alpha.1
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord