activerecord-pg_enum 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 375facb22f785682bbc48ddd221c8fd2ccd7c1d5
-  data.tar.gz: 61d7656a02c14feb0e6d591dbb3ecd15839a6154
+SHA256:
+  metadata.gz: fff1e0a83e5de4507a70ca673c8dbe261715810cda9936430a4c73673b74c623
+  data.tar.gz: 4a02ec6d42efb7fdec11f5cd5ceeee2200b47d6e544202d6eef6fa7947bef69d
 SHA512:
-  metadata.gz: dcd88c40ee6625cdf4120e06def40dcdbe5573ccebb77f710e62bfa037222d896a64762798a6ba8736bbbf7e89702633771f20671f92cd63c7a603a5c7cc6293
-  data.tar.gz: be1393454674cd111816dc113902d4240cbd0ff0a10e5cd4441dbe87fa1daaf98920eaf20ece41e5a494802a2e0c33c6b79e766261320f4920334eb33be2d61e
+  metadata.gz: 61cdf54e236bb77fc2196779ff2c8300ef504a23a5d714a63ab9423d3d02bc3fef7f31c598dda827db950652f9eb680ce01e7c54ab0bb7b2d63b6fcd364a2844
+  data.tar.gz: f546fa5f64257640d9bc4889bea00fd23e52033928a7f7623e571be48f16ce8358904caffac975994404b73115bb0214e124e4f8f36be88b3beef55085d06caa

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.4.0] - 2019-06-19
+### Added
+- `enum` method on `TableDefinition`
+
+### Changed
+- Refactored init hook to be much more flexible
+- Removed `ActiveRecord::PGEnum::Helper` in favor of `ActiveRecord::PGEnum()` module builder
+
 ## [0.3.0] - 2019-03-03
 - Support for 5.0 and 5.1
 - Change travis config to test against oldest supported version of ruby

data/README.md

@@ -58,22 +58,30 @@ class AddSMSToContactMethodType < ActiveRecord::Migration[5.2]
 end
 ```
 
-### Helper Methods
+Adding an enum column to a table
 
 ```ruby
-class ContactInfo < ActiveRecord::Base
-  include ActiveRecord::PGEnum::Helper
-
-  pg_enum contact_method: %w[Email SMS Phone]
+class AddStatusToOrder < ActiveRecord::Migration[5.2]
+  def change
+    change_table :orders do |t|
+      t.enum :status, as: "status_type"
+    end
+  end
 end
 ```
 
-`pg_enum` is a wrapper around the official `enum` method that converts array syntax into strings. The above example is equivalent to:
+### Module Builder
 
 ```ruby
 class ContactInfo < ActiveRecord::Base
-  include ActiveRecord::PGEnum::Helper
+  include ActiveRecord::PGEnum(contact_method: %w[Email SMS Phone])
+end
+```
+
+The generated module calls the official `enum` method converting array syntax into strings. The above example is equivalent to:
 
+```ruby
+class ContactInfo < ActiveRecord::Base
   enum contact_method: { Email: "Email", SMS: "SMS", Phone: "Phone" }
 end
 ```

data/gemfiles/5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    activerecord-pg_enum (0.3.0)
+    activerecord-pg_enum (0.4.0)
       activerecord (>= 5.0.0)
       activesupport
       pg

data/gemfiles/5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    activerecord-pg_enum (0.3.0)
+    activerecord-pg_enum (0.4.0)
       activerecord (>= 5.0.0)
       activesupport
       pg
@@ -68,4 +68,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/gemfiles/5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    activerecord-pg_enum (0.3.0)
+    activerecord-pg_enum (0.4.0)
       activerecord (>= 5.0.0)
       activesupport
       pg
@@ -68,4 +68,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/gemfiles/edge.gemfile.lock

@@ -66,7 +66,7 @@ GIT
 PATH
   remote: ..
   specs:
-    activerecord-pg_enum (0.3.0)
+    activerecord-pg_enum (0.4.0)
       activerecord (>= 5.0.0)
       activesupport
       pg
@@ -157,4 +157,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/lib/active_record/pg_enum/5.0/prepare_column_options.rb

@@ -0,0 +1,18 @@
+module ActiveRecord
+  module PGEnum
+    def self.install_column_options
+      require "active_record/connection_adapters/postgresql/schema_dumper"
+      ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnDumper.prepend PrepareColumnOptions
+    end
+
+    module PrepareColumnOptions
+      def prepare_column_options(column)
+        super.tap do |spec|
+          if column.type == :enum
+            spec[:as] = column.sql_type
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/pg_enum/{4.2 → 5.0}/schema_dumper.rb

@@ -1,5 +1,10 @@
 module ActiveRecord
   module PGEnum
+    def self.install_schema_dumper
+      require "active_record/schema_dumper"
+      ActiveRecord::SchemaDumper.prepend SchemaDumper
+    end
+
     module SchemaDumper
       private
 
@@ -19,18 +24,6 @@ module ActiveRecord
 
         stream.puts
       end
-
-      # Takes a column specification in Object form and serializes it into a String.
-      def format_colspec(colspec)
-        case colspec
-        when String
-          colspec
-        when Array
-          colspec.map { |value| format_colspec(value) }.select(&:present?).join(", ")
-        else
-          super
-        end
-      end
     end
   end
 end

data/lib/active_record/pg_enum/5.1/prepare_column_options.rb

@@ -0,0 +1 @@
+require "active_record/pg_enum/5.0/prepare_column_options"

data/lib/active_record/pg_enum/5.1/schema_dumper.rb

@@ -0,0 +1 @@
+require "active_record/pg_enum/5.0/schema_dumper"

data/lib/active_record/pg_enum/5.2/prepare_column_options.rb

@@ -0,0 +1,10 @@
+require "active_record/pg_enum/5.0/prepare_column_options"
+
+module ActiveRecord
+  module PGEnum
+    def self.install_column_options
+      require "active_record/connection_adapters/postgresql/schema_dumper"
+      ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend PrepareColumnOptions
+    end
+  end
+end

data/lib/active_record/pg_enum/5.2/schema_dumper.rb

@@ -0,0 +1,10 @@
+require "active_record/pg_enum/5.0/schema_dumper"
+
+module ActiveRecord
+  module PGEnum
+    def self.install_schema_dumper
+      require "active_record/connection_adapters/postgresql/schema_dumper"
+      ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend SchemaDumper
+    end
+  end
+end

data/lib/active_record/pg_enum/6.alpha/prepare_column_options.rb

@@ -0,0 +1 @@
+require "active_record/pg_enum/5.2/prepare_column_options"

data/lib/active_record/pg_enum/6.alpha/schema_dumper.rb

@@ -0,0 +1 @@
+require "active_record/pg_enum/5.2/schema_dumper"

data/lib/active_record/pg_enum/command_recorder.rb

@@ -1,5 +1,10 @@
 module ActiveRecord
   module PGEnum
+    def self.install_command_recorder
+      require "active_record/migration/command_recorder"
+      ActiveRecord::Migration::CommandRecorder.include CommandRecorder
+    end
+
     # 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.

data/lib/active_record/pg_enum/helper.rb

@@ -1,36 +1,30 @@
 module ActiveRecord
-  module PGEnum
-    module Helper
-      def self.included(klass)
-        klass.extend ClassMethods
-      end
+  # Declare an enum attribute where the values map to strings enforced by PostgreSQL's
+  # enumerated types.
+  #
+  #   class Conversation < ActiveRecord::Base
+  #     include ActiveRecord::PGEnum(status: %i[active archived])
+  #   end
+  #
+  # This is merely a wrapper over traditional enum syntax so that you can define
+  # string-based enums with an array of values.
+  def self.PGEnum(**definitions)
+    values = definitions.values.map do |value|
+      if value.is_a? Array
+        keys   = value.map(&:to_sym)
+        values = value.map(&:to_s)
 
-      module ClassMethods
-        # Declare an enum attribute where the values map to strings enforced by PostgreSQL's
-        # enumerated types.
-        #
-        #   class Conversation < ActiveRecord::Base
-        #     include ActiveRecord::PGEnum::Helper
-        #
-        #     pg_enum status: %i[active archived]
-        #   end
-        #
-        # This is merely a wrapper over traditional enum syntax so that you can define
-        # string-based enums with an array of values.
-        def pg_enum(definitions)
-          values = definitions.values.map do |value|
-            if value.is_a? Array
-              keys   = value.map(&:to_sym)
-              values = value.map(&:to_s)
+        Hash[keys.zip(values)]
+      else
+        value
+      end
+    end
 
-              Hash[keys.zip(values)]
-            else
-              value
-            end
-          end
+    Module.new do
+      define_singleton_method(:inspect) { %{ActiveRecord::PGEnum(#{definitions.keys.join(" ")})} }
 
-          enum Hash[definitions.keys.zip(values)]
-        end
+      define_singleton_method :included do |klass|
+        klass.enum Hash[definitions.keys.zip(values)]
       end
     end
   end

data/lib/active_record/pg_enum/postgresql_adapter.rb

@@ -1,5 +1,11 @@
 module ActiveRecord
   module PGEnum
+    def self.install_postgresql_adapter
+      require "active_record/connection_adapters/postgresql_adapter"
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include PostgreSQLAdapter
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.merge!(enum: { name: "enum" })
+    end
+
     module PostgreSQLAdapter
       # Helper method used by the monkeypatch internals. Provides a hash of ENUM types as they exist currently.
       #

data/lib/active_record/pg_enum/schema_statements.rb

@@ -1,5 +1,10 @@
 module ActiveRecord
   module PGEnum
+    def self.install_schema_statements
+      require "active_record/connection_adapters/postgresql/schema_statements"
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include SchemaStatements
+    end
+
     module SchemaStatements
       # Create a new ENUM type, with an arbitrary number of values.
       #

data/lib/active_record/pg_enum/table_definition.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module PGEnum
+    def self.install_table_definition
+      require "active_record/connection_adapters/postgresql_adapter"
+      ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition.include TableDefinition
+    end
+
+    module TableDefinition
+      # Create an enum column inside a TableDefinition
+      #
+      # Example:
+      #
+      #   create_table :orders do |t|
+      #     t.enum :status, as: "status_type"
+      #   end
+      def enum(name, as:, **options)
+        column(name, as, options)
+      end
+    end
+  end
+end

data/lib/active_record/pg_enum/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module PGEnum
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/active_record/pg_enum.rb

@@ -1,30 +1,39 @@
-require "active_record"
-require "active_record/connection_adapters/postgresql/schema_dumper"
-require "active_record/connection_adapters/postgresql/schema_statements"
-require "active_record/connection_adapters/postgresql_adapter"
 require "active_support/lazy_load_hooks"
+require "active_record"
 
 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_statements"
   require "active_record/pg_enum/helper"
+  ActiveRecord::PGEnum.install Gem.loaded_specs["activerecord"].version
+end
 
-  ar_version = Gem.loaded_specs["activerecord"].version
+module ActiveRecord
+  module PGEnum
+    KNOWN_VERSIONS = %w[5.0 5.1 5.2 6.alpha].map { |v| Gem::Version.new(v) }
 
-  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.merge!(enum: { name: "enum" })
+    def self.install(version)
+      major_minor = version.canonical_segments[0..1].join(".")
+      major_minor = Gem::Version.new(major_minor)
 
-  if ar_version >= Gem::Version.new("5.2.0")
-    require "active_record/pg_enum/schema_dumper"
-    ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend ActiveRecord::PGEnum::SchemaDumper
-  else
-    require "active_record/pg_enum/4.2/column_dumper"
-    require "active_record/pg_enum/4.2/schema_dumper"
-    ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnDumper.prepend ActiveRecord::PGEnum::ColumnDumper
-    ActiveRecord::SchemaDumper.prepend ActiveRecord::PGEnum::SchemaDumper
-  end
+      # Don't immediately fail if we don't yet support the current version.
+      # There's at least a chance it could work.
+      if !KNOWN_VERSIONS.include?(major_minor) && major_minor > KNOWN_VERSIONS.last
+        major_minor = KNOWN_VERSIONS.last
+        warn "[PGEnum] Current ActiveRecord version unsupported! Falling back to: #{major_minor}"
+      end
+
+      require "active_record/pg_enum/#{major_minor}/prepare_column_options"
+      require "active_record/pg_enum/#{major_minor}/schema_dumper"
+      require "active_record/pg_enum/postgresql_adapter"
+      require "active_record/pg_enum/schema_statements"
+      require "active_record/pg_enum/command_recorder"
+      require "active_record/pg_enum/table_definition"
 
-  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::PostgreSQLAdapter
-  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::SchemaStatements
-  ActiveRecord::Migration::CommandRecorder.include ActiveRecord::PGEnum::CommandRecorder
+      install_column_options
+      install_schema_dumper
+      install_postgresql_adapter
+      install_schema_statements
+      install_command_recorder
+      install_table_definition
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg_enum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Adam Lassek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -152,13 +152,19 @@ files:
 - gemfiles/edge.gemfile
 - gemfiles/edge.gemfile.lock
 - lib/active_record/pg_enum.rb
-- lib/active_record/pg_enum/4.2/column_dumper.rb
-- lib/active_record/pg_enum/4.2/schema_dumper.rb
+- lib/active_record/pg_enum/5.0/prepare_column_options.rb
+- lib/active_record/pg_enum/5.0/schema_dumper.rb
+- lib/active_record/pg_enum/5.1/prepare_column_options.rb
+- lib/active_record/pg_enum/5.1/schema_dumper.rb
+- lib/active_record/pg_enum/5.2/prepare_column_options.rb
+- lib/active_record/pg_enum/5.2/schema_dumper.rb
+- lib/active_record/pg_enum/6.alpha/prepare_column_options.rb
+- lib/active_record/pg_enum/6.alpha/schema_dumper.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
 - lib/active_record/pg_enum/schema_statements.rb
+- lib/active_record/pg_enum/table_definition.rb
 - lib/active_record/pg_enum/version.rb
 - lib/activerecord/pg_enum.rb
 homepage: https://github.com/getflywheel/activerecord-pg_enum
@@ -180,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Integrate PostgreSQL's enumerated types with the Rails enum feature

data/lib/active_record/pg_enum/4.2/column_dumper.rb

@@ -1,13 +0,0 @@
-module ActiveRecord
-  module PGEnum
-    module ColumnDumper
-      def column_spec(column)
-        if column.type == :enum
-          return ["column", [column.sql_type.inspect, prepare_column_options(column)]]
-        end
-
-        super
-      end
-    end
-  end
-end

data/lib/active_record/pg_enum/schema_dumper.rb

@@ -1,45 +0,0 @@
-module ActiveRecord
-  module PGEnum
-    module SchemaDumper
-      private
-
-      def extensions(stream)
-        super
-        enums(stream)
-      end
-
-      def enums(stream)
-        return unless (enum_types = @connection.enum_types).any?
-
-        stream.puts "  # These are custom enum types that must be created before they can be used in the schema definition"
-
-        enum_types.each do |name, definition|
-          stream.puts %Q{  create_enum "#{name}", %w[#{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
-          return ["column", [column.sql_type.inspect, prepare_column_options(column)]]
-        end
-
-        super
-      end
-
-      # Takes a column specification in Object form and serializes it into a String.
-      def format_colspec(colspec)
-        case colspec
-        when String
-          colspec
-        when Array
-          colspec.map { |value| format_colspec(value) }.select(&:present?).join(", ")
-        else
-          super
-        end
-      end
-    end
-  end
-end