db_fuel 1.2.1.pre.alpha.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50352c41173cfcd379df4c836b7005750af724460f4533e112b7acc539f3adaf
-  data.tar.gz: 1536941988c987c6dd90d6e581b60ca9be1d3e25df9b927e3b2f393f54fa0478
+  metadata.gz: 532f508d6074e44c1dd4bb57dcecf343f32e035d44f6bdbfcb0405127ede5552
+  data.tar.gz: dccd390d0c15277ab9ca6c93027d12db85ebe7ad970333ebc2eadc7fc6f39b8c
 SHA512:
-  metadata.gz: 4d3bdb76cf43715d1bef3f92b5a6eb63e497c1a69cc9bfa113d648ed72f09900d5cae82aac991e45aea20629a274cffc0c0e1c808a8258c0e55a71a4ff1b5151
-  data.tar.gz: 6cf1100fc98dd991a18bada43391b3aa9db4dea2f8dba66ab382b3ef58fc4db5fce30e60120f8e425328ecc29e5cdf28b11a8fc0e679ebc7d8e43a5358115b08
+  metadata.gz: b49ad96e45049b564625a2288786e26087701e84c063aa71b316fde794237006c430fb9cc101ef2704efd79117702c36427e3bdf41098622ddb747e2af01d2f0
+  data.tar.gz: 1d426794ea2045a5a6c1966352b1e9a00ae991cf4d2996315011da26c99fa652ab0ce719dc3a8cd9a495f61df350a1cc1584d7e47a3aa0317276fbea866e6f37

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.0.0 (March 16th, 2021)
+
+New Jobs:
+* db_fuel/active_record/upsert
+* db_fuel/active_record/update_all
+
+Changes:
+* db_fuel/active_record/update now only updates a single record. Use db_fuel/active_record/update_all to update multiple records at a time.
+
 # 1.1.0 (Decmeber 1st, 2020)
 
 New Jobs:

data/README.md

@@ -24,11 +24,11 @@ Refer to the [Burner](https://github.com/bluemarblepayroll/burner) library for m
 
 ### ActiveRecord Jobs
 
-* **db_fuel/active_record/find_or_insert** [name, table_name, attributes, debug, primary_key, register, separator, timestamps, unique_attributes]: An extension of the `db_fuel/active_record/insert` job that adds an existence check before SQL insertion. The  `unique_attributes` will be converted to WHERE clauses for performing the existence check.
-* **db_fuel/active_record/insert** [name, table_name, attributes, debug, primary_key, register, separator, timestamps]: This job can take the objects in a register and insert them into a database table.  If primary_key is specified then its key will be set to the primary key.  Note that composite primary keys are not supported.  Attributes defines which object properties to convert to SQL.  Refer to the class and constructor specification for more detail.
+* **db_fuel/active_record/find_or_insert** [name, table_name, attributes, debug, primary_keyed_column, register, separator, timestamps, unique_attributes]: An extension of the `db_fuel/active_record/insert` job that adds an existence check before SQL insertion. The  `unique_attributes` will be converted to WHERE clauses for performing the existence check.
+* **db_fuel/active_record/insert** [name, table_name, attributes, debug, primary_keyed_column, register, separator, timestamps]: This job can take the objects in a register and insert them into a database table.  If primary_keyed_column is specified then its key will be set to the primary key.  Note that composite primary keys are not supported.  Attributes defines which object properties to convert to SQL.  Refer to the class and constructor specification for more detail.
 * **db_fuel/active_record/update_all** [name, table_name, attributes, debug, register, separator, timestamps, unique_attributes]: This job can take the objects in a register and updates them within a database table.  Attributes defines which object properties to convert to SQL SET clauses while unique_attributes translate to WHERE clauses. One or more records may be updated at a time.  Refer to the class and constructor specification for more detail.
-* **db_fuel/active_record/update** [name, table_name, attributes, debug, register, primary_key, separator, timestamps, unique_attributes]: This job can take the unique objects in a register and updates them within a database table.  Attributes defines which object properties to convert to SQL SET clauses while unique_attributes translate to WHERE clauses to find the records to update. The primary_key is used to update the unique record. Only one record will be updated per statement.  Refer to the class and constructor specification for more detail.
-* **db_fuel/active_record/upsert** [name, table_name, attributes, debug, primary_key, register, separator, timestamps, unique_attributes]: This job can take the objects in a register and either inserts or updates them within a database table.  Attributes defines which object properties to convert to SQL SET clauses while each key in unique_attributes become a WHERE clause in order to check for the existence of a specific record. The updated record will use the primary_key specified to perform the UPDATE operation. Note that composite primary keys are not supported. Refer to the class and constructor specification for more detail.
+* **db_fuel/active_record/update** [name, table_name, attributes, debug, register, primary_keyed_column, separator, timestamps, unique_attributes]: This job can take the unique objects in a register and updates them within a database table.  Attributes defines which object properties to convert to SQL SET clauses while unique_attributes translate to WHERE clauses to find the records to update. The primary_keyed_column is used to update the unique record. Only one record will be updated per statement. Note that composite primary keys are not supported.  Refer to the class and constructor specification for more detail.
+* **db_fuel/active_record/upsert** [name, table_name, attributes, debug, primary_keyed_column, register, separator, timestamps, unique_attributes]: This job can take the objects in a register and either inserts or updates them within a database table.  Attributes defines which object properties to convert to SQL SET clauses while each key in unique_attributes become a WHERE clause in order to check for the existence of a specific record. The updated record will use the primary_keyed_column specified to perform the UPDATE operation. Note that composite primary keys are not supported. Refer to the class and constructor specification for more detail.
 
 ### Dbee Jobs
 
@@ -187,7 +187,7 @@ pipeline = {
         { key: :last_name }
       ],
       table_name: 'patients',
-      primary_key: {
+      primary_keyed_column: {
         key: :id
       }
     }
@@ -203,13 +203,13 @@ There should now be two new patients, AB0 and AB1, present in the table `patient
 
 Notes:
 
-* Since we specified the `primary_key`, the records' `id` attributes should be set to their respective primary key values.
+* Since we specified the `primary_keyed_column`, the records' `id` attributes should be set to their respective primary key values.
 * Composite primary keys are not currently supported.
 * Set `debug: true` to print out each INSERT statement in the output (not for production use.)
 
 #### Inserting Only New Records
 
-Another job `db_fuel/active_record/find_or_insert` allows for an existence check to performed each insertion.  If a record is found then it will not insert the record.  If `primary_key` is set then the existence check will also still set the primary key on the payload's respective object.  Note that composite primary keys are not currently supported. We can build on the above insert example for only inserting new patients if their chart_number is unique:
+Another job `db_fuel/active_record/find_or_insert` allows for an existence check to performed each insertion.  If a record is found then it will not insert the record.  If `primary_keyed_column` is set then the existence check will also still set the primary key on the payload's respective object.  Note that composite primary keys are not currently supported. We can build on the above insert example for only inserting new patients if their chart_number is unique:
 
 ````ruby
 pipeline = {
@@ -233,7 +233,7 @@ pipeline = {
         { key: :last_name }
       ],
       table_name: 'patients',
-      primary_key: {
+      primary_keyed_column: {
         key: :id
       },
       unique_attributes: [
@@ -274,7 +274,7 @@ pipeline = {
         { key: :last_name }
       ],
       table_name: 'patients',
-      primary_key: {
+      primary_keyed_column: {
         key: :id
       },
       unique_attributes: [
@@ -356,7 +356,7 @@ pipeline = {
         { key: :last_name }
       ],
       table_name: 'patients',
-      primary_key: {
+      primary_keyed_column: {
         key: :id
       },
       unique_attributes: [

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

@@ -36,8 +36,8 @@ module DbFuel
           super(name: name, register: register)
 
           @resolver = Objectable.resolver(separator: separator)
-          @attribute_renderers_set = Modeling::AttributeRendererSet.new(attributes: attributes,
-                                                                        resolver: resolver)
+          @attribute_renderers_set = Modeling::AttributeRendererSet.new(resolver: resolver,
+                                                                        attributes: attributes)
           @db_provider = DbProvider.new(table_name)
           @debug = debug || false
         end

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

@@ -14,8 +14,9 @@ module DbFuel
     module ActiveRecord
       # This job is a slight enhancement to the insert job, in that it will only insert new
       # records.  It will use the unique_keys to first run a query to see if it exists.
-      # Each unique_key becomes a WHERE clause.  If primary_key is specified and a record is
-      # found then the first record's id will be set to the primary_key.
+      # Each unique_key becomes a WHERE clause.  If primary_keyed_column is specified
+      # and a record is found then the first record's id will be set to
+      # the primary_keyed_column.
       #
       # Expected Payload[register] input: array of objects
       # Payload[register] output: array of objects.
@@ -36,8 +37,9 @@ module DbFuel
         #          returned objects 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.
         #
-        #   primary_key: If primary_key is present then it will be used to set the object's
-        #                property to the returned primary key from the INSERT statement.
+        #   primary_keyed_column: If primary_keyed_column is present then it will be used to set
+        #                     the object's property to the returned primary key
+        #                       from the INSERT statement.
         #
         #   separator: Just like other jobs with a 'separator' option, if the objects require
         #              key-path notation or nested object support, you can set the separator
@@ -55,7 +57,7 @@ module DbFuel
           name: '',
           attributes: [],
           debug: false,
-          primary_key: nil,
+          primary_keyed_column: nil,
           register: Burner::DEFAULT_REGISTER,
           separator: '',
           timestamps: true,
@@ -67,7 +69,7 @@ module DbFuel
             table_name: table_name,
             attributes: attributes,
             debug: debug,
-            primary_key: primary_key,
+            primary_keyed_column: primary_keyed_column,
             register: register,
             separator: separator,
             timestamps: timestamps,

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

@@ -17,8 +17,6 @@ module DbFuel
       # Expected Payload[register] input: array of objects
       # Payload[register] output: array of objects.
       class Insert < Upsert
-        # attr_reader :primary_key
-
         # Arguments:
         #   name: name of the job within the Burner::Pipeline.
         #
@@ -33,8 +31,9 @@ module DbFuel
         #          returned objects 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.
         #
-        #   primary_key: If primary_key is present then it will be used to set the object's
-        #                property to the returned primary key from the INSERT statement.
+        #   primary_keyed_column: If primary_keyed_column is present then it will be used to
+        #                     set the object's property to the returned primary key
+        #                     from the INSERT statement.
         #
         #   separator: Just like other jobs with a 'separator' option, if the objects require
         #              key-path notation or nested object support, you can set the separator
@@ -49,7 +48,7 @@ module DbFuel
           name: '',
           attributes: [],
           debug: false,
-          primary_key: nil,
+          primary_keyed_column: nil,
           register: Burner::DEFAULT_REGISTER,
           separator: '',
           timestamps: true
@@ -62,7 +61,7 @@ module DbFuel
             table_name: table_name,
             attributes: attributes,
             debug: debug,
-            primary_key: primary_key,
+            primary_keyed_column: primary_keyed_column,
             register: register,
             separator: separator,
             timestamps: timestamps

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

@@ -15,7 +15,7 @@ module DbFuel
       # This job can take the unique objects in a register and updates them within database table.
       # The attributes translate to SQL SET clauses and the unique_keys translate to
       # WHERE clauses to find the records to update.
-      # The primary_key is used to update the unique record.
+      # The primary_keyed_column is used to update the unique record.
       # Only one record will be updated per statement.
       #
       # Expected Payload[register] input: array of objects
@@ -35,7 +35,7 @@ module DbFuel
         #          returned objects 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.
         #
-        #   primary_key [required]: Primary key column for the corresponding table.
+        #   primary_keyed_column [required]: Primary key column for the corresponding table.
         #                           Used as the WHERE clause for the UPDATE statement.
         #                           Only one record will be updated at a time
         #                           using the primary key specified.
@@ -56,7 +56,7 @@ module DbFuel
           name: '',
           attributes: [],
           debug: false,
-          primary_key: nil,
+          primary_keyed_column: nil,
           register: Burner::DEFAULT_REGISTER,
           separator: '',
           timestamps: true,
@@ -70,7 +70,7 @@ module DbFuel
             table_name: table_name,
             attributes: attributes,
             debug: debug,
-            primary_key: primary_key,
+            primary_keyed_column: primary_keyed_column,
             register: register,
             separator: separator,
             timestamps: timestamps,

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

@@ -62,7 +62,7 @@ module DbFuel
             table_name: table_name,
             attributes: attributes,
             debug: debug,
-            primary_key: nil,
+            primary_keyed_column: nil,
             register: register,
             separator: separator,
             timestamps: timestamps,

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

@@ -16,12 +16,12 @@ module DbFuel
       # It will use the unique_keys to first run a query to see if it exists.
       # Each unique_key becomes a WHERE clause. If a record is found it will then
       # update the found record using the primary key specified.
-      # If a record is updated or created the record's id will be set to the primary_key.
+      # If a record is updated or created the record's id will be set to the primary_keyed_column.
       #
       # Expected Payload[register] input: array of objects
       # Payload[register] output: array of objects.
       class Upsert < Base
-        attr_reader :primary_key, :timestamps, :unique_attribute_renderers
+        attr_reader :primary_keyed_column, :timestamps, :unique_attribute_renderers
 
         # Arguments:
         #   name: name of the job within the Burner::Pipeline.
@@ -38,9 +38,10 @@ module DbFuel
         #                debugging issues as it will fill
         #                up the output with (potentially too much) data.
         #
-        #   primary_key [required]: Used to set the object's property to the returned primary key
-        #                           from the INSERT statement or used as the
-        #                           WHERE clause for the UPDATE statement.
+        #   primary_keyed_column [required]: Used to set the object's property to the
+        #                                returned primary key from the
+        #                                INSERT statement or used as the
+        #                                WHERE clause for the UPDATE statement.
         #
         #   separator: Just like other jobs with a 'separator' option, if the objects require
         #              key-path notation or nested object support, you can set the separator
@@ -57,7 +58,7 @@ module DbFuel
         #                      order to check for the existence of a specific record.
         def initialize(
           table_name:,
-          primary_key:,
+          primary_keyed_column:,
           name: '',
           attributes: [],
           debug: false,
@@ -75,10 +76,10 @@ module DbFuel
             separator: separator
           )
 
-          @primary_key = Modeling::KeyedColumn.make(primary_key, nullable: true)
+          @primary_keyed_column = Modeling::KeyedColumn.make(primary_keyed_column, nullable: true)
 
           @unique_attribute_renderers = attribute_renderers_set
-                                        .make_attribute_renderers(unique_attributes)
+                                        .make_renderers(unique_attributes)
 
           @timestamps = timestamps
 
@@ -86,7 +87,7 @@ module DbFuel
         end
 
         def perform(output, payload)
-          raise ArgumentError, 'primary_key is required' unless primary_key
+          raise ArgumentError, 'primary_keyed_column is required' unless primary_keyed_column
 
           total_inserted = 0
           total_updated  = 0
@@ -118,9 +119,9 @@ module DbFuel
 
           first_record = db_provider.first(unique_row)
 
-          id = resolver.get(first_record, primary_key.column)
+          id = resolver.get(first_record, primary_keyed_column.column)
 
-          resolver.set(row, primary_key.key, id)
+          resolver.set(row, primary_keyed_column.key, id)
 
           debug_detail(output, "Record Exists: #{first_record}") if first_record
 
@@ -144,24 +145,24 @@ module DbFuel
 
           id = db_provider.insert(set_object)
 
-          # add the primary key name and value to row if primary_key was specified
-          resolver.set(row, primary_key.key, id) if primary_key
+          # add the primary key name and value to row if primary_keyed_column was specified
+          resolver.set(row, primary_keyed_column.key, id) if primary_keyed_column
 
           debug_detail(output, "Insert Return: #{row}")
         end
 
         # Updates only a single record. Lookups primary key to update the record.
         def update_record(output, row, time)
-          raise ArgumentError, 'primary_key is required' unless primary_key
+          raise ArgumentError, 'primary_keyed_column is required' unless primary_keyed_column
 
           first_record = find_record(output, row, time)
 
           if first_record
             debug_detail(output, "Record Exists: #{first_record}")
 
-            id = resolver.get(first_record, primary_key.column)
+            id = resolver.get(first_record, primary_keyed_column.column)
 
-            where_object = { primary_key.column => id }
+            where_object = { primary_keyed_column.column => id }
 
             # update record using the primary key as the WHERE clause
             update(output, row, time, where_object)

data/lib/db_fuel/modeling/attribute_renderer_set.rb

@@ -12,25 +12,31 @@ module DbFuel
     # 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
+    class AttributeRendererSet # :nodoc:
       NOW_TYPE   = 'r/value/now'
-      UPDATED_AT = :updated_at
+
+      CREATED_AT = Burner::Modeling::Attribute.make(
+        key: :created_at, transformers: [{ type: NOW_TYPE }]
+      )
+
+      UPDATED_AT = Burner::Modeling::Attribute.make(
+        key: :updated_at, transformers: [{ type: NOW_TYPE }]
+      )
 
       attr_reader :attribute_renderers, :resolver
 
-      def initialize(attributes: [], resolver: nil)
+      def initialize(resolver:, attributes: [])
         raise ArgumentError, 'resolver is required' unless resolver
 
         @resolver            = resolver
-        @attribute_renderers = make_attribute_renderers(attributes)
+        @attribute_renderers = make_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 = [CREATED_AT, UPDATED_AT]
 
         timestamp_attributes.map do |a|
           Burner::Modeling::AttributeRenderer.new(a, resolver)
@@ -39,14 +45,14 @@ module DbFuel
 
       # Adds the attribute for updated_at to the currrent attribute renderers.
       def timestamp_updated_attribute_renderers
-        timestamp_attributes = [updated_at_timestamp_attribute]
+        timestamp_attributes = [UPDATED_AT]
 
         timestamp_attributes.map do |a|
           Burner::Modeling::AttributeRenderer.new(a, resolver)
         end + attribute_renderers
       end
 
-      def make_attribute_renderers(attributes)
+      def make_renderers(attributes)
         Burner::Modeling::Attribute
           .array(attributes)
           .map { |a| Burner::Modeling::AttributeRenderer.new(a, resolver) }
@@ -59,25 +65,6 @@ module DbFuel
           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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_fuel
 version: !ruby/object:Gem::Version
-  version: 1.2.1.pre.alpha.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -274,9 +274,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: