dbee-active_record 2.1.0.pre.alpha.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75d42ea7f3b391ad5014264a4b914339bf7dff8582aebe85c4c3180576ae7648
-  data.tar.gz: e63553d0dcc906a38b336767dfcf10bcc162807682ae866f4450a80185993b8e
+  metadata.gz: e71321e2f9366122dfbcc7bbfa5a18be43693e6d0c7eda44cf06221e646bef33
+  data.tar.gz: f59ad369064af84ba7cd387df7b0c072eb38bf6658d7342320e158e5d297c65a
 SHA512:
-  metadata.gz: f727e65305615a6e5b2450654ce4bb174674970be4b6855922035dac6bc8378862a003f0c1ec4677433d560dee4f5ca3b9094b57a4be8eae6a7d78720c805910
-  data.tar.gz: 21d91630d8ba8407550dcdd6d8a7aab9bc7dc52ad39679ed5b673f59263f2761e55505c61b8cafcc2ce09a31fee1571e58e9fffc76b24f1dd7a5d3d62e3b4ef7
+  metadata.gz: 6ad043966cba813e731ab4e7d53cf22fc359ec6a2000097b18719d0bf7a317c3521c8785999cfc99f31b5d091724337afad62ff62c02aca19f448d37989eecbc
+  data.tar.gz: eb496b07348bbb79a2cd97be2816ea696186ac8068172ca38f521d22343cf3f80f67c71bf99adeb0022f723643dbc579e145641afb814a1772237ff92e35ef82

data/.rubocop.yml

@@ -1,15 +1,10 @@
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
 
 Layout/LineLength:
   Max: 100
 
-Lint/RaiseException:
-  Enabled: True
-
-Lint/StructNewOverride:
-  Enabled: True
-
 Metrics/AbcSize:
   Max: 16
   Exclude:
@@ -28,18 +23,9 @@ Metrics/BlockLength:
     - dbee-active_record.gemspec
 
 Metrics/ClassLength:
-  Max: 125
+  Max: 140
 
 Metrics/MethodLength:
   Max: 25
   Exclude:
     - spec/db_helper.rb
-
-Style/HashEachMethods:
-  Enabled: True
-
-Style/HashTransformKeys:
-  Enabled: True
-
-Style/HashTransformValues:
-  Enabled: True

data/CHANGELOG.md

@@ -1,9 +1,10 @@
-# 2.1.0 (TBD)
+# 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:
 

data/dbee-active_record.gemspec

@@ -42,15 +42,15 @@ Gem::Specification.new do |s|
     end
 
   s.add_dependency('activerecord', activerecord_version)
-  s.add_dependency('dbee', '=2.1.0.pre.alpha')
+  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('rake', '~> 13')
   s.add_development_dependency('rspec', '~> 3.8')
-  s.add_development_dependency('rubocop', '~>0.81.0')
-  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('rubocop', '~>0.88.0')
+  s.add_development_dependency('simplecov', '~>0.18.5')
   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,30 +7,29 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'expression_builder/constraint'
-require_relative 'expression_builder/order'
-require_relative 'expression_builder/select'
-require_relative 'expression_builder/where'
+require_relative 'maker'
 
 module Dbee
   module Providers
     class ActiveRecordProvider
       # This class can generate an Arel expression tree.
-      class ExpressionBuilder
+      class ExpressionBuilder < Maker # :nodoc: all
         class MissingConstraintError < StandardError; end
 
         def initialize(model, table_alias_maker, column_alias_maker)
-          @model              = model
-          @table_alias_maker  = table_alias_maker
-          @column_alias_maker = column_alias_maker
-          @requires_group_by  = false
-          @group_by_columns   = []
+          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)
 
@@ -38,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) }
@@ -54,6 +55,8 @@ module Dbee
             @group_by_columns = []
           end
 
+          return statement.project(select_maker.star(base_table)).to_sql if select_all
+
           statement.to_sql
         end
 
@@ -63,9 +66,9 @@ module Dbee
                     :statement,
                     :model,
                     :table_alias_maker,
-                    :column_alias_maker,
                     :requires_group_by,
-                    :group_by_columns
+                    :group_by_columns,
+                    :select_all
 
         def tables
           @tables ||= {}
@@ -80,7 +83,7 @@ module Dbee
 
           key_path    = filter.key_path
           arel_column = key_paths_to_arel_columns[key_path]
-          predicate   = Where.instance.make(filter, arel_column)
+          predicate   = where_maker.make(filter, arel_column)
 
           build(statement.where(predicate))
 
@@ -92,7 +95,7 @@ module Dbee
 
           key_path    = sorter.key_path
           arel_column = key_paths_to_arel_columns[key_path]
-          predicate   = Order.instance.make(sorter, arel_column)
+          predicate   = order_maker.make(sorter, arel_column)
 
           build(statement.order(predicate))
 
@@ -108,14 +111,14 @@ module Dbee
         end
 
         def add_field(field)
+          @select_all                 = false
           arel_value_column           = add_key_path(field.key_path)
           arel_key_columns_to_filters = add_filter_key_paths(field.filters)
 
-          predicate = Select.instance.make(
+          predicate = select_maker.make(
             field,
             arel_key_columns_to_filters,
-            arel_value_column,
-            column_alias_maker
+            arel_value_column
           )
 
           build(statement.project(predicate))
@@ -151,7 +154,7 @@ module Dbee
         def table(name, model, previous_table)
           table = make_table(model.table, name)
 
-          on = Constraint.instance.make(model.constraints, table, previous_table)
+          on = constraint_maker.make(model.constraints, table, previous_table)
 
           raise MissingConstraintError, "for: #{name}" unless on
 

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 → makers}/constraint.rb

@@ -10,7 +10,7 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      class ExpressionBuilder
+      module Makers # :nodoc: all
         # Can derive constraints for Arel table JOIN statements.
         class Constraint
           include Singleton

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

@@ -10,7 +10,7 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      class ExpressionBuilder
+      module Makers # :nodoc: all
         # Derives Arel#order predicates.
         class Order
           include Singleton

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

@@ -10,12 +10,22 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      class ExpressionBuilder
+      module Makers # :nodoc: all
         # Derives Arel#project predicates.
         class Select
-          include Singleton
+          attr_reader :alias_maker
 
-          def make(field, arel_key_nodes_to_filters, arel_value_node, 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)

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

@@ -10,7 +10,7 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      class ExpressionBuilder
+      module Makers # :nodoc: all
         # Derives Arel#where predicates.
         class Where
           include Singleton

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

@@ -10,7 +10,7 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      VERSION = '2.1.0-alpha.1'
+      VERSION = '2.1.1'
     end
   end
 end

data/spec/db_helper.rb

@@ -106,6 +106,8 @@ def load_schema
       t.timestamps
     end
 
+    add_index :fields, %i[section key], unique: true
+
     create_table :patients do |t|
       t.column :first,  :string
       t.column :middle, :string
@@ -114,14 +116,16 @@ def load_schema
     end
 
     create_table :patient_field_values do |t|
-      t.column :patient_id, :integer
-      t.column :field_id,   :integer
+      t.column :patient_id, :integer, foreign_key: true
+      t.column :field_id,   :integer, foreign_key: true
       t.column :value,      :string
       t.timestamps
     end
 
+    add_index :patient_field_values, %i[patient_id field_id], unique: true
+
     create_table :patient_payments do |t|
-      t.column :patient_id, :integer
+      t.column :patient_id, :integer, foreign_key: true
       t.column :amount,     :decimal
       t.timestamps
     end

data/spec/dbee/providers/active_record_provider/expression_builder_spec.rb

@@ -0,0 +1,117 @@
+# 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 'spec_helper'
+require 'db_helper'
+
+describe Dbee::Providers::ActiveRecordProvider::ExpressionBuilder do
+  let(:model)       { Dbee::Model.make(models['Patients']) }
+  let(:alias_maker) { Dbee::Providers::ActiveRecordProvider::SafeAliasMaker.new }
+
+  let(:id_and_average_query) do
+    Dbee::Query.make(
+      fields: [
+        {
+          key_path: :id,
+          display: 'ID #'
+        },
+        {
+          key_path: 'patient_payments.amount',
+          display: 'Ave Payment',
+          aggregator: :ave
+        }
+      ],
+      sorters: [
+        {
+          key_path: :id
+        }
+      ],
+      filters: [
+        {
+          key_path: :id,
+          value: 123
+        }
+      ]
+    )
+  end
+
+  let(:first_and_count_query) do
+    Dbee::Query.make(
+      fields: [
+        {
+          key_path: :first,
+          display: 'First Name'
+        },
+        {
+          key_path: 'patient_payments.amount',
+          display: 'Number of Payments',
+          aggregator: :count
+        }
+      ]
+    )
+  end
+
+  subject { described_class.new(model, alias_maker, alias_maker) }
+
+  before(:all) do
+    connect_to_db(:sqlite)
+  end
+
+  describe '#clear' do
+    it 'provides fluent interface (returns self)' do
+      expect(subject.clear).to eq(subject)
+    end
+
+    it 'resets selecting, grouping, sorting, and filtering' do
+      subject.add(id_and_average_query)
+
+      sql = subject.to_sql
+
+      expect(sql).not_to include('*')
+      expect(sql).to     include('GROUP')
+      expect(sql).to     include('WHERE')
+      expect(sql).to     include('ORDER')
+
+      sql = subject.clear.to_sql
+
+      expect(sql).to     include('*')
+      expect(sql).not_to include('GROUP')
+      expect(sql).not_to include('WHERE')
+      expect(sql).not_to include('ORDER')
+    end
+  end
+
+  describe '#to_sql' do
+    specify 'when called with no fields, then called with fields removes star select' do
+      expect(subject.to_sql).to include('*')
+
+      subject.add(id_and_average_query)
+
+      expect(subject.to_sql).not_to include('*')
+    end
+
+    context 'with aggregation' do
+      it 'generates the same sql when called multiple times' do
+        subject.add(id_and_average_query)
+
+        first_sql  = subject.to_sql
+        second_sql = subject.to_sql
+
+        expect(first_sql).to eq(second_sql)
+
+        subject.add(first_and_count_query)
+
+        first_sql  = subject.to_sql
+        second_sql = subject.to_sql
+
+        expect(first_sql).to eq(second_sql)
+      end
+    end
+  end
+end

data/spec/dbee/providers/active_record_provider_spec.rb

@@ -11,8 +11,6 @@ require 'spec_helper'
 require 'db_helper'
 
 describe Dbee::Providers::ActiveRecordProvider do
-  let(:models) { yaml_fixture('models.yaml') }
-
   describe '#sql' do
     before(:all) do
       connect_to_db(:sqlite)
@@ -176,8 +174,7 @@ describe Dbee::Providers::ActiveRecordProvider do
       let(:model)    { Dbee::Model.make(models['Patients']) }
 
       it 'executes correct SQL aggregate functions' do
-        sql = described_class.new.sql(model, query)
-
+        sql     = described_class.new.sql(model, query)
         results = ActiveRecord::Base.connection.execute(sql)
 
         expect(results[0]).to include(

data/spec/fixtures/active_record_snapshots/one_table_empty_query.yaml

@@ -0,0 +1,10 @@
+model_name: Patients
+query:
+sqlite_readable: |+
+  SELECT "patients".* FROM "patients" "patients"
+sqlite_not_readable: |+
+  SELECT "t0".* FROM "patients" "t0"
+mysql_readable: |+
+  SELECT `patients`.* FROM `patients` `patients`
+mysql_not_readable: |+
+  SELECT `t0`.* FROM `patients` `t0`

data/spec/spec_helper.rb

@@ -50,3 +50,7 @@ end
 def file_read(*filename)
   File.open(File.join(*filename), 'r:bom|utf-8').read
 end
+
+def models
+  yaml_fixture('models.yaml')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbee-active_record
 version: !ruby/object:Gem::Version
-  version: 2.1.0.pre.alpha.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -34,16 +34,22 @@ dependencies:
   name: dbee
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0.pre.alpha
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0.pre.alpha
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +126,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.88.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -195,18 +201,21 @@ files:
 - exe/.gitkeep
 - lib/dbee/providers/active_record_provider.rb
 - lib/dbee/providers/active_record_provider/expression_builder.rb
-- lib/dbee/providers/active_record_provider/expression_builder/constraint.rb
-- lib/dbee/providers/active_record_provider/expression_builder/order.rb
-- lib/dbee/providers/active_record_provider/expression_builder/select.rb
-- lib/dbee/providers/active_record_provider/expression_builder/where.rb
+- lib/dbee/providers/active_record_provider/maker.rb
+- lib/dbee/providers/active_record_provider/makers/constraint.rb
+- lib/dbee/providers/active_record_provider/makers/order.rb
+- lib/dbee/providers/active_record_provider/makers/select.rb
+- lib/dbee/providers/active_record_provider/makers/where.rb
 - lib/dbee/providers/active_record_provider/obfuscated_alias_maker.rb
 - lib/dbee/providers/active_record_provider/safe_alias_maker.rb
 - lib/dbee/providers/active_record_provider/version.rb
 - spec/config/database.yaml.ci
 - spec/db_helper.rb
+- spec/dbee/providers/active_record_provider/expression_builder_spec.rb
 - spec/dbee/providers/active_record_provider_spec.rb
 - spec/fixtures/active_record_snapshots/five_table_query.yaml
 - spec/fixtures/active_record_snapshots/multiple_same_table_query_with_static_constraints.yaml
+- spec/fixtures/active_record_snapshots/one_table_empty_query.yaml
 - spec/fixtures/active_record_snapshots/one_table_query.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_ascending_sort.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_descending_sort.yaml
@@ -241,9 +250,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: 
@@ -252,9 +261,11 @@ summary: Plugs in ActiveRecord so Dbee can use Arel for SQL generation.
 test_files:
 - spec/config/database.yaml.ci
 - spec/db_helper.rb
+- spec/dbee/providers/active_record_provider/expression_builder_spec.rb
 - spec/dbee/providers/active_record_provider_spec.rb
 - spec/fixtures/active_record_snapshots/five_table_query.yaml
 - spec/fixtures/active_record_snapshots/multiple_same_table_query_with_static_constraints.yaml
+- spec/fixtures/active_record_snapshots/one_table_empty_query.yaml
 - spec/fixtures/active_record_snapshots/one_table_query.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_ascending_sort.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_descending_sort.yaml