pg_activerecord_enum 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86899f2fd76d82fd51e37a540b7548211d07d167
-  data.tar.gz: 469fb6907906238115839004d2f5c667ddf127dc
+  metadata.gz: 8fe9547627600e36141697fe97434cb7c0f3c7cb
+  data.tar.gz: d88758d4d17ec31e2aa20e13b169981379fd5025
 SHA512:
-  metadata.gz: cf1b2dfb1b84d758e4a54db7ead10e447e3443364c682e6d46e13fc311b6a96de0c120a1c394a835630aaed883dcd2226a42406cfeb54cbbd1329d3477d69c20
-  data.tar.gz: 7572c4c9b29ecb5e86b5172927a9d616e433e869ec130b441e868b4b6409fba97147f3cdee913810d804774b0ed8d1a68b90d675672e5bd11f2b9571911abf86
+  metadata.gz: 0f77ab292a4137eb0f3f74e685f40266fa3ca048c16bdfdab8cdc10e157ae8ce0ec4ace9596b688296f273928ca346a50ed4d01aa8df4e881c8a0d30ff276137
+  data.tar.gz: 41d06432b1edcb027536bef19bf93525ffa84608395b332f60382c221aafa01138714b607b15c149ba35487ddacf37a72bd0762f34ff4bf5f7389f372e237987

data/README.md

@@ -36,7 +36,7 @@ Migration:
 class CreateFruits < ActiveRecord::Migration[5.1]
   def change
     create_table :fruits do |t|
-      t.enum :fruit_type, values: %i[banana orange grape], allow_blank: true
+      t.enum :fruit_type, values: %i[banana orange grape], allow_blank: true, null: false, default: 'banana', index: true
       t.timestamps
     end
   end
@@ -53,7 +53,7 @@ class CreateFruits < ActiveRecord::Migration[5.1]
 end
 ```
 
-**allow_blank** adds empty value to enum.
+**allow_blank** adds empty value to enum, other options are default options for column.
 
 **Note:** migration rollback will remove enums only if other tables do not depend on them.
 
@@ -68,8 +68,8 @@ end
 
 ```ruby
 Fruit.banana.count # 0
-banana = Fruit.banana.create
-banana.banana? # true
+banana = Fruit.create
+banana.banana? # true because default
 banana.orange! #
 banana.orange? # true
 Fruit.orange.count # 1
@@ -82,10 +82,23 @@ In PostgreSQL DB:
 # select * from fruits;
  id | fruit_type |         created_at         |         updated_at         | color  
 ----+------------+----------------------------+----------------------------+--------
-  1 | grape      | 2018-02-19 04:07:20.548005 | 2018-02-19 04:07:20.554754 | yellow
+  3 | orange     | 2018-02-28 20:45:13.724395 | 2018-02-28 20:45:13.731656 | orange
 (1 row)
 
-=# \dT+ fruit_type;
+# \d fruits
+                                     Table "public.fruits"
+   Column   |            Type             |                      Modifiers                      
+------------+-----------------------------+-----------------------------------------------------
+ id         | bigint                      | not null default nextval('fruits_id_seq'::regclass)
+ fruit_type | fruit_type                  | not null default 'banana'::fruit_type
+ created_at | timestamp without time zone | not null
+ updated_at | timestamp without time zone | not null
+ color      | color                       | 
+Indexes:
+    "fruits_pkey" PRIMARY KEY, btree (id)
+    "index_fruits_on_fruit_type" btree (fruit_type)
+    
+# \dT+ fruit_type;
                                          List of data types
  Schema |    Name    | Internal name | Size | Elements |  Owner   | Access privileges | Description 
 --------+------------+---------------+------+----------+----------+-------------------+-------------
@@ -95,17 +108,29 @@ In PostgreSQL DB:
         |            |               |      |          |          |                   | 
 (1 row)
 
-=# \dT+ color;
+# \dT+ color;
                                       List of data types
  Schema | Name  | Internal name | Size | Elements |  Owner   | Access privileges | Description 
 --------+-------+---------------+------+----------+----------+-------------------+-------------
  public | color | color         | 4    | red     +| postgres |                   | 
         |       |               |      | green   +|          |                   | 
         |       |               |      | yellow  +|          |                   | 
+        |       |               |      | orange  +|          |                   | 
         |       |               |      |          |          |                   | 
 (1 row)
 ```
 
+In `schema.rb`:
+```ruby
+create_table "fruits", force: :cascade do |t|
+  t.enum "fruit_type", default: "banana", null: false, values: ["banana", "orange", "grape", ""]
+  t.datetime "created_at", null: false
+  t.datetime "updated_at", null: false
+  t.enum "color", values: ["red", "green", "yellow", "orange", ""]
+  t.index ["fruit_type"], name: "index_fruits_on_fruit_type"
+end
+```
+
 ## 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/pg_activerecord_enum/schema.rb

@@ -4,6 +4,8 @@ module PgActiveRecordEnum
       ActiveRecord::ConnectionAdapters::Table.send :include, TableDefinition
       ActiveRecord::ConnectionAdapters::TableDefinition.send :include, TableDefinition
       ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Statements
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :prepend, AdapterEnumSupport
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :prepend, ColumnDumper
       ActiveRecord::Migration::CommandRecorder.send :include, CommandRecorder
     end
 
@@ -53,6 +55,23 @@ module PgActiveRecordEnum
       end
     end
 
+    module AdapterEnumSupport
+      def native_database_types
+        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.merge(enum: {name: :enum})
+      end
+    end
+
+    module ColumnDumper
+      def prepare_column_options(column)
+        spec = super
+        spec[:array] = "true" if column.array?
+        if column.sql_type_metadata.type == :enum
+          spec[:values] = PgActiveRecordEnum.values_for(column.name)
+        end
+        spec
+      end
+    end
+
     module CommandRecorder
       def add_enum(*args)
         record(:add_enum, args)

data/lib/pg_activerecord_enum/version.rb

@@ -1,3 +1,3 @@
 module PgActiveRecordEnum
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

data/lib/pg_activerecord_enum.rb

@@ -75,5 +75,6 @@ end
 
 require 'active_support/all'
 require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
 ActiveRecord::Base.send :extend, PgActiveRecordEnum
 PgActiveRecordEnum::Schema.include_migrations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_activerecord_enum
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - inpego