activerecord-pg_enum 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bbfe6c729c9007f5ef0957ac8cb1854ca3f1c4735e32ad77f2e69acd919299e
-  data.tar.gz: f6ab04b012fb0be96ec35e5ba94457d01815bcfadebcabba72fd34688b11baa3
+  metadata.gz: cd614eca633279bd5a19660137152b8461356b8431fea368a3c3a947c64715f7
+  data.tar.gz: ce1bba6131f601029c42402e2561869530f4a2ff2bc0d38a56b84c3ba9226f03
 SHA512:
-  metadata.gz: fc82a1ac6688320020943da922e8d409198a7461d635a0eb1a046a0442bdbf2164638352287532dc7ec991083a6fdc2cd8f824c23ff93dd2ff7480a93797e6cb
-  data.tar.gz: 6a93c60c30d7b1e89f21473b6d6459c14f157d00dec1ecd69154dfdcc609b01466f7aa16b8a69dbe60fe03f8c0444cfad5e9ae0c54bc010ecd71bdff8ddae2a9
+  metadata.gz: '095f6470ee10ea1c3499b8452cf5e0d9e8d8e5cbc937e91969014574c6558eec1bc30a85306017a98a5e6ae2ddc631381ca91af5d4eb8a4c8991d50dc4575bf2'
+  data.tar.gz: ad1ecac7919ea5e73a0653bc8700403b002a5ca518ef305d713c2a22f1ab8bd13ae17f54652bd0c07cdc72cf425ae5bcdaeb9668443627f4891887557dea02f5

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.2.0] - 2018-08-18
+### Changed
+- Change API of `create_enum` to take two arguments instead, the name and an array of values
+
 ## [0.1.1] - 2018-08-14
 - Bump Ruby requirement to 2.2.2 (for Rails 5.2) until earlier framework versions are supported.
 - `enum_types` are listed in alphabetical order

data/README.md

@@ -2,6 +2,12 @@
 
 This gem is a small monkeypatch to ActiveRecord so that your `schema.rb` file can support PostgreSQL's native enumerated types.
 
+This will allow you to use enum columns in your database without replacing `schema.rb` with `structure.sql`.
+
+## Version support
+
+Currently only Rails 5.2 is supported. Support for previous versions going back to 4.1 are planned.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +26,57 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Migrations
+
+Defining a new ENUM
+
+```ruby
+class AddContactMethodType < ActiveRecord::Migration[5.2]
+  def up
+    create_enum "contact_method_type", %w[Email Phone]
+  end
+
+  def down
+    drop_enum "contact_method_type"
+  end
+end
+```
+
+Adding a value to an existing ENUM
+
+```ruby
+class AddSMSToContactMethodType < ActiveRecord::Migration[5.2]
+  def up
+    add_enum_value "contact_method_type", "SMS", before: "Phone"
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end
+```
+
+### Helper Methods
+
+```ruby
+class ContactInfo < ActiveRecord::Base
+  include ActiveRecord::PGEnum::Helper
+
+  pg_enum contact_method: %w[Email SMS Phone]
+end
+```
+
+`pg_enum` is a wrapper around the official `enum` method that converts array syntax into strings. The above example is equivalent to:
+
+```ruby
+class ContactInfo < ActiveRecord::Base
+  include ActiveRecord::PGEnum::Helper
+
+  enum contact_method: { Email: "Email", SMS: "SMS", Phone: "Phone" }
+end
+```
+
+There's no technical reason why you couldn't detect enum columns at startup time and automatically do this wireup, but I feel that the benefit of self-documenting outweighs the convenience.
 
 ## Development
 

data/lib/active_record/pg_enum/schema_dumper.rb

@@ -14,7 +14,7 @@ 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 |name, definition|
-          stream.puts %Q{  create_enum "#{name}", "#{definition.join("\", \"")}"}
+          stream.puts %Q{  create_enum "#{name}", %w[#{definition.join(" ")}]"}
         end
 
         stream.puts

data/lib/active_record/pg_enum/schema_statements.rb

@@ -6,12 +6,12 @@ module ActiveRecord
       # Example:
       #
       #   create_enum("foo_type", "foo", "bar", "baz")
-      def create_enum(name, *values)
-        execute "CREATE TYPE #{name} AS ENUM (#{values.map { |v| "'#{v}'" }.join(", ")})"
+      def create_enum(name, values)
+        execute "CREATE TYPE #{name} AS ENUM (#{Array(values).map { |v| "'#{v}'" }.join(", ")})"
       end
 
       # Drop an ENUM type from the database.
-      def drop_enum(name, *values_for_revert)
+      def drop_enum(name, values_for_revert = nil)
         execute "DROP TYPE #{name}"
       end
 

data/lib/active_record/pg_enum/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module PGEnum
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Lassek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg