string_enumerate 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +9 -0
- data/LICENSE.txt +21 -0
- data/README.md +47 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/generators/string_enum/install_generator.rb +45 -0
- data/lib/generators/templates/app_config.yml +11 -0
- data/lib/string_enumerate/models.rb +104 -0
- data/lib/string_enumerate/orm/active_record.rb +7 -0
- data/lib/string_enumerate/version.rb +3 -0
- data/lib/string_enumerate.rb +2 -0
- data/string_enumerate.gemspec +43 -0
- metadata +103 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 93f60f669c7ab6742be41b34618e0a4cb0027996
|
4
|
+
data.tar.gz: ea8bd9c0cee7234ff1f5cfbc7b40bcd4549ac543
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 83db5c8f46315b6d2625380d675067098c1f64d21c8b23245c0f0e6094467bb1c1bb56aa01fcff1dcaaba490d1aeebaff025fd73d4b4270cfa448bf25c7dd40a
|
7
|
+
data.tar.gz: abde7ff1e2c2c6922687b9a528dd10bf60cd7721672c4ab3197091febb742bd9fa4c72c67141427a9de45999cf71f920924c144b3fccb90479220e796b52a3b0
|
data/.gitignore
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
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.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
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
|
22
|
+
|
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 se.ustinov@gmail.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 [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 Sergey U
|
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
|
13
|
+
all 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
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# StringEnumerate
|
2
|
+
|
3
|
+
Gem provide ability to use enum of active record with string field at DB and store available values at config(yml file)
|
4
|
+
|
5
|
+
@todo add description, tests
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'string_enumerate'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
$ rails g string_enumerate:install
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
app/models/post.rb
|
24
|
+
```ruby
|
25
|
+
class Post < ApplicationRecord
|
26
|
+
enumerate :status
|
27
|
+
....
|
28
|
+
end
|
29
|
+
```
|
30
|
+
|
31
|
+
config/models.yml
|
32
|
+
``` yaml
|
33
|
+
# YAML
|
34
|
+
post:
|
35
|
+
statuses:
|
36
|
+
- draft
|
37
|
+
- published
|
38
|
+
- archived
|
39
|
+
```
|
40
|
+
|
41
|
+
## Contributing
|
42
|
+
|
43
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/string_enumerate. 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.
|
44
|
+
|
45
|
+
## License
|
46
|
+
|
47
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "string_enumerate"
|
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 "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
require 'rails/generators/base'
|
2
|
+
|
3
|
+
module StringEnumerate
|
4
|
+
module Generators
|
5
|
+
class InstallGenerator < Rails::Generators::Base
|
6
|
+
source_root File.expand_path('../templates', __dir__)
|
7
|
+
|
8
|
+
desc 'create config file at application and set MODELS constant for next use'
|
9
|
+
|
10
|
+
def create_yml
|
11
|
+
create_file 'config/models.yml'
|
12
|
+
end
|
13
|
+
|
14
|
+
def create_constant
|
15
|
+
write_to_file(
|
16
|
+
file: 'config/environment.rb',
|
17
|
+
line: 'Rails.application.initialize!',
|
18
|
+
content_before: "MODELS = AppEnvConfig.get('models', false)",
|
19
|
+
shift: "\n" * 2
|
20
|
+
)
|
21
|
+
end
|
22
|
+
|
23
|
+
protected
|
24
|
+
|
25
|
+
def file_contain_content?(options = {})
|
26
|
+
file_content = File.read(options[:file])
|
27
|
+
|
28
|
+
(options[:content_before].blank? || file_content.include?(options[:content_before])) &&
|
29
|
+
(options[:content_after].blank? || file_content.include?(options[:content_after]))
|
30
|
+
end
|
31
|
+
|
32
|
+
def write_to_file(options = {})
|
33
|
+
return if file_contain_content?(options)
|
34
|
+
|
35
|
+
gsub_file options[:file], /(#{Regexp.escape(options[:line])})/mi do |match|
|
36
|
+
[
|
37
|
+
options[:content_before].presence,
|
38
|
+
match,
|
39
|
+
options[:content_after].presence
|
40
|
+
].compact.join(options.fetch(:shift, "\n"))
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,104 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'active_model'
|
4
|
+
|
5
|
+
module StringEnumerate
|
6
|
+
module Models
|
7
|
+
extend ActiveSupport::Concern
|
8
|
+
|
9
|
+
module ClassMethods
|
10
|
+
def enumerate(*fields)
|
11
|
+
set_enumerate_fields fields
|
12
|
+
before_validation :set_enum_fields
|
13
|
+
end
|
14
|
+
|
15
|
+
def set_enumerate_fields(fields) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Naming/AccessorMethodName
|
16
|
+
enumerate_fields = class_variable_get(:@@enumerate_fields) rescue nil # rubocop:disable Style/RescueModifier
|
17
|
+
enumerate_fields ||= {}.with_indifferent_access
|
18
|
+
|
19
|
+
enumerate_fields[name.underscore] ||= {}
|
20
|
+
|
21
|
+
fields.each do |field|
|
22
|
+
if field.is_a?(Hash)
|
23
|
+
(prefix = field[:prefix]) || (suffix = field[:suffix])
|
24
|
+
set_default = field[:set_default]
|
25
|
+
field = field[:field]
|
26
|
+
else
|
27
|
+
prefix = nil
|
28
|
+
suffix = nil
|
29
|
+
set_default = nil
|
30
|
+
end
|
31
|
+
|
32
|
+
enumeration_labels(field).each_with_object(prepared_labels = {}) do |k|
|
33
|
+
key = k.is_a?(Array) ? k.first : k
|
34
|
+
prepared_labels[key] = key
|
35
|
+
end
|
36
|
+
|
37
|
+
enumerate_fields[name.underscore][field] = {
|
38
|
+
field => prepared_labels,
|
39
|
+
_prefix: prefix,
|
40
|
+
_suffix: suffix
|
41
|
+
}
|
42
|
+
|
43
|
+
enum enumerate_fields[name.underscore][field]
|
44
|
+
|
45
|
+
enumerate_fields[name.underscore][field][:set_default] = set_default
|
46
|
+
end
|
47
|
+
|
48
|
+
class_variable_set :@@enumerate_fields, enumerate_fields
|
49
|
+
end
|
50
|
+
|
51
|
+
def enumeration_labels(field)
|
52
|
+
if (res = MODELS[name.underscore] && MODELS[name.underscore][field.to_s.pluralize])
|
53
|
+
return res
|
54
|
+
end
|
55
|
+
|
56
|
+
raise(
|
57
|
+
"Please set list of values in config/model.yml
|
58
|
+
for model '#{name.underscore}' with key '#{field.to_s.pluralize}'"
|
59
|
+
)
|
60
|
+
end
|
61
|
+
|
62
|
+
def enumeration_key_by_index(field, index)
|
63
|
+
enumeration_labels(field).to_a[index.to_i].first
|
64
|
+
end
|
65
|
+
|
66
|
+
def enumeration_label_by_index(field, index)
|
67
|
+
enumeration_labels(field).to_a[index.to_i].last
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
protected
|
72
|
+
|
73
|
+
def set_enum_changed_at(field) # rubocop:disable Naming/AccessorMethodName
|
74
|
+
return if changes[field].blank? || !attribute_names.include?("#{field}_changed_at")
|
75
|
+
|
76
|
+
send("#{field}_changed_at=", Time.zone.now)
|
77
|
+
end
|
78
|
+
|
79
|
+
def set_enum_default(field, values)
|
80
|
+
return if enumerate_fields[self.class.name.underscore][field][:set_default] == false
|
81
|
+
|
82
|
+
return if send(field).present?
|
83
|
+
|
84
|
+
send("#{field}=", values.to_a.first.first)
|
85
|
+
end
|
86
|
+
|
87
|
+
def enumerate_fields
|
88
|
+
self.class.class_variable_get(:@@enumerate_fields)
|
89
|
+
rescue NameError
|
90
|
+
Rails.logger 'no enumerate fields'
|
91
|
+
nil
|
92
|
+
end
|
93
|
+
|
94
|
+
def set_enum_fields
|
95
|
+
return unless enumerate_fields
|
96
|
+
|
97
|
+
defined_enums.each do |field, values|
|
98
|
+
set_enum_default(field, values)
|
99
|
+
|
100
|
+
set_enum_changed_at(field)
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "string_enumerate/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "string_enumerate"
|
8
|
+
spec.version = StringEnumerate::VERSION
|
9
|
+
spec.authors = ["Sergey U"]
|
10
|
+
spec.email = ["se.ustinov@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = 'String field for ActiveRecord::Enum'
|
13
|
+
spec.description = 'Gem provide ability to use enum of active record with string field at postgreSQL and store available values at config(yml file)'
|
14
|
+
spec.homepage = 'https://github.com/sergeyustinov/string_enumerate'
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
18
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
19
|
+
if spec.respond_to?(:metadata)
|
20
|
+
# spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
|
21
|
+
|
22
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
23
|
+
# spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
|
24
|
+
# spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
|
25
|
+
else
|
26
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
27
|
+
"public gem pushes."
|
28
|
+
end
|
29
|
+
|
30
|
+
# Specify which files should be added to the gem when it is released.
|
31
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
32
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
33
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
34
|
+
end
|
35
|
+
spec.bindir = "exe"
|
36
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
37
|
+
spec.require_paths = ["lib"]
|
38
|
+
|
39
|
+
spec.add_development_dependency "bundler", "~> 1.17"
|
40
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
41
|
+
|
42
|
+
spec.add_dependency("orm_adapter", "~> 0.1")
|
43
|
+
end
|
metadata
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: string_enumerate
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.4
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Sergey U
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-03-25 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.17'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.17'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: orm_adapter
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0.1'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0.1'
|
55
|
+
description: Gem provide ability to use enum of active record with string field at
|
56
|
+
postgreSQL and store available values at config(yml file)
|
57
|
+
email:
|
58
|
+
- se.ustinov@gmail.com
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- ".gitignore"
|
64
|
+
- CODE_OF_CONDUCT.md
|
65
|
+
- Gemfile
|
66
|
+
- LICENSE.txt
|
67
|
+
- README.md
|
68
|
+
- Rakefile
|
69
|
+
- bin/console
|
70
|
+
- bin/setup
|
71
|
+
- lib/generators/string_enum/install_generator.rb
|
72
|
+
- lib/generators/templates/app_config.yml
|
73
|
+
- lib/string_enumerate.rb
|
74
|
+
- lib/string_enumerate/models.rb
|
75
|
+
- lib/string_enumerate/orm/active_record.rb
|
76
|
+
- lib/string_enumerate/version.rb
|
77
|
+
- string_enumerate.gemspec
|
78
|
+
homepage: https://github.com/sergeyustinov/string_enumerate
|
79
|
+
licenses:
|
80
|
+
- MIT
|
81
|
+
metadata:
|
82
|
+
homepage_uri: https://github.com/sergeyustinov/string_enumerate
|
83
|
+
post_install_message:
|
84
|
+
rdoc_options: []
|
85
|
+
require_paths:
|
86
|
+
- lib
|
87
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - ">="
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
requirements: []
|
98
|
+
rubyforge_project:
|
99
|
+
rubygems_version: 2.6.13
|
100
|
+
signing_key:
|
101
|
+
specification_version: 4
|
102
|
+
summary: String field for ActiveRecord::Enum
|
103
|
+
test_files: []
|