pg_saurus 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a10802e45cc1cb9e289081e96b420ddbcf4459c1
-  data.tar.gz: 5f570fb003f9551eb793213c99586a5b6cf8597d
+  metadata.gz: 18d59e56fbebaf661db0f4282517d39ed626e929
+  data.tar.gz: 486ae857a907186f330793f3ab94fc26e1491100
 SHA512:
-  metadata.gz: 22b9bcda65cdbec23a53f07f41fd6a37b808f605e3ba65a972f6ba0c19b17f966e9092107b807208ece28ff318fbe3082c6a5cc78ba69ac9e69fad80c4eb5e28
-  data.tar.gz: 8c57bb5f82920f46ee793236cf031dfa1b2e758a1bc97f24c683ec42c483d661e3bab117bb888c210619a8036e31741751447419e35109cc093f02c2d3e0bd55
+  metadata.gz: df7e2e4c78ef8aedf0e9d26394a3decdefae7761a5e26e6a4e2e9039c3f1c679348539aed360d7e340f653572f07f31d75cb56900d364f0be72569b8f5fdcc5b
+  data.tar.gz: 25fabf172159dd396218b7833a98f4561bea292b58614beabaff3713d1edb660d8803134f4309a098fba9e500439fd84eb5210c9b3cca685ca17a5cc97c05501

data/README.markdown

@@ -270,9 +270,49 @@ with the understanding that it is preliminary 'alpha' at best.
 create_view "demography.citizens_view", "select * from demography.citizens"
 ```
 
+## Roles
+
+If you want to execute a migration as a specific PostgreSQL role you can use the `set_role` method:
+
+```ruby
+class CreateRockBands < ActiveRecord::Migration
+  set_role "rocker"
+
+  def change
+    create_table :rock_bands do |t|
+      # create columns
+    end
+  end
+end
+```
+
+Technically it is equivalent to the following:
+
+```ruby
+class CreateRockBands < ActiveRecord::Migration
+  def change
+    execute "SET ROLE rocker"
+    create_table :rock_bands do |t|
+      # create columns
+    end
+  ensure
+    execute "RESET ROLE"
+  end
+end
+```
+
+You may force all migrations to have `set_role`, for this, configure PgSaurus with
+`ensure_role_set=true`:
+
+```ruby
+PgSaurus.configre do |config|
+  config.ensure_role_set = true
+end
+```
+
 ## Tools
 
-PgSaurus::Tools provides number of useful methods:
+PgSaurus::Tools provides a number of useful methods:
 
 ```ruby
 PgSaurus::Tools.create_schema "services"                 # => create new PG schema "services"

data/lib/generators/pg_saurus/install/install_generator.rb

@@ -0,0 +1,22 @@
+module PgSaurus
+  # :nodoc:
+  module Generators
+    # Generates config/initializers/pg_saurus.rb with default settings.
+    class InstallGenerator < ::Rails::Generators::Base
+
+      # :nodoc:
+      desc <<-DESC
+Description:
+  Create default PgSaurus configuration
+DESC
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      # :nodoc:
+      def copy_rails_files
+        template "config/initializers/pg_saurus.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/pg_saurus/install/templates/config/initializers/pg_saurus.rb

@@ -0,0 +1,6 @@
+# Configure PgSaurus behaviour.
+#
+PgSaurus.configure do |config|
+  # Set to true if you want to enforce migrations to set role.
+  config.ensure_role_set = false
+end

data/lib/pg_saurus.rb

@@ -1,5 +1,6 @@
 require "pg_saurus/engine"
 require "pg_saurus/errors"
+require "pg_saurus/config"
 
 # Rails engine which allows to use some PostgreSQL features:
 # * Schemas.
@@ -15,4 +16,12 @@ module PgSaurus
   autoload :Migration
   autoload :ConnectionAdapters
   autoload :CreateIndexConcurrently
+
+  mattr_accessor :config
+  self.config = PgSaurus::Config.new
+
+  # Configure the engine.
+  def self.configure
+    yield(config)
+  end
 end

data/lib/pg_saurus/config.rb

@@ -0,0 +1,12 @@
+module PgSaurus
+  # Configuration for PgSaurus behaviour.
+  class Config
+    # When true, raise exception if migration is executed without a role.
+    attr_accessor :ensure_role_set
+
+    # Instantiate and set default config settings.
+    def initialize
+      @ensure_role_set = true
+    end
+  end
+end

data/lib/pg_saurus/engine.rb

@@ -14,6 +14,10 @@ module PgSaurus
 
         ActiveRecord::SchemaDumper.class_eval { include ::PgSaurus::SchemaDumper }
 
+        ActiveRecord::Migration.class_eval do
+          include ::PgSaurus::Migration::SetRoleMethod
+        end
+
         if defined?(ActiveRecord::Migration::CommandRecorder)
           ActiveRecord::Migration::CommandRecorder.class_eval do
             include ::PgSaurus::Migration::CommandRecorder

data/lib/pg_saurus/errors.rb

@@ -1,6 +1,10 @@
-module PgSaurus # :nodoc:
+module PgSaurus
+  # Base error for PgSaurus errors.
+  class Error < StandardError; end
 
   # Raised when an unexpected index exists
-  class IndexExistsError < StandardError; end
+  class IndexExistsError < Error; end
 
+  # Raised if config.ensure_role_set = true, but migration have no role set.
+  class RoleNotSetError < Error; end
 end

data/lib/pg_saurus/migration.rb

@@ -1,4 +1,6 @@
 module PgSaurus::Migration  # :nodoc:
   extend ActiveSupport::Autoload
+
   autoload :CommandRecorder
+  autoload :SetRoleMethod
 end

data/lib/pg_saurus/migration/set_role_method.rb

@@ -0,0 +1,76 @@
+module PgSaurus
+  # Wrap original `exec_migration` to run migration with set postgresql role.
+  # If config.ensure_role_set=true but no role is set for the migration, then an
+  # exception is raised.
+  module Migration::SetRoleMethod
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        attr_reader :role
+
+        # Set role
+        #
+        # @param role [String]
+        def set_role(role)
+          @role = role
+        end
+
+        # Prevents raising exception when ensure_role_set=true and no role is set.
+        def keep_default_role
+          @keep_default_role = true
+        end
+
+        # Was +keep_default_role+ called for the migration?
+        #
+        # @return [Boolean]
+        def keep_default_role?
+          @keep_default_role
+        end
+      end
+
+      alias_method_chain :exec_migration, :role
+    end
+
+    # Get role
+    def role
+      self.class.role
+    end
+
+    # :nodoc:
+    def keep_default_role?
+      self.class.keep_default_role?
+    end
+
+    # Wrap original `exec_migration` to run migration with set role.
+    #
+    # @param conn [ActiveRecord::ConnectionAdapters::PostgreSQLAdapter]
+    # @param direction [Symbole] :up or :down
+    #
+    # @return [void]
+    def exec_migration_with_role(conn, direction)
+      if role
+        begin
+          conn.execute "SET ROLE #{role}"
+          exec_migration_without_role(conn, direction)
+        ensure
+          conn.execute "RESET ROLE"
+        end
+      elsif PgSaurus.config.ensure_role_set && !keep_default_role?
+        msg =
+          "Role for migration #{self.class} is not set\n\n" \
+          "You've configured PgSaurus with ensure_role_set=true. \n" \
+          "That means that every migration must explicitly set role with set_role method.\n\n" \
+          "Example:\n" \
+          "  class CreateNewTable < ActiveRecord::Migration\n" \
+          "    set_role \"superhero\"\n" \
+          "  end\n\n" \
+          "If you want to set ensure_role_set=false, take a look at config/initializers/pg_saurus.rb\n\n"
+        raise PgSaurus::RoleNotSetError, msg
+      else
+        exec_migration_without_role(conn, direction)
+      end
+    end
+
+  end
+end

data/lib/pg_saurus/version.rb

@@ -1,4 +1,4 @@
 module PgSaurus
   # Version of pg_saurus gem.
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_saurus
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Potapov Sergey
@@ -160,7 +160,10 @@ files:
 - lib/core_ext/active_record/connection_adapters/postgresql_adapter.rb
 - lib/core_ext/active_record/errors.rb
 - lib/core_ext/active_record/schema_dumper.rb
+- lib/generators/pg_saurus/install/install_generator.rb
+- lib/generators/pg_saurus/install/templates/config/initializers/pg_saurus.rb
 - lib/pg_saurus.rb
+- lib/pg_saurus/config.rb
 - lib/pg_saurus/connection_adapters.rb
 - lib/pg_saurus/connection_adapters/abstract_adapter.rb
 - lib/pg_saurus/connection_adapters/abstract_adapter/comment_methods.rb
@@ -190,6 +193,7 @@ files:
 - lib/pg_saurus/migration/command_recorder/foreigner_methods.rb
 - lib/pg_saurus/migration/command_recorder/schema_methods.rb
 - lib/pg_saurus/migration/command_recorder/view_methods.rb
+- lib/pg_saurus/migration/set_role_method.rb
 - lib/pg_saurus/schema_dumper.rb
 - lib/pg_saurus/schema_dumper/comment_methods.rb
 - lib/pg_saurus/schema_dumper/extension_methods.rb