dbee-active_record 1.0.0.pre.alpha

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

@@ -0,0 +1,40 @@
+# 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
+      # Derives new alias names and keeps count of ones already generated in order to avoid
+      # collision.
+      class ObfuscatedAliasMaker
+        attr_reader :prefix
+
+        def initialize(prefix = '')
+          @counter  = -1
+          @prefix   = prefix
+        end
+
+        def make(_name)
+          increment
+          current
+        end
+
+        private
+
+        def current
+          "#{prefix}#{@counter}"
+        end
+
+        def increment
+          @counter += 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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
+      # This class can be used when readable alias names are expected.
+      class SafeAliasMaker
+        def make(name)
+          name.to_s.tr('.', '_')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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
+      VERSION = '1.0.0-alpha'
+    end
+  end
+end

data/lib/dbee/providers/active_record_provider.rb

@@ -0,0 +1,51 @@
+# 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 'dbee'
+require 'active_record'
+
+require_relative 'active_record_provider/expression_builder'
+require_relative 'active_record_provider/obfuscated_alias_maker'
+require_relative 'active_record_provider/safe_alias_maker'
+
+module Dbee
+  module Providers
+    # Provider which leverages ActiveRecord and Arel for generating SQL.
+    class ActiveRecordProvider
+      DEFAULT_TABLE_PREFIX  = 't'
+      DEFAULT_COLUMN_PREFIX = 'c'
+
+      attr_reader :readable, :table_alias_maker, :column_alias_maker
+
+      def initialize(
+        readable: true,
+        table_prefix: DEFAULT_TABLE_PREFIX,
+        column_prefix: DEFAULT_COLUMN_PREFIX
+      )
+        @readable           = readable
+        @table_alias_maker  = alias_maker(table_prefix)
+        @column_alias_maker = alias_maker(column_prefix)
+      end
+
+      def sql(model, query)
+        ExpressionBuilder.new(
+          model,
+          table_alias_maker,
+          column_alias_maker
+        ).add(query).to_sql
+      end
+
+      private
+
+      def alias_maker(prefix)
+        readable ? SafeAliasMaker.new : ObfuscatedAliasMaker.new(prefix)
+      end
+    end
+  end
+end

data/spec/config/database.yaml.ci

@@ -0,0 +1,9 @@
+sqlite:
+  adapter: sqlite3
+  database: ':memory:'
+mysql:
+  adapter: mysql2
+  database: dbee_test
+  username: root
+  host: 127.0.0.1
+  port: 3306

data/spec/db_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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.
+#
+
+# Enable logging using something like:
+# ActiveRecord::Base.logger = Logger.new(STDERR)
+
+def connect_to_db(name)
+  config = yaml_file_read('spec', 'config', 'database.yaml')[name.to_s]
+  ActiveRecord::Base.establish_connection(config)
+end
+
+def load_schema
+  ActiveRecord::Schema.define do
+    create_table :theaters do |t|
+      t.column :name, :string
+      t.column :partition, :string
+      t.column :active, :boolean
+      t.column :inspected, :boolean
+      t.timestamps
+    end
+
+    create_table :members do |t|
+      t.column :tid, :integer
+      t.column :account_number, :string
+      t.column :partition, :string
+      t.timestamps
+    end
+
+    create_table :demographics do |t|
+      t.column :member_id, :integer
+      t.column :name, :string
+      t.timestamps
+    end
+
+    create_table :phone_numbers do |t|
+      t.column :demographic_id, :integer
+      t.column :phone_type, :string
+      t.column :phone_number, :string
+      t.timestamps
+    end
+
+    create_table :movies do |t|
+      t.column :member_id, :integer
+      t.column :name, :string
+      t.column :genre, :string
+      t.column :favorite, :boolean, default: false, null: false
+      t.timestamps
+    end
+  end
+end

data/spec/dbee/providers/active_record_provider_spec.rb

@@ -0,0 +1,79 @@
+# 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 do
+  let(:models) { yaml_fixture('models.yaml') }
+
+  describe 'Snapshot' do
+    context 'Generating SQL' do
+      %w[sqlite mysql].each do |dbms|
+        context dbms do
+          before(:all) do
+            connect_to_db(dbms)
+          end
+
+          { readable: true, not_readable: false }.each_pair do |type, readable|
+            context type.to_s do
+              let(:key) { "#{dbms}_#{type}" }
+
+              yaml_fixture_files('active_record_snapshots').each_pair do |filename, snapshot|
+                specify File.basename(filename) do
+                  model_name = snapshot['model_name']
+                  query = Dbee::Query.make(snapshot['query'])
+                  model = Dbee::Model.make(models[model_name])
+                  expected_sql  = snapshot[key].to_s.chomp.tr("\n", ' ')
+                  actual_sql    = described_class.new(readable: readable).sql(model, query)
+
+                  error_msg = <<~ERROR_MSG
+                    Expected: #{expected_sql}
+                    Actual:   #{actual_sql}
+                  ERROR_MSG
+
+                  expect(actual_sql).to eq(expected_sql), error_msg
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    context 'Executing SQL' do
+      %w[sqlite].each do |dbms|
+        context dbms do
+          before(:all) do
+            connect_to_db(dbms)
+            load_schema
+          end
+
+          { readable: true, not_readable: false }.each_pair do |type, readable|
+            context type.to_s do
+              let(:key) { "#{dbms}_#{type}" }
+
+              yaml_fixture_files('active_record_snapshots').each_pair do |filename, snapshot|
+                specify File.basename(filename) do
+                  model_name = snapshot['model_name']
+                  query = Dbee::Query.make(snapshot['query'])
+                  model = Dbee::Model.make(models[model_name])
+
+                  sql = described_class.new(readable: readable).sql(model, query)
+
+                  expect { ActiveRecord::Base.connection.execute(sql) }.to_not raise_error
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/active_record_snapshots/five_table_query.yaml

@@ -0,0 +1,77 @@
+model_name: Theaters, Members, and Movies
+query:
+  fields:
+    - key_path: members.demos.phone_numbers.phone_number
+      display: PHONE NUMBER
+    - key_path: members.demos.name
+    - key_path: id
+    - key_path: name
+    - key_path: members.movies.id
+    - key_path: members.id
+    - key_path: members.account_number
+    - key_path: members.demos.phone_numbers.phone_type
+    - key_path: members.movies.name
+sqlite_readable: |+
+  SELECT
+  "members_demos_phone_numbers"."phone_number" AS 'PHONE NUMBER',
+  "members_demos"."name" AS 'members_demos_name',
+  "theaters"."id" AS 'id',
+  "theaters"."name" AS 'name',
+  "members_movies"."id" AS 'members_movies_id',
+  "members"."id" AS 'members_id',
+  "members"."account_number" AS 'members_account_number',
+  "members_demos_phone_numbers"."phone_type" AS 'members_demos_phone_numbers_phone_type',
+  "members_movies"."name" AS 'members_movies_name'
+  FROM "theaters" "theaters"
+  LEFT OUTER JOIN "members" "members" ON "members"."tid" = "theaters"."id" AND "members"."partition" = "theaters"."partition"
+  LEFT OUTER JOIN "demographics" "members_demos" ON "members_demos"."member_id" = "members"."id"
+  LEFT OUTER JOIN "phone_numbers" "members_demos_phone_numbers" ON "members_demos_phone_numbers"."demographic_id" = "members_demos"."id"
+  LEFT OUTER JOIN "movies" "members_movies" ON "members_movies"."member_id" = "members"."id"
+sqlite_not_readable: |+
+  SELECT
+  "t3"."phone_number" AS 'c0',
+  "t2"."name" AS 'c1',
+  "t0"."id" AS 'c2',
+  "t0"."name" AS 'c3',
+  "t4"."id" AS 'c4',
+  "t1"."id" AS 'c5',
+  "t1"."account_number" AS 'c6',
+  "t3"."phone_type" AS 'c7',
+  "t4"."name" AS 'c8'
+  FROM "theaters" "t0"
+  LEFT OUTER JOIN "members" "t1" ON "t1"."tid" = "t0"."id" AND "t1"."partition" = "t0"."partition"
+  LEFT OUTER JOIN "demographics" "t2" ON "t2"."member_id" = "t1"."id"
+  LEFT OUTER JOIN "phone_numbers" "t3" ON "t3"."demographic_id" = "t2"."id"
+  LEFT OUTER JOIN "movies" "t4" ON "t4"."member_id" = "t1"."id"
+mysql_readable: |+
+  SELECT
+  `members_demos_phone_numbers`.`phone_number` AS 'PHONE NUMBER',
+  `members_demos`.`name` AS 'members_demos_name',
+  `theaters`.`id` AS 'id',
+  `theaters`.`name` AS 'name',
+  `members_movies`.`id` AS 'members_movies_id',
+  `members`.`id` AS 'members_id',
+  `members`.`account_number` AS 'members_account_number',
+  `members_demos_phone_numbers`.`phone_type` AS 'members_demos_phone_numbers_phone_type',
+  `members_movies`.`name` AS 'members_movies_name'
+  FROM `theaters` `theaters`
+  LEFT OUTER JOIN `members` `members` ON `members`.`tid` = `theaters`.`id` AND `members`.`partition` = `theaters`.`partition`
+  LEFT OUTER JOIN `demographics` `members_demos` ON `members_demos`.`member_id` = `members`.`id`
+  LEFT OUTER JOIN `phone_numbers` `members_demos_phone_numbers` ON `members_demos_phone_numbers`.`demographic_id` = `members_demos`.`id`
+  LEFT OUTER JOIN `movies` `members_movies` ON `members_movies`.`member_id` = `members`.`id`
+mysql_not_readable: |+
+  SELECT
+  `t3`.`phone_number` AS 'c0',
+  `t2`.`name` AS 'c1',
+  `t0`.`id` AS 'c2',
+  `t0`.`name` AS 'c3',
+  `t4`.`id` AS 'c4',
+  `t1`.`id` AS 'c5',
+  `t1`.`account_number` AS 'c6',
+  `t3`.`phone_type` AS 'c7',
+  `t4`.`name` AS 'c8'
+  FROM `theaters` `t0`
+  LEFT OUTER JOIN `members` `t1` ON `t1`.`tid` = `t0`.`id` AND `t1`.`partition` = `t0`.`partition`
+  LEFT OUTER JOIN `demographics` `t2` ON `t2`.`member_id` = `t1`.`id`
+  LEFT OUTER JOIN `phone_numbers` `t3` ON `t3`.`demographic_id` = `t2`.`id`
+  LEFT OUTER JOIN `movies` `t4` ON `t4`.`member_id` = `t1`.`id`

data/spec/fixtures/active_record_snapshots/multiple_same_table_query_with_static_constraints.yaml

@@ -0,0 +1,104 @@
+model_name: Theaters, Members, and Movies
+query:
+  fields:
+    - key_path: id
+    - key_path: name
+    - key_path: members.id
+    - key_path: members.account_number
+    - key_path: members.movies.id
+    - key_path: members.movies.name
+      display: 'Movie Name'
+    - key_path: members.movies.genre
+    - key_path: members.favorite_comic_movies.id
+    - key_path: members.favorite_comic_movies.name
+      display: 'Favorite Comic Movie Name'
+    - key_path: members.favorite_comic_movies.genre
+    - key_path: members.favorite_mystery_movies.id
+    - key_path: members.favorite_mystery_movies.name
+      display: 'Favorite Mystery Movie Name'
+    - key_path: members.favorite_mystery_movies.genre
+  limit: 12
+sqlite_readable: |+
+  SELECT
+   "theaters"."id" AS 'id',
+  "theaters"."name" AS 'name',
+  "members"."id" AS 'members_id',
+  "members"."account_number" AS 'members_account_number',
+  "members_movies"."id" AS 'members_movies_id',
+  "members_movies"."name" AS 'Movie Name',
+  "members_movies"."genre" AS 'members_movies_genre',
+  "members_favorite_comic_movies"."id" AS 'members_favorite_comic_movies_id',
+  "members_favorite_comic_movies"."name" AS 'Favorite Comic Movie Name',
+  "members_favorite_comic_movies"."genre" AS 'members_favorite_comic_movies_genre',
+  "members_favorite_mystery_movies"."id" AS 'members_favorite_mystery_movies_id',
+  "members_favorite_mystery_movies"."name" AS 'Favorite Mystery Movie Name',
+  "members_favorite_mystery_movies"."genre" AS 'members_favorite_mystery_movies_genre'
+  FROM "theaters" "theaters"
+  LEFT OUTER JOIN "members" "members" ON "members"."tid" = "theaters"."id" AND "members"."partition" = "theaters"."partition"
+  LEFT OUTER JOIN "movies" "members_movies" ON "members_movies"."member_id" = "members"."id"
+  LEFT OUTER JOIN "movies" "members_favorite_comic_movies" ON "members_favorite_comic_movies"."member_id" = "members"."id" AND "members_favorite_comic_movies"."genre" = 'comic'
+  LEFT OUTER JOIN "movies" "members_favorite_mystery_movies" ON "members_favorite_mystery_movies"."member_id" = "members"."id" AND "members_favorite_mystery_movies"."genre" = 'mystery'
+  LIMIT 12
+sqlite_not_readable: |+
+  SELECT
+   "t0"."id" AS 'c0',
+  "t0"."name" AS 'c1',
+  "t1"."id" AS 'c2',
+  "t1"."account_number" AS 'c3',
+  "t2"."id" AS 'c4',
+  "t2"."name" AS 'c5',
+  "t2"."genre" AS 'c6',
+  "t3"."id" AS 'c7',
+  "t3"."name" AS 'c8',
+  "t3"."genre" AS 'c9',
+  "t4"."id" AS 'c10',
+  "t4"."name" AS 'c11',
+  "t4"."genre" AS 'c12'
+  FROM "theaters" "t0"
+  LEFT OUTER JOIN "members" "t1" ON "t1"."tid" = "t0"."id" AND "t1"."partition" = "t0"."partition"
+  LEFT OUTER JOIN "movies" "t2" ON "t2"."member_id" = "t1"."id"
+  LEFT OUTER JOIN "movies" "t3" ON "t3"."member_id" = "t1"."id" AND "t3"."genre" = 'comic'
+  LEFT OUTER JOIN "movies" "t4" ON "t4"."member_id" = "t1"."id" AND "t4"."genre" = 'mystery'
+  LIMIT 12
+mysql_readable: |+
+  SELECT
+   `theaters`.`id` AS 'id',
+  `theaters`.`name` AS 'name',
+  `members`.`id` AS 'members_id',
+  `members`.`account_number` AS 'members_account_number',
+  `members_movies`.`id` AS 'members_movies_id',
+  `members_movies`.`name` AS 'Movie Name',
+  `members_movies`.`genre` AS 'members_movies_genre',
+  `members_favorite_comic_movies`.`id` AS 'members_favorite_comic_movies_id',
+  `members_favorite_comic_movies`.`name` AS 'Favorite Comic Movie Name',
+  `members_favorite_comic_movies`.`genre` AS 'members_favorite_comic_movies_genre',
+  `members_favorite_mystery_movies`.`id` AS 'members_favorite_mystery_movies_id',
+  `members_favorite_mystery_movies`.`name` AS 'Favorite Mystery Movie Name',
+  `members_favorite_mystery_movies`.`genre` AS 'members_favorite_mystery_movies_genre'
+  FROM `theaters` `theaters`
+  LEFT OUTER JOIN `members` `members` ON `members`.`tid` = `theaters`.`id` AND `members`.`partition` = `theaters`.`partition`
+  LEFT OUTER JOIN `movies` `members_movies` ON `members_movies`.`member_id` = `members`.`id`
+  LEFT OUTER JOIN `movies` `members_favorite_comic_movies` ON `members_favorite_comic_movies`.`member_id` = `members`.`id` AND `members_favorite_comic_movies`.`genre` = 'comic'
+  LEFT OUTER JOIN `movies` `members_favorite_mystery_movies` ON `members_favorite_mystery_movies`.`member_id` = `members`.`id` AND `members_favorite_mystery_movies`.`genre` = 'mystery'
+  LIMIT 12
+mysql_not_readable: |+
+  SELECT
+   `t0`.`id` AS 'c0',
+  `t0`.`name` AS 'c1',
+  `t1`.`id` AS 'c2',
+  `t1`.`account_number` AS 'c3',
+  `t2`.`id` AS 'c4',
+  `t2`.`name` AS 'c5',
+  `t2`.`genre` AS 'c6',
+  `t3`.`id` AS 'c7',
+  `t3`.`name` AS 'c8',
+  `t3`.`genre` AS 'c9',
+  `t4`.`id` AS 'c10',
+  `t4`.`name` AS 'c11',
+  `t4`.`genre` AS 'c12'
+  FROM `theaters` `t0`
+  LEFT OUTER JOIN `members` `t1` ON `t1`.`tid` = `t0`.`id` AND `t1`.`partition` = `t0`.`partition`
+  LEFT OUTER JOIN `movies` `t2` ON `t2`.`member_id` = `t1`.`id`
+  LEFT OUTER JOIN `movies` `t3` ON `t3`.`member_id` = `t1`.`id` AND `t3`.`genre` = 'comic'
+  LEFT OUTER JOIN `movies` `t4` ON `t4`.`member_id` = `t1`.`id` AND `t4`.`genre` = 'mystery'
+  LIMIT 12

data/spec/fixtures/active_record_snapshots/one_table_query.yaml

@@ -0,0 +1,26 @@
+model_name: Theaters, Members, and Movies
+query:
+  fields:
+    - key_path: id
+      display: 'ID #'
+    - key_path: name
+sqlite_not_readable: |+
+  SELECT
+  "t0"."id" AS 'c0',
+  "t0"."name" AS 'c1'
+  FROM "theaters" "t0"
+sqlite_readable: |+
+  SELECT
+  "theaters"."id" AS 'ID #',
+  "theaters"."name" AS 'name'
+  FROM "theaters" "theaters"
+mysql_not_readable: |+
+  SELECT
+  `t0`.`id` AS 'c0',
+  `t0`.`name` AS 'c1'
+  FROM `theaters` `t0`
+mysql_readable: |+
+  SELECT
+  `theaters`.`id` AS 'ID #',
+  `theaters`.`name` AS 'name'
+  FROM `theaters` `theaters`

data/spec/fixtures/active_record_snapshots/one_table_query_with_ascending_sort.yaml

@@ -0,0 +1,31 @@
+model_name: Theaters, Members, and Movies
+query:
+  fields:
+    - key_path: id
+    - key_path: name
+  sorters:
+    - key_path: created_at
+sqlite_readable: |+
+  SELECT
+  "theaters"."id" AS 'id',
+  "theaters"."name" AS 'name'
+  FROM "theaters" "theaters"
+  ORDER BY "theaters"."created_at"
+sqlite_not_readable: |+
+  SELECT
+  "t0"."id" AS 'c0',
+  "t0"."name" AS 'c1'
+  FROM "theaters" "t0"
+  ORDER BY "t0"."created_at"
+mysql_readable: |+
+  SELECT
+  `theaters`.`id` AS 'id',
+  `theaters`.`name` AS 'name'
+  FROM `theaters` `theaters`
+  ORDER BY `theaters`.`created_at`
+mysql_not_readable: |+
+  SELECT
+  `t0`.`id` AS 'c0',
+  `t0`.`name` AS 'c1'
+  FROM `theaters` `t0`
+  ORDER BY `t0`.`created_at`

data/spec/fixtures/active_record_snapshots/one_table_query_with_descending_sort.yaml

@@ -0,0 +1,32 @@
+model_name: Theaters, Members, and Movies
+query:
+  fields:
+    - key_path: id
+    - key_path: name
+  sorters:
+    - key_path: created_at
+      direction: descending
+sqlite_readable: |+
+  SELECT
+  "theaters"."id" AS 'id',
+  "theaters"."name" AS 'name'
+  FROM "theaters" "theaters"
+  ORDER BY "theaters"."created_at" DESC
+sqlite_not_readable: |+
+  SELECT
+  "t0"."id" AS 'c0',
+  "t0"."name" AS 'c1'
+  FROM "theaters" "t0"
+  ORDER BY "t0"."created_at" DESC
+mysql_readable: |+
+  SELECT
+  `theaters`.`id` AS 'id',
+  `theaters`.`name` AS 'name'
+  FROM `theaters` `theaters`
+  ORDER BY `theaters`.`created_at` DESC
+mysql_not_readable: |+
+  SELECT
+  `t0`.`id` AS 'c0',
+  `t0`.`name` AS 'c1'
+  FROM `theaters` `t0`
+  ORDER BY `t0`.`created_at` DESC