activerecord-postgres_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d34e14ab6cb6bb3067632c5ea90dfa62a9e23be88330c30cb118ffe4f70e55d
+  data.tar.gz: 7b6dd1a8dbe8e7e2b08b616ca15894eb72e2040f7f0d691f02b3452d37a08542
+SHA512:
+  metadata.gz: 19e8a1a1a6b55cca9ae200356c6bcff134809e1d17a3e3b37c0269a482a0f263925ae72ea467ae897133aa0d5e718536b8a693488716f45c9b1c8f5d68fa573e
+  data.tar.gz: 98cc761dec0bfa6248da5135e767d23ea54bcf36c91b604e0eee71c003f22cf79c32273a9bb3e9ec97a8afdc692389a7610665479356189484d569a2a9aa9a8c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Merkushin
+
+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,71 @@
+[![Gem Version](https://badge.fury.io/rb/activerecord-postgres_enum.svg)](https://badge.fury.io/rb/activerecord-postgres_enum)
+[![Build Status](https://travis-ci.org/bibendi/activerecord-postgres_enum.svg?branch=master)](https://travis-ci.org/bibendi/activerecord-postgres_enum)
+
+# ActiveRecord::PostgresEnum
+
+Adds migration and schema.rb support to PostgreSQL enum data types.
+
+<a href="https://evilmartians.com/?utm_source=activerecord-postgres_enum">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-postgres_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-postgres_enum
+
+## Usage
+
+### Migrations
+
+```ruby
+create_enum :mood, %w(happy great been_better)
+
+create_table :person do
+  t.enum :person_mood, enum_name: :mood
+end
+```
+
+Running the above will create a table :person, with a column :person_mood of type :mood. This will also be saved on schema.rb so that `rake schema:load` works as expected.
+
+To drop an existing enum:
+
+```ruby
+drop_enum :mood
+```
+
+To add a value into existing enum:
+
+```ruby
+alter_enum :mood, "crazy"
+```
+
+Renaming / updating enums is currently not supported, since it's quite tricky.
+
+## 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/bibendi/activerecord-postgres_enum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activerecord::PostgresEnum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bibendi/activerecord-postgres_enum/blob/master/CODE_OF_CONDUCT.md).

data/lib/active_record/postgres_enum.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_record/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/postgres_enum/version"
+require "active_record/postgres_enum/postgresql_adapter"
+require "active_record/postgres_enum/schema_dumper"
+
+ActiveSupport.on_load(:active_record) do
+  require "active_record/postgres_enum/extensions"
+
+  ActiveRecord::SchemaDumper.prepend ActiveRecord::PostgresEnum::SchemaDumper
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend ActiveRecord::PostgresEnum::PostgreSQLAdapter
+
+  ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:enum] = {
+    name: 'enum'
+  }
+end

data/lib/active_record/postgres_enum/extensions.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module PostgreSQL
+      module OID # :nodoc:
+        class Enum < Type::Value # :nodoc:
+          attr_reader :enum_name
+
+          def initialize(options = {})
+            @enum_name = options.delete(:enum_name).to_sym
+            super
+          end
+        end
+
+        class TypeMapInitializer
+          # We need to know the column name, and the default implementation discards it
+          def register_enum_type(row)
+            register row['oid'], OID::Enum.new(enum_name: row['typname'])
+          end
+        end
+      end
+
+      module ColumnMethods # :nodoc:
+        # Enables `t.enum :my_field, enum_name: :my_enum_name` on migrations
+        def enum(name, options = {})
+          column(name, options.delete(:enum_name), options.except(:enum_name))
+        end
+      end
+    end
+  end
+end

data/lib/active_record/postgres_enum/postgresql_adapter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PostgresEnum
+    module PostgreSQLAdapter
+      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
+
+      def alter_enum(name, value)
+        execute "ALTER TYPE #{name} ADD VALUE '#{value}'"
+      end
+
+      def migration_keys
+        super + [:enum_name]
+      end
+
+      def prepare_column_options(column, types)
+        spec = super(column, types)
+        spec[:enum_name] = column.cast_type.enum_name.inspect if column.type == :enum
+        spec
+      end
+    end
+  end
+end

data/lib/active_record/postgres_enum/schema_dumper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PostgresEnum
+    # provide support for writing out the 'create_enum' calls in schema.rb
+    module SchemaDumper
+      def tables(stream)
+        enums(stream)
+        super(stream)
+      end
+
+      private
+
+      def defined_enums
+        query = <<~SQL
+          SELECT t.OID, t.typname, t.typtype, array_agg(e.enumlabel) as enumlabels
+          FROM pg_type t
+          INNER JOIN pg_enum e ON e.enumtypid = t.oid
+          WHERE typtype = 'e'
+          GROUP BY t.OID, t.typname, t.typtype
+          ORDER BY t.typname
+        SQL
+
+        @connection.select_all(query).each do |enum|
+          enum['enumlabels'] = enum['enumlabels'].gsub!(/[{}]/, '').split(',')
+        end
+      end
+
+      def enums(stream)
+        statements = []
+
+        defined_enums.each do |enum|
+          enum_name = enum['typname']
+          values = enum['enumlabels'].map(&:inspect).join(', ')
+          statements << "  create_enum(#{enum_name.inspect}, [#{values}])"
+        end
+
+        stream.puts statements.join("\n")
+        stream.puts
+      end
+    end
+  end
+end

data/lib/active_record/postgres_enum/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PostgresEnum
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/postgres_enum.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "active_record/postgres_enum"

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-postgres_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Merkushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-30 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+description: 
+email:
+- merkushin.m.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/active_record/postgres_enum.rb
+- lib/active_record/postgres_enum/extensions.rb
+- lib/active_record/postgres_enum/postgresql_adapter.rb
+- lib/active_record/postgres_enum/schema_dumper.rb
+- lib/active_record/postgres_enum/version.rb
+- lib/activerecord/postgres_enum.rb
+homepage: https://github.com/bibendi/activerecord-postgres_enum
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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 enum data type into ActiveRecord's schema and migrations.
+test_files: []