dbee-active_record 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f116ae2834ca7c1bb8401f58d6eb0a45464f44eb6d972267e9c8d66374c825c1
-  data.tar.gz: 8b4b89ed376d95c61cfb093ee6966bd958a53afacbfaf385011f6dfa6cfddcae
+  metadata.gz: a19e2929826b2291f8309610e4740340a887deead5ad1a19a9a54b49d5e1fb12
+  data.tar.gz: aa96b0004e4a7d7c11c161088d6edaafe9d21099df94d20beed8df0dc0676b84
 SHA512:
-  metadata.gz: 63c5e3440f06afab714dd1591a00d1da4ee42df659d35edf96f927528d9413ac1773414ba61973bb20c489e75491e6bc5bbd378fc3e2972b6b9843ae2087663a
-  data.tar.gz: b60502a160fe716ab7b32fcf3e474ae56a7552772a0fc7e54105139ded1128c6a334e81fa90ea12d71f9d6af63736b620705c78ccc5b1542382f47ac31eb8556
+  metadata.gz: 87eaf4667b57c442f8f08923c96f2ba9428acff018b6e4f5f44becfe7e4fca41031f93a19f35935a46fc2277bbc0484f48807bf483a06c5fcd06d7616009f165
+  data.tar.gz: 67838d5d7d683ce91bfbebbed17dce20d50cd640af580c0f816a8e5989bd2cc46fa4eff356226bc84af66a689200c9c63790693c465727fde3abea3f919ab3ed

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.2.0 (August 29th, 2019)
+
+* Add support for Dbee partitioners
+* Only support Dbee version 1.2.0 and above
+
 # 1.1.0 (August 27th, 2019)
 
 * Only support Dbee version 1.1.0 and above

data/dbee-active_record.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
     end
 
   s.add_dependency('activerecord', activerecord_version)
-  s.add_dependency('dbee', '~>1', '>=1.1.0')
+  s.add_dependency('dbee', '~>1', '>=1.2.0')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('mysql2', '~>0.5')

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

@@ -13,6 +13,8 @@ module Dbee
       class ExpressionBuilder
         # Can derive constraints for Arel table JOIN statements.
         class ConstraintMaker
+          include Singleton
+
           CONCAT_METHOD = lambda do |on, arel_column, value|
             on ? on.and(arel_column.eq(value)) : arel_column.eq(value)
           end

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

@@ -13,6 +13,8 @@ module Dbee
       class ExpressionBuilder
         # Derives Arel#order predicates.
         class OrderMaker
+          include Singleton
+
           SORTER_EVALUATORS = {
             Query::Sorters::Ascending => ->(column) { column },
             Query::Sorters::Descending => ->(column) { column.desc }

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

@@ -13,6 +13,8 @@ module Dbee
       class ExpressionBuilder
         # Derives Arel#project predicates.
         class SelectMaker
+          include Singleton
+
           def make(column, arel_column, alias_maker)
             column_alias = quote(alias_maker.make(column.display))
 

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

@@ -13,6 +13,8 @@ module Dbee
       class ExpressionBuilder
         # Derives Arel#where predicates.
         class WhereMaker
+          include Singleton
+
           FILTER_EVALUATORS = {
             Query::Filters::Contains => ->(column, val) { column.matches("%#{val}%") },
             Query::Filters::Equals => ->(column, val) { column.eq(val) },

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

@@ -28,10 +28,15 @@ module Dbee
           @table_alias_maker  = table_alias_maker
           @column_alias_maker = column_alias_maker
 
-          @base_table = Arel::Table.new(model.table)
-          @base_table.table_alias = table_alias_maker.make(model.name)
+          clear
+        end
+
+        def clear
+          @base_table = make_table(model.table, model.name)
 
-          @statement = base_table
+          build(base_table)
+
+          add_partitioners(base_table, model.partitioners)
         end
 
         def add(query)
@@ -60,31 +65,14 @@ module Dbee
           @key_paths_to_arel_columns ||= {}
         end
 
-        def where_maker
-          @where_maker ||= WhereMaker.new
-        end
-
-        def order_maker
-          @order_maker ||= OrderMaker.new
-        end
-
-        def select_maker
-          @select_maker ||= SelectMaker.new
-        end
-
-        def constraint_maker
-          @constraint_maker ||= ConstraintMaker.new
-        end
-
         def add_filter(filter)
           add_key_path(filter.key_path)
 
           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)
-
-          @statement = statement.where(predicate)
+          build(statement.where(predicate))
 
           self
         end
@@ -92,12 +80,11 @@ module Dbee
         def add_sorter(sorter)
           add_key_path(sorter.key_path)
 
-          key_path = sorter.key_path
+          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)
-
-          @statement = statement.order(predicate)
+          build(statement.order(predicate))
 
           self
         end
@@ -105,34 +92,45 @@ module Dbee
         def add_field(field)
           add_key_path(field.key_path)
 
-          key_path = field.key_path
+          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_column, column_alias_maker)
-
-          @statement = statement.project(predicate)
+          build(statement.project(predicate))
 
           self
         end
 
         def add_limit(limit)
-          @limit = limit ? limit.to_i : nil
+          limit = limit ? limit.to_i : nil
+
+          build(statement.take(limit))
 
-          @statement = @statement.take(limit) if limit
+          self
+        end
+
+        def add_partitioners(table, partitioners)
+          partitioners.each do |partitioner|
+            arel_column = table[partitioner.name]
+            predicate   = arel_column.eq(partitioner.value)
+
+            build(statement.where(predicate))
+          end
 
           self
         end
 
         def table(name, model, previous_table)
-          table = Arel::Table.new(model.table)
-          table.table_alias = table_alias_maker.make(name)
+          table = make_table(model.table, name)
 
-          on = constraint_maker.make(model.constraints, table, previous_table)
+          on = ConstraintMaker.instance.make(model.constraints, table, previous_table)
 
           raise MissingConstraintError, "for: #{name}" unless on
 
-          @statement = statement.join(table, ::Arel::Nodes::OuterJoin)
-          @statement = statement.on(on)
+          build(statement.join(table, ::Arel::Nodes::OuterJoin))
+          build(statement.on(on))
+
+          add_partitioners(table, model.partitioners)
 
           tables[name] = table
         end
@@ -146,7 +144,7 @@ module Dbee
         def add_key_path(key_path)
           return if key_paths_to_arel_columns.key?(key_path)
 
-          ancestors = model.ancestors(key_path.ancestor_names)
+          ancestors = model.ancestors!(key_path.ancestor_names)
 
           table = traverse_ancestors(ancestors)
 
@@ -155,6 +153,16 @@ module Dbee
 
           self
         end
+
+        def build(new_expression)
+          @statement = new_expression
+        end
+
+        def make_table(table_name, alias_name)
+          Arel::Table.new(table_name).tap do |table|
+            table.table_alias = table_alias_maker.make(alias_name)
+          end
+        end
       end
     end
   end

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

@@ -12,8 +12,10 @@ module Dbee
     class ActiveRecordProvider
       # This class can be used when readable alias names are expected.
       class SafeAliasMaker
-        def make(name)
-          name.to_s.tr('.', '_')
+        def make(*parts)
+          parts.flatten
+               .join('_')
+               .tr('.', '_')
         end
       end
     end

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

@@ -10,7 +10,7 @@
 module Dbee
   module Providers
     class ActiveRecordProvider
-      VERSION = '1.1.0'
+      VERSION = '1.2.0'
     end
   end
 end

data/spec/db_helper.rb

@@ -53,10 +53,17 @@ def load_schema
       t.timestamps
     end
 
+    create_table :owners do |t|
+      t.column :name, :string
+      t.timestamps
+    end
+
     create_table :animals do |t|
+      t.column :owner_id, :integer
       t.column :toy_id, :integer
       t.column :type, :string
       t.column :name, :string
+      t.column :deleted, :boolean
       t.timestamps
     end
 

data/spec/fixtures/active_record_snapshots/partitioner_example_1_query.yaml

@@ -0,0 +1,27 @@
+model_name: Partitioner Example 1
+query:
+  fields:
+    - key_path: id
+sqlite_readable: |+
+  SELECT "dogs"."id" AS 'id'
+  FROM "animals" "dogs"
+  WHERE "dogs"."type" = 'Dog' AND
+  "dogs"."deleted" = 'f'
+sqlite_not_readable: |+
+  SELECT
+  "t0"."id" AS 'c0'
+  FROM "animals" "t0"
+  WHERE "t0"."type" = 'Dog' AND
+  "t0"."deleted" = 'f'
+mysql_readable: |+
+  SELECT
+  `dogs`.`id` AS 'id'
+  FROM `animals` `dogs`
+  WHERE `dogs`.`type` = 'Dog' AND
+  `dogs`.`deleted` = FALSE
+mysql_not_readable: |+
+  SELECT
+  `t0`.`id` AS 'c0'
+  FROM `animals` `t0`
+  WHERE `t0`.`type` = 'Dog' AND
+  `t0`.`deleted` = FALSE

data/spec/fixtures/active_record_snapshots/partitioner_example_2_query.yaml

@@ -0,0 +1,37 @@
+model_name: Partitioner Example 2
+query:
+  fields:
+    - key_path: id
+    - key_path: dogs.id
+sqlite_readable: |+
+  SELECT
+  "owners"."id" AS 'id',
+  "dogs"."id" AS 'dogs_id'
+  FROM "owners" "owners"
+  LEFT OUTER JOIN "animals" "dogs" ON "dogs"."owner_id" = "owners"."id"
+  WHERE "dogs"."type" = 'Dog' AND
+  "dogs"."deleted" = 'f'
+sqlite_not_readable: |+
+  SELECT
+  "t0"."id" AS 'c0',
+  "t1"."id" AS 'c1'
+  FROM "owners" "t0"
+  LEFT OUTER JOIN "animals" "t1" ON "t1"."owner_id" = "t0"."id"
+  WHERE "t1"."type" = 'Dog' AND
+  "t1"."deleted" = 'f'
+mysql_readable: |+
+  SELECT
+  `owners`.`id` AS 'id',
+  `dogs`.`id` AS 'dogs_id'
+  FROM `owners` `owners`
+  LEFT OUTER JOIN `animals` `dogs` ON `dogs`.`owner_id` = `owners`.`id`
+  WHERE `dogs`.`type` = 'Dog' AND
+  `dogs`.`deleted` = FALSE
+mysql_not_readable: |+
+  SELECT
+  `t0`.`id` AS 'c0',
+  `t1`.`id` AS 'c1'
+  FROM `owners` `t0`
+  LEFT OUTER JOIN `animals` `t1` ON `t1`.`owner_id` = `t0`.`id`
+  WHERE `t1`.`type` = 'Dog' AND
+  `t1`.`deleted` = FALSE

data/spec/fixtures/models.yaml

@@ -80,3 +80,26 @@ Reverse Polymorphic Example:
         - type: static
           parent: type
           value: Cat
+
+Partitioner Example 1:
+  name: dogs
+  table: animals
+  partitioners:
+    - name: type
+      value: Dog
+    - name: deleted
+      value: false
+
+Partitioner Example 2:
+  name: owners
+  models:
+    - name: dogs
+      table: animals
+      constraints:
+        - name: owner_id
+          parent: id
+      partitioners:
+        - name: type
+          value: Dog
+        - name: deleted
+          value: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbee-active_record
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,7 +39,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +219,8 @@ files:
 - spec/fixtures/active_record_snapshots/one_table_query_with_filters.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_limit.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_multiple_sorts.yaml
+- spec/fixtures/active_record_snapshots/partitioner_example_1_query.yaml
+- spec/fixtures/active_record_snapshots/partitioner_example_2_query.yaml
 - spec/fixtures/active_record_snapshots/reverse_polymorphic_query.yaml
 - spec/fixtures/active_record_snapshots/two_table_query.yaml
 - spec/fixtures/models.yaml
@@ -258,6 +260,8 @@ test_files:
 - spec/fixtures/active_record_snapshots/one_table_query_with_filters.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_limit.yaml
 - spec/fixtures/active_record_snapshots/one_table_query_with_multiple_sorts.yaml
+- spec/fixtures/active_record_snapshots/partitioner_example_1_query.yaml
+- spec/fixtures/active_record_snapshots/partitioner_example_2_query.yaml
 - spec/fixtures/active_record_snapshots/reverse_polymorphic_query.yaml
 - spec/fixtures/active_record_snapshots/two_table_query.yaml
 - spec/fixtures/models.yaml