enum_from_pg_constraint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3711ec19e6311d977aa193e1043a66b8b0e08ee
+  data.tar.gz: 1a03f6186d41c38fd82e0d186c1a1c172e6e742b
+SHA512:
+  metadata.gz: 38ab0a2349e1bdf5a40b962217b9f8b13b2cb5ffb3deeb61275ea29b7b343e856d1d46626244c945547be16a5c11a62995e6ffab2d50d8530a7c03949221f834
+  data.tar.gz: 3876e1d03ac40fc9a6adf7e285b0108b700cb17173a9763733a96b30f9f45b1a140f0f1aa4d1f411ebb936aad5c24b71d76e762e82cd15b1c96fb186fd10a98d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at somlor@eml.cc. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum_from_pg_constraint.gemspec
+gemspec
+
+gem 'activerecord'
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sean Omlor
+
+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,66 @@
+## EnumFromPgConstraint
+
+Derive a Rails [enum](http://edgeapi.rubyonrails.org/classes/ActiveRecord/Enum.html) from an existing PostgreSQL constraint.
+
+## Usage:
+
+Given a migration to create table `Thing` with a PostgreSQL constraint:
+
+```ruby
+class CreateThing < ActiveRecord::Migration
+  def up
+    create_table :things do |t|
+      t.string :name
+      t.string :status, null: false, default: 'pending'
+      t.timestamps null: false
+    end
+
+    execute <<-SQL.strip_heredoc
+      ALTER TABLE things
+      ADD CONSTRAINT allowed_statuses
+      CHECK (status IN (
+        'pending', -- thing not yet attempted
+        'success', -- thing succeeded
+        'failure'  -- thing failed
+      ));
+    SQL
+  end
+
+  def down
+    drop_table :things
+  end
+end
+```
+
+Add the constraint to your Model:
+
+```ruby
+class Thing < ActiveRecord::Base
+  include EnumFromPgConstraint
+
+  enum_from_pg_constraint :status
+end
+```
+
+```ruby
+$ rails c
+> Thing.statuses
+=> {"pending"=>"pending", "success"=>"success", "failure"=>"failure"}
+
+> Thing.create(name: 'Hello World!')
+> Thing.pending
+=> [#<Thing:0x007fec93d6b5f0
+  id: 1,
+  name: 'Hello World!'
+  status: "pending",
+  created_at: Sun, 31 Jan 2016 18:53:25 PST -08:00,
+  updated_at: Sun, 31 Jan 2016 18:53:25 PST -08:00>]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/somlor/enum_from_pg_constraint. 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](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enum_from_pg_constraint"
+
+# 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 "irb"
+IRB.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/enum_from_pg_constraint.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_from_pg_constraint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'enum_from_pg_constraint'
+  spec.version       = EnumFromPgConstraint::VERSION
+  spec.authors       = ['Sean Omlor']
+  spec.email         = ['somlor@eml.cc']
+
+  spec.summary       = %q{ActiveRecord enum from PostgreSQL database constraint.}
+  spec.description   = %q{Helper to derive an ActiveRecord enum from existing PostgreSQL database constraint.}
+  spec.homepage      = 'https://github.com/somlor/enum_from_pg_constraint'
+  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', '>= 4.0.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/enum_from_pg_constraint.rb

@@ -0,0 +1,38 @@
+require 'enum_from_pg_constraint/version'
+require 'active_support/concern'
+
+class EnumFromPgConstraintError < StandardError; end
+
+module EnumFromPgConstraint
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def enum_from_pg_constraint(enum_name, constraint_name = nil)
+      unless (adapter_name = ActiveRecord::Base.connection.adapter_name) == 'PostgreSQL'
+        raise EnumFromPgConstraintError,
+          "unexpected database adapter. 'PostgreSQL' required, found: #{adapter_name.inspect}"
+      end
+
+      constraint_name ||= "allowed_#{enum_name.to_s.pluralize}"
+
+      sql = <<-SQL.strip_heredoc
+        SELECT consrc
+        AS #{constraint_name}
+        FROM pg_constraint
+        WHERE conrelid = '#{table_name}'::regclass
+        AND conname = '#{constraint_name}';
+      SQL
+
+      result = ActiveRecord::Base.connection.execute(sql)
+      constraint = result.entries.first[constraint_name]
+      values = constraint.scan(/'([^']*)'/).flatten
+
+      if values.none?
+        raise EnumFromPgConstraintError,
+          "no values found for constraint #{constraint_name.inspect}"
+      end
+
+      enum(enum_name.to_sym => Hash[values.zip(values)])
+    end
+  end
+end

data/lib/enum_from_pg_constraint/version.rb

@@ -0,0 +1,3 @@
+module EnumFromPgConstraint
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: enum_from_pg_constraint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Omlor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Helper to derive an ActiveRecord enum from existing PostgreSQL database
+  constraint.
+email:
+- somlor@eml.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enum_from_pg_constraint.gemspec
+- lib/enum_from_pg_constraint.rb
+- lib/enum_from_pg_constraint/version.rb
+homepage: https://github.com/somlor/enum_from_pg_constraint
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord enum from PostgreSQL database constraint.
+test_files: []