dbee-active_record 2.0.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f50827b6f31ffb9749796b4532b8a48f704c522be4e0011b7e9a58ed716dd26
-  data.tar.gz: e9469a99514bfdfbe03da6cdcda339aef1b12b2d829a82d7e2278a22b006f0b3
+  metadata.gz: a9ad362290b7ac95e9ad1c466868f81bad354df55b9772742c9bf6591f9f762d
+  data.tar.gz: 0ff078fc8e40af83f984729f3320856af95cf95b3562f97bc17b0b8787342a12
 SHA512:
-  metadata.gz: 7162ee879530dd36b2078a347b6fade9a5e5ce8e79f47709b33b11cb308303195cbafb3e6096a1529ddb7b7c23da6a19caccdc61356f29dd14b48b4e077cc041
-  data.tar.gz: 6d19989ed13fd0e2d7a88b3341309cf517aede0f4924c8f76f1325685a099b4b20985774adb445b0bb3487c9d91568500a86c767237618f57194e2806ee0fa93
+  metadata.gz: 93b68e1d07bfe82c469d1169d7e94fa2dece7a7f32fc01adcf895356bdfa285d7d1352b1a37e3bd7b50e1023551160988b4dc7a49c97d904b1b4c37d77d1e676
+  data.tar.gz: 44aa0eda58e8d5f50f9d99d1b44a81ade7781ba9cad9cf35b47e6b3dcab2f2699c69898e774b33c3a00c535b4927481b3bb62411856f607ff78b24e34dd320a5

data/.rubocop.yml

@@ -1,8 +1,17 @@
-Metrics/LineLength:
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Layout/LineLength:
   Max: 100
 
+Metrics/AbcSize:
+  Max: 17
+  Exclude:
+    - spec/db_helper.rb
+
 Metrics/BlockLength:
-  ExcludedMethods:
+  IgnoredMethods:
     - let
     - it
     - describe
@@ -13,18 +22,10 @@ Metrics/BlockLength:
     - spec/dbee/**/*
     - dbee-active_record.gemspec
 
+Metrics/ClassLength:
+  Max: 140
+
 Metrics/MethodLength:
   Max: 25
   Exclude:
     - spec/db_helper.rb
-
-AllCops:
-  TargetRubyVersion: 2.3
-
-Metrics/AbcSize:
-  Max: 16
-  Exclude:
-    - spec/db_helper.rb
-
-Metrics/ClassLength:
-  Max: 125

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.6.6

data/.travis.yml

@@ -1,24 +1,18 @@
 env:
   global:
     - CC_TEST_REPORTER_ID=036a8fd92cf0c323c9704c041015837d14889e47de936bab18287626ff3372c1
+    - DISABLE_RSPEC_FOCUS=true
 language: ruby
 services:
   - mysql
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.5
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
 env:
   - AR_VERSION=5
   - AR_VERSION=6
-matrix:
-  exclude:
-    - rvm: 2.3.8
-      env: AR_VERSION=6
-    - rvm: 2.4.6
-      env: AR_VERSION=6
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# 2.2.0 (March 11th, 2021)
+
+### Additions:
+
+* Support for graph based models.
+
+# 2.1.2 (October 15th, 2020)
+
+* Improved test coverage for Where maker
+* Fixed bug in Where maker which resulted in only IS NULL predicates being generated, even in cases
+  of when IS NOT NULL intended.
+
+# 2.1.1 (July 15th, 2020)
+
+### Additions:
+
+* Implemented Dbee::Query::Field#aggregator
+* Implemented Dbee::Query::Field#filters
+* Implemented base case when a Dbee::Query contains no fields
+
+### Changes:
+
+* Bumped minimum Ruby version to 2.5
+
 # 2.0.4 (February 13th, 2020)
 
 * use Arel#in for Equal filters when there is more than one value

data/Guardfile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+command = 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation --order=defined'
+guard :rspec, cmd: command do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -11,7 +11,7 @@ This library is a plugin for [Dbee](https://github.com/bluemarblepayroll/dbee).
 To install through Rubygems:
 
 ````
-gem install install dbee-active_record
+gem install dbee-active_record
 ````
 
 You can also add this to your Gemfile:

data/dbee-active_record.gemspec

@@ -11,15 +11,23 @@ Gem::Specification.new do |s|
     By default Dbee ships with no underlying SQL generator.  This library will plug in ActiveRecord into Dbee and Dbee will use it for SQL generation.
   DESCRIPTION
 
-  s.authors     = ['Matthew Ruggio']
-  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.authors     = ['Matthew Ruggio', 'Craig Kattner']
+  s.email       = ['mruggio@bluemarblepayroll.com', 'ckattner@bluemarblepayroll.com']
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.bindir      = 'exe'
+  s.executables = []
   s.homepage    = 'https://github.com/bluemarblepayroll/dbee-active_record'
   s.license     = 'MIT'
+  s.metadata    = {
+    'bug_tracker_uri' => 'https://github.com/bluemarblepayroll/dbee-active_record/issues',
+    'changelog_uri' => 'https://github.com/bluemarblepayroll/dbee-active_record/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/dbee-active_record',
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage
+  }
 
-  s.required_ruby_version = '>= 2.3.8'
+  s.required_ruby_version = '>= 2.5'
 
   ar_version = ENV['AR_VERSION'] || ''
 
@@ -34,15 +42,20 @@ Gem::Specification.new do |s|
     end
 
   s.add_dependency('activerecord', activerecord_version)
-  s.add_dependency('dbee', '~>2', '>=2.0.3')
+  s.add_dependency('dbee', '~>3')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('mysql2', '~>0.5')
   s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('pry-byebug')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec', '~> 3.8')
-  s.add_development_dependency('rubocop', '~>0.79.0')
-  s.add_development_dependency('simplecov', '~>0.17.0')
-  s.add_development_dependency('simplecov-console', '~>0.6.0')
+  s.add_development_dependency('rubocop', '~> 1')
+  s.add_development_dependency('rubocop-rake')
+  s.add_development_dependency('rubocop-rspec')
+  s.add_development_dependency('simplecov', '~>0.19.0')
+  s.add_development_dependency('simplecov-console', '~>0.7.0')
   s.add_development_dependency('sqlite3', '~>1')
+  # Helpful to spot differences in longer SQL queries:
+  s.add_development_dependency('super_diff', '~>0.6')
 end

data/lib/dbee/providers/active_record_provider.rb

@@ -35,12 +35,12 @@ module Dbee
         @column_alias_maker = alias_maker(column_prefix)
       end
 
-      def sql(model, query)
+      def sql(schema, query)
         ExpressionBuilder.new(
-          model,
+          schema,
           table_alias_maker,
           column_alias_maker
-        ).add(query).to_sql
+        ).to_sql(query)
       end
 
       private

data/lib/dbee/providers/active_record_provider/expression_builder.rb

@@ -7,62 +7,75 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'expression_builder/constraint_maker'
-require_relative 'expression_builder/order_maker'
-require_relative 'expression_builder/select_maker'
-require_relative 'expression_builder/where_maker'
+require_relative 'maker'
 
 module Dbee
   module Providers
     class ActiveRecordProvider
-      # This class can generate an Arel expression tree.
-      class ExpressionBuilder
-        extend Forwardable
-
+      # This class can generate an Arel expression tree given a Dbee::Schema
+      # and Dbee::Query.
+      class ExpressionBuilder < Maker # :nodoc: all
         class MissingConstraintError < StandardError; end
 
-        def_delegators :statement, :to_sql
-
-        def initialize(model, table_alias_maker, column_alias_maker)
-          @model              = model
-          @table_alias_maker  = table_alias_maker
-          @column_alias_maker = column_alias_maker
+        def initialize(schema, table_alias_maker, column_alias_maker)
+          super(column_alias_maker)
 
-          clear
+          @schema            = schema
+          @table_alias_maker = table_alias_maker
         end
 
-        def clear
-          @base_table = make_table(model.table, model.name)
+        def to_sql(query)
+          reset_query_state
+          build_query(query)
 
-          build(base_table)
+          return statement.project(select_maker.star(base_table)).to_sql if select_all
 
-          add_partitioners(base_table, model.partitioners)
-        end
-
-        def add(query)
-          query.fields.each   { |field| add_field(field) }
-          query.sorters.each  { |sorter| add_sorter(sorter) }
-          query.filters.each  { |filter| add_filter(filter) }
-
-          add_limit(query.limit)
-
-          self
+          statement.to_sql
         end
 
         private
 
         attr_reader :base_table,
+                    :key_paths_to_arel_columns,
+                    :from_model,
                     :statement,
-                    :model,
                     :table_alias_maker,
-                    :column_alias_maker
+                    :requires_group_by,
+                    :group_by_columns,
+                    :schema,
+                    :select_all,
+                    :tables
+
+        def reset_query_state
+          @base_table = nil
+          @key_paths_to_arel_columns = {}
+          @from_model        = nil
+          @group_by_columns  = []
+          @requires_group_by = false
+          @select_all        = true
+          @tables            = {}
+        end
 
-        def tables
-          @tables ||= {}
+        def build_query(query)
+          establish_query_base(query)
+          process_fields_sorters_and_filters(query)
+
+          add_partitioners(base_table, from_model.partitioners)
+          add_limit(query.limit)
+
+          statement.group(group_by_columns) if requires_group_by && !group_by_columns.empty?
         end
 
-        def key_paths_to_arel_columns
-          @key_paths_to_arel_columns ||= {}
+        def establish_query_base(query)
+          @from_model = schema.model_for_name!(query.from)
+          @base_table = make_table(from_model.table, @from_model.name)
+          build(base_table)
+        end
+
+        def process_fields_sorters_and_filters(query)
+          query.fields.each   { |field| add_field(field) }
+          query.sorters.each  { |sorter| add_sorter(sorter) }
+          query.filters.each  { |filter| add_filter(filter) }
         end
 
         def add_filter(filter)
@@ -70,7 +83,7 @@ module Dbee
 
           key_path    = filter.key_path
           arel_column = key_paths_to_arel_columns[key_path]
-          predicate   = WhereMaker.instance.make(filter, arel_column)
+          predicate   = where_maker.make(filter, arel_column)
 
           build(statement.where(predicate))
 
@@ -82,22 +95,40 @@ module Dbee
 
           key_path    = sorter.key_path
           arel_column = key_paths_to_arel_columns[key_path]
-          predicate   = OrderMaker.instance.make(sorter, arel_column)
+          predicate   = order_maker.make(sorter, arel_column)
 
           build(statement.order(predicate))
 
           self
         end
 
+        def add_filter_key_paths(filters)
+          filters.each_with_object({}) do |filter, memo|
+            arel_key_column = add_key_path(filter.key_path)
+
+            memo[arel_key_column] = filter
+          end
+        end
+
         def add_field(field)
-          add_key_path(field.key_path)
+          @select_all                 = false
+          arel_value_column           = add_key_path(field.key_path)
+          arel_key_columns_to_filters = add_filter_key_paths(field.filters)
 
-          key_path    = field.key_path
-          arel_column = key_paths_to_arel_columns[key_path]
-          predicate   = SelectMaker.instance.make(field, arel_column, column_alias_maker)
+          predicate = select_maker.make(
+            field,
+            arel_key_columns_to_filters,
+            arel_value_column
+          )
 
           build(statement.project(predicate))
 
+          if field.aggregator?
+            @requires_group_by = true
+          else
+            group_by_columns << arel_value_column
+          end
+
           self
         end
 
@@ -120,38 +151,48 @@ module Dbee
           self
         end
 
-        def table(name, model, previous_table)
-          table = make_table(model.table, name)
+        def table(ancestor_names, relationship, model, previous_table)
+          table = make_table(model.table, ancestor_names)
 
-          on = ConstraintMaker.instance.make(model.constraints, table, previous_table)
+          on = constraint_maker.make(relationship.constraints, table, previous_table)
 
-          raise MissingConstraintError, "for: #{name}" unless on
+          raise MissingConstraintError, "for: #{ancestor_names}" unless on
 
           build(statement.join(table, ::Arel::Nodes::OuterJoin))
           build(statement.on(on))
 
           add_partitioners(table, model.partitioners)
 
-          tables[name] = table
+          tables[ancestor_names] = table
         end
 
-        def traverse_ancestors(ancestors)
-          ancestors.each_pair.inject(base_table) do |memo, (name, model)|
-            tables.key?(name) ? tables[name] : table(name, model, memo)
+        # Travel the query path returning the table at the end of the path.
+        #
+        # Side effect: intermediate tables are created along the way and are
+        # added to the "tables" hash keyed by path.
+        def traverse_query_path(expanded_query_path)
+          visited_path = []
+
+          expanded_query_path.inject(base_table) do |prev_model, (relationship, next_model)|
+            visited_path += [relationship.name]
+            if tables.key?(visited_path)
+              tables[visited_path]
+            else
+              table(visited_path, relationship, next_model, prev_model)
+            end
           end
         end
 
         def add_key_path(key_path)
-          return if key_paths_to_arel_columns.key?(key_path)
+          return key_paths_to_arel_columns[key_path] if key_paths_to_arel_columns.key?(key_path)
 
-          ancestors = model.ancestors!(key_path.ancestor_names)
-
-          table = traverse_ancestors(ancestors)
+          expanded_query_path = schema.expand_query_path(from_model, key_path)
+          table = traverse_query_path(expanded_query_path)
 
           arel_column = table[key_path.column_name]
-          key_paths_to_arel_columns[key_path] = arel_column
 
-          self
+          # Note that this returns arel_column
+          key_paths_to_arel_columns[key_path] = arel_column
         end
 
         def build(new_expression)

data/lib/dbee/providers/active_record_provider/maker.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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 'makers/constraint'
+require_relative 'makers/order'
+require_relative 'makers/select'
+require_relative 'makers/where'
+
+module Dbee
+  module Providers
+    class ActiveRecordProvider
+      # This class composes all the maker instances into one for use together.
+      class Maker # :nodoc: all
+        def initialize(column_alias_maker)
+          @column_alias_maker = column_alias_maker
+          @constraint_maker   = Makers::Constraint.instance
+          @order_maker        = Makers::Order.instance
+          @select_maker       = Makers::Select.new(column_alias_maker)
+          @where_maker        = Makers::Where.instance
+        end
+
+        private
+
+        attr_reader :constraint_maker,
+                    :order_maker,
+                    :select_maker,
+                    :where_maker
+      end
+    end
+  end
+end