activerecord-postgres_enum 0.5.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fd9c6d97f0434ff36fd04e33b64cd039ea6fc10afcc0dfb0d90728e4317e5ee
-  data.tar.gz: 731183b8229e9c84d4bbefff1010e9825c274f93a06d0d26c5b53753ef187a54
+  metadata.gz: 2e453014b2e32bcb23b20fd8c1f2dbb628690f303a61368bfad37564868244e4
+  data.tar.gz: 55b98925e297a91892c5c284e53564a6012cdb82e2494b93505974207e8d7de2
 SHA512:
-  metadata.gz: e12752bf700f712f6e82a473992a84a0a6d86b8d2c8931dd993bc24e80fe7251c5ef2a98e6af2094e0fe294e1562e32dde3954df3277d3eb4c11cec08bfc8fd8
-  data.tar.gz: dc34f7be14cecd03afcea23fb279a57383296b673d7ed3721d837e394b22ac5e69e1d1944e48519099b3f56d587eddf2ceffdd0283e559b1641b261851a4932f
+  metadata.gz: 45e0ba20aeaf52968c9022fca7aed356272ad2deb9883c98020d0bcdc17dfa73786fac4776f1f8cd02b45babe4a1344b5bcf9e516b8c3161275713910babc797
+  data.tar.gz: 66fd78a22198c3326b66ce410fac6782599164d3087473b1e3d5550e94801af37407d85786ca38c5f4c5c0503b5320dcde7c377a5d1ef3f94db72f4b236a73f2

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/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,31 +38,54 @@ 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}'" }
+      def create_enum(name, values, if_not_exists: nil)
+        return if if_not_exists && enums.include?(name.to_sym)
+
+        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)
-        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.2"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_enum
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2020-07-26 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: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -173,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.