ar-enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fafa2cb564dcb6f21264144628705d9c7d68af50a13ea21638ef448a447de8a
+  data.tar.gz: 607ed017f7d41594e0c1c48d89a854b3921607236a859160076491c8091118dc
+SHA512:
+  metadata.gz: 57fceb9b862e7bb38e953bedd08843af834fe5f35e8665388441a712b520eebd4991f6520275d5a1f71f4f186058f35eb3180e139c03456f027af89b78ad2e61
+  data.tar.gz: ebf8f91d84c179226b6303faaad634059336bc1da8edd8ff641d8ffc6c234fa2f7bf002bfadf90fc24f05d3677ade918555bc1f642c31a2171328459b320735c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,33 @@
+language: ruby
+addons:
+  postgresql: "10"
+  apt:
+    packages:
+    - postgresql-10
+    - postgresql-client-10
+cache: bundler
+before_install:
+- sudo service postgresql stop
+- sed -e 's/^port.*/port = 5432/' /etc/postgresql/10/main/postgresql.conf > postgresql.conf
+- sudo chown postgres postgresql.conf
+- sudo mv postgresql.conf /etc/postgresql/10/main
+- sudo service postgresql start 10
+before_script:
+- createdb test
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+gemfile:
+- Gemfile
+- gemfiles/activerecord_6_0.gemfile
+- gemfiles/activerecord_5_2.gemfile
+rvm:
+- 2.6.1
+- 2.5.3
+notifications:
+  email: false
+env:
+  global:
+    secure: ItWMub2Jbp/Xey50SAPWeYzZcKoEFORj716NmbQI1NbnOzqEDOF3pDZd9HHCxHoBA6gYYDIGWFCa15ymfugzBJ/eGaL7qzEF098xU7hwgG0DOlU31RAPOwn7ov3merGVJOttWOgYYmTR7pxyyg5iMc7/IzU5ag1As+Sz8s7vq9uR2HRdRALvuRFAS1Vty5lV1dINVNIs2vSHMIdgwWCaraWno8R3WupchXgkoA4WGwK6+n99ZUfuCv6kLwAJhlH3rWXEuwT49ILGRCYUp3rRZ/wawclUviYjxgVvS5xeEGzsh3X9AMkbq68up9zxcG1KYeL+EKxLDL6ieC2OtaqMst3k7UariK5QWro00TdGdNpw2M83d0ca81PUW8lpyZVvOJ8STDFR3Dtt8emaz/F0rHiBJlMP1vKWYxgQgpIEIv+WQV2YcVJBg0NNjQ8Ei6ujGG2s8pJNvJBudK/jL3okpXy/uPd5djQfoJcLnZk0xHOqJtcr1+Xg/9TUo/vh81U8cIgGJDtwssoyMastqv1U9Gm2AfsRKmjDyRoIhvwbF9V3dpdks4tRtmnEoYo91K9y2nv45tyO0R6PSEhNL8wDGlvgqUk4XlaaQEs2yNPgpX07ivs47+/x8ufkcyzAf0nHXN/FDzqLnHQBHqdk8a/BTY9wWQP1d5iIuojr30vR4X4=

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# ar-check
+
+#### v0.1.0
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ar-check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nando Vieira
+
+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,100 @@
+# AR::Enum
+
+[![Travis-CI](https://travis-ci.org/fnando/ar-enum.svg)](https://travis-ci.org/fnando/ar-enum)
+[![Code Climate](https://codeclimate.com/github/fnando/ar-enum/badges/gpa.svg)](https://codeclimate.com/github/fnando/ar-enum)
+[![Test Coverage](https://codeclimate.com/github/fnando/ar-enum/badges/coverage.svg)](https://codeclimate.com/github/fnando/ar-enum/coverage)
+[![Gem](https://img.shields.io/gem/v/ar-enum.svg)](https://rubygems.org/gems/ar-enum)
+[![Gem](https://img.shields.io/gem/dt/ar-enum.svg)](https://rubygems.org/gems/ar-enum)
+
+Add support for creating `ENUM` types in PostgreSQL with ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ar-enum"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar-enum
+
+## Usage
+
+To create a `enum` type, use the method `create_enum`.
+
+```ruby
+# The type is created independently from the table.
+create_enum :article_status, %w[draft published]
+
+create_table :articles do |t|
+  # Use the type `article_status` when defining your column.
+  t.column :status, :article_status, null: false, default: "draft"
+end
+```
+
+To remove the enum, use `drop_enum`.
+
+```ruby
+drop_enum :article_status
+```
+
+You'll receive a `ActiveRecord::StatementInvalid` if any of your tables have a dependency on the type; i.e. you're have a column using that enum. You can drop these columns by specifying `cascade: true`.
+
+```ruby
+drop_enum :article_status, cascade: true
+```
+
+If you don't want to remove the column, change the column type before dropping the enum.
+
+```ruby
+change_column :articles, :status, :text
+drop_enum :article_status
+```
+
+Use `add_enum_label` to add new values to the enum type. You can control where the value will be inserted by using `before: label` and `after: label`.
+
+```ruby
+create_enum :article_status, %w[draft published]
+
+# labels will be sorted as [draft, published, unlisted]
+add_enum_label :article_status, "unlisted"
+
+# labels will be sorted as [draft, unlisted, published]
+add_enum_value :article_status, "unlisted", after: "draft"
+
+# labels will be sorted as [draft, unlisted, published]
+add_enum_value :article_status, "unlisted", before: "published"
+```
+
+Use `rename_enum_label` to rename a value.
+
+```ruby
+create_enum :article_status, %w[draft unlisted published]
+
+# labels will be [draft, hidden, unlisted]
+rename_enum_label :article_status, "unlisted", "hidden"
+```
+
+**WARNING:** PostgreSQL does not have a way of removing values from enum types.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/fnando/ar-enum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/ar-enum.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "./lib/ar/enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar-enum"
+  spec.version       = AR::Enum::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+
+  spec.summary       = "Add support for creating `ENUM` types in PostgreSQL with ActiveRecord"
+  spec.description   = spec.summary
+  spec.homepage      = "https://rubygems.org/gems/ar-enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject {|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

data/gemfiles/activerecord_5_2.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "activerecord", "~> 5.2.0"

data/gemfiles/activerecord_6_0.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "activerecord", "~> 6.0.0.beta2"

data/lib/ar-enum.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "ar/enum"

data/lib/ar/enum.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
+require "active_record/schema_dumper"
+require "ar/enum/version"
+
+module AR
+  module Enum
+    require "ar/enum/adapter"
+    require "ar/enum/schema_dumper"
+  end
+end
+
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include AR::Enum::Adapter
+ActiveRecord::SchemaDumper.prepend AR::Enum::SchemaDumper

data/lib/ar/enum/adapter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module AR
+  module Enum
+    module Adapter
+      def enum_types
+        execute <<~SQL
+          with
+          sorted_enums as (
+            select
+              t.typname,
+              e.enumlabel
+            from
+              pg_type t,
+              pg_enum e
+            where
+              t.oid = e.enumtypid
+            order by
+              e.enumsortorder
+          )
+
+          select
+            typname as name,
+            string_agg(enumlabel, ',') as labels
+          from
+            sorted_enums
+          group by
+            typname
+        SQL
+      end
+
+      def create_enum(name, values)
+        values = values.map do |value|
+          quote(value.to_s)
+        end
+
+        sql = <<-SQL
+          CREATE TYPE #{name}
+          AS ENUM (#{values.join(', ')})
+        SQL
+
+        execute(sql)
+      end
+
+      def add_enum_label(name, value, options = {})
+        sql = "ALTER TYPE #{name} ADD VALUE #{quote(value.to_s)}"
+
+        if options[:before]
+          sql = "#{sql} BEFORE #{quote(options[:before].to_s)}"
+        elsif options[:after]
+          sql = "#{sql} AFTER #{quote(options[:after].to_s)}"
+        end
+
+        execute(sql)
+      end
+
+      def rename_enum_label(name, from, to)
+        sql = "ALTER TYPE #{name} RENAME VALUE #{quote(from.to_s)} TO #{quote(to.to_s)}"
+        execute(sql)
+      end
+
+      def drop_enum(name, options = {})
+        sql = "DROP TYPE IF EXISTS #{name}"
+        sql = "#{sql} CASCADE" if options[:cascade]
+
+        execute(sql)
+      end
+    end
+  end
+end

data/lib/ar/enum/schema_dumper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module AR
+  module Enum
+    module SchemaDumper
+      def header(stream)
+        super
+        enum_types(stream)
+      end
+
+      def enum_types(stream)
+        list = @connection.enum_types.to_a
+
+        stream.puts("  # These are enum types created on this database") if list.any?
+
+        list.each do |row|
+          labels = row["labels"].split(",")
+          name = row["name"]
+
+          statement = [
+            "  create_enum",
+            "#{name.to_sym.inspect},",
+            labels.inspect
+          ].join(" ")
+
+          stream.puts(statement)
+        end
+
+        stream.puts
+      end
+    end
+  end
+end

data/lib/ar/enum/version.rb

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

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: ar-enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Add support for creating `ENUM` types in PostgreSQL with ActiveRecord
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar-enum.gemspec
+- gemfiles/activerecord_5_2.gemfile
+- gemfiles/activerecord_6_0.gemfile
+- lib/ar-enum.rb
+- lib/ar/enum.rb
+- lib/ar/enum/adapter.rb
+- lib/ar/enum/schema_dumper.rb
+- lib/ar/enum/version.rb
+homepage: https://rubygems.org/gems/ar-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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Add support for creating `ENUM` types in PostgreSQL with ActiveRecord
+test_files: []