logn-mongoid-enum 1.1.2 → 1.1.3
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 +4 -4
- data/.autotest +0 -0
- data/.gitignore +17 -9
- data/.rspec +1 -0
- data/.travis.yml +14 -0
- data/Gemfile +1 -1
- data/Guardfile +8 -0
- data/LICENSE.txt +18 -17
- data/README.md +146 -19
- data/Rakefile +0 -1
- data/lib/mongoid/enum/configuration.rb +19 -0
- data/lib/mongoid/enum/validators/multiple_validator.rb +29 -0
- data/lib/mongoid/enum/version.rb +5 -0
- data/lib/mongoid/enum.rb +93 -0
- data/logn-mongoid-enum.gemspec +4 -6
- metadata +9 -9
- data/CODE_OF_CONDUCT.md +0 -74
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/gemfiles/mongoid-5.gemfile +0 -4
- data/lib/logn/mongoid/enum/configuration.rb +0 -21
- data/lib/logn/mongoid/enum/validators/multiple_validator.rb +0 -31
- data/lib/logn/mongoid/enum/version.rb +0 -7
- data/lib/logn/mongoid/enum.rb +0 -95
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 41b8e0e962ed51440e5decb371ca565ca36cad93
|
4
|
+
data.tar.gz: d2653e3b16f71a4baa47897c62c7758d308953a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0e7e21dfe38b3175229a12769d2350a32700b6e39286f32444aadf3aacf848976fee13019efb0080002d519615cc6e9e9c836c5fcf5517e6b995906e971d0cf1
|
7
|
+
data.tar.gz: 32f3a25193cbd895cacaeac954e700286a85cd475b3dce10ee9c2b5593ef3081a26eec708f6f73af48c68c45d23c2e701ce07123baab5a7ec3e51c83c23a2a6c
|
data/.autotest
ADDED
File without changes
|
data/.gitignore
CHANGED
@@ -1,9 +1,17 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.config
|
5
|
+
.yardoc
|
6
|
+
Gemfile.lock
|
7
|
+
InstalledFiles
|
8
|
+
_yardoc
|
9
|
+
coverage
|
10
|
+
doc/
|
11
|
+
lib/bundler/man
|
12
|
+
pkg
|
13
|
+
rdoc
|
14
|
+
spec/reports
|
15
|
+
test/tmp
|
16
|
+
test/version_tmp
|
17
|
+
tmp
|
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/.travis.yml
ADDED
data/Gemfile
CHANGED
data/Guardfile
ADDED
data/LICENSE.txt
CHANGED
@@ -1,21 +1,22 @@
|
|
1
|
-
|
1
|
+
Copyright (c) 2013 Nicholas Bruning
|
2
2
|
|
3
|
-
|
3
|
+
MIT License
|
4
4
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
-
of this software and associated documentation files (the
|
7
|
-
in the Software without restriction, including
|
8
|
-
to use, copy, modify, merge, publish,
|
9
|
-
copies of the Software, and to
|
10
|
-
furnished to do so, subject to
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
11
12
|
|
12
|
-
The above copyright notice and this permission notice shall be
|
13
|
-
all copies or substantial portions of the Software.
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
14
15
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
THE SOFTWARE.
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
CHANGED
@@ -1,41 +1,168 @@
|
|
1
|
-
#
|
1
|
+
# Mongoid::Enum
|
2
2
|
|
3
|
-
|
3
|
+
[](https://travis-ci.org/thetron/mongoid-enum)
|
5
|
+
[](https://codeclimate.com/github/thetron/mongoid-enum)
|
4
6
|
|
5
|
-
|
7
|
+
Heavily inspired by [DHH's
|
8
|
+
ActiveRecord::Enum](https://github.com/rails/rails/commit/db41eb8a6ea88b854bf5cd11070ea4245e1639c5), this little library is
|
9
|
+
there to help you cut down the cruft in your models and make the
|
10
|
+
world a happier place at the same time.
|
6
11
|
|
7
|
-
|
12
|
+
A single line will get you fields, accessors, validations and scopes,
|
13
|
+
and a few other bits-and-bobs.
|
8
14
|
|
9
|
-
|
15
|
+
|
16
|
+
# Installation
|
17
|
+
|
18
|
+
Add this to your Gemfile:
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
gem "mongoid-enum"
|
22
|
+
```
|
23
|
+
|
24
|
+
And then run `bundle install`.
|
25
|
+
|
26
|
+
|
27
|
+
# Usage
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
class Payment
|
31
|
+
include Mongoid::Document
|
32
|
+
include Mongoid::Enum
|
33
|
+
|
34
|
+
enum :status, [:pending, :approved, :declined]
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
Aaaaaaand then you get things like:
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
payment = Payment.create
|
42
|
+
|
43
|
+
payment.status
|
44
|
+
# => :pending
|
45
|
+
|
46
|
+
payment.approved!
|
47
|
+
# => :approved
|
48
|
+
|
49
|
+
payment.pending?
|
50
|
+
# => :false
|
51
|
+
|
52
|
+
Payment.approved
|
53
|
+
# => Mongoid::Criteria for payments with status == :approved
|
54
|
+
|
55
|
+
```
|
56
|
+
|
57
|
+
# Features
|
58
|
+
|
59
|
+
## Field
|
60
|
+
|
61
|
+
Your enum value is stored as either a Symbol, or an Array (when storing
|
62
|
+
multiple values). The actual field name has a leading underscore (e.g.:
|
63
|
+
`_status`), but is also aliased with its actual name for you
|
64
|
+
convenience.
|
65
|
+
|
66
|
+
|
67
|
+
## Accessors
|
68
|
+
|
69
|
+
Your enums will get getters-and-setters with the same name. So using the
|
70
|
+
`Payment` example above:
|
10
71
|
|
11
72
|
```ruby
|
12
|
-
|
73
|
+
payment.status = :declined
|
74
|
+
payment.status
|
75
|
+
# => :declined
|
13
76
|
```
|
14
77
|
|
15
|
-
And
|
78
|
+
And you also get bang(!) and query(?) methods for each of the values in
|
79
|
+
your enum (see [this example](#usage).
|
16
80
|
|
17
|
-
$ bundle
|
18
81
|
|
19
|
-
|
82
|
+
## Constants
|
20
83
|
|
21
|
-
|
84
|
+
For each enum, you'll also get a constant named after it. This is to
|
85
|
+
help you elsewhere in your app, should you need to display, or leverage
|
86
|
+
the list of values. Using the above example:
|
22
87
|
|
23
|
-
|
88
|
+
```ruby
|
89
|
+
Payment::STATUS
|
90
|
+
# => [:pending, :approved, :declined]
|
91
|
+
```
|
92
|
+
|
93
|
+
|
94
|
+
## Validations
|
95
|
+
|
96
|
+
Enum values are automatically validated against the list. You can
|
97
|
+
disable this behaviour (see [below](#options)).
|
98
|
+
|
99
|
+
|
100
|
+
## Scopes
|
24
101
|
|
25
|
-
|
102
|
+
A scope added for each of your enum's values. Using the example above,
|
103
|
+
you'd automatically get:
|
26
104
|
|
27
|
-
|
105
|
+
```ruby
|
106
|
+
Payment.pending # => Mongoid::Criteria
|
107
|
+
Payment.approved # => Mongoid::Criteria
|
108
|
+
Payment.declined # => Mongoid::Criteria
|
109
|
+
```
|
28
110
|
|
29
|
-
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
111
|
|
31
|
-
|
112
|
+
# Options
|
32
113
|
|
33
|
-
##
|
114
|
+
## Default value
|
34
115
|
|
35
|
-
|
116
|
+
If not specified, the default will be the first in your list of values
|
117
|
+
(`:pending` in the example above). You can override this with the
|
118
|
+
`:default` option:
|
36
119
|
|
120
|
+
```ruby
|
121
|
+
enum :roles, [:manager, :administrator], :default => ""
|
122
|
+
```
|
37
123
|
|
38
|
-
##
|
124
|
+
## Multiple values
|
125
|
+
|
126
|
+
Sometimes you'll need to store multiple values from your list, this
|
127
|
+
couldn't be easier:
|
128
|
+
|
129
|
+
```ruby
|
130
|
+
enum :roles, [:basic, :manager, :administrator], :multiple => true
|
131
|
+
|
132
|
+
# ...
|
133
|
+
|
134
|
+
user = User.create
|
135
|
+
user.roles << :basic
|
136
|
+
user.roles << :manager
|
137
|
+
user.save!
|
138
|
+
|
139
|
+
user.manager? # => true
|
140
|
+
user.administrator? # => false
|
141
|
+
user.roles # => [:basic, :manager]
|
142
|
+
```
|
143
|
+
|
144
|
+
Since the underlying datatype for storing values is an array, if you
|
145
|
+
need to specify default(s), ensure you use an array:
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
enum :roles, [:noob, :author, :editor], :multiple => true, :default => [:author, :editor] # two defaults
|
149
|
+
enum :roles, [:noob, :author, :editor], :multiple => true, :default => [] # no default
|
150
|
+
```
|
151
|
+
|
152
|
+
## Validations
|
153
|
+
|
154
|
+
Validations are baked in by default, and ensure that the value(s) set in
|
155
|
+
your field are always from your list of options. If you need more
|
156
|
+
complex validations, or you just want to throw caution to the wind, you
|
157
|
+
can turn them off:
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
enum :status, [:up, :down], :validate => false
|
161
|
+
```
|
39
162
|
|
40
|
-
|
163
|
+
# Issues and Feature Requests
|
41
164
|
|
165
|
+
If you have any problems, or you have a suggestion, please [submit an
|
166
|
+
issue](https://github.com/thetron/mongoid-enum/issues) (and a failing
|
167
|
+
test, if you can). Pull requests and feature requests are alwasy welcome
|
168
|
+
and greatly appreciated.
|
data/Rakefile
CHANGED
@@ -0,0 +1,19 @@
|
|
1
|
+
module Mongoid
|
2
|
+
module Enum
|
3
|
+
class Configuration
|
4
|
+
attr_accessor :field_name_prefix
|
5
|
+
|
6
|
+
def initialize
|
7
|
+
self.field_name_prefix = "_"
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
def self.configuration
|
12
|
+
@configuration ||= Configuration.new
|
13
|
+
end
|
14
|
+
|
15
|
+
def self.configure
|
16
|
+
yield(configuration) if block_given?
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
module Mongoid
|
2
|
+
module Enum
|
3
|
+
module Validators
|
4
|
+
class MultipleValidator < ActiveModel::EachValidator
|
5
|
+
def validate_each(record, attribute, values)
|
6
|
+
values = Array(values)
|
7
|
+
|
8
|
+
if options[:allow_nil]
|
9
|
+
add_error_message record, attribute if !all_included?(values, options[:in])
|
10
|
+
else
|
11
|
+
add_error_message record, attribute if values.empty? || !all_included?(values, options[:in])
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
def add_error_message(record, attribute)
|
16
|
+
record.errors[attribute] << (options[:message] || "is not in #{options[:in].join ", "}")
|
17
|
+
end
|
18
|
+
|
19
|
+
def all_included?(values, allowed)
|
20
|
+
(values - allowed).empty?
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.kind
|
24
|
+
:custom
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
data/lib/mongoid/enum.rb
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
require "mongoid/enum/version"
|
2
|
+
require "mongoid/enum/validators/multiple_validator"
|
3
|
+
require "mongoid/enum/configuration"
|
4
|
+
|
5
|
+
module Mongoid
|
6
|
+
module Enum
|
7
|
+
extend ActiveSupport::Concern
|
8
|
+
module ClassMethods
|
9
|
+
|
10
|
+
def enum(name, values, options = {})
|
11
|
+
field_name = :"#{Mongoid::Enum.configuration.field_name_prefix}#{name}"
|
12
|
+
options = default_options(values).merge(options)
|
13
|
+
|
14
|
+
set_values_constant name, values
|
15
|
+
|
16
|
+
create_field field_name, options
|
17
|
+
|
18
|
+
create_validations field_name, values, options
|
19
|
+
define_value_scopes_and_accessors field_name, values, options
|
20
|
+
define_field_accessor name, field_name, options
|
21
|
+
end
|
22
|
+
|
23
|
+
private
|
24
|
+
def default_options(values)
|
25
|
+
{
|
26
|
+
:multiple => false,
|
27
|
+
:default => values.first,
|
28
|
+
:required => true,
|
29
|
+
:validate => true
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
def set_values_constant(name, values)
|
34
|
+
const_name = name.to_s.upcase
|
35
|
+
const_set const_name, values
|
36
|
+
end
|
37
|
+
|
38
|
+
def create_field(field_name, options)
|
39
|
+
type = options[:multiple] && Array || Symbol
|
40
|
+
field field_name, :type => type, :default => options[:default]
|
41
|
+
end
|
42
|
+
|
43
|
+
def create_validations(field_name, values, options)
|
44
|
+
if options[:multiple] && options[:validate]
|
45
|
+
validates field_name, :'mongoid/enum/validators/multiple' => { :in => values.map(&:to_sym), :allow_nil => !options[:required] }
|
46
|
+
#FIXME: Shouldn't this be `elsif options[:validate]` ???
|
47
|
+
elsif validate
|
48
|
+
validates field_name, :inclusion => {:in => values.map(&:to_sym)}, :allow_nil => !options[:required]
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def define_value_scopes_and_accessors(field_name, values, options)
|
53
|
+
values.each do |value|
|
54
|
+
scope value, ->{ where(field_name => value) }
|
55
|
+
|
56
|
+
if options[:multiple]
|
57
|
+
define_array_accessor(field_name, value)
|
58
|
+
else
|
59
|
+
define_string_accessor(field_name, value)
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
def define_field_accessor(name, field_name, options)
|
65
|
+
if options[:multiple]
|
66
|
+
define_array_field_accessor name, field_name
|
67
|
+
else
|
68
|
+
define_string_field_accessor name, field_name
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
def define_array_field_accessor(name, field_name)
|
73
|
+
class_eval "def #{name}=(vals) self.write_attribute(:#{field_name}, Array(vals).compact.map(&:to_sym)) end"
|
74
|
+
class_eval "def #{name}() self.read_attribute(:#{field_name}) end"
|
75
|
+
end
|
76
|
+
|
77
|
+
def define_string_field_accessor(name, field_name)
|
78
|
+
class_eval "def #{name}=(val) self.write_attribute(:#{field_name}, val && val.to_sym || nil) end"
|
79
|
+
class_eval "def #{name}() self.read_attribute(:#{field_name}) end"
|
80
|
+
end
|
81
|
+
|
82
|
+
def define_array_accessor(field_name, value)
|
83
|
+
class_eval "def #{value}?() self.#{field_name}.include?(:#{value}) end"
|
84
|
+
class_eval "def #{value}!() update_attributes! :#{field_name} => (self.#{field_name} || []) + [:#{value}] end"
|
85
|
+
end
|
86
|
+
|
87
|
+
def define_string_accessor(field_name, value)
|
88
|
+
class_eval "def #{value}?() self.#{field_name} == :#{value} end"
|
89
|
+
class_eval "def #{value}!() update_attributes! :#{field_name} => :#{value} end"
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
data/logn-mongoid-enum.gemspec
CHANGED
@@ -1,10 +1,11 @@
|
|
1
|
-
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
2
3
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
-
require '
|
4
|
+
require 'mongoid/enum/version'
|
4
5
|
|
5
6
|
Gem::Specification.new do |spec|
|
6
7
|
spec.name = 'logn-mongoid-enum'
|
7
|
-
spec.version =
|
8
|
+
spec.version = Mongoid::Enum::VERSION
|
8
9
|
spec.authors = ['kennethrosales']
|
9
10
|
spec.email = ['kenneth@lognllc.com']
|
10
11
|
|
@@ -13,9 +14,6 @@ Gem::Specification.new do |spec|
|
|
13
14
|
spec.homepage = "https://github.com/kennethrosales/logn-mongoid-enum"
|
14
15
|
spec.license = 'MIT'
|
15
16
|
|
16
|
-
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
17
|
-
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
18
|
-
|
19
17
|
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
20
18
|
f.match(%r{^(test|spec|features)/})
|
21
19
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logn-mongoid-enum
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- kennethrosales
|
@@ -102,19 +102,19 @@ extensions: []
|
|
102
102
|
extra_rdoc_files: []
|
103
103
|
files:
|
104
104
|
- ".DS_Store"
|
105
|
+
- ".autotest"
|
105
106
|
- ".gitignore"
|
106
|
-
-
|
107
|
+
- ".rspec"
|
108
|
+
- ".travis.yml"
|
107
109
|
- Gemfile
|
110
|
+
- Guardfile
|
108
111
|
- LICENSE.txt
|
109
112
|
- README.md
|
110
113
|
- Rakefile
|
111
|
-
-
|
112
|
-
-
|
113
|
-
-
|
114
|
-
- lib/
|
115
|
-
- lib/logn/mongoid/enum/configuration.rb
|
116
|
-
- lib/logn/mongoid/enum/validators/multiple_validator.rb
|
117
|
-
- lib/logn/mongoid/enum/version.rb
|
114
|
+
- lib/mongoid/enum.rb
|
115
|
+
- lib/mongoid/enum/configuration.rb
|
116
|
+
- lib/mongoid/enum/validators/multiple_validator.rb
|
117
|
+
- lib/mongoid/enum/version.rb
|
118
118
|
- logn-mongoid-enum.gemspec
|
119
119
|
homepage: https://github.com/kennethrosales/logn-mongoid-enum
|
120
120
|
licenses:
|
data/CODE_OF_CONDUCT.md
DELETED
@@ -1,74 +0,0 @@
|
|
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 kenneth@lognllc.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/bin/console
DELETED
@@ -1,14 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
require "bundler/setup"
|
4
|
-
require "logn/mongoid/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 "irb"
|
14
|
-
IRB.start(__FILE__)
|
data/bin/setup
DELETED
data/gemfiles/mongoid-5.gemfile
DELETED
@@ -1,21 +0,0 @@
|
|
1
|
-
module Logn
|
2
|
-
module Mongoid
|
3
|
-
module Enum
|
4
|
-
class Configuration
|
5
|
-
attr_accessor :field_name_prefix
|
6
|
-
|
7
|
-
def initialize
|
8
|
-
self.field_name_prefix = '_'
|
9
|
-
end
|
10
|
-
end
|
11
|
-
|
12
|
-
def self.configuration
|
13
|
-
@configuration ||= Configuration.new
|
14
|
-
end
|
15
|
-
|
16
|
-
def self.configure
|
17
|
-
yield(configuration) if block_given?
|
18
|
-
end
|
19
|
-
end
|
20
|
-
end
|
21
|
-
end
|
@@ -1,31 +0,0 @@
|
|
1
|
-
module Logn
|
2
|
-
module Mongoid
|
3
|
-
module Enum
|
4
|
-
module Validators
|
5
|
-
class MultipleValidator < ActiveModel::EachValidator
|
6
|
-
def validate_each(record, attribute, values)
|
7
|
-
values = Array(values)
|
8
|
-
|
9
|
-
if options[:allow_nil]
|
10
|
-
add_error_message record, attribute unless all_included?(values, options[:in])
|
11
|
-
else
|
12
|
-
add_error_message record, attribute if values.empty? || !all_included?(values, options[:in])
|
13
|
-
end
|
14
|
-
end
|
15
|
-
|
16
|
-
def add_error_message(record, attribute)
|
17
|
-
record.errors[attribute] << (options[:message] || "is not in #{options[:in].join ', '}")
|
18
|
-
end
|
19
|
-
|
20
|
-
def all_included?(values, allowed)
|
21
|
-
(values - allowed).empty?
|
22
|
-
end
|
23
|
-
|
24
|
-
def self.kind
|
25
|
-
:custom
|
26
|
-
end
|
27
|
-
end
|
28
|
-
end
|
29
|
-
end
|
30
|
-
end
|
31
|
-
end
|
data/lib/logn/mongoid/enum.rb
DELETED
@@ -1,95 +0,0 @@
|
|
1
|
-
require 'logn/mongoid/enum/version'
|
2
|
-
require 'logn/mongoid/enum/validators/multiple_validator'
|
3
|
-
require 'logn/mongoid/enum/configuration'
|
4
|
-
|
5
|
-
module Logn
|
6
|
-
module Mongoid
|
7
|
-
module Enum
|
8
|
-
extend ActiveSupport::Concern
|
9
|
-
module ClassMethods
|
10
|
-
def enum(name, values, options = {})
|
11
|
-
field_name = :"#{Logn::Mongoid::Enum.configuration.field_name_prefix}#{name}"
|
12
|
-
options = default_options(values).merge(options)
|
13
|
-
|
14
|
-
set_values_constant name, values
|
15
|
-
|
16
|
-
create_field field_name, options
|
17
|
-
|
18
|
-
create_validations field_name, values, options
|
19
|
-
define_value_scopes_and_accessors field_name, values, options
|
20
|
-
define_field_accessor name, field_name, options
|
21
|
-
end
|
22
|
-
|
23
|
-
private
|
24
|
-
|
25
|
-
def default_options(values)
|
26
|
-
{
|
27
|
-
multiple: false,
|
28
|
-
default: values.first,
|
29
|
-
required: true,
|
30
|
-
validate: true
|
31
|
-
}
|
32
|
-
end
|
33
|
-
|
34
|
-
def set_values_constant(name, values)
|
35
|
-
const_name = name.to_s.upcase
|
36
|
-
const_set const_name, values
|
37
|
-
end
|
38
|
-
|
39
|
-
def create_field(field_name, options)
|
40
|
-
type = options[:multiple] && Array || Symbol
|
41
|
-
field field_name, type: type, default: options[:default]
|
42
|
-
end
|
43
|
-
|
44
|
-
def create_validations(field_name, values, options)
|
45
|
-
if options[:multiple] && options[:validate]
|
46
|
-
validates field_name, 'logn/mongoid/enum/validators/multiple': { in: values.map(&:to_sym), allow_nil: !options[:required] }
|
47
|
-
# FIXME: Shouldn't this be `elsif options[:validate]` ???
|
48
|
-
elsif validate
|
49
|
-
validates field_name, inclusion: { in: values.map(&:to_sym) }, allow_nil: !options[:required]
|
50
|
-
end
|
51
|
-
end
|
52
|
-
|
53
|
-
def define_value_scopes_and_accessors(field_name, values, options)
|
54
|
-
values.each do |value|
|
55
|
-
scope value, -> { where(field_name => value) }
|
56
|
-
|
57
|
-
if options[:multiple]
|
58
|
-
define_array_accessor(field_name, value)
|
59
|
-
else
|
60
|
-
define_string_accessor(field_name, value)
|
61
|
-
end
|
62
|
-
end
|
63
|
-
end
|
64
|
-
|
65
|
-
def define_field_accessor(name, field_name, options)
|
66
|
-
if options[:multiple]
|
67
|
-
define_array_field_accessor name, field_name
|
68
|
-
else
|
69
|
-
define_string_field_accessor name, field_name
|
70
|
-
end
|
71
|
-
end
|
72
|
-
|
73
|
-
def define_array_field_accessor(name, field_name)
|
74
|
-
class_eval "def #{name}=(vals) self.write_attribute(:#{field_name}, Array(vals).compact.map(&:to_sym)) end"
|
75
|
-
class_eval "def #{name}() self.read_attribute(:#{field_name}) end"
|
76
|
-
end
|
77
|
-
|
78
|
-
def define_string_field_accessor(name, field_name)
|
79
|
-
class_eval "def #{name}=(val) self.write_attribute(:#{field_name}, val && val.to_sym || nil) end"
|
80
|
-
class_eval "def #{name}() self.read_attribute(:#{field_name}) end"
|
81
|
-
end
|
82
|
-
|
83
|
-
def define_array_accessor(field_name, value)
|
84
|
-
class_eval "def #{value}?() self.#{field_name}.include?(:#{value}) end"
|
85
|
-
class_eval "def #{value}!() update_attributes! :#{field_name} => (self.#{field_name} || []) + [:#{value}] end"
|
86
|
-
end
|
87
|
-
|
88
|
-
def define_string_accessor(field_name, value)
|
89
|
-
class_eval "def #{value}?() self.#{field_name} == :#{value} end"
|
90
|
-
class_eval "def #{value}!() update_attributes! :#{field_name} => :#{value} end"
|
91
|
-
end
|
92
|
-
end
|
93
|
-
end
|
94
|
-
end
|
95
|
-
end
|