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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 65fcc4a7e3250aa3718e4be66d8fad6a47d13fce
4
- data.tar.gz: 50b70bf87cf51db2ed45a6a4384c8fa15484ad5c
3
+ metadata.gz: 41b8e0e962ed51440e5decb371ca565ca36cad93
4
+ data.tar.gz: d2653e3b16f71a4baa47897c62c7758d308953a3
5
5
  SHA512:
6
- metadata.gz: 71b8afa64fa2cf2e4d68502f7fd007f603d5494855c6adbbe261df994c4f93ba6ac8af2d71b0e58600b3a25f99f570628e18a2f0c47558fae568e9f697331796
7
- data.tar.gz: 7900795d8bcdd9304639de3ccd6f95c4443edb5af701dee45578272ef96bb2430d25656161e5e163876aeb8e300b1ea01c3e6894dafeb8adaa40d4fb871f26dd
6
+ metadata.gz: 0e7e21dfe38b3175229a12769d2350a32700b6e39286f32444aadf3aacf848976fee13019efb0080002d519615cc6e9e9c836c5fcf5517e6b995906e971d0cf1
7
+ data.tar.gz: 32f3a25193cbd895cacaeac954e700286a85cd475b3dce10ee9c2b5593ef3081a26eec708f6f73af48c68c45d23c2e701ce07123baab5a7ec3e51c83c23a2a6c
data/.autotest ADDED
File without changes
data/.gitignore CHANGED
@@ -1,9 +1,17 @@
1
- /.bundle/
2
- /.yardoc
3
- /Gemfile.lock
4
- /_yardoc/
5
- /coverage/
6
- /doc/
7
- /pkg/
8
- /spec/reports/
9
- /tmp/
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
@@ -0,0 +1,14 @@
1
+ script: "bundle exec rspec spec"
2
+
3
+ language: ruby
4
+
5
+ rvm:
6
+ - 1.9.3
7
+ - 2.0.0
8
+ - 2.1.0
9
+ - 2.1.1
10
+ - 2.1.2
11
+ - jruby-19mode
12
+
13
+ services:
14
+ - mongodb
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
1
  source 'https://rubygems.org'
2
2
 
3
- # Specify your gem's dependencies in logn-mongoid-enum.gemspec
3
+ # Specify your gem's dependencies in mongoid-enum.gemspec
4
4
  gemspec
data/Guardfile ADDED
@@ -0,0 +1,8 @@
1
+ # A sample Guardfile
2
+ # More info at https://github.com/guard/guard#readme
3
+
4
+ guard :rspec, cmd: "bundle exec rspec" do
5
+ watch(%r{^spec/.+_spec\.rb$})
6
+ watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
7
+ watch('spec/spec_helper.rb') { "spec" }
8
+ end
data/LICENSE.txt CHANGED
@@ -1,21 +1,22 @@
1
- The MIT License (MIT)
1
+ Copyright (c) 2013 Nicholas Bruning
2
2
 
3
- Copyright (c) 2018 kennethrosales
3
+ MIT License
4
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:
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 included in
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, 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.
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
- # Logn::Mongoid::Enum
1
+ # Mongoid::Enum
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/logn/mongoid/enum`. To experiment with that code, run `bin/console` for an interactive prompt.
3
+ [![Build
4
+ Status](https://travis-ci.org/thetron/mongoid-enum.png)](https://travis-ci.org/thetron/mongoid-enum)
5
+ [![Code Climate](https://codeclimate.com/github/thetron/mongoid-enum.png)](https://codeclimate.com/github/thetron/mongoid-enum)
4
6
 
5
- TODO: Delete this and the text above, and describe your gem
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
- ## Installation
12
+ A single line will get you fields, accessors, validations and scopes,
13
+ and a few other bits-and-bobs.
8
14
 
9
- Add this line to your application's Gemfile:
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
- gem 'logn-mongoid-enum'
73
+ payment.status = :declined
74
+ payment.status
75
+ # => :declined
13
76
  ```
14
77
 
15
- And then execute:
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
- Or install it yourself as:
82
+ ## Constants
20
83
 
21
- $ gem install logn-mongoid-enum
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
- ## Usage
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
- TODO: Write usage instructions here
102
+ A scope added for each of your enum's values. Using the example above,
103
+ you'd automatically get:
26
104
 
27
- ## Development
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
- 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).
112
+ # Options
32
113
 
33
- ## Contributing
114
+ ## Default value
34
115
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/kennethrosales/logn-mongoid-enum. 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.
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
- ## License
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
- The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
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
@@ -1,2 +1 @@
1
1
  require "bundler/gem_tasks"
2
- task :default => :spec
@@ -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
@@ -0,0 +1,5 @@
1
+ module Mongoid
2
+ module Enum
3
+ VERSION = "1.1.3"
4
+ end
5
+ end
@@ -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
@@ -1,10 +1,11 @@
1
- lib = File.expand_path('lib', __dir__)
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
2
3
  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
- require 'logn/mongoid/enum/version'
4
+ require 'mongoid/enum/version'
4
5
 
5
6
  Gem::Specification.new do |spec|
6
7
  spec.name = 'logn-mongoid-enum'
7
- spec.version = Logn::Mongoid::Enum::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.2
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
- - CODE_OF_CONDUCT.md
107
+ - ".rspec"
108
+ - ".travis.yml"
107
109
  - Gemfile
110
+ - Guardfile
108
111
  - LICENSE.txt
109
112
  - README.md
110
113
  - Rakefile
111
- - bin/console
112
- - bin/setup
113
- - gemfiles/mongoid-5.gemfile
114
- - lib/logn/mongoid/enum.rb
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
@@ -1,8 +0,0 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here
@@ -1,4 +0,0 @@
1
- source 'https://rubygems.org'
2
-
3
- gemspec path: "../"
4
- gem "mongoid", "~> 5.2"
@@ -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
@@ -1,7 +0,0 @@
1
- module Logn
2
- module Mongoid
3
- module Enum
4
- VERSION = "1.1.2"
5
- end
6
- end
7
- end
@@ -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