pg_activerecord_enum 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16f4a5bbf1734048bd67184750467bcb6c2f9eaf
+  data.tar.gz: eb092b571eed066c3d6fd4b211b1dfaa7217c82e
+SHA512:
+  metadata.gz: 3c0fb8ff250c43d2405c94fdb772e1fc2b4fa005e78ca2e83b4c218df1c48350ee7885c15c23795eafba0efed6c8a329639e4796487a2cf897927f6bbed88499
+  data.tar.gz: 94d0b339d143a3ff3b78ec17568b734601167ad3c229858182c7c42a155a2f9f59b83f1de136ac6a0d85d9ac06ad8d5e0c3de250b1840cb8c98e583463b074f2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 inpego
+
+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,121 @@
+# PgActiveRecordEnum
+
+Integration of PostgreSQL native enums with ActiveRecord enums.
+
+## Motivation
+
+1.	All the activerecord enum's abilities out of the box.
+2.	All schema definitions are placed inside migrations, not inside models. That makes code cleaner and eliminates the possibility to accidentally change model's enum definition even if it's defined via hash.
+3.	All the enums changes may be followed by migrations timestamps. If enum is defined inside model, it's changes may be investigated only through source control, which is far less convenient.
+4.	Performance degrade could hardly be noticed, 'cause PostgreSQL uses four-byte integers to provide enums internally.
+5.	Data validation is carried out by database itself. That makes it impossible to write inconsistent values via `update_column` or `update_all` method calls, which is an issue when using original activerecord enums, or even working with the database directly.
+6.	The last but not least, all the enum's values are displayed with their original values when working with the database via console or GUI client. No need to look into the code base to find out which number stands for which value.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_activerecord_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_activerecord_enum
+
+## Usage
+
+Migration:
+
+```ruby
+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.timestamps
+    end
+  end
+end
+```
+
+Or for existing table:
+
+```ruby
+class CreateFruits < ActiveRecord::Migration[5.1]
+  def change
+    add_enum :fruits, :color, values: %i[red green yellow], allow_blank: true
+  end
+end
+```
+
+**allow_blank** adds empty value to enum.
+
+**Note:** migration rollback will remove enums only if other tables do not depend on them.
+
+Model:
+
+```ruby
+class Fruit < ApplicationRecord
+  pg_enum :fruit_type
+  pg_enum :color
+end
+```
+
+```ruby
+Fruit.banana.count # 0
+banana = Fruit.banana.create
+banana.yellow!
+banana.banana? # true
+banana.color # "yellow"
+banana.grape! #
+banana.grape? # true
+Fruit.grape.count # 1
+```
+
+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
+(1 row)
+
+=# \dT+ fruit_type;
+                                         List of data types
+ Schema |    Name    | Internal name | Size | Elements |  Owner   | Access privileges | Description 
+--------+------------+---------------+------+----------+----------+-------------------+-------------
+ public | fruit_type | fruit_type    | 4    | banana  +| postgres |                   | 
+        |            |               |      | orange  +|          |                   | 
+        |            |               |      | grape   +|          |                   | 
+        |            |               |      |          |          |                   | 
+(1 row)
+
+=# \dT+ color;
+                                      List of data types
+ Schema | Name  | Internal name | Size | Elements |  Owner   | Access privileges | Description 
+--------+-------+---------------+------+----------+----------+-------------------+-------------
+ public | color | color         | 4    | red     +| postgres |                   | 
+        |       |               |      | green   +|          |                   | 
+        |       |               |      | yellow  +|          |                   | 
+        |       |               |      |          |          |                   | 
+(1 row)
+```
+
+## 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/inpego/pg_activerecord_enum.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pg_activerecord_enum/schema.rb

@@ -0,0 +1,81 @@
+module PgActiveRecordEnum
+  module Schema
+    def self.include_migrations
+      ActiveRecord::ConnectionAdapters::Table.send :include, TableDefinition
+      ActiveRecord::ConnectionAdapters::TableDefinition.send :include, TableDefinition
+      ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Statements
+      ActiveRecord::Migration::CommandRecorder.send :include, CommandRecorder
+    end
+
+    module Statements
+      def add_enum(table_name, *enum_names)
+        raise ArgumentError, 'Please specify enum name in your add_enum call in your migration.' if enum_names.empty?
+
+        options = enum_names.extract_options!
+        values = options.delete(:values)
+
+        raise ArgumentError, 'Please specify values for enum in your migration.' if values.blank?
+
+        enum_names.each do |enum_name|
+          PgActiveRecordEnum.define enum_name, values, options
+          add_column(table_name, enum_name, enum_name, options)
+        end
+      end
+
+      def remove_enum(table_name, *enum_names)
+        raise ArgumentError, 'Please specify enum name in your add_enum call in your migration.' if enum_names.empty?
+
+        enum_names.extract_options!
+
+        enum_names.each do |enum_name|
+          remove_column(table_name, enum_name)
+          PgActiveRecordEnum.drop enum_name
+        end
+      end
+
+      def drop_table_with_enums(table_name, enums, *args, &block)
+        drop_table(table_name, *args, &block)
+        enums.each { |enum_name| PgActiveRecordEnum.drop enum_name }
+      end
+    end
+
+    module TableDefinition
+      def enum(*enum_names)
+        options = enum_names.extract_options!
+        values = options.delete(:values)
+
+        raise ArgumentError, 'Please specify values for enum in your migration.' if values.blank?
+
+        enum_names.each do |enum_name|
+          PgActiveRecordEnum.define enum_name, values, options
+          column(enum_name, enum_name, options)
+        end
+      end
+    end
+
+    module CommandRecorder
+      def add_enum(*args)
+        record(:add_enum, args)
+      end
+
+      private
+
+      def invert_create_table(args)
+        table_name = args.first
+        enums = ActiveRecord::Base.connection.columns(table_name).select do |column|
+          column.sql_type_metadata.type == :enum
+        end
+        if enums.present?
+          args.shift
+          [:drop_table_with_enums, [table_name, enums.map(&:name)] + args]
+        else
+          [:drop_table, args]
+        end
+      end
+
+      def invert_add_enum(args)
+        [:remove_enum, args]
+      end
+    end
+  end
+end

data/lib/pg_activerecord_enum/version.rb

@@ -0,0 +1,3 @@
+module PgActiveRecordEnum
+  VERSION = '0.0.7'
+end

data/lib/pg_activerecord_enum.rb

@@ -0,0 +1,79 @@
+require 'pg_activerecord_enum/version'
+require 'pg_activerecord_enum/schema'
+
+module PgActiveRecordEnum
+  def self.define(name, values, options = {})
+    values << '' if options[:allow_blank]
+    return if values.blank?
+    values.map!(&:to_s)
+    previously_defined = values_for(name)
+    if previously_defined.present? && previously_defined.sort != values.sort
+      raise ArgumentError, "Enum `#{name}` already defined with other values: " +
+        "#{_j(previously_defined)} (#{_j(values)} supplied)."
+    elsif previously_defined.blank?
+      ActiveRecord::Base.connection.execute("CREATE TYPE #{name} AS ENUM (#{_j(values)});")
+    else
+      ActiveRecord::Base.logger.info "Enum `#{name}` with same values already defined, skip."
+    end
+  end
+
+  def self.drop(name, options = {})
+    enum_dependencies = dependencies(name)
+    if enum_dependencies.present?
+      if options[:cascade]
+        ActiveRecord::Base.connection.execute("DROP TYPE #{name} CASCADE;")
+      else
+        ActiveRecord::Base.logger.warn "Other objects (#{_j(enum_dependencies)}) depend on enum `#{name}`, skip."
+      end
+    else
+      ActiveRecord::Base.connection.execute("DROP TYPE IF EXISTS #{name};")
+    end
+  end
+
+  def self.change(name, values, options = {})
+    drop(name)
+    define(name, values, options)
+  end
+
+  def self.add_values(name, values)
+    values.each do |value|
+      ActiveRecord::Base.connection.execute("ALTER TYPE #{name} ADD VALUE '#{value}';")
+    end
+  end
+
+  def self.allow_blank_for(name)
+    add_values(name, [''])
+  end
+
+  def self.values_for(name)
+    enum_values_sql = <<-SQL
+SELECT e.enumlabel 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 t.typname = '#{name}'
+    SQL
+    ActiveRecord::Base.connection.execute(enum_values_sql).map { |row| row['enum_value'] }
+  end
+
+  def self.dependencies(name)
+    ActiveRecord::Base.connection.execute(
+      'SELECT objid::regclass::text FROM pg_depend ' +
+        "WHERE classid = 'pg_class'::regclass AND refobjid::regtype::text = '#{name}';"
+    ).to_a.map(&:values).flatten
+  end
+
+  def self._j(values)
+    "'#{values.join("', '")}'"
+  end
+
+  def pg_enum(name)
+    enum_values = PgActiveRecordEnum.values_for(name).reject(&:blank?)
+    enum name => enum_values.zip(enum_values).to_h
+  end
+end
+
+require 'active_support/all'
+require 'active_record'
+ActiveRecord::Base.send :extend, PgActiveRecordEnum
+PgActiveRecordEnum::Schema.include_migrations

data/pg_activerecord_enum.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_activerecord_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_activerecord_enum'
+  spec.version       = PgActiveRecordEnum::VERSION
+  spec.authors       = ['inpego']
+  spec.email         = 'inpego@mail.ru'
+
+  spec.summary       = %q{Gem that integrates PostgreSQL native enums with ActiveRecord enums.}
+  spec.homepage      = 'https://github.com/inpego/pg_activerecord_enum'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.1.8'
+  spec.add_runtime_dependency 'activesupport', '>= 4.1.8'
+  spec.add_runtime_dependency 'pg'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: pg_activerecord_enum
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- inpego
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !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: 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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !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'
+description: 
+email: inpego@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_activerecord_enum.rb
+- lib/pg_activerecord_enum/schema.rb
+- lib/pg_activerecord_enum/version.rb
+- pg_activerecord_enum.gemspec
+homepage: https://github.com/inpego/pg_activerecord_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.6.13
+signing_key: 
+specification_version: 4
+summary: Gem that integrates PostgreSQL native enums with ActiveRecord enums.
+test_files: []