dbee-active_record 2.0.3 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382941d933c56ac2efc758119b32568638f6ac4d2842bcfe0e84cbb6d03f5994
-  data.tar.gz: 80a5aedc314d37202c0e976160168c8ecbeaa17e64c0f4be44bdfa48c97a6e1e
+  metadata.gz: 8ec480363c33c49f4dd4cd5de9023b6ddad2f3d8b39ee90b4a67bc282a2b35f3
+  data.tar.gz: 6db9e48a3bb04e73ae91f01c63640b36db530f04a06245462b4e4d72e2f083c0
 SHA512:
-  metadata.gz: 68df7e7994baf9cb29ea0ea6d2860e4bcf2509af4e046568064458b5f6309d0cba3d791d8b1461080bcd4e73706cd00b696106f8ede28bb89afc0c0529801f30
-  data.tar.gz: 15a4a9fdd0597b4cfa69e2a216c30f4ab51a64521c419f51316b12cfed21ebc7d7f4c87871c35a3958f4a3a0b918cb7d15616d2c1986e4ae0f831062a1995fd7
+  metadata.gz: 694720a4ff3a557ebdf03cf94bb38010e9c52eacbf188c26f4b3e6e6c7adbd08353e31aae214797bbc79e7493f9d53f178b866b017e4c5feba13a23d253b1449
+  data.tar.gz: 7ba4120f8e7ddc71b2f7d2783c854f9f6ac5b1935260fb7c769d96f1e0ac900ffa8cbb2b3233dd7ccd4d3e7b38d4c702dc9a142a29fd45a2258b0e27ad69ad42

data/.rubocop.yml

@@ -1,6 +1,15 @@
-Metrics/LineLength:
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Layout/LineLength:
   Max: 100
 
+Metrics/AbcSize:
+  Max: 17
+  Exclude:
+    - spec/db_helper.rb
+
 Metrics/BlockLength:
   ExcludedMethods:
     - let
@@ -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

@@ -6,19 +6,12 @@ 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.1
 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,4 +1,27 @@
-# 2.0.3 (January 7th, 2019)
+# 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
+* use Arel#not_in for NotEqual filters when there are is than one value
+
+# 2.0.3 (January 7th, 2020)
 
 * Added/tested support for Dbee 2.0.3
 * Added support for Ruby 2.6.5

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,16 @@ Gem::Specification.new do |s|
     end
 
   s.add_dependency('activerecord', activerecord_version)
-  s.add_dependency('dbee', '~>2', '>=2.0.3')
+  s.add_dependency('dbee', '~>2', '>=2.1.1')
 
   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', '~>0.90.0')
+  s.add_development_dependency('simplecov', '~>0.19.0')
+  s.add_development_dependency('simplecov-console', '~>0.7.0')
   s.add_development_dependency('sqlite3', '~>1')
 end

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

@@ -7,32 +7,29 @@
 # 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
-
+      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
+          super(column_alias_maker)
+
+          @model             = model
+          @table_alias_maker = table_alias_maker
 
           clear
         end
 
         def clear
-          @base_table = make_table(model.table, model.name)
+          @requires_group_by  = false
+          @group_by_columns   = []
+          @base_table         = make_table(model.table, model.name)
+          @select_all         = true
 
           build(base_table)
 
@@ -40,6 +37,8 @@ module Dbee
         end
 
         def add(query)
+          return self unless query
+
           query.fields.each   { |field| add_field(field) }
           query.sorters.each  { |sorter| add_sorter(sorter) }
           query.filters.each  { |filter| add_filter(filter) }
@@ -49,13 +48,27 @@ module Dbee
           self
         end
 
+        def to_sql
+          if requires_group_by
+            @requires_group_by = false
+            statement.group(group_by_columns) unless group_by_columns.empty?
+            @group_by_columns = []
+          end
+
+          return statement.project(select_maker.star(base_table)).to_sql if select_all
+
+          statement.to_sql
+        end
+
         private
 
         attr_reader :base_table,
                     :statement,
                     :model,
                     :table_alias_maker,
-                    :column_alias_maker
+                    :requires_group_by,
+                    :group_by_columns,
+                    :select_all
 
         def tables
           @tables ||= {}
@@ -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
 
@@ -123,7 +154,7 @@ module Dbee
         def table(name, model, previous_table)
           table = make_table(model.table, name)
 
-          on = ConstraintMaker.instance.make(model.constraints, table, previous_table)
+          on = constraint_maker.make(model.constraints, table, previous_table)
 
           raise MissingConstraintError, "for: #{name}" unless on
 
@@ -142,16 +173,16 @@ module Dbee
         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)
 
           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

data/lib/dbee/providers/active_record_provider/{expression_builder/constraint_maker.rb → makers/constraint.rb}

@@ -10,11 +10,21 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      class ExpressionBuilder
+      module Makers # :nodoc: all
         # Can derive constraints for Arel table JOIN statements.
-        class ConstraintMaker
+        class Constraint
           include Singleton
 
+          def make(constraints, table, previous_table)
+            constraints.inject(nil) do |memo, constraint|
+              method = CONSTRAINT_RESOLVERS[constraint.class]
+
+              raise ArgumentError, "constraint unhandled: #{constraint.class.name}" unless method
+
+              method.call(constraint, memo, table, previous_table)
+            end
+          end
+
           CONCAT_METHOD = lambda do |on, arel_column, value|
             on ? on.and(arel_column.eq(value)) : arel_column.eq(value)
           end
@@ -44,16 +54,6 @@ module Dbee
           }.freeze
 
           private_constant :CONSTRAINT_RESOLVERS
-
-          def make(constraints, table, previous_table)
-            constraints.inject(nil) do |memo, constraint|
-              method = CONSTRAINT_RESOLVERS[constraint.class]
-
-              raise ArgumentError, "constraint unhandled: #{constraint.class.name}" unless method
-
-              method.call(constraint, memo, table, previous_table)
-            end
-          end
         end
       end
     end

data/lib/dbee/providers/active_record_provider/{expression_builder/order_maker.rb → makers/order.rb}

@@ -10,18 +10,11 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      class ExpressionBuilder
+      module Makers # :nodoc: all
         # Derives Arel#order predicates.
-        class OrderMaker
+        class Order
           include Singleton
 
-          SORTER_EVALUATORS = {
-            Query::Sorters::Ascending => ->(column) { column },
-            Query::Sorters::Descending => ->(column) { column.desc }
-          }.freeze
-
-          private_constant :SORTER_EVALUATORS
-
           def make(sorter, arel_column)
             method = SORTER_EVALUATORS[sorter.class]
 
@@ -29,6 +22,13 @@ module Dbee
 
             method.call(arel_column)
           end
+
+          SORTER_EVALUATORS = {
+            Query::Sorters::Ascending => ->(column) { column },
+            Query::Sorters::Descending => ->(column) { column.desc }
+          }.freeze
+
+          private_constant :SORTER_EVALUATORS
         end
       end
     end

data/lib/dbee/providers/active_record_provider/makers/select.rb

@@ -0,0 +1,81 @@
+# 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.
+#
+
+module Dbee
+  module Providers
+    class ActiveRecordProvider
+      module Makers # :nodoc: all
+        # Derives Arel#project predicates.
+        class Select
+          attr_reader :alias_maker
+
+          def initialize(alias_maker)
+            @alias_maker = alias_maker
+
+            freeze
+          end
+
+          def star(arel_table)
+            arel_table[Arel.star]
+          end
+
+          def make(field, arel_key_nodes_to_filters, arel_value_node)
+            column_alias = quote(alias_maker.make(field.display))
+            predicate    = expression(field, arel_key_nodes_to_filters, arel_value_node)
+            predicate    = aggregate(field, predicate)
+
+            predicate.as(column_alias)
+          end
+
+          private
+
+          AGGREGRATOR_EVALUATORS = {
+            nil => ->(arel_node) { arel_node },
+            Query::Field::Aggregator::AVE => ->(node) { Arel::Nodes::Avg.new([node]) },
+            Query::Field::Aggregator::COUNT => ->(node) { Arel::Nodes::Count.new([node]) },
+            Query::Field::Aggregator::MAX => ->(node) { Arel::Nodes::Max.new([node]) },
+            Query::Field::Aggregator::MIN => ->(node) { Arel::Nodes::Min.new([node]) },
+            Query::Field::Aggregator::SUM => ->(node) { Arel::Nodes::Sum.new([node]) }
+          }.freeze
+
+          private_constant :AGGREGRATOR_EVALUATORS
+
+          def quote(value)
+            ActiveRecord::Base.connection.quote(value)
+          end
+
+          def aggregate(field, predicate)
+            AGGREGRATOR_EVALUATORS[field.aggregator].call(predicate)
+          end
+
+          def expression(field, arel_key_nodes_to_filters, arel_value_node)
+            if field.filters?
+              case_statement   = Arel::Nodes::Case.new
+              filter_predicate = make_filter_predicate(arel_key_nodes_to_filters)
+
+              case_statement.when(filter_predicate).then(arel_value_node)
+            else
+              arel_value_node
+            end
+          end
+
+          def make_filter_predicate(arel_key_nodes_to_filters)
+            predicates = arel_key_nodes_to_filters.map do |arel_key_node, filter|
+              Where.instance.make(filter, arel_key_node)
+            end
+
+            predicates.inject(predicates.shift) do |memo, predicate|
+              memo.and(predicate)
+            end
+          end
+        end
+      end
+    end
+  end
+end