ar-enum 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fafa2cb564dcb6f21264144628705d9c7d68af50a13ea21638ef448a447de8a
-  data.tar.gz: 607ed017f7d41594e0c1c48d89a854b3921607236a859160076491c8091118dc
+  metadata.gz: 7d0d98ef7326a262b83b299baaf0912de2452f3cfba75e4ce47365896fa82bdc
+  data.tar.gz: 825fb4e5a0e0911eaff410324abaf15a72251b5434dbfcbfb2f71b57cbf161c4
 SHA512:
-  metadata.gz: 57fceb9b862e7bb38e953bedd08843af834fe5f35e8665388441a712b520eebd4991f6520275d5a1f71f4f186058f35eb3180e139c03456f027af89b78ad2e61
-  data.tar.gz: ebf8f91d84c179226b6303faaad634059336bc1da8edd8ff641d8ffc6c234fa2f7bf002bfadf90fc24f05d3677ade918555bc1f642c31a2171328459b320735c
+  metadata.gz: a13ac7fde7ec4ddb9ec49182b16cfe23d8c0ce1f1e3c6313dda9714f5e0b5b7a57d608196fb9c47c43f59019a8132ecc8f1b8118f4b61fc514b9d277db2869e1
+  data.tar.gz: d40f5cb1237b57d14b5d188ef4bbfd56a590658ae93f5e640490692d7a961eea5fe5d2e18d4877b3cc133273f0dcde0ed54508327acb4930ec689608e21e8ede

data/README.md

@@ -26,6 +26,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Creating enums
+
 To create a `enum` type, use the method `create_enum`.
 
 ```ruby
@@ -38,6 +40,8 @@ create_table :articles do |t|
 end
 ```
 
+### Dropping enums
+
 To remove the enum, use `drop_enum`.
 
 ```ruby
@@ -57,6 +61,8 @@ change_column :articles, :status, :text
 drop_enum :article_status
 ```
 
+### Adding new labels
+
 Use `add_enum_label` to add new values to the enum type. You can control where the value will be inserted by using `before: label` and `after: label`.
 
 ```ruby
@@ -72,16 +78,34 @@ add_enum_value :article_status, "unlisted", after: "draft"
 add_enum_value :article_status, "unlisted", before: "published"
 ```
 
+**WARNING:** PostgreSQL does not have a way of removing values from enum types.
+
+### Renaming existing labels
+
 Use `rename_enum_label` to rename a value.
 
 ```ruby
 create_enum :article_status, %w[draft unlisted published]
 
-# labels will be [draft, hidden, unlisted]
-rename_enum_label :article_status, "unlisted", "hidden"
+# labels will be [draft, unlisted, live]
+rename_enum_label :article_status, "published", "live"
 ```
 
-**WARNING:** PostgreSQL does not have a way of removing values from enum types.
+### Reversing changes
+
+The following commands can be reversed:
+
+- `create_enum`
+- `rename_enum_label`
+
+
+```ruby
+class CreateColorEnumClass < ActiveRecord::Migration
+  def change
+    create_enum :color, %w[red blue black]
+  end
+end
+```
 
 ## Development
 

data/lib/ar/enum.rb

@@ -4,14 +4,17 @@ require "active_support/all"
 require "active_record"
 require "active_record/connection_adapters/postgresql_adapter"
 require "active_record/schema_dumper"
+require "active_record/migration/command_recorder"
 require "ar/enum/version"
 
 module AR
   module Enum
     require "ar/enum/adapter"
     require "ar/enum/schema_dumper"
+    require "ar/enum/command_recorder"
   end
 end
 
+ActiveRecord::Migration::CommandRecorder.include AR::Enum::CommandRecorder
 ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include AR::Enum::Adapter
 ActiveRecord::SchemaDumper.prepend AR::Enum::SchemaDumper

data/lib/ar/enum/command_recorder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AR
+  module Enum
+    module CommandRecorder
+      def create_enum(name, values)
+        record(__method__, [name, values])
+      end
+
+      def rename_enum_label(name, from, to)
+        record(__method__, [name, from, to])
+      end
+
+      def invert_create_enum(args)
+        name, _ = args
+        [:drop_enum, name]
+      end
+
+      def invert_rename_enum_label(args)
+        name, to, from = args
+        [:rename_enum_label, [name, from, to]]
+      end
+    end
+  end
+end

data/lib/ar/enum/version.rb

@@ -2,6 +2,6 @@
 
 module AR
   module Enum
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ar-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nando Vieira
@@ -129,6 +129,7 @@ files:
 - lib/ar-enum.rb
 - lib/ar/enum.rb
 - lib/ar/enum/adapter.rb
+- lib/ar/enum/command_recorder.rb
 - lib/ar/enum/schema_dumper.rb
 - lib/ar/enum/version.rb
 homepage: https://rubygems.org/gems/ar-enum