activerecord-postgres_enum 0.5.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc8b2da12bdecab45218daa75f6f4a6e6d560e87c20f3c20024a268757e609b
-  data.tar.gz: ee367a630606e4dd7902d310179156afe5213d568a2507ccfed7ad96f2b82544
+  metadata.gz: 65fc162010507d18b3607853f938bc02f2106ba56764d020943a241c00af3f07
+  data.tar.gz: 42eb21dd6b8441e8ca5589b38a30da8cbc646de28c89ecf58f09df5c92c67f54
 SHA512:
-  metadata.gz: fc9bf477c7369bd0753f728cea8ec8ae147ac5834dce7282f4289d18cbb5e3148e28bae8d0d286328864351afee588c73ade4d1b2e5b66a23f0547384aa0b224
-  data.tar.gz: b48a4817f9ff6cfbbe8e5b36538c9ae900b9dfacd2dd0c8463f6c86bee4fbfaa33431dfa48ef8af66cd794e641b80acecbe2552ee78760ce185722e1128ad75c
+  metadata.gz: 753abb413ecf0ee2a32e68c3bf1be93c3678c75b1b578a9c3177426bb31a8bbeff9010dc7550f66a2b710394ca97eb11e17eaeedbd17d1f6f0ddb7ddd1ce5799
+  data.tar.gz: 76200a6b37e19b00066a133d5ae377f9a3396681ac7bda6031b1cb89a1c0316ea9ae2c1de69c0f0ea1eb0fab196abad4cd7f0be23f7e04ae0fb34de614a51216

data/README.md

@@ -53,15 +53,36 @@ rename_enum :mood, :emotions
 To add a value into existing enum:
 
 ```ruby
-add_enum_value :mood, "crazy"
+add_enum_value :mood, "pensive"
+```
+
+To remove a value from existing enum:
+
+> :warning: Make sure that value is not used anywhere in the database.
+
+```ruby
+remove_enum_value :mood, "pensive"
+```
+
+To add a new enum column to an existing table:
+
+```ruby
+def change
+  create_enum :product_type, %w[one-off subscription]
+
+  add_column :products, :type, :product_type
+end
 ```
 
 To rename a value:
 
 ```ruby
-rename_enum_value :mood, "crazy", "nutty"
+rename_enum_value :mood, "pensive", "wistful"
 ```
 
+**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.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/active_record/postgres_enum.rb

@@ -9,6 +9,7 @@ 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
@@ -33,4 +34,6 @@ ActiveSupport.on_load(:active_record) do
   ::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

@@ -24,7 +24,11 @@ module ActiveRecord
       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'
@@ -34,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
 
@@ -51,14 +55,31 @@ 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, if_not_exists: nil)
+        if_not_exists_statement = 'IF NOT EXISTS' if if_not_exists
+
+        sql = "ALTER TYPE #{name} ADD VALUE #{if_not_exists_statement} #{quote value}"
+        if after
+          sql += " AFTER #{quote after}"
+        elsif before
+          sql += " BEFORE #{quote before}"
+        end
+        execute sql
+      end
+
+      def remove_enum_value(name, value)
+        sql = %{
+          DELETE FROM pg_enum
+          WHERE enumlabel=#{quote value}
+          AND enumtypid=(SELECT oid FROM pg_type WHERE typname='#{name}')
+        }
+        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.inspect}, [#{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.5.1"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_enum
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2020-07-24 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.