activerecord-postgres_enum 0.6.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e43929712c3569c4b839d4c3464681e4841faf269e669ecb87ce36866b079ac
-  data.tar.gz: 25a312a9bab4f9af1c69b5e4ae39826053da9e0757be8cab4dbb96ce3549288a
+  metadata.gz: 27d16c338c8dcb14b9746be0e941981230c9a7eee7e4704755da15ed9869025a
+  data.tar.gz: 5077374a8566971f0236c67e4d52ae0467659f5fe14d384ec331bb58bbfb2df3
 SHA512:
-  metadata.gz: af99b8890d255f425db4ad5b013c10ec88dac286b56286cd08a78ef519935032bf6b0ed53b65402e1cdc3fbaf7df73094f0febfca08d189a26ec6919b3ff9d78
-  data.tar.gz: 066a1f40435ea2e4ecde9384bb6ef21cdf5e4175bc2fbe4f2a0b221f26a4a598b2cc7c9e2c7c1d2bce532263a9d39c9c5c7bf9564627450d65b6a5d20db4917a
+  metadata.gz: a58d412d08199ef784ec320d8534c39b58d150c7bc423aa493ac50602edbb9bd20e6cd176e989ec6629659ceb53117576ae98fb27ba0be9186d5c6bda6d11527
+  data.tar.gz: 39a6e9e9bb211cc7c3931f13459b83bf747398d0b0b94df3da0f9471565931b553beedb08b9e645c13654c5e1231f6c99b37c303133a454b80a5ce10c3e8b8ea

data/README.md

@@ -56,12 +56,33 @@ To add a value into existing enum:
 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, "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/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

@@ -42,21 +42,31 @@ module ActiveRecord
         end
       end
 
-      def create_enum(name, values)
+      def create_enum(name, values, force: false, if_not_exists: nil)
+        return if if_not_exists && enums.include?(name.to_sym)
+
+        drop_enum(name, cascade: force == :cascade, if_exists: true) if force
+
         values = values.map { |v| quote v }
         execute "CREATE TYPE #{name} AS ENUM (#{values.join(', ')})"
       end
 
-      def drop_enum(name)
-        execute "DROP TYPE #{name}"
+      def drop_enum(name, cascade: nil, if_exists: nil)
+        if_exists_statement = 'IF EXISTS' if if_exists
+        cascade_statement = 'CASCADE' if cascade
+
+        sql = "DROP TYPE #{if_exists_statement} #{name} #{cascade_statement}"
+        execute sql
       end
 
       def rename_enum(name, new_name)
         execute "ALTER TYPE #{name} RENAME TO #{new_name}"
       end
 
-      def add_enum_value(name, value, after: nil, before: nil)
-        sql = "ALTER TYPE #{name} ADD VALUE #{quote 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
@@ -65,6 +75,15 @@ module ActiveRecord
         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?
 

data/lib/active_record/postgres_enum/schema_dumper.rb

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

data/lib/active_record/postgres_enum/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module PostgresEnum
-    VERSION = "0.6.0"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_enum
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2020-08-21 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
@@ -100,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -166,15 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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.