activerecord-pg_enum 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d75573d2938384fe7b152068e7ea8574c06edd54a568288d32fc02e97ba91d
-  data.tar.gz: 8eb7a669608474a001058437252519035b6a59d4663ab83aab470b92603f3869
+  metadata.gz: 33a876e540cf1813b1d54ed406ce47ef39c49168e45967452e587f3e34617348
+  data.tar.gz: acd215db0882fac1c90303721b1118b06a036f006e7b4eb66a1efbb6df5d781c
 SHA512:
-  metadata.gz: da008c7e1bbc9304dd4ce5570b4800abefc6e1caca83d20c11fa1bdf3e29e8665ff6184f569edde7a1b106b5b4976ad23eb3dc4dc62b7c2d8854b66935f5483a
-  data.tar.gz: dd7f6e35923433c9cc97cc44560904407a04c1f50036fcb3e5ec13b8a9be41e65de3b1b67632dbc0d0f98130e36fedeeee4407070e15e36a111bde4e19ec9984
+  metadata.gz: 4d897a53720eebf23d808eb4a5c927db868a69055d6f77919a0f3f20d6a8ece2a27be4d53edc0e94d767e17711b8e50d24e30055f37da8985e2e3ecefe26bab9
+  data.tar.gz: 5c733a6b3c41a56325c290ee6f46756f18217f3d64b0a8e9b70d9bccbe4a6b01be893f788ddf3fc4ccb92c1de64573b590b11a95eb226e4252077b41b65a98e3

data/.travis.yml

@@ -1,6 +1,7 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.1
   - 2.5
 services:
   - postgresql

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2018-08-12
+### Added
+- `add_to_enum` for modifying existing types
+- `ActiveRecord::Migration::CommandRecorder` is patched to make `create_enum`, and `drop_enum` reversible.
+
+### Changed
+- Ruby 2.1 is defined as the earliest supported version (for kwargs)
+- `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter#enum_types` returns a Hash instead of a nested Array

data/activerecord-pg_enum.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
+  spec.required_ruby_version = ">= 2.1"
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/lib/active_record/pg_enum.rb

@@ -5,6 +5,7 @@ require "active_record/connection_adapters/postgresql_adapter"
 require "active_support/lazy_load_hooks"
 
 ActiveSupport.on_load(:active_record) do
+  require "active_record/pg_enum/command_recorder"
   require "active_record/pg_enum/postgresql_adapter"
   require "active_record/pg_enum/schema_dumper"
   require "active_record/pg_enum/schema_statements"
@@ -16,4 +17,5 @@ ActiveSupport.on_load(:active_record) do
 
   ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::PostgreSQLAdapter
   ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::SchemaStatements
+  ActiveRecord::Migration::CommandRecorder.include ActiveRecord::PGEnum::CommandRecorder
 end

data/lib/active_record/pg_enum/command_recorder.rb

@@ -0,0 +1,48 @@
+module ActiveRecord
+  module PGEnum
+    # ActiveRecord::Migration::CommandRecorder is a class used by reversible migrations.
+    # It captures the forward migration commands and translates them into their inverse
+    # by way of some simple metaprogramming.
+    #
+    # The Migrator class uses CommandRecorder during the reverse migration instead of
+    # the connection object. Forward migration calls are translated to their inverse
+    # where possible, and then forwarded to the connetion. Irreversible migrations
+    # raise an exception.
+    #
+    # Known schema statement methods are metaprogrammed into an inverse method like so:
+    #
+    #   create_table => invert_create_table
+    #
+    # which returns:
+    #
+    #   [:drop_table, args.first]
+    module CommandRecorder
+      def create_enum(*args, &block)
+        record(:create_enum, args, &block)
+      end
+
+      def drop_enum(*args, &block)
+        record(:drop_enum, args, &block)
+      end
+
+      def add_enum_value(*args, &block)
+        record(:add_enum_value, args, &block)
+      end
+
+      private
+
+      def invert_create_enum(args)
+        [:drop_enum, args]
+      end
+
+      def invert_drop_enum(args)
+        raise ActiveRecord::IrreversibleMigration, "drop_enum is only reversible if given a list of values" unless args.length > 1
+        [:create_enum, args]
+      end
+
+      def invert_add_enum_value(args)
+        raise ActiveRecord::IrreversibleMigration, "ENUM values cannot be removed once added. Drop and Replace it instead at your own risk."
+      end
+    end
+  end
+end

data/lib/active_record/pg_enum/postgresql_adapter.rb

@@ -1,6 +1,11 @@
 module ActiveRecord
   module PGEnum
     module PostgreSQLAdapter
+      # Helper method used by the monkeypatch internals. Provides a hash of ENUM types as they exist currently.
+      #
+      # Example:
+      #
+      #   { "foo_type" => ["foo", "bar", "baz"] }
       def enum_types
         res = exec_query(<<-SQL.strip_heredoc, "SCHEMA").cast_values
           SELECT t.typname AS enum_name, string_agg(e.enumlabel, ' ' ORDER BY e.enumsortorder) AS enum_value
@@ -11,8 +16,9 @@ module ActiveRecord
           GROUP BY enum_name
         SQL
 
-        res.map do |(name, values)|
-          [name, values.split(" ")]
+        res.inject({}) do |memo, (name, values)|
+          memo[name] = values.split(" ")
+          memo
         end
       end
     end

data/lib/active_record/pg_enum/schema_dumper.rb

@@ -13,13 +13,14 @@ module ActiveRecord
 
         stream.puts "  # These are custom enum types that must be created before they can be used in the schema definition"
 
-        enum_types.each do |enum_type|
-          stream.puts %Q{  create_enum "#{enum_type.first}", "#{enum_type.second.join("\", \"")}"}
+        enum_types.each do |name, definition|
+          stream.puts %Q{  create_enum "#{name}", "#{definition.join("\", \"")}"}
         end
 
         stream.puts
       end
 
+      # Gathers the arguments needed for the column line inside the create_table block.
       def column_spec(column)
         if column.type == :enum
           ["column", [column.sql_type.inspect, prepare_column_options(column)]]
@@ -28,6 +29,7 @@ module ActiveRecord
         end
       end
 
+      # Takes a column specification in Object form and serializes it into a String.
       def format_colspec(colspec)
         case colspec
         when String

data/lib/active_record/pg_enum/schema_statements.rb

@@ -1,13 +1,43 @@
 module ActiveRecord
   module PGEnum
     module SchemaStatements
+      # Create a new ENUM type, with an arbitrary number of values.
+      #
+      # Example:
+      #
+      #   create_enum("foo_type", "foo", "bar", "baz")
       def create_enum(name, *values)
         execute "CREATE TYPE #{name} AS ENUM (#{values.map { |v| "'#{v}'" }.join(", ")})"
       end
 
-      def drop_enum(name)
+      # Drop an ENUM type from the database.
+      def drop_enum(name, *values_for_revert)
         execute "DROP TYPE #{name}"
       end
+
+      # Add a new value to an existing ENUM type.
+      # Only one value at a time is supported by PostgreSQL.
+      #
+      # Options:
+      #   before: add value BEFORE the given value
+      #   after:  add value AFTER the given value
+      #
+      # Example:
+      #
+      #   add_enum_value("foo_type", "quux", before: "bar")
+      def add_enum_value(type, value, before: nil, after: nil)
+        cmd = "ALTER TYPE #{type} ADD VALUE '#{value}'"
+
+        if before && after
+          raise ArgumentError, "Cannot have both :before and :after at the same time"
+        elsif before
+          cmd << " BEFORE '#{before}'"
+        elsif after
+          cmd << " AFTER '#{after}'"
+        end
+
+        execute cmd
+      end
     end
   end
 end

data/lib/active_record/pg_enum/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module PGEnum
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg_enum
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Lassek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -119,6 +119,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -127,6 +128,7 @@ files:
 - bin/console
 - bin/setup
 - lib/active_record/pg_enum.rb
+- lib/active_record/pg_enum/command_recorder.rb
 - lib/active_record/pg_enum/helper.rb
 - lib/active_record/pg_enum/postgresql_adapter.rb
 - lib/active_record/pg_enum/schema_dumper.rb
@@ -145,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -153,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Integrate PostgreSQL's enumerated types with the Rails enum feature