db_fuel 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e96867b0df819c4a00e446f47fe586d48a12da5798e0743b8895940ff126af
-  data.tar.gz: fed359df2f9d2512740e39ad65fd5e6fabed287fb1403bed525fe4b0af5bdf0d
+  metadata.gz: 6153de5e6e01820bf9c5b0bb67260ab4aa71198a82b775e1f34c771d4a520140
+  data.tar.gz: a95690fcf11543f4fdeb247190e993efe53c05f946ec866eb8e482378fd75e68
 SHA512:
-  metadata.gz: 72382d90f1368e9ac9d4cb35a64b60235ec5822568be79ce5a92fd956e41eed9a139d6cf9681585af24932c4e5ff7759e8cb4b36eb2e1cefa0f20e120baa478c
-  data.tar.gz: d127c76c1d94e35e2c8b46aff67c6e80735b9381348ae3fb984e983b67701889b0448d5ae00e53218ec52453d7a7e1d7f3df39feaefaaa139652fe35e36fbaff
+  metadata.gz: e446d0a87845c79afbcfb1d20859b6fc363e39cf6069c10e833f8524a161f66f4ef254282294e0188193f4e41054877b18b781077287f2c19bb10d1a03cba545
+  data.tar.gz: 172f25cbc3503861f0f82ffa20885697b7a1b46fd04f44d80a8a565f6781e7d72f1e714a57aab98ca2245e2fcbf44667bfb692a88e69f2021aedc8eba92e6a73

data/.circleci/config.yml

@@ -0,0 +1,73 @@
+version: 2.1
+
+orbs:
+  status_to_ms_teams: bluemarblepayroll/status_to_ms_teams_pure_bash@1.0.0
+
+jobs:
+  build:
+    parameters:
+      use-bundler-cache:
+        type: boolean
+        default: true
+
+    docker:
+      - image: circleci/ruby:2.6.6-buster
+        environment:
+          FORBID_FOCUSED_SPECS: 1
+          AR_VERSION: 5
+    working_directory: ~/db_fuel
+    steps:
+      - checkout
+      - run: cp spec/config/database.yaml.ci spec/config/database.yaml
+
+      # TODO: wrap bundler caching logic into an Orb:
+      - when:
+          condition: << parameters.use-bundler-cache >>
+          steps:
+            - restore_cache:
+                key: v1.0.0-build-ruby-dependency-cache-{{ checksum "db_fuel.gemspec" }}-{{ checksum "Gemfile" }}-{{ checksum ".ruby-version" }}
+
+      - run: bundle install --path vendor/bundle
+
+      - when:
+          condition: << parameters.use-bundler-cache >>
+          steps:
+            - save_cache:
+                key: v1.0.0-build-ruby-dependency-cache-{{ checksum "db_fuel.gemspec" }}-{{ checksum "Gemfile" }}-{{ checksum ".ruby-version" }}
+                paths:
+                  - vendor/bundle
+
+      - store_artifacts:
+          path: Gemfile.lock
+
+      - run: bundle exec rubocop
+
+      - run: COVERAGE=true bundle exec rspec -r rspec_junit_formatter --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+
+      - store_test_results:
+          path: test-results
+
+      - store_artifacts:
+          path: coverage
+
+      - status_to_ms_teams/report:
+          webhook_url: $MS_TEAMS_WEBHOOK_URL
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - build:
+          context: org-global
+  monthly-gem-dependency-refresh-check:
+    triggers:
+      - schedule:
+          cron: '0 0 1 * *'
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - build:
+          context: org-global
+          use-bundler-cache: false

data/README.md

@@ -1,6 +1,6 @@
 # DB Fuel
 
-[![Gem Version](https://badge.fury.io/rb/db_fuel.svg)](https://badge.fury.io/rb/db_fuel) [![Build Status](https://travis-ci.org/bluemarblepayroll/db_fuel.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/db_fuel) [![Maintainability](https://api.codeclimate.com/v1/badges/21945483950d9c35fabb/maintainability)](https://codeclimate.com/github/bluemarblepayroll/db_fuel/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/21945483950d9c35fabb/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/db_fuel/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CircleCI](https://circleci.com/bb/bluemarble-ondemand/db_fuel/tree/master.svg?style=svg&circle-token=f1b2aed3fa173235db39da671c5b5db22e061609)](https://circleci.com/bb/bluemarble-ondemand/db_fuel/tree/master)
 
 This library is a plugin for [Burner](https://github.com/bluemarblepayroll/burner).  Burner, by itself, cannot use a database.  So, if you wish to use a database as a data source or as a target for mutation then you need to add a library similar to this.
 
@@ -421,7 +421,7 @@ Note: ensure you have proper authorization before trying to publish new versions
 After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
 
 1. Merge Pull Request into master
-2. Update `lib/db_fuel/version.rb` using [semantic versioning](https://semver.org/)
+2. Update `version.rb` using [semantic versioning](https://semver.org/)
 3. Install dependencies: `bundle`
 4. Update `CHANGELOG.md` with release notes
 5. Commit & push master to remote and ensure CI builds master successfully

data/db_fuel.gemspec

@@ -16,15 +16,7 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.bindir      = 'exe'
   s.executables = %w[]
-  s.homepage    = 'https://github.com/bluemarblepayroll/db_fuel'
   s.license     = 'MIT'
-  s.metadata    = {
-    'bug_tracker_uri' => 'https://github.com/bluemarblepayroll/db_fuel/issues',
-    'changelog_uri' => 'https://github.com/bluemarblepayroll/db_fuel/blob/master/CHANGELOG.md',
-    'documentation_uri' => 'https://www.rubydoc.info/gems/db_fuel',
-    'homepage_uri' => s.homepage,
-    'source_code_uri' => s.homepage
-  }
 
   s.required_ruby_version = '>= 2.5'
 
@@ -51,6 +43,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('rspec_junit_formatter')
   s.add_development_dependency('rubocop', '~>1.7.0')
   s.add_development_dependency('simplecov', '~>0.18.5')
   s.add_development_dependency('simplecov-console', '~>0.7.0')

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

@@ -19,12 +19,11 @@ module DbFuel
         NOW_TYPE   = 'r/value/now'
         UPDATED_AT = :updated_at
 
-        attr_reader :attribute_renderers,
-                    :db_provider,
+        attr_reader :db_provider,
                     :debug,
                     :keys_register,
                     :resolver,
-                    :attribute_renderers_set
+                    :record_transformer
 
         def initialize(
           table_name:,
@@ -37,10 +36,14 @@ module DbFuel
         )
           super(name: name, register: register)
 
-          @keys_register           = keys_register.to_s
-          @resolver                = Objectable.resolver(separator: separator)
-          @attribute_renderers_set = Modeling::AttributeRendererSet.new(resolver: resolver,
-                                                                        attributes: attributes)
+          @keys_register = keys_register.to_s
+          @resolver      = Objectable.resolver(separator: separator)
+
+          @record_transformer = Modeling::RecordTransformer.new(
+            resolver: resolver,
+            attributes: attributes
+          )
+
           @db_provider = DbProvider.new(table_name)
           @debug = debug || false
         end

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

@@ -79,12 +79,7 @@ module DbFuel
           keys              = resolve_key_set(output, payload)
 
           total_rows_affected = payload[register].inject(0) do |memo, row|
-            where_object = attribute_renderers_set.transform(
-              unique_attribute_renderers,
-              row,
-              payload.time
-            )
-
+            where_object  = unique_record_transformer.transform(row, payload.time)
             rows_affected = update(output, row, payload.time, where_object, keys)
 
             debug_detail(output, "Individual Rows Affected: #{rows_affected}")

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

@@ -21,7 +21,7 @@ module DbFuel
       # Expected Payload[register] input: array of objects
       # Payload[register] output: array of objects.
       class Upsert < Base
-        attr_reader :primary_keyed_column, :timestamps, :unique_attribute_renderers
+        attr_reader :primary_keyed_column, :timestamps, :unique_record_transformer
 
         # Arguments:
         #   name: name of the job within the Burner::Pipeline.
@@ -80,8 +80,10 @@ module DbFuel
 
           @primary_keyed_column = Modeling::KeyedColumn.make(primary_keyed_column, nullable: true)
 
-          @unique_attribute_renderers = attribute_renderers_set
-                                        .make_renderers(unique_attributes)
+          @unique_record_transformer = Modeling::RecordTransformer.new(
+            resolver: resolver,
+            attributes: unique_attributes
+          )
 
           @timestamps = timestamps
 
@@ -114,7 +116,7 @@ module DbFuel
         protected
 
         def find_record(output, row, time)
-          unique_row = attribute_renderers_set.transform(unique_attribute_renderers, row, time)
+          unique_row = unique_record_transformer.transform(row, time)
 
           first_sql = db_provider.first_sql(unique_row)
 
@@ -132,15 +134,13 @@ module DbFuel
         end
 
         def insert_record(output, row, time, keys = Set.new)
-          dynamic_attrs = if timestamps
-                            # doing an INSERT and timestamps should be set
-                            # set the created_at and updated_at fields
-                            attribute_renderers_set.timestamp_created_attribute_renderers
-                          else
-                            attribute_renderers_set.attribute_renderers
-                          end
-
-          set_object = attribute_renderers_set.transform(dynamic_attrs, row, time, keys)
+          set_object = record_transformer.transform(
+            row,
+            time,
+            keys: keys,
+            created_at: timestamps,
+            updated_at: timestamps
+          )
 
           insert_sql = db_provider.insert_sql(set_object)
 
@@ -176,15 +176,12 @@ module DbFuel
 
         # Updates one or many records depending on where_object passed
         def update(output, row, time, where_object, keys)
-          dynamic_attrs = if timestamps
-                            # doing an UPDATE and timestamps should be set,
-                            # modify the updated_at field, don't modify the created_at field
-                            attribute_renderers_set.timestamp_updated_attribute_renderers
-                          else
-                            attribute_renderers_set.attribute_renderers
-                          end
-
-          set_object = attribute_renderers_set.transform(dynamic_attrs, row, time, keys)
+          set_object = record_transformer.transform(
+            row,
+            time,
+            keys: keys,
+            updated_at: timestamps
+          )
 
           update_sql = db_provider.update_sql(set_object, where_object)
 

data/lib/db_fuel/modeling/{attribute_renderer_set.rb → record_transformer.rb}

@@ -12,10 +12,10 @@ module DbFuel
     # Creates attribute renderers based on attributes passed.
     # Also constains methods to transform attribute renderers
     # and include timestamp attributes if needed.
-    class AttributeRendererSet # :nodoc:
+    class RecordTransformer # :nodoc:
       NOW_TYPE   = 'r/value/now'
-      CREATED_AT = :created_at
-      UPDATED_AT = :updated_at
+      CREATED_AT = 'created_at'
+      UPDATED_AT = 'updated_at'
 
       attr_reader :attribute_renderers, :resolver
 
@@ -28,22 +28,48 @@ module DbFuel
         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]
+      def transform(row, time, keys: Set.new, created_at: false, updated_at: false)
+        dynamic_attributes, all_keys = make_dynamic_attributes(
+          keys: keys,
+          created_at: created_at,
+          updated_at: updated_at
+        )
+
+        dynamic_attributes.each_with_object({}) do |attribute_renderer, memo|
+          next if all_keys.any? && all_keys.exclude?(attribute_renderer.key)
+
+          value = attribute_renderer.transform(row, time)
 
-        timestamp_attributes.map do |a|
-          Burner::Modeling::AttributeRenderer.new(a, resolver)
-        end + attribute_renderers
+          resolver.set(memo, attribute_renderer.key, value)
+        end
       end
 
-      # Adds the attribute for updated_at to the currrent attribute renderers.
-      def timestamp_updated_attribute_renderers
-        timestamp_attributes = [updated_at_timestamp_attribute]
+      private
+
+      def make_dynamic_attributes(keys:, created_at:, updated_at:)
+        dynamic_attributes = attribute_renderers
+        all_keys           = keys
+
+        if created_at
+          dynamic_attributes += [
+            Burner::Modeling::AttributeRenderer.new(created_at_timestamp_attribute, resolver)
+          ]
+
+          all_keys += [CREATED_AT] if keys.any?
+        end
+
+        if updated_at
+          dynamic_attributes += [
+            Burner::Modeling::AttributeRenderer.new(updated_at_timestamp_attribute, resolver)
+          ]
+
+          all_keys += [UPDATED_AT] if keys.any?
+        end
 
-        timestamp_attributes.map do |a|
-          Burner::Modeling::AttributeRenderer.new(a, resolver)
-        end + attribute_renderers
+        [
+          dynamic_attributes,
+          all_keys
+        ]
       end
 
       def make_renderers(attributes)
@@ -52,16 +78,6 @@ module DbFuel
           .map { |a| Burner::Modeling::AttributeRenderer.new(a, resolver) }
       end
 
-      def transform(attribute_renderers, row, time, keys = Set.new)
-        attribute_renderers.each_with_object({}) do |attribute_renderer, memo|
-          next if keys.any? && keys.exclude?(attribute_renderer.key)
-
-          value = attribute_renderer.transform(row, time)
-
-          resolver.set(memo, attribute_renderer.key, value)
-        end
-      end
-
       def created_at_timestamp_attribute
         timestamp_attribute(CREATED_AT)
       end

data/lib/db_fuel/modeling.rb

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

data/lib/db_fuel/version.rb

@@ -8,5 +8,5 @@
 #
 
 module DbFuel
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_fuel
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -157,6 +157,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -222,12 +236,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -251,18 +265,13 @@ files:
 - 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/modeling/record_transformer.rb
 - lib/db_fuel/version.rb
-homepage: https://github.com/bluemarblepayroll/db_fuel
+homepage:
 licenses:
 - MIT
-metadata:
-  bug_tracker_uri: https://github.com/bluemarblepayroll/db_fuel/issues
-  changelog_uri: https://github.com/bluemarblepayroll/db_fuel/blob/master/CHANGELOG.md
-  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
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,28 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=2d57d597269e2cb04a63d0a7262927cf811abb7ab528da7de681943b212b4134
-  jobs:
-    - AR_VERSION=5
-    - AR_VERSION=6
-language: ruby
-rvm:
-  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-cache: bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-  - cp spec/config/database.yaml.ci spec/config/database.yaml
-script:
-  - bundle exec rubocop
-  - bundle exec rspec spec --format documentation
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-addons:
-  # https://docs.travis-ci.com/user/uploading-artifacts/
-  artifacts:
-    paths:
-      - Gemfile.lock