activerecord-pg_enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67d75573d2938384fe7b152068e7ea8574c06edd54a568288d32fc02e97ba91d
+  data.tar.gz: 8eb7a669608474a001058437252519035b6a59d4663ab83aab470b92603f3869
+SHA512:
+  metadata.gz: da008c7e1bbc9304dd4ce5570b4800abefc6e1caca83d20c11fa1bdf3e29e8665ff6184f569edde7a1b106b5b4976ad23eb3dc4dc62b7c2d8854b66935f5483a
+  data.tar.gz: dd7f6e35923433c9cc97cc44560904407a04c1f50036fcb3e5ec13b8a9be41e65de3b1b67632dbc0d0f98130e36fedeeee4407070e15e36a111bde4e19ec9984

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.vim
+.envrc
+.DS_Store
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: http://www.example.com/rubocop.yml
+
+Style/StringLiterals:
+  EnforcedStyled: double_quotes

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+services:
+  - postgresql
+before_install: gem install bundler -v 1.15.4
+before_script:
+  - "rake spec:setup"
+env:
+  global:
+    - TEST_USER=postgres

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "activerecord", "~> 5.1"
+
+# Specify your gem's dependencies in activerecord-pg_enum.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Flywheel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# ActiveRecord::PGEnum [![Build Status](https://travis-ci.com/getflywheel/activerecord-pg_enum.svg?branch=master)](https://travis-ci.com/getflywheel/activerecord-pg_enum)
+
+This gem is a small monkeypatch to ActiveRecord so that your `schema.rb` file can support PostgreSQL's native enumerated types.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pg_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-pg_enum
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/getflywheel/activerecord-pg_enum.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :connection do
+  require "active_record"
+
+  ActiveRecord::Base.establish_connection(
+    adapter:  "postgresql",
+    username: ENV.fetch("TEST_USER") { ENV.fetch("USER", "pg_enum") },
+    password: ENV["TEST_PASSWORD"]
+  )
+end
+
+namespace :spec do
+  desc "Setup the Database for testing"
+  task setup: [:connection] do
+    ActiveRecord::Base.connection_pool.with_connection do |conn|
+      conn.create_database ENV.fetch("TEST_DATABASE", "pg_enum_test"), owner: ENV.fetch("TEST_USER") { ENV.fetch("USER", "pg_enum") }
+    end
+  end
+
+  desc "Discard the test database"
+  task teardown: [:connection] do
+    ActiveRecord::Base.connection_pool.with_connection do |conn|
+      conn.drop_database ENV.fetch("TEST_DATABASE", "pg_enum_test")
+    end
+  end
+end

data/activerecord-pg_enum.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/pg_enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-pg_enum"
+  spec.version       = ActiveRecord::PGEnum::VERSION
+  spec.authors       = ["Adam Lassek"]
+  spec.email         = ["adam@doubleprime.net"]
+
+  spec.summary       = %q{Integrate PostgreSQL's enumerated types with the Rails enum feature}
+  spec.homepage      = "https://github.com/getflywheel/activerecord-pg_enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg"
+  spec.add_dependency "activerecord", ">= 5.2.0"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/pg_enum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/pg_enum/helper.rb

@@ -0,0 +1,37 @@
+module ActiveRecord
+  module PGEnum
+    module Helper
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      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
+
+          enum Hash[definitions.keys.zip(values)]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/pg_enum/postgresql_adapter.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module PGEnum
+    module PostgreSQLAdapter
+      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
+          FROM pg_type t
+          JOIN pg_enum e ON t.oid = e.enumtypid
+          JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
+          WHERE n.nspname = 'public'
+          GROUP BY enum_name
+        SQL
+
+        res.map do |(name, values)|
+          [name, values.split(" ")]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/pg_enum/schema_dumper.rb

@@ -0,0 +1,43 @@
+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 |enum_type|
+          stream.puts %Q{  create_enum "#{enum_type.first}", "#{enum_type.second.join("\", \"")}"}
+        end
+
+        stream.puts
+      end
+
+      def column_spec(column)
+        if column.type == :enum
+          ["column", [column.sql_type.inspect, prepare_column_options(column)]]
+        else
+          super
+        end
+      end
+
+      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/schema_statements.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module PGEnum
+    module SchemaStatements
+      def create_enum(name, *values)
+        execute "CREATE TYPE #{name} AS ENUM (#{values.map { |v| "'#{v}'" }.join(", ")})"
+      end
+
+      def drop_enum(name)
+        execute "DROP TYPE #{name}"
+      end
+    end
+  end
+end

data/lib/active_record/pg_enum/version.rb

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

data/lib/active_record/pg_enum.rb

@@ -0,0 +1,19 @@
+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"
+
+ActiveSupport.on_load(:active_record) do
+  require "active_record/pg_enum/postgresql_adapter"
+  require "active_record/pg_enum/schema_dumper"
+  require "active_record/pg_enum/schema_statements"
+  require "active_record/pg_enum/helper"
+
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.merge!(enum: { name: "enum" })
+
+  ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend ActiveRecord::PGEnum::SchemaDumper
+
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::PostgreSQLAdapter
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::SchemaStatements
+end

data/lib/activerecord/pg_enum.rb

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

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pg_enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Lassek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- adam@doubleprime.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-pg_enum.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/pg_enum.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/version.rb
+- lib/activerecord/pg_enum.rb
+homepage: https://github.com/getflywheel/activerecord-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.7.6
+signing_key: 
+specification_version: 4
+summary: Integrate PostgreSQL's enumerated types with the Rails enum feature
+test_files: []