ar-enum 0.2.1 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/FUNDING.yml +4 -0
- data/.github/ISSUE_TEMPLATE/bug_report.md +41 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +23 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +38 -0
- data/.github/workflows/tests.yml +73 -0
- data/.rubocop.yml +17 -0
- data/.travis.yml +20 -18
- data/CHANGELOG.md +39 -3
- data/CODE_OF_CONDUCT.md +68 -7
- data/CONTRIBUTING.md +79 -0
- data/Gemfile +0 -1
- data/LICENSE.md +20 -0
- data/README.md +36 -13
- data/Rakefile +4 -1
- data/ar-enum.gemspec +6 -2
- data/bin/console +16 -0
- data/bin/setup +10 -0
- data/gemfiles/{activerecord_5_2.gemfile → 5_2.gemfile} +0 -0
- data/gemfiles/{activerecord_6_0.gemfile → 6_0.gemfile} +1 -1
- data/gemfiles/6_1.gemfile +6 -0
- data/lib/ar/enum/adapter.rb +8 -1
- data/lib/ar/enum/schema_dumper.rb +2 -2
- data/lib/ar/enum/version.rb +1 -1
- data/lib/ar/enum.rb +55 -4
- metadata +50 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 44b09eea4d7318b86ae2827cf5901000bd84db76b5116ffeefd95c153e7a7f22
|
|
4
|
+
data.tar.gz: cd88b176ee53183d2fe24f2b5bc96fdb6727199b535295842eca3ac5baafd3c1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8c519cdb0dc0093677912069e309572cd3a2891250873e48239e64a4560069082c58ef4eb0b99c0242e9ead15e4f4a7a2d82d74f00f1c8f7b317ea8166bed523
|
|
7
|
+
data.tar.gz: c885c484124a77d95d99a29cbf3cf6bc0828cb2d97ab0acc6e84ef14ba587cd03651861f3bac416e9592673f75dc00eb3b25f8f4dddd72ca38807dbd4fe5c6cb
|
data/.github/FUNDING.yml
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "🐛 Bug Report"
|
|
3
|
+
about: Report a reproducible bug or regression.
|
|
4
|
+
title: 'Bug: '
|
|
5
|
+
labels: 'Status: Unconfirmed'
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
<!--
|
|
10
|
+
- Please provide a clear and concise description of what the bug is.
|
|
11
|
+
- If possible, add an example reproducing your issue.
|
|
12
|
+
- Please test using the latest version of ar-enum
|
|
13
|
+
to make sure your issue has not already been fixed.
|
|
14
|
+
-->
|
|
15
|
+
|
|
16
|
+
## Description
|
|
17
|
+
|
|
18
|
+
[Add bug description here]
|
|
19
|
+
|
|
20
|
+
## How to reproduce
|
|
21
|
+
|
|
22
|
+
[Add steps on how to reproduce this issue]
|
|
23
|
+
|
|
24
|
+
## What do you expect
|
|
25
|
+
|
|
26
|
+
[Describe what do you expect to happen]
|
|
27
|
+
|
|
28
|
+
## What happened instead
|
|
29
|
+
|
|
30
|
+
[Describe the actual results]
|
|
31
|
+
|
|
32
|
+
## Software:
|
|
33
|
+
|
|
34
|
+
- Gem version: [Add gem version here]
|
|
35
|
+
- Ruby version: [Add version here]
|
|
36
|
+
|
|
37
|
+
## Full backtrace
|
|
38
|
+
|
|
39
|
+
```text
|
|
40
|
+
[Paste full backtrace here]
|
|
41
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "💡 Feature request"
|
|
3
|
+
about: Have an idea that may be useful? Make a suggestion!
|
|
4
|
+
title: 'Feature Request: '
|
|
5
|
+
labels: 'Feature request'
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Description
|
|
10
|
+
|
|
11
|
+
_A clear and concise description of what the problem is._
|
|
12
|
+
|
|
13
|
+
## Describe the solution
|
|
14
|
+
|
|
15
|
+
_A clear and concise description of what you want to happen._
|
|
16
|
+
|
|
17
|
+
## Alternatives you considered
|
|
18
|
+
|
|
19
|
+
_A clear and concise description of any alternative solutions or features you've considered._
|
|
20
|
+
|
|
21
|
+
## Additional context
|
|
22
|
+
|
|
23
|
+
_Add any other context, screenshots, links, etc about the feature request here._
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
If you're making a doc PR or something tiny where the below is irrelevant,
|
|
3
|
+
delete this template and use a short description, but in your description aim to
|
|
4
|
+
include both what the change is, and why it is being made, with enough context
|
|
5
|
+
for anyone to understand.
|
|
6
|
+
-->
|
|
7
|
+
|
|
8
|
+
<details>
|
|
9
|
+
<summary>PR Checklist</summary>
|
|
10
|
+
|
|
11
|
+
### PR Structure
|
|
12
|
+
|
|
13
|
+
- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
|
|
14
|
+
PRs).
|
|
15
|
+
- [ ] This PR avoids mixing refactoring changes with feature changes (split into
|
|
16
|
+
two PRs otherwise).
|
|
17
|
+
- [ ] This PR's title starts is concise and descriptive.
|
|
18
|
+
|
|
19
|
+
### Thoroughness
|
|
20
|
+
|
|
21
|
+
- [ ] This PR adds tests for the most critical parts of the new functionality or
|
|
22
|
+
fixes.
|
|
23
|
+
- [ ] I've updated any docs, `.md` files, etc… affected by this change.
|
|
24
|
+
|
|
25
|
+
</details>
|
|
26
|
+
|
|
27
|
+
### What
|
|
28
|
+
|
|
29
|
+
[TODO: Short statement about what is changing.]
|
|
30
|
+
|
|
31
|
+
### Why
|
|
32
|
+
|
|
33
|
+
[TODO: Why this change is being made. Include any context required to understand
|
|
34
|
+
the why.]
|
|
35
|
+
|
|
36
|
+
### Known limitations
|
|
37
|
+
|
|
38
|
+
[TODO or N/A]
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Tests
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
pull_request:
|
|
6
|
+
branches:
|
|
7
|
+
- main
|
|
8
|
+
push:
|
|
9
|
+
branches:
|
|
10
|
+
- main
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
build:
|
|
14
|
+
name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
|
|
15
|
+
runs-on: "ubuntu-latest"
|
|
16
|
+
strategy:
|
|
17
|
+
fail-fast: false
|
|
18
|
+
matrix:
|
|
19
|
+
ruby: [2.6.x, 2.7.x, 3.0.x]
|
|
20
|
+
gemfile:
|
|
21
|
+
- Gemfile
|
|
22
|
+
- gemfiles/6_1.gemfile
|
|
23
|
+
- gemfiles/6_0.gemfile
|
|
24
|
+
|
|
25
|
+
services:
|
|
26
|
+
postgres:
|
|
27
|
+
image: postgres:11.5
|
|
28
|
+
ports: ["5432:5432"]
|
|
29
|
+
options:
|
|
30
|
+
--health-cmd pg_isready --health-interval 10s --health-timeout 5s
|
|
31
|
+
--health-retries 5
|
|
32
|
+
|
|
33
|
+
steps:
|
|
34
|
+
- uses: actions/checkout@v1
|
|
35
|
+
|
|
36
|
+
- uses: actions/cache@v2
|
|
37
|
+
with:
|
|
38
|
+
path: vendor/bundle
|
|
39
|
+
key: >
|
|
40
|
+
${{ runner.os }}-${{ matrix.ruby }}-gems-${{
|
|
41
|
+
hashFiles(matrix.gemfile) }}
|
|
42
|
+
restore-keys: >
|
|
43
|
+
${{ runner.os }}-${{ matrix.ruby }}-gems-${{
|
|
44
|
+
hashFiles(matrix.gemfile) }}
|
|
45
|
+
|
|
46
|
+
- name: Set up Ruby
|
|
47
|
+
uses: actions/setup-ruby@v1
|
|
48
|
+
with:
|
|
49
|
+
ruby-version: ${{ matrix.ruby }}
|
|
50
|
+
|
|
51
|
+
- name: Install PostgreSQL client
|
|
52
|
+
env:
|
|
53
|
+
PGHOST: localhost
|
|
54
|
+
PGUSER: postgres
|
|
55
|
+
run: |
|
|
56
|
+
sudo apt-get -yqq install libpq-dev
|
|
57
|
+
psql -U postgres -c "create database test"
|
|
58
|
+
|
|
59
|
+
- name: Install gem dependencies
|
|
60
|
+
env:
|
|
61
|
+
BUNDLE_GEMFILE: ${{ matrix.gemfile }}
|
|
62
|
+
run: |
|
|
63
|
+
gem install bundler
|
|
64
|
+
bundle config path vendor/bundle
|
|
65
|
+
bundle update --jobs 4 --retry 3
|
|
66
|
+
|
|
67
|
+
- name: Run Tests
|
|
68
|
+
env:
|
|
69
|
+
PGHOST: localhost
|
|
70
|
+
PGUSER: postgres
|
|
71
|
+
BUNDLE_GEMFILE: ${{ matrix.gemfile }}
|
|
72
|
+
run: |
|
|
73
|
+
bundle exec rake
|
data/.rubocop.yml
ADDED
data/.travis.yml
CHANGED
|
@@ -1,31 +1,33 @@
|
|
|
1
|
+
---
|
|
1
2
|
language: ruby
|
|
3
|
+
dist: xenial
|
|
2
4
|
addons:
|
|
3
|
-
postgresql: "
|
|
5
|
+
postgresql: "11"
|
|
4
6
|
apt:
|
|
5
7
|
packages:
|
|
6
|
-
- postgresql-
|
|
7
|
-
- postgresql-client-
|
|
8
|
+
- postgresql-11
|
|
9
|
+
- postgresql-client-11
|
|
8
10
|
cache: bundler
|
|
9
11
|
before_install:
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
- sudo
|
|
14
|
-
- sudo
|
|
12
|
+
- gem install bundler
|
|
13
|
+
- sudo service postgresql stop
|
|
14
|
+
- sed -e 's/^port.*/port = 5432/' /etc/postgresql/11/main/postgresql.conf > postgresql.conf
|
|
15
|
+
- sudo chown postgres postgresql.conf
|
|
16
|
+
- sudo mv postgresql.conf /etc/postgresql/11/main
|
|
17
|
+
- sudo service postgresql start 11
|
|
15
18
|
before_script:
|
|
16
|
-
- createdb test
|
|
17
|
-
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
|
18
|
-
- chmod +x ./cc-test-reporter
|
|
19
|
-
- "./cc-test-reporter before-build"
|
|
19
|
+
- createdb test
|
|
20
|
+
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
|
21
|
+
- chmod +x ./cc-test-reporter
|
|
22
|
+
- "./cc-test-reporter before-build"
|
|
20
23
|
after_script:
|
|
21
|
-
- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
|
|
24
|
+
- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
|
|
22
25
|
gemfile:
|
|
23
|
-
-
|
|
24
|
-
- gemfiles/
|
|
25
|
-
- gemfiles/activerecord_5_2.gemfile
|
|
26
|
+
- gemfiles/activerecord_6_0.gemfile
|
|
27
|
+
- gemfiles/activerecord_5_2.gemfile
|
|
26
28
|
rvm:
|
|
27
|
-
- 2.6.
|
|
28
|
-
- 2.5.
|
|
29
|
+
- 2.6.5
|
|
30
|
+
- 2.5.7
|
|
29
31
|
notifications:
|
|
30
32
|
email: false
|
|
31
33
|
env:
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,41 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Changelog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<!--
|
|
4
|
+
Prefix your message with one of the following:
|
|
4
5
|
|
|
5
|
-
-
|
|
6
|
+
- [Added] for new features.
|
|
7
|
+
- [Changed] for changes in existing functionality.
|
|
8
|
+
- [Deprecated] for soon-to-be removed features.
|
|
9
|
+
- [Removed] for now removed features.
|
|
10
|
+
- [Fixed] for any bug fixes.
|
|
11
|
+
- [Security] in case of vulnerabilities.
|
|
12
|
+
-->
|
|
13
|
+
|
|
14
|
+
## v0.4.0 - 2021-09-16
|
|
15
|
+
|
|
16
|
+
- [Changed] Sort enums by name.
|
|
17
|
+
- [Removed] Support for Rails 5.2
|
|
18
|
+
|
|
19
|
+
## v0.3.0 - 2019-11-26
|
|
20
|
+
|
|
21
|
+
- [Added] Support for Rails 6.
|
|
22
|
+
|
|
23
|
+
## v0.2.3 - 2019-03-12
|
|
24
|
+
|
|
25
|
+
- [Fixed] Don't try to recreate a type that already exists.
|
|
26
|
+
|
|
27
|
+
## v0.2.2 - 2019-03-12
|
|
28
|
+
|
|
29
|
+
- [Fixed] Schema dumping.
|
|
30
|
+
|
|
31
|
+
## v0.2.1 - 2019-03-11
|
|
32
|
+
|
|
33
|
+
- [Added] Define `enum` type so schema dumper can work appropriately.
|
|
34
|
+
|
|
35
|
+
## v0.2.0 - 2019-03-10
|
|
36
|
+
|
|
37
|
+
- [Added] Add command recorder reversing.
|
|
38
|
+
|
|
39
|
+
## v0.1.0 - 2019-03-10
|
|
40
|
+
|
|
41
|
+
- Initial release.
|
data/CODE_OF_CONDUCT.md
CHANGED
|
@@ -1,13 +1,74 @@
|
|
|
1
|
-
# Contributor Code of Conduct
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Our Pledge
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
|
10
|
+
orientation.
|
|
6
11
|
|
|
7
|
-
|
|
12
|
+
## Our Standards
|
|
8
13
|
|
|
9
|
-
|
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
|
15
|
+
include:
|
|
10
16
|
|
|
11
|
-
|
|
17
|
+
* Using welcoming and inclusive language
|
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
|
19
|
+
* Gracefully accepting constructive criticism
|
|
20
|
+
* Focusing on what is best for the community
|
|
21
|
+
* Showing empathy towards other community members
|
|
12
22
|
|
|
13
|
-
|
|
23
|
+
Examples of unacceptable behavior by participants include:
|
|
24
|
+
|
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
26
|
+
advances
|
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
28
|
+
* Public or private harassment
|
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
|
30
|
+
address, without explicit permission
|
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
|
+
professional setting
|
|
33
|
+
|
|
34
|
+
## Our Responsibilities
|
|
35
|
+
|
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
|
38
|
+
response to any instances of unacceptable behavior.
|
|
39
|
+
|
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
|
44
|
+
threatening, offensive, or harmful.
|
|
45
|
+
|
|
46
|
+
## Scope
|
|
47
|
+
|
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
|
49
|
+
when an individual is representing the project or its community. Examples of
|
|
50
|
+
representing a project or community include using an official project e-mail
|
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
|
53
|
+
further defined and clarified by project maintainers.
|
|
54
|
+
|
|
55
|
+
## Enforcement
|
|
56
|
+
|
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
+
reported by contacting the project team at me@fnando.com. All
|
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
|
63
|
+
|
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
|
66
|
+
members of the project's leadership.
|
|
67
|
+
|
|
68
|
+
## Attribution
|
|
69
|
+
|
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
|
72
|
+
|
|
73
|
+
[homepage]: https://contributor-covenant.org
|
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Contributing to ar-enum
|
|
2
|
+
|
|
3
|
+
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
|
|
4
|
+
|
|
5
|
+
The following is a set of guidelines for contributing to this project. These are
|
|
6
|
+
mostly guidelines, not rules. Use your best judgment, and feel free to propose
|
|
7
|
+
changes to this document in a pull request.
|
|
8
|
+
|
|
9
|
+
## Code of Conduct
|
|
10
|
+
|
|
11
|
+
Everyone interacting in this project's codebases, issue trackers, chat rooms and
|
|
12
|
+
mailing lists is expected to follow the [code of conduct](https://github.com/fnando/ar-enum/blob/main/CODE_OF_CONDUCT.md).
|
|
13
|
+
|
|
14
|
+
## Reporting bugs
|
|
15
|
+
|
|
16
|
+
This section guides you through submitting a bug report. Following these
|
|
17
|
+
guidelines helps maintainers and the community understand your report, reproduce
|
|
18
|
+
the behavior, and find related reports.
|
|
19
|
+
|
|
20
|
+
- Before creating bug reports, please check the open issues; somebody may
|
|
21
|
+
already have submitted something similar, and you may not need to create a new
|
|
22
|
+
one.
|
|
23
|
+
- When you are creating a bug report, please include as many details as
|
|
24
|
+
possible, with an example reproducing the issue.
|
|
25
|
+
|
|
26
|
+
## Contributing with code
|
|
27
|
+
|
|
28
|
+
Before making any radicals changes, please make sure you discuss your intention
|
|
29
|
+
by [opening an issue on Github](https://github.com/fnando/ar-enum/issues).
|
|
30
|
+
|
|
31
|
+
When you're ready to make your pull request, follow checklist below to make sure
|
|
32
|
+
your contribution is according to how this project works.
|
|
33
|
+
|
|
34
|
+
1. [Fork](https://help.github.com/forking/) ar-enum
|
|
35
|
+
2. Create a topic branch - `git checkout -b my_branch`
|
|
36
|
+
3. Make your changes using [descriptive commit messages](#commit-messages)
|
|
37
|
+
4. Update CHANGELOG.md describing your changes by adding an entry to the
|
|
38
|
+
"Unreleased" section. If this section is not available, create one right
|
|
39
|
+
before the last version.
|
|
40
|
+
5. Push to your branch - `git push origin my_branch`
|
|
41
|
+
6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
|
|
42
|
+
7. That's it!
|
|
43
|
+
|
|
44
|
+
## Styleguides
|
|
45
|
+
|
|
46
|
+
### Commit messages
|
|
47
|
+
|
|
48
|
+
- Use the present tense ("Add feature" not "Added feature")
|
|
49
|
+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
|
|
50
|
+
- Limit the first line to 72 characters or less
|
|
51
|
+
- Reference issues and pull requests liberally after the first line
|
|
52
|
+
|
|
53
|
+
### Changelog
|
|
54
|
+
|
|
55
|
+
- Add a message describing your changes to the "Unreleased" section. The
|
|
56
|
+
changelog message should follow the same style as the commit message.
|
|
57
|
+
- Prefix your message with one of the following:
|
|
58
|
+
- `[Added]` for new features.
|
|
59
|
+
- `[Changed]` for changes in existing functionality.
|
|
60
|
+
- `[Deprecated]` for soon-to-be removed features.
|
|
61
|
+
- `[Removed]` for now removed features.
|
|
62
|
+
- `[Fixed]` for any bug fixes.
|
|
63
|
+
- `[Security]` in case of vulnerabilities.
|
|
64
|
+
|
|
65
|
+
### Ruby code
|
|
66
|
+
|
|
67
|
+
- This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
|
|
68
|
+
submitting your changes, make sure your tests are passing and code conforms to
|
|
69
|
+
the expected style by running `rake`.
|
|
70
|
+
- Do not change the library version. This will be done by the maintainer
|
|
71
|
+
whenever a new version is about to be released.
|
|
72
|
+
|
|
73
|
+
### JavaScript code
|
|
74
|
+
|
|
75
|
+
- This project uses [ESLint](https://eslint.org) to enforce code style. Before
|
|
76
|
+
submitting your changes, make sure your tests are passing and code conforms to
|
|
77
|
+
the expected style by running `yarn test:ci`.
|
|
78
|
+
- Do not change the library version. This will be done by the maintainer
|
|
79
|
+
whenever a new version is about to be released.
|
data/Gemfile
CHANGED
data/LICENSE.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Nando Vieira
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
7
|
+
the Software without restriction, including without limitation the rights to
|
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
10
|
+
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, FITNESS
|
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ar-enum
|
|
2
2
|
|
|
3
|
-
[](https://github.com/fnando/ar-enum)
|
|
4
4
|
[](https://codeclimate.com/github/fnando/ar-enum)
|
|
5
|
-
[](https://codeclimate.com/github/fnando/ar-enum/coverage)
|
|
6
5
|
[](https://rubygems.org/gems/ar-enum)
|
|
7
6
|
[](https://rubygems.org/gems/ar-enum)
|
|
8
7
|
|
|
@@ -40,6 +39,19 @@ create_table :articles do |t|
|
|
|
40
39
|
end
|
|
41
40
|
```
|
|
42
41
|
|
|
42
|
+
You can even use the type shortcut if you want; i.e. you can use
|
|
43
|
+
`t.article_status` instead of `t.column`.
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
# The type is created independently from the table.
|
|
47
|
+
create_enum :article_status, %w[draft published]
|
|
48
|
+
|
|
49
|
+
create_table :articles do |t|
|
|
50
|
+
# Use the type `article_status` when defining your column.
|
|
51
|
+
t.article_status :status, null: false, default: "draft"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
43
55
|
### Dropping enums
|
|
44
56
|
|
|
45
57
|
To remove the enum, use `drop_enum`.
|
|
@@ -48,13 +60,16 @@ To remove the enum, use `drop_enum`.
|
|
|
48
60
|
drop_enum :article_status
|
|
49
61
|
```
|
|
50
62
|
|
|
51
|
-
You'll receive a `ActiveRecord::StatementInvalid` if any of your tables have a
|
|
63
|
+
You'll receive a `ActiveRecord::StatementInvalid` if any of your tables have a
|
|
64
|
+
dependency on the type; i.e. you're have a column using that enum. You can drop
|
|
65
|
+
these columns by specifying `cascade: true`.
|
|
52
66
|
|
|
53
67
|
```ruby
|
|
54
68
|
drop_enum :article_status, cascade: true
|
|
55
69
|
```
|
|
56
70
|
|
|
57
|
-
If you don't want to remove the column, change the column type before dropping
|
|
71
|
+
If you don't want to remove the column, change the column type before dropping
|
|
72
|
+
the enum.
|
|
58
73
|
|
|
59
74
|
```ruby
|
|
60
75
|
change_column :articles, :status, :text
|
|
@@ -63,7 +78,8 @@ drop_enum :article_status
|
|
|
63
78
|
|
|
64
79
|
### Adding new labels
|
|
65
80
|
|
|
66
|
-
Use `add_enum_label` to add new values to the enum type. You can control where
|
|
81
|
+
Use `add_enum_label` to add new values to the enum type. You can control where
|
|
82
|
+
the value will be inserted by using `before: label` and `after: label`.
|
|
67
83
|
|
|
68
84
|
```ruby
|
|
69
85
|
create_enum :article_status, %w[draft published]
|
|
@@ -98,7 +114,6 @@ The following commands can be reversed:
|
|
|
98
114
|
- `create_enum`
|
|
99
115
|
- `rename_enum_label`
|
|
100
116
|
|
|
101
|
-
|
|
102
117
|
```ruby
|
|
103
118
|
class CreateColorEnumClass < ActiveRecord::Migration
|
|
104
119
|
def change
|
|
@@ -109,16 +124,24 @@ end
|
|
|
109
124
|
|
|
110
125
|
## Development
|
|
111
126
|
|
|
112
|
-
After checking out the repo, run `bin/setup` to install dependencies. Then, run
|
|
127
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run
|
|
128
|
+
`rake test` to run the tests. You can also run `bin/console` for an interactive
|
|
129
|
+
prompt that will allow you to experiment.
|
|
113
130
|
|
|
114
|
-
To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
131
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
132
|
+
release a new version, update the version number in `version.rb`, and then run
|
|
133
|
+
`bundle exec rake release`, which will create a git tag for the version, push
|
|
134
|
+
git commits and tags, and push the `.gem` file to
|
|
135
|
+
[rubygems.org](https://rubygems.org).
|
|
115
136
|
|
|
116
137
|
## Contributing
|
|
117
138
|
|
|
118
|
-
Bug reports and pull requests are welcome on GitHub at
|
|
119
|
-
|
|
139
|
+
Bug reports and pull requests are welcome on GitHub at
|
|
140
|
+
https://github.com/fnando/ar-enum. This project is intended to be a safe,
|
|
141
|
+
welcoming space for collaboration, and contributors are expected to adhere to
|
|
142
|
+
the [Contributor Covenant](contributor-covenant.org) code of conduct.
|
|
120
143
|
|
|
121
144
|
## License
|
|
122
145
|
|
|
123
|
-
The gem is available as open source under the terms of the
|
|
124
|
-
|
|
146
|
+
The gem is available as open source under the terms of the
|
|
147
|
+
[MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
require "bundler/gem_tasks"
|
|
4
4
|
require "rake/testtask"
|
|
5
|
+
require "rubocop/rake_task"
|
|
5
6
|
|
|
6
7
|
Rake::TestTask.new(:test) do |t|
|
|
7
8
|
t.libs << "test"
|
|
@@ -11,4 +12,6 @@ Rake::TestTask.new(:test) do |t|
|
|
|
11
12
|
t.warning = false
|
|
12
13
|
end
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
RuboCop::RakeTask.new
|
|
16
|
+
|
|
17
|
+
task default: %i[test rubocop]
|
data/ar-enum.gemspec
CHANGED
|
@@ -7,8 +7,10 @@ Gem::Specification.new do |spec|
|
|
|
7
7
|
spec.version = AR::Enum::VERSION
|
|
8
8
|
spec.authors = ["Nando Vieira"]
|
|
9
9
|
spec.email = ["fnando.vieira@gmail.com"]
|
|
10
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
|
|
10
11
|
|
|
11
|
-
spec.summary = "Add support for creating `ENUM` types in PostgreSQL
|
|
12
|
+
spec.summary = "Add support for creating `ENUM` types in PostgreSQL " \
|
|
13
|
+
"with ActiveRecord"
|
|
12
14
|
spec.description = spec.summary
|
|
13
15
|
spec.homepage = "https://rubygems.org/gems/ar-enum"
|
|
14
16
|
spec.license = "MIT"
|
|
@@ -20,12 +22,14 @@ Gem::Specification.new do |spec|
|
|
|
20
22
|
spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
|
|
21
23
|
spec.require_paths = ["lib"]
|
|
22
24
|
|
|
23
|
-
spec.add_dependency "activerecord"
|
|
25
|
+
spec.add_dependency "activerecord", ">= 6.0.0"
|
|
24
26
|
|
|
25
27
|
spec.add_development_dependency "bundler"
|
|
26
28
|
spec.add_development_dependency "minitest-utils"
|
|
27
29
|
spec.add_development_dependency "pg"
|
|
28
30
|
spec.add_development_dependency "pry-meta"
|
|
29
31
|
spec.add_development_dependency "rake"
|
|
32
|
+
spec.add_development_dependency "rubocop"
|
|
33
|
+
spec.add_development_dependency "rubocop-fnando"
|
|
30
34
|
spec.add_development_dependency "simplecov"
|
|
31
35
|
end
|
data/bin/console
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
require "bundler/setup"
|
|
5
|
+
require "ar-enum"
|
|
6
|
+
|
|
7
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
|
8
|
+
# with your gem easier. You can also use a different console, if you like.
|
|
9
|
+
|
|
10
|
+
begin
|
|
11
|
+
require "pry"
|
|
12
|
+
Pry.start
|
|
13
|
+
rescue LoadError
|
|
14
|
+
require "irb"
|
|
15
|
+
IRB.start(__FILE__)
|
|
16
|
+
end
|
data/bin/setup
ADDED
|
File without changes
|
data/lib/ar/enum/adapter.rb
CHANGED
|
@@ -30,6 +30,8 @@ module AR
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
def create_enum(name, values)
|
|
33
|
+
return if enum_exists?(name)
|
|
34
|
+
|
|
33
35
|
values = values.map do |value|
|
|
34
36
|
quote(value.to_s)
|
|
35
37
|
end
|
|
@@ -42,6 +44,10 @@ module AR
|
|
|
42
44
|
execute(sql)
|
|
43
45
|
end
|
|
44
46
|
|
|
47
|
+
def enum_exists?(name)
|
|
48
|
+
enum_types.any? {|type| type["name"] == name.to_s }
|
|
49
|
+
end
|
|
50
|
+
|
|
45
51
|
def add_enum_label(name, value, options = {})
|
|
46
52
|
sql = "ALTER TYPE #{name} ADD VALUE #{quote(value.to_s)}"
|
|
47
53
|
|
|
@@ -55,7 +61,8 @@ module AR
|
|
|
55
61
|
end
|
|
56
62
|
|
|
57
63
|
def rename_enum_label(name, from, to)
|
|
58
|
-
sql = "ALTER TYPE #{name} RENAME VALUE #{quote(from.to_s)}
|
|
64
|
+
sql = "ALTER TYPE #{name} RENAME VALUE #{quote(from.to_s)}" \
|
|
65
|
+
" TO #{quote(to.to_s)}"
|
|
59
66
|
execute(sql)
|
|
60
67
|
end
|
|
61
68
|
|
|
@@ -9,9 +9,9 @@ module AR
|
|
|
9
9
|
end
|
|
10
10
|
|
|
11
11
|
def enum_types(stream)
|
|
12
|
-
list = @connection.enum_types.to_a
|
|
12
|
+
list = @connection.enum_types.to_a.sort_by {|type| type["name"] }
|
|
13
13
|
|
|
14
|
-
stream.puts(" # These are enum types
|
|
14
|
+
stream.puts(" # These are enum types available on this database") if list.any?
|
|
15
15
|
|
|
16
16
|
list.each do |row|
|
|
17
17
|
labels = row["labels"].split(",")
|
data/lib/ar/enum/version.rb
CHANGED
data/lib/ar/enum.rb
CHANGED
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
require "active_support/all"
|
|
4
4
|
require "active_record"
|
|
5
5
|
require "active_record/connection_adapters/postgresql_adapter"
|
|
6
|
+
require "active_record/connection_adapters/postgresql/schema_statements"
|
|
7
|
+
require "active_record/connection_adapters/postgresql/schema_definitions"
|
|
6
8
|
require "active_record/schema_dumper"
|
|
7
9
|
require "active_record/migration/command_recorder"
|
|
8
10
|
require "ar/enum/version"
|
|
@@ -15,7 +17,56 @@ module AR
|
|
|
15
17
|
end
|
|
16
18
|
end
|
|
17
19
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES
|
|
20
|
+
ActiveSupport.on_load(:active_record) do
|
|
21
|
+
require "active_record/connection_adapters/postgresql_adapter"
|
|
22
|
+
silence_warnings do
|
|
23
|
+
::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES = ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.dup
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(
|
|
27
|
+
Module.new do
|
|
28
|
+
def create_table_definition(*args, **kwargs)
|
|
29
|
+
ActiveRecord::Base.connection.enum_types.each do |enum|
|
|
30
|
+
ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnMethods.class_eval do
|
|
31
|
+
::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[enum["name"].to_sym] = {name: enum["name"]}
|
|
32
|
+
|
|
33
|
+
define_method(enum["name"]) do |*names, **options|
|
|
34
|
+
names.each do |name|
|
|
35
|
+
column(name, enum["name"].to_sym, **options)
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
super
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements.class_eval do
|
|
47
|
+
original_fetch_type_metadata = instance_method(:fetch_type_metadata)
|
|
48
|
+
|
|
49
|
+
define_method(:fetch_type_metadata) do |*args|
|
|
50
|
+
type_metadata = original_fetch_type_metadata.bind(self).call(*args)
|
|
51
|
+
|
|
52
|
+
if type_metadata.type == :enum
|
|
53
|
+
type_metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(
|
|
54
|
+
sql_type: type_metadata.sql_type,
|
|
55
|
+
type: type_metadata.sql_type.to_sym,
|
|
56
|
+
limit: type_metadata.limit,
|
|
57
|
+
precision: type_metadata.precision,
|
|
58
|
+
scale: type_metadata.scale
|
|
59
|
+
)
|
|
60
|
+
type_metadata = ActiveRecord::ConnectionAdapters::PostgreSQLTypeMetadata.new(type_metadata)
|
|
61
|
+
|
|
62
|
+
::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[type_metadata.type] = {name: "character varying"}
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
type_metadata
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
ActiveRecord::Migration::CommandRecorder.include AR::Enum::CommandRecorder
|
|
70
|
+
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include AR::Enum::Adapter
|
|
71
|
+
ActiveRecord::SchemaDumper.prepend AR::Enum::SchemaDumper
|
|
72
|
+
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ar-enum
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Nando Vieira
|
|
8
|
-
autorequire:
|
|
8
|
+
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-09-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: activerecord
|
|
@@ -16,14 +16,14 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
19
|
+
version: 6.0.0
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
24
|
- - ">="
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
26
|
+
version: 6.0.0
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: bundler
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -94,6 +94,34 @@ dependencies:
|
|
|
94
94
|
- - ">="
|
|
95
95
|
- !ruby/object:Gem::Version
|
|
96
96
|
version: '0'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: rubocop
|
|
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
|
+
- !ruby/object:Gem::Dependency
|
|
112
|
+
name: rubocop-fnando
|
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
|
114
|
+
requirements:
|
|
115
|
+
- - ">="
|
|
116
|
+
- !ruby/object:Gem::Version
|
|
117
|
+
version: '0'
|
|
118
|
+
type: :development
|
|
119
|
+
prerelease: false
|
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - ">="
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: '0'
|
|
97
125
|
- !ruby/object:Gem::Dependency
|
|
98
126
|
name: simplecov
|
|
99
127
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -115,17 +143,28 @@ executables: []
|
|
|
115
143
|
extensions: []
|
|
116
144
|
extra_rdoc_files: []
|
|
117
145
|
files:
|
|
146
|
+
- ".github/FUNDING.yml"
|
|
147
|
+
- ".github/ISSUE_TEMPLATE/bug_report.md"
|
|
148
|
+
- ".github/ISSUE_TEMPLATE/feature_request.md"
|
|
149
|
+
- ".github/PULL_REQUEST_TEMPLATE.md"
|
|
150
|
+
- ".github/workflows/tests.yml"
|
|
118
151
|
- ".gitignore"
|
|
152
|
+
- ".rubocop.yml"
|
|
119
153
|
- ".travis.yml"
|
|
120
154
|
- CHANGELOG.md
|
|
121
155
|
- CODE_OF_CONDUCT.md
|
|
156
|
+
- CONTRIBUTING.md
|
|
122
157
|
- Gemfile
|
|
158
|
+
- LICENSE.md
|
|
123
159
|
- LICENSE.txt
|
|
124
160
|
- README.md
|
|
125
161
|
- Rakefile
|
|
126
162
|
- ar-enum.gemspec
|
|
127
|
-
-
|
|
128
|
-
-
|
|
163
|
+
- bin/console
|
|
164
|
+
- bin/setup
|
|
165
|
+
- gemfiles/5_2.gemfile
|
|
166
|
+
- gemfiles/6_0.gemfile
|
|
167
|
+
- gemfiles/6_1.gemfile
|
|
129
168
|
- lib/ar-enum.rb
|
|
130
169
|
- lib/ar/enum.rb
|
|
131
170
|
- lib/ar/enum/adapter.rb
|
|
@@ -136,7 +175,7 @@ homepage: https://rubygems.org/gems/ar-enum
|
|
|
136
175
|
licenses:
|
|
137
176
|
- MIT
|
|
138
177
|
metadata: {}
|
|
139
|
-
post_install_message:
|
|
178
|
+
post_install_message:
|
|
140
179
|
rdoc_options: []
|
|
141
180
|
require_paths:
|
|
142
181
|
- lib
|
|
@@ -144,15 +183,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
144
183
|
requirements:
|
|
145
184
|
- - ">="
|
|
146
185
|
- !ruby/object:Gem::Version
|
|
147
|
-
version:
|
|
186
|
+
version: 2.6.0
|
|
148
187
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
149
188
|
requirements:
|
|
150
189
|
- - ">="
|
|
151
190
|
- !ruby/object:Gem::Version
|
|
152
191
|
version: '0'
|
|
153
192
|
requirements: []
|
|
154
|
-
rubygems_version: 3.
|
|
155
|
-
signing_key:
|
|
193
|
+
rubygems_version: 3.2.22
|
|
194
|
+
signing_key:
|
|
156
195
|
specification_version: 4
|
|
157
196
|
summary: Add support for creating `ENUM` types in PostgreSQL with ActiveRecord
|
|
158
197
|
test_files: []
|