activerecord-postgres_enum 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8126b681a13ce0266aff512380576a00a47a93a7a018a507dbda0a18ffa7e775
-  data.tar.gz: 3190be425e34c6c3c7116b46afb5fa671e573d831afcbfb3b36ef8ef7b169d23
+  metadata.gz: e97d08a739660755211e03868a76e345eba7546be13b374619a644dfa048ab11
+  data.tar.gz: d37271b37da014e68ad570a071e8841e3e851552d001084ac5668b4bd43b58f6
 SHA512:
-  metadata.gz: 5e7e17e5b245b285ec234cf069d31c98d54e5f2f043247ef81956c72859a0f72ccb6ca28dccffcc2e6ac4d318a4fe916982c18a1a338b82f6ccebb1b0fcfd582
-  data.tar.gz: e03ab649fc29e58f7938da1a30648acebe23af42efde515b0241ceb338ec3f7d4e9638d6f15f07aa91a7b9c4fc477ef85521e8b912677ceeac3f3ef06daf6d30
+  metadata.gz: b1486eeb1f2621cc0f2625fffb52ccbb56c272c95238587a93a7ced95ec743aeb333ee441cfc566d9a6d346e896ef3300dbef8f5348632d0b9e3c527adedbcb4
+  data.tar.gz: 338a9914209f6797286e6e90658a867682289909539cadb4c3d8e4de5cf7ebd6ad6d803c2e1ed7e197f0fbe0e2134c8dc9542da937708d5640bcaf6c5930a2a5

data/README.md

@@ -53,13 +53,15 @@ rename_enum :mood, :emotions
 To add a value into existing enum:
 
 ```ruby
-add_enum_value :mood, "crazy"
+add_enum_value :mood, "pensive"
 ```
 
+**NB:** To stop Postgres complaining about adding enum values inside a transaction, use [`disable_ddl_transaction!`](https://api.rubyonrails.org/classes/ActiveRecord/Migration.html#method-c-disable_ddl_transaction-21) in your migration.        
+
 To rename a value:
 
 ```ruby
-rename_enum_value :mood, "crazy", "nutty"
+rename_enum_value :mood, "pensive", "wistful"
 ```
 
 ## Development

data/lib/active_record/postgres_enum.rb

@@ -9,15 +9,31 @@ require "active_support/lazy_load_hooks"
 require "active_record/postgres_enum/version"
 require "active_record/postgres_enum/postgresql_adapter"
 require "active_record/postgres_enum/schema_dumper"
+require "active_record/postgres_enum/command_recorder"
 require "active_record/postgres_enum/enum_validator"
 
 ActiveSupport.on_load(:active_record) do
   require "active_record/postgres_enum/extensions"
 
   ActiveRecord::SchemaDumper.prepend ActiveRecord::PostgresEnum::SchemaDumper
+
   ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend ActiveRecord::PostgresEnum::PostgreSQLAdapter
 
+  if defined?(ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnDumper)
+    ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnDumper.prepend(
+      ActiveRecord::PostgresEnum::PostgreSQLAdapter::ColumnDumperExt
+    )
+  end
+
+  if defined?(ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper)
+    ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend(
+      ActiveRecord::PostgresEnum::PostgreSQLAdapter::SchemaDumperExt
+    )
+  end
+
   ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:enum] = {
     name: 'enum'
   }
+
+  ActiveRecord::Migration::CommandRecorder.prepend ActiveRecord::PostgresEnum::CommandRecorder
 end

data/lib/active_record/postgres_enum/command_recorder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PostgresEnum
+    module CommandRecorder
+      def create_enum(name, values)
+        record(:create_enum, [name, values])
+      end
+
+      def invert_create_enum(args)
+        [:drop_enum, args.first]
+      end
+
+      def rename_enum(name, new_name)
+        record(:rename_enum, [name, new_name])
+      end
+
+      def invert_rename_enum(args)
+        [:rename_enum, args.reverse]
+      end
+
+      def rename_enum_value(name, existing_value, new_value)
+        record(:rename_enum_value, [name, existing_value, new_value])
+      end
+
+      def invert_rename_enum_value(args)
+        [:rename_enum_value, [args.first] + args.last(2).reverse]
+      end
+    end
+  end
+end

data/lib/active_record/postgres_enum/extensions.rb

@@ -7,9 +7,9 @@ module ActiveRecord
         class Enum < Type::Value # :nodoc:
           attr_reader :enum_name
 
-          def initialize(options = {})
-            @enum_name = options.delete(:enum_name).to_sym
-            super
+          def initialize(enum_name:, **kwargs)
+            @enum_name = enum_name.to_sym
+            super(**kwargs)
           end
         end
 

data/lib/active_record/postgres_enum/postgresql_adapter.rb

@@ -3,8 +3,32 @@
 module ActiveRecord
   module PostgresEnum
     module PostgreSQLAdapter
+      # For Rails >= 5.2
+      # https://github.com/rails/rails/blob/5-2-stable/activerecord/lib/active_record/connection_adapters/postgresql/schema_dumper.rb
+      module SchemaDumperExt
+        def prepare_column_options(column)
+          spec = super
+          spec[:enum_name] = column.sql_type.inspect if column.type == :enum
+          spec
+        end
+      end
+
+      # For Rails <5.2
+      # https://github.com/rails/rails/blob/5-1-stable/activerecord/lib/active_record/connection_adapters/postgresql/schema_dumper.rb
+      module ColumnDumperExt
+        def prepare_column_options(column)
+          spec = super
+          spec[:enum_name] = column.sql_type.inspect if column.type == :enum
+          spec
+        end
+      end
+
       DEFINED_ENUMS_QUERY = <<~SQL
-        SELECT t.OID, t.typname, t.typtype, array_agg(e.enumlabel) as enumlabels
+        SELECT
+          t.OID,
+          t.typname,
+          t.typtype,
+          array_to_string(array_agg(e.enumlabel ORDER BY e.enumsortorder), '\t\t', '') as enumlabels
         FROM pg_type t
         LEFT JOIN pg_enum e ON e.enumtypid = t.oid
         WHERE typtype = 'e'
@@ -14,12 +38,12 @@ module ActiveRecord
 
       def enums
         select_all(DEFINED_ENUMS_QUERY).each_with_object({}) do |row, memo|
-          memo[row["typname"].to_sym] = row['enumlabels'].gsub(/[{}]/, '').gsub('NULL', '').split(',').sort
+          memo[row["typname"].to_sym] = row['enumlabels'].split("\t\t")
         end
       end
 
       def create_enum(name, values)
-        values = values.map { |v| "'#{v}'" }
+        values = values.map { |v| quote v }
         execute "CREATE TYPE #{name} AS ENUM (#{values.join(', ')})"
       end
 
@@ -31,14 +55,20 @@ module ActiveRecord
         execute "ALTER TYPE #{name} RENAME TO #{new_name}"
       end
 
-      def add_enum_value(name, value)
-        execute "ALTER TYPE #{name} ADD VALUE '#{value}'"
+      def add_enum_value(name, value, after: nil, before: nil)
+        sql = "ALTER TYPE #{name} ADD VALUE #{quote value}"
+        if after
+          sql += " AFTER #{quote after}"
+        elsif before
+          sql += " BEFORE #{quote before}"
+        end
+        execute sql
       end
 
       def rename_enum_value(name, existing_value, new_value)
         raise "Renaming enum values is only supported in PostgreSQL 10.0+" unless rename_enum_value_supported?
 
-        execute "ALTER TYPE #{name} RENAME VALUE '#{existing_value}' TO '#{new_value}'"
+        execute "ALTER TYPE #{name} RENAME VALUE #{quote existing_value} TO #{quote new_value}"
       end
 
       def migration_keys

data/lib/active_record/postgres_enum/schema_dumper.rb

@@ -16,8 +16,8 @@ module ActiveRecord
         statements = []
 
         @connection.enums.each do |name, values|
-          values = values.map(&:inspect).join(', ')
-          statements << "  create_enum('#{name}', [#{values}])"
+          values = values.map { |v| "    #{v.inspect}," }.join("\n")
+          statements << "  create_enum #{name.inspect}, [\n#{values}\n  ]"
         end
 
         stream.puts statements.join("\n")

data/lib/active_record/postgres_enum/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module PostgresEnum
-    VERSION = "0.4.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_enum
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -100,42 +106,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +152,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/active_record/postgres_enum.rb
+- lib/active_record/postgres_enum/command_recorder.rb
 - lib/active_record/postgres_enum/enum_validator.rb
 - lib/active_record/postgres_enum/extensions.rb
 - lib/active_record/postgres_enum/postgresql_adapter.rb
@@ -186,8 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Integrate PostgreSQL's enum data type into ActiveRecord's schema and migrations.