activerecord-postgres_enum 1.0.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e97d08a739660755211e03868a76e345eba7546be13b374619a644dfa048ab11
-  data.tar.gz: d37271b37da014e68ad570a071e8841e3e851552d001084ac5668b4bd43b58f6
+  metadata.gz: ac2154f798abecd00d17ad2ddb22307b9567113d10bb6e46b93ac2696a166afe
+  data.tar.gz: 75925162b95e2e293bf6f6834dbc05bea188ad40b35aac7d7c5b3f0ac36caf59
 SHA512:
-  metadata.gz: b1486eeb1f2621cc0f2625fffb52ccbb56c272c95238587a93a7ced95ec743aeb333ee441cfc566d9a6d346e896ef3300dbef8f5348632d0b9e3c527adedbcb4
-  data.tar.gz: 338a9914209f6797286e6e90658a867682289909539cadb4c3d8e4de5cf7ebd6ad6d803c2e1ed7e197f0fbe0e2134c8dc9542da937708d5640bcaf6c5930a2a5
+  metadata.gz: 8a8599019f7412e927bce0a25c5ae26de5a7b0e197a7a4c5da54f53edcb888e4bb6b7e0414d20f461fa61b2f33f2927e7edd67542eb8e968ed4766d25a15a811
+  data.tar.gz: 1042bdcdd209e900527348265f906da95773635053118806ea7107f2496f6da39c3b885024d28b7fdcb292fb0868a11ed1aa277e37e9aeea8cab4389ba835599

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/activerecord-postgres_enum.svg)](https://badge.fury.io/rb/activerecord-postgres_enum)
-[![Build Status](https://travis-ci.org/bibendi/activerecord-postgres_enum.svg?branch=master)](https://travis-ci.org/bibendi/activerecord-postgres_enum)
+[![Build Status](https://github.com/bibendi/activerecord-postgres_enum/workflows/Ruby/badge.svg?branch=master)](https://github.com/bibendi/activerecord-postgres_enum/actions?query=branch%3Amaster)
 
 # ActiveRecord::PostgresEnum
 
@@ -56,7 +56,23 @@ To add a value into existing enum:
 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 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:
 
@@ -64,6 +80,9 @@ To rename a value:
 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

@@ -32,7 +32,7 @@ ActiveSupport.on_load(:active_record) do
   end
 
   ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:enum] = {
-    name: 'enum'
+    name: "enum"
   }
 
   ActiveRecord::Migration::CommandRecorder.prepend ActiveRecord::PostgresEnum::CommandRecorder

data/lib/active_record/postgres_enum/extensions.rb

@@ -16,7 +16,7 @@ module ActiveRecord
         class TypeMapInitializer
           # We need to know the column name, and the default implementation discards it
           def register_enum_type(row)
-            register row['oid'], OID::Enum.new(enum_name: row['typname'])
+            register row["oid"], OID::Enum.new(enum_name: row["typname"])
           end
         end
       end

data/lib/active_record/postgres_enum/postgresql_adapter.rb

@@ -38,25 +38,35 @@ module ActiveRecord
 
       def enums
         select_all(DEFINED_ENUMS_QUERY).each_with_object({}) do |row, memo|
-          memo[row["typname"].to_sym] = row['enumlabels'].split("\t\t")
+          memo[row["typname"].to_sym] = row["enumlabels"].split("\t\t")
         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(', ')})"
+        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 = "1.0.0"
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +120,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '0.10'
 description: 
 email:
 - merkushin.m.s@gmail.com
@@ -172,7 +172,7 @@ 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:
   - - ">="