activerecord-pg_enum 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +15 -0
- data/.rspec +2 -0
- data/.rubocop.yml +4 -0
- data/.travis.yml +12 -0
- data/Gemfile +8 -0
- data/LICENSE +21 -0
- data/README.md +37 -0
- data/Rakefile +32 -0
- data/activerecord-pg_enum.gemspec +33 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/active_record/pg_enum/helper.rb +37 -0
- data/lib/active_record/pg_enum/postgresql_adapter.rb +20 -0
- data/lib/active_record/pg_enum/schema_dumper.rb +43 -0
- data/lib/active_record/pg_enum/schema_statements.rb +13 -0
- data/lib/active_record/pg_enum/version.rb +5 -0
- data/lib/active_record/pg_enum.rb +19 -0
- data/lib/activerecord/pg_enum.rb +1 -0
- metadata +160 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 67d75573d2938384fe7b152068e7ea8574c06edd54a568288d32fc02e97ba91d
|
4
|
+
data.tar.gz: 8eb7a669608474a001058437252519035b6a59d4663ab83aab470b92603f3869
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: da008c7e1bbc9304dd4ce5570b4800abefc6e1caca83d20c11fa1bdf3e29e8665ff6184f569edde7a1b106b5b4976ad23eb3dc4dc62b7c2d8854b66935f5483a
|
7
|
+
data.tar.gz: dd7f6e35923433c9cc97cc44560904407a04c1f50036fcb3e5ec13b8a9be41e65de3b1b67632dbc0d0f98130e36fedeeee4407070e15e36a111bde4e19ec9984
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2018 Flywheel
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# ActiveRecord::PGEnum [](https://travis-ci.com/getflywheel/activerecord-pg_enum)
|
2
|
+
|
3
|
+
This gem is a small monkeypatch to ActiveRecord so that your `schema.rb` file can support PostgreSQL's native enumerated types.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'activerecord-pg_enum'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install activerecord-pg_enum
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
TODO: Write usage instructions here
|
24
|
+
|
25
|
+
## Development
|
26
|
+
|
27
|
+
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.
|
28
|
+
|
29
|
+
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).
|
30
|
+
|
31
|
+
## Contributing
|
32
|
+
|
33
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/getflywheel/activerecord-pg_enum.
|
34
|
+
|
35
|
+
## License
|
36
|
+
|
37
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
2
|
+
require "rspec/core/rake_task"
|
3
|
+
|
4
|
+
RSpec::Core::RakeTask.new(:spec)
|
5
|
+
|
6
|
+
task :default => :spec
|
7
|
+
|
8
|
+
task :connection do
|
9
|
+
require "active_record"
|
10
|
+
|
11
|
+
ActiveRecord::Base.establish_connection(
|
12
|
+
adapter: "postgresql",
|
13
|
+
username: ENV.fetch("TEST_USER") { ENV.fetch("USER", "pg_enum") },
|
14
|
+
password: ENV["TEST_PASSWORD"]
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
18
|
+
namespace :spec do
|
19
|
+
desc "Setup the Database for testing"
|
20
|
+
task setup: [:connection] do
|
21
|
+
ActiveRecord::Base.connection_pool.with_connection do |conn|
|
22
|
+
conn.create_database ENV.fetch("TEST_DATABASE", "pg_enum_test"), owner: ENV.fetch("TEST_USER") { ENV.fetch("USER", "pg_enum") }
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
desc "Discard the test database"
|
27
|
+
task teardown: [:connection] do
|
28
|
+
ActiveRecord::Base.connection_pool.with_connection do |conn|
|
29
|
+
conn.drop_database ENV.fetch("TEST_DATABASE", "pg_enum_test")
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
|
3
|
+
lib = File.expand_path("../lib", __FILE__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
require "active_record/pg_enum/version"
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = "activerecord-pg_enum"
|
9
|
+
spec.version = ActiveRecord::PGEnum::VERSION
|
10
|
+
spec.authors = ["Adam Lassek"]
|
11
|
+
spec.email = ["adam@doubleprime.net"]
|
12
|
+
|
13
|
+
spec.summary = %q{Integrate PostgreSQL's enumerated types with the Rails enum feature}
|
14
|
+
spec.homepage = "https://github.com/getflywheel/activerecord-pg_enum"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
|
21
|
+
spec.bindir = "exe"
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
|
+
spec.require_paths = ["lib"]
|
24
|
+
|
25
|
+
spec.add_dependency "pg"
|
26
|
+
spec.add_dependency "activerecord", ">= 5.2.0"
|
27
|
+
spec.add_dependency "activesupport"
|
28
|
+
|
29
|
+
spec.add_development_dependency "bundler", "~> 1.15"
|
30
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
31
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
32
|
+
spec.add_development_dependency "pry"
|
33
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "activerecord/pg_enum"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "pry"
|
14
|
+
Pry.start
|
data/bin/setup
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
module ActiveRecord
|
2
|
+
module PGEnum
|
3
|
+
module Helper
|
4
|
+
def self.included(klass)
|
5
|
+
klass.extend ClassMethods
|
6
|
+
end
|
7
|
+
|
8
|
+
module ClassMethods
|
9
|
+
# Declare an enum attribute where the values map to strings enforced by PostgreSQL's
|
10
|
+
# enumerated types.
|
11
|
+
#
|
12
|
+
# class Conversation < ActiveRecord::Base
|
13
|
+
# include ActiveRecord::PGEnum::Helper
|
14
|
+
#
|
15
|
+
# pg_enum status: %i[active archived]
|
16
|
+
# end
|
17
|
+
#
|
18
|
+
# This is merely a wrapper over traditional enum syntax so that you can define
|
19
|
+
# string-based enums with an array of values.
|
20
|
+
def pg_enum(definitions)
|
21
|
+
values = definitions.values.map do |value|
|
22
|
+
if value.is_a? Array
|
23
|
+
keys = value.map(&:to_sym)
|
24
|
+
values = value.map(&:to_s)
|
25
|
+
|
26
|
+
Hash[keys.zip(values)]
|
27
|
+
else
|
28
|
+
value
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
enum Hash[definitions.keys.zip(values)]
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
module ActiveRecord
|
2
|
+
module PGEnum
|
3
|
+
module PostgreSQLAdapter
|
4
|
+
def enum_types
|
5
|
+
res = exec_query(<<-SQL.strip_heredoc, "SCHEMA").cast_values
|
6
|
+
SELECT t.typname AS enum_name, string_agg(e.enumlabel, ' ' ORDER BY e.enumsortorder) AS enum_value
|
7
|
+
FROM pg_type t
|
8
|
+
JOIN pg_enum e ON t.oid = e.enumtypid
|
9
|
+
JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
|
10
|
+
WHERE n.nspname = 'public'
|
11
|
+
GROUP BY enum_name
|
12
|
+
SQL
|
13
|
+
|
14
|
+
res.map do |(name, values)|
|
15
|
+
[name, values.split(" ")]
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
module ActiveRecord
|
2
|
+
module PGEnum
|
3
|
+
module SchemaDumper
|
4
|
+
private
|
5
|
+
|
6
|
+
def extensions(stream)
|
7
|
+
super
|
8
|
+
enums(stream)
|
9
|
+
end
|
10
|
+
|
11
|
+
def enums(stream)
|
12
|
+
return unless (enum_types = @connection.enum_types).any?
|
13
|
+
|
14
|
+
stream.puts " # These are custom enum types that must be created before they can be used in the schema definition"
|
15
|
+
|
16
|
+
enum_types.each do |enum_type|
|
17
|
+
stream.puts %Q{ create_enum "#{enum_type.first}", "#{enum_type.second.join("\", \"")}"}
|
18
|
+
end
|
19
|
+
|
20
|
+
stream.puts
|
21
|
+
end
|
22
|
+
|
23
|
+
def column_spec(column)
|
24
|
+
if column.type == :enum
|
25
|
+
["column", [column.sql_type.inspect, prepare_column_options(column)]]
|
26
|
+
else
|
27
|
+
super
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def format_colspec(colspec)
|
32
|
+
case colspec
|
33
|
+
when String
|
34
|
+
colspec
|
35
|
+
when Array
|
36
|
+
colspec.map { |value| format_colspec(value) }.select(&:present?).join(", ")
|
37
|
+
else
|
38
|
+
super
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
module ActiveRecord
|
2
|
+
module PGEnum
|
3
|
+
module SchemaStatements
|
4
|
+
def create_enum(name, *values)
|
5
|
+
execute "CREATE TYPE #{name} AS ENUM (#{values.map { |v| "'#{v}'" }.join(", ")})"
|
6
|
+
end
|
7
|
+
|
8
|
+
def drop_enum(name)
|
9
|
+
execute "DROP TYPE #{name}"
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require "active_record"
|
2
|
+
require "active_record/connection_adapters/postgresql/schema_dumper"
|
3
|
+
require "active_record/connection_adapters/postgresql/schema_statements"
|
4
|
+
require "active_record/connection_adapters/postgresql_adapter"
|
5
|
+
require "active_support/lazy_load_hooks"
|
6
|
+
|
7
|
+
ActiveSupport.on_load(:active_record) do
|
8
|
+
require "active_record/pg_enum/postgresql_adapter"
|
9
|
+
require "active_record/pg_enum/schema_dumper"
|
10
|
+
require "active_record/pg_enum/schema_statements"
|
11
|
+
require "active_record/pg_enum/helper"
|
12
|
+
|
13
|
+
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.merge!(enum: { name: "enum" })
|
14
|
+
|
15
|
+
ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend ActiveRecord::PGEnum::SchemaDumper
|
16
|
+
|
17
|
+
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::PostgreSQLAdapter
|
18
|
+
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include ActiveRecord::PGEnum::SchemaStatements
|
19
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require "active_record/pg_enum"
|
metadata
ADDED
@@ -0,0 +1,160 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: activerecord-pg_enum
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Adam Lassek
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-08-06 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: pg
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: activerecord
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 5.2.0
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 5.2.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: activesupport
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: bundler
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.15'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.15'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '10.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '10.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rspec
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '3.0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '3.0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: pry
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
description:
|
112
|
+
email:
|
113
|
+
- adam@doubleprime.net
|
114
|
+
executables: []
|
115
|
+
extensions: []
|
116
|
+
extra_rdoc_files: []
|
117
|
+
files:
|
118
|
+
- ".gitignore"
|
119
|
+
- ".rspec"
|
120
|
+
- ".rubocop.yml"
|
121
|
+
- ".travis.yml"
|
122
|
+
- Gemfile
|
123
|
+
- LICENSE
|
124
|
+
- README.md
|
125
|
+
- Rakefile
|
126
|
+
- activerecord-pg_enum.gemspec
|
127
|
+
- bin/console
|
128
|
+
- bin/setup
|
129
|
+
- lib/active_record/pg_enum.rb
|
130
|
+
- lib/active_record/pg_enum/helper.rb
|
131
|
+
- lib/active_record/pg_enum/postgresql_adapter.rb
|
132
|
+
- lib/active_record/pg_enum/schema_dumper.rb
|
133
|
+
- lib/active_record/pg_enum/schema_statements.rb
|
134
|
+
- lib/active_record/pg_enum/version.rb
|
135
|
+
- lib/activerecord/pg_enum.rb
|
136
|
+
homepage: https://github.com/getflywheel/activerecord-pg_enum
|
137
|
+
licenses:
|
138
|
+
- MIT
|
139
|
+
metadata: {}
|
140
|
+
post_install_message:
|
141
|
+
rdoc_options: []
|
142
|
+
require_paths:
|
143
|
+
- lib
|
144
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
145
|
+
requirements:
|
146
|
+
- - ">="
|
147
|
+
- !ruby/object:Gem::Version
|
148
|
+
version: '0'
|
149
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
150
|
+
requirements:
|
151
|
+
- - ">="
|
152
|
+
- !ruby/object:Gem::Version
|
153
|
+
version: '0'
|
154
|
+
requirements: []
|
155
|
+
rubyforge_project:
|
156
|
+
rubygems_version: 2.7.6
|
157
|
+
signing_key:
|
158
|
+
specification_version: 4
|
159
|
+
summary: Integrate PostgreSQL's enumerated types with the Rails enum feature
|
160
|
+
test_files: []
|