migration-patterns 0.0.0.pre.rc1 → 0.0.0.pre.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 865fc1328c592bc00258c83832c12f7ed83757f0202868d8532d7dd30585d57d
-  data.tar.gz: 88c9961f45cbdce525167682ade3e60a99b25f70dc40a9016313580bbf420237
+  metadata.gz: 9e3669e424c6540f18368d3314457ac3a3891dc5887db56a75283402913e879e
+  data.tar.gz: 14a223fbb3467497672a14eb8fbaab612e1bef31ed2a0dc494545cd72e53fb6a
 SHA512:
-  metadata.gz: 9b6f7ad7f9224be6ead4110071034363e0b9434cc6dc202f9f6b96e2c3962fb15ba0b78f5395ed3a46ef545ad94c895f5f897281d3c77a2b84e6baa121be8242
-  data.tar.gz: e88d6293f73a04a59c9c46a1ce4fd9fff604d33e9d0d93a8e71310e95d2e043f7b319921821123b4d2674849815d8b430fdfd18e459cbaf897641987a7d9cf25
+  metadata.gz: e42f11dc8b56b7427795a9da5f49d913010f4ca6b0404167bc708453d6a59382aef0459c395c943cfdea700aba97016bf45f2cb87dec9eaa09e751f366444b01
+  data.tar.gz: 3fd758d0699a22bc236a6e4eeda0ea3970d3ffc539097f52698f4e87b238e68bcd976f875659a0f689c5ae14aff3b7555bd984f7e6a3e2a56578850a70255e25

data/lib/generators/migration_patterns.rb

@@ -0,0 +1,3 @@
+# Pre-warm the in-memory store of these class instance vars when we launch the
+# server. Prevents unnecessary file I/O per-request.
+VRT.reload!

data/lib/generators/vrt/install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+module Vrt
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root(File.expand_path(File.dirname(__dir__)))
+      def create_initializer_file
+        copy_file '../vrt.rb', 'config/initializers/vrt.rb'
+      end
+    end
+  end
+end

data/lib/migration_patterns.rb

@@ -1,12 +1,29 @@
 # frozen_string_literal: true
 
-require 'migration_patterns/database_helpers'
-require 'migration_patterns/migration_helpers'
-# require 'migration_patterns/errors'
+require 'active_record'
+
+require 'migration_patterns/configuration'
 
 # require 'date'
 # require 'json'
 # require 'pathname'
 
 module MigrationPatterns
+  def self.configure
+    @configuration = MigrationPatterns::Configuration.new
+
+    yield configuration if block_given?
+
+    configuration
+  end
+
+  def self.configuration
+    @configuration || configure
+  end
+
+  require 'migration_patterns/sql/union'
+  require 'migration_patterns/from_union'
+  require 'migration_patterns/database_helpers'
+  require 'migration_patterns/grant'
+  require 'migration_patterns/migration_helpers'
 end

data/lib/migration_patterns/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MigrationPatterns
+  class Configuration
+    attr_accessor :adapter, :database, :username
+
+    private
+
+    def initialize
+      @adapter = 'postgresql'
+      @database = 'db_name'
+      @username = 'postgres'
+    end
+  end
+end

data/lib/migration_patterns/database_helpers.rb

@@ -3,7 +3,7 @@
 module MigrationPatterns
   module DatabaseHelpers
     def self.adapter_name
-      config['adapter']
+      config.adapter
     end
 
     def self.postgresql?
@@ -31,11 +31,15 @@ module MigrationPatterns
     end
 
     def self.username
-      config['username'] || ENV['USER']
+      config.username || ENV['USER']
     end
 
     def self.database_name
-      config['database']
+      config.database
+    end
+
+    def self.config
+      MigrationPatterns.configuration
     end
   end
 end

data/lib/migration_patterns/from_union.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MigrationPatterns
+  module FromUnion
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Produces a query that uses a FROM to select data using a UNION.
+      #
+      # Using a FROM for a UNION has in the past lead to better query plans. As
+      # such, we generally recommend this pattern instead of using a WHERE IN.
+      #
+      # Example:
+      #     users = User.from_union([User.where(id: 1), User.where(id: 2)])
+      #
+      # This would produce the following SQL query:
+      #
+      #     SELECT *
+      #     FROM (
+      #       SELECT *
+      #       FROM users
+      #       WHERE id = 1
+      #
+      #       UNION
+      #
+      #       SELECT *
+      #       FROM users
+      #       WHERE id = 2
+      #     ) users;
+      #
+      # members - An Array of ActiveRecord::Relation objects to use in the UNION.
+      #
+      # remove_duplicates - A boolean indicating if duplicate entries should be
+      #                     removed. Defaults to true.
+      #
+      # alias_as - The alias to use for the sub query. Defaults to the name of the
+      #            table of the current model.
+      def from_union(members, remove_duplicates: true, alias_as: table_name)
+        union = MigrationPatterns::SQL::Union
+          .new(members, remove_duplicates: remove_duplicates)
+          .to_sql
+
+        # This pattern is necessary as a bug in Rails 4 can cause the use of
+        # `from("string here").includes(:foo)` to break ActiveRecord. This is
+        # fixed in https://github.com/rails/rails/pull/25374, which is released as
+        # part of Rails 5.
+        from([Arel.sql("(#{union}) #{alias_as}")])
+      end
+    end
+  end
+end

data/lib/migration_patterns/grant.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MigrationPatterns
+  # Model that can be used for querying permissions of a SQL user.
+  class Grant < ::ActiveRecord::Base
+    include MigrationPatterns::FromUnion
+
+    self.table_name =
+      if ::MigrationPatterns::DatabaseHelpers.postgresql?
+        'information_schema.role_table_grants'
+      else
+        'information_schema.schema_privileges'
+      end
+
+    # Returns true if the current user can create and execute triggers on the
+    # given table.
+    def self.create_and_execute_trigger?(table)
+      if DatabaseHelpers.postgresql?
+        # We _must not_ use quote_table_name as this will produce double
+        # quotes on PostgreSQL and for "has_table_privilege" we need single
+        # quotes.
+        quoted_table = connection.quote(table)
+
+        begin
+          from(nil)
+            .pluck("has_table_privilege(#{quoted_table}, 'TRIGGER')")
+            .first
+        rescue ActiveRecord::StatementInvalid
+          # This error is raised when using a non-existing table name. In this
+          # case we just want to return false as a user technically can't
+          # create triggers for such a table.
+          false
+        end
+      else
+        queries = [
+          Grant.select(1)
+            .from('information_schema.user_privileges')
+            .where("PRIVILEGE_TYPE = 'SUPER'")
+            .where("GRANTEE = CONCAT('\\'', REPLACE(CURRENT_USER(), '@', '\\'@\\''), '\\'')"),
+
+          Grant.select(1)
+            .from('information_schema.schema_privileges')
+            .where("PRIVILEGE_TYPE = 'TRIGGER'")
+            .where('TABLE_SCHEMA = ?', DatabaseHelpers.database_name)
+            .where("GRANTEE = CONCAT('\\'', REPLACE(CURRENT_USER(), '@', '\\'@\\''), '\\'')")
+        ]
+
+        Grant.from_union(queries, alias_as: 'privs').any?
+      end
+    end
+  end
+end

data/lib/migration_patterns/migration_helpers.rb

@@ -55,7 +55,7 @@ module MigrationPatterns
           'in the body of your migration class'
       end
 
-      options = options.merge(algorithm: :concurrently) if Database.postgresql?
+      options = options.merge(algorithm: :concurrently) if DatabaseHelpers.postgresql?
 
       if index_exists?(table_name, column_name, options)
         Rails.logger.warn "Index not created because it already exists (this may be due to an aborted migration or similar): table_name: #{table_name}, column_name: #{column_name}"
@@ -125,7 +125,7 @@ module MigrationPatterns
 
     # Only available on Postgresql >= 9.2
     def supports_drop_index_concurrently?
-      return false unless Database.postgresql?
+      return false unless DatabaseHelpers.postgresql?
 
       version = select_one("SELECT current_setting('server_version_num') AS v")['v'].to_i
 
@@ -150,7 +150,7 @@ module MigrationPatterns
       # While MySQL does allow disabling of foreign keys it has no equivalent
       # of PostgreSQL's "VALIDATE CONSTRAINT". As a result we'll just fall
       # back to the normal foreign key procedure.
-      if Database.mysql?
+      if DatabaseHelpers.mysql?
         if foreign_key_exists?(source, target, column: column)
           Rails.logger.warn 'Foreign key not created because it exists already ' \
             '(this may be due to an aborted migration or similar): ' \
@@ -230,7 +230,7 @@ module MigrationPatterns
     # or `RESET ALL` is executed
     def disable_statement_timeout
       # bypass disabled_statement logic when not using postgres, but still execute block when one is given
-      unless Database.postgresql?
+      unless DatabaseHelpers.postgresql?
         yield if block_given?
 
         return
@@ -261,11 +261,11 @@ module MigrationPatterns
     end
 
     def true_value
-      Database.true_value
+      DatabaseHelpers.true_value
     end
 
     def false_value
-      Database.false_value
+      DatabaseHelpers.false_value
     end
 
     # Updates the value of a column in batches.
@@ -482,7 +482,7 @@ module MigrationPatterns
       quoted_old = quote_column_name(old_column)
       quoted_new = quote_column_name(new_column)
 
-      if Database.postgresql?
+      if DatabaseHelpers.postgresql?
         install_rename_triggers_for_postgresql(trigger_name, quoted_table,
                                                quoted_old, quoted_new)
       else
@@ -531,7 +531,7 @@ module MigrationPatterns
 
       check_trigger_permissions!(table)
 
-      if Database.postgresql?
+      if DatabaseHelpers.postgresql?
         remove_rename_triggers_for_postgresql(table, trigger_name)
       else
         remove_rename_triggers_for_mysql(trigger_name)
@@ -880,7 +880,7 @@ module MigrationPatterns
       quoted_pattern = Arel::Nodes::Quoted.new(pattern.to_s)
       quoted_replacement = Arel::Nodes::Quoted.new(replacement.to_s)
 
-      if Database.mysql?
+      if DatabaseHelpers.mysql?
         locate = Arel::Nodes::NamedFunction
                  .new('locate', [quoted_pattern, column])
         insert_in_place = Arel::Nodes::NamedFunction
@@ -919,8 +919,8 @@ module MigrationPatterns
 
     def check_trigger_permissions!(table)
       unless Grant.create_and_execute_trigger?(table)
-        dbname = Database.database_name
-        user = Database.username
+        dbname = DatabaseHelpers.database_name
+        user = DatabaseHelpers.username
 
         raise <<~EOF
           Your database user is not allowed to create, drop, or execute triggers on the
@@ -1052,7 +1052,7 @@ module MigrationPatterns
       # does not find indexes without passing a column name.
       if indexes(table).map(&:name).include?(index.to_s)
         true
-      elsif Database.postgresql?
+      elsif DatabaseHelpers.postgresql?
         postgres_exists_by_name?(table, index)
       else
         false
@@ -1072,7 +1072,7 @@ module MigrationPatterns
     end
 
     def mysql_compatible_index_length
-      Database.mysql? ? 20 : nil
+      DatabaseHelpers.mysql? ? 20 : nil
     end
   end
 end

data/lib/migration_patterns/sql/union.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MigrationPatterns
+  module SQL
+    # Class for building SQL UNION statements.
+    #
+    # ORDER BYs are dropped from the relations as the final sort order is not
+    # guaranteed any way.
+    #
+    # Example usage:
+    #
+    #     union = Gitlab::SQL::Union.new([user.personal_projects, user.projects])
+    #     sql   = union.to_sql
+    #
+    #     Project.where("id IN (#{sql})")
+    class Union
+      def initialize(relations, remove_duplicates: true)
+        @relations = relations
+        @remove_duplicates = remove_duplicates
+      end
+
+      def to_sql
+        # Some relations may include placeholders for prepared statements, these
+        # aren't incremented properly when joining relations together this way.
+        # By using "unprepared_statements" we remove the usage of placeholders
+        # (thus fixing this problem), at a slight performance cost.
+        fragments = ActiveRecord::Base.connection.unprepared_statement do
+          @relations.map { |rel| rel.reorder(nil).to_sql }.reject(&:blank?)
+        end
+
+        if fragments.any?
+          fragments.join("\n#{union_keyword}\n")
+        else
+          'NULL'
+        end
+      end
+
+      def union_keyword
+        @remove_duplicates ? 'UNION' : 'UNION ALL'
+      end
+    end
+  end
+end

data/lib/migration_patterns/version.rb

@@ -2,6 +2,6 @@
 
 module MigrationPatterns
   module Version
-    STRING = '0.0.0-rc1'
+    STRING = '0.0.0-rc3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migration-patterns
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre.rc1
+  version: 0.0.0.pre.rc3
 platform: ruby
 authors:
 - Adam David
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - adamrdavid@gmail.com
@@ -102,10 +116,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/migration_patterns.rb
+- lib/generators/vrt/install_generator.rb
 - lib/migration_patterns.rb
 - lib/migration_patterns/background_job.rb
+- lib/migration_patterns/configuration.rb
 - lib/migration_patterns/database_helpers.rb
+- lib/migration_patterns/from_union.rb
+- lib/migration_patterns/grant.rb
 - lib/migration_patterns/migration_helpers.rb
+- lib/migration_patterns/sql/union.rb
 - lib/migration_patterns/version.rb
 homepage: https://github.com/adamrdavid/migration-patterns
 licenses: