pg-enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b082cfa24cef44a2a3ba845c77487592d38f3c38
+  data.tar.gz: 6853f6d73ea44dab65af796c8e50767412a29eb5
+SHA512:
+  metadata.gz: 9efcfc73fc57b672fad074f8059863808f336f922b02960269739f95d16fa4300ec9754fcdb9dc9c2d64dd2584e609e063fb511a7f5d093f85b76813508ffcdf
+  data.tar.gz: e68e047c7d4a8813a851511d804986532cbfa90c6172039a0f24087fb4c7f42ee97332e3ea18d3c6650fd22c8602aac4a50f1b1e612a479ba0950dc1ccdea20b

data/README.md

@@ -0,0 +1,72 @@
+# PgEnum
+
+Add support for Postgres (enum)erated types to Active Record
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg-enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg-enum
+
+## Usage
+
+Create an enum type like:
+
+```ruby
+# db/migrate/20170818114925_add_status_to_conversations.rb
+class AddStatusToConversations < ActiveRecord::Migration[5.1]
+  include PgEnum::MigrationHelpers
+
+  def up
+    create_enum :conversation_status, [:active, :archived]
+    add_column :conversations, :status, :conversation_status, default: "created"
+  end
+
+  def down
+    remove_column :conversations, :status
+    drop_enum :conversation_status
+  end
+end
+```
+
+To add PgEnum to an Active Record model, simply include the `PgEnum` module.
+
+```ruby
+class Conversation < ActiveRecord::Base
+  include PgEnum
+
+  pg_enum :status
+end
+```
+
+The API is the same as [ActiveRecord::Enum](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html).
+
+```ruby
+Conversation.statuses
+# => { active: 'active', archived: 'archived' }
+
+conversation = Conversation.create
+conversation.status   # => "created"
+conversation.created? # => true
+
+conversation.archived!
+conversation.status    # => "archived"
+conversation.archived? # => true
+
+Conversation.active.count   # => 0
+Conversation.archived.count # => 1
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/pg-enum.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "pg_enum"

data/lib/pg_enum.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module PgEnum
+  extend ActiveSupport::Concern
+
+  ENUM_SQL = <<~SQL.squish
+    SELECT e.enumlabel
+      FROM pg_enum e
+      JOIN pg_type t
+        ON e.enumtypid = t.oid
+     WHERE t.typname = ?
+  SQL
+
+  class_methods do
+    def pg_enum(attr, options = {})
+      column = columns_hash[attr.to_s]
+
+      if column.nil? || column.type != :enum
+        raise "PgEnum: #{ model.table_name }.#{ attr } is not an enum"
+      end
+
+      enum(options.merge(column.name.to_sym => enum_values(column)))
+    end
+
+    private
+
+    def enum_values(column)
+      connection
+        .select_all(sanitize_sql_array([ENUM_SQL, column.sql_type]))
+        .map { |v| v["enumlabel"] }
+        .each_with_object({}) { |v, h| h[v.to_sym] = v }
+    end
+  end
+
+  module MigrationHelpers
+    def create_enum(name, values)
+      values = values.map { |v| "'#{ v }'" }
+
+      execute "CREATE TYPE #{ name } AS ENUM (#{ values.join(', ') })"
+    end
+
+    def drop_enum(name)
+      execute "DROP TYPE #{ name }"
+    end
+  end
+end

data/test/pg_enum_test.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "active_record"
+require "pg"
+require "minitest/autorun"
+require_relative "../lib/pg_enum"
+
+configuration = {
+  "adapter"  => "postgresql",
+  "database" => "pg_enum",
+  "host" => "localhost",
+  "port" => 5432
+}
+
+ActiveRecord::Base.establish_connection(configuration.merge(
+  "database" => "postgres",
+  "schema_search_path" => "public"
+))
+
+ActiveRecord::Base.connection.drop_database(configuration["database"])
+
+ActiveRecord::Base.connection.create_database(configuration["database"])
+
+ActiveRecord::Base.establish_connection(configuration)
+
+ActiveRecord::Schema.define do
+  execute "CREATE TYPE conversation_status AS ENUM ('active', 'archived')"
+
+  create_table :conversations, force: true do |t|
+    t.column :status, :conversation_status, default: "active"
+  end
+end
+
+class Conversation < ActiveRecord::Base
+  include PgEnum
+
+  pg_enum :status
+end
+
+class PgEnumTest < Minitest::Test
+  def setup
+    Conversation.delete_all
+  end
+
+  def test_default
+    assert_equal "active", Conversation.new.status
+  end
+
+  def test_enum_values
+    assert_equal "active", Conversation.statuses[:active]
+    assert_equal "archived", Conversation.statuses[:archived]
+  end
+
+  def test_scopes
+    conversation = Conversation.create!
+
+    assert_equal 1, Conversation.active.count
+    assert_equal 0, Conversation.archived.count
+
+    conversation = Conversation.create!(status: "archived")
+
+    assert_equal 1, Conversation.archived.count
+  end
+
+  def test_predicates
+    assert Conversation.new.active?
+    refute Conversation.new.archived?
+  end
+
+  def test_writter
+    conversation = Conversation.create!
+
+    assert_equal "active", conversation.status
+
+    conversation.archived!
+
+    assert_equal "archived", conversation.status
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: pg-enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Adds support for Postgres (enum)erated types to Active Record
+email: frodsan@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/pg-enum.rb
+- lib/pg_enum.rb
+- test/pg_enum_test.rb
+homepage: https://github.com/frodsan/pg-enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Adds support for Postgres (enum)erated types to Active Record
+test_files:
+- test/pg_enum_test.rb