mongoid-enum-logn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4d73a17bdea83319aa258345960004a399c2840
+  data.tar.gz: 06b72e7b2191fec9b0eb6f3cd6c9977e2fe4f7b4
+SHA512:
+  metadata.gz: 7a6a50b4c4b46ae5fc4ad36de844fb572134a081cf520feb8b2f90bdf9fade5ce9bdff4ae02703296da47ce7f5cc77c89cb3513536eac0322a95476551fd1af3
+  data.tar.gz: c4da5ecb6f255ff54bbdac3aecb0c7c9f6660d49c25e9d7245e32e3ca286a0720e2c9ddc653841e02d528c76ee8f79901d43de54526e1617959f5b62d12cfd19

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kenneth@lognllc.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-enum.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicholas Bruning
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+# Mongoid::Enum
+
+[![Build
+Status](https://travis-ci.org/thetron/mongoid-enum.png)](https://travis-ci.org/thetron/mongoid-enum)
+[![Code Climate](https://codeclimate.com/github/thetron/mongoid-enum.png)](https://codeclimate.com/github/thetron/mongoid-enum)
+
+Heavily inspired by [DHH's
+ActiveRecord::Enum](https://github.com/rails/rails/commit/db41eb8a6ea88b854bf5cd11070ea4245e1639c5), this little library is
+there to help you cut down the cruft in your models and make the
+world a happier place at the same time.
+
+A single line will get you fields, accessors, validations and scopes,
+and a few other bits-and-bobs.
+
+
+# Installation
+
+Add this to your Gemfile:
+
+```ruby
+gem "mongoid-enum"
+```
+
+And then run `bundle install`.
+
+
+# Usage
+
+```ruby
+class Payment
+  include Mongoid::Document
+  include Mongoid::Enum
+
+  enum :status, [:pending, :approved, :declined]
+end
+```
+
+Aaaaaaand then you get things like:
+
+```ruby
+payment = Payment.create
+
+payment.status
+# => :pending
+
+payment.approved!
+# => :approved
+
+payment.pending?
+# => :false
+
+Payment.approved
+# => Mongoid::Criteria for payments with status == :approved
+
+```
+
+# Features
+
+## Field
+
+Your enum value is stored as either a Symbol, or an Array (when storing
+multiple values). The actual field name has a leading underscore (e.g.:
+`_status`), but is also aliased with its actual name for you
+convenience.
+
+
+## Accessors
+
+Your enums will get getters-and-setters with the same name. So using the
+`Payment` example above:
+
+```ruby
+payment.status = :declined
+payment.status
+# => :declined
+```
+
+And you also get bang(!) and query(?) methods for each of the values in
+your enum (see [this example](#usage).
+
+
+## Constants
+
+For each enum, you'll also get a constant named after it. This is to
+help you elsewhere in your app, should you need to display, or leverage
+the list of values. Using the above example:
+
+```ruby
+Payment::STATUS
+# => [:pending, :approved, :declined]
+```
+
+
+## Validations
+
+Enum values are automatically validated against the list. You can
+disable this behaviour (see [below](#options)).
+
+
+## Scopes
+
+A scope added for each of your enum's values. Using the example above,
+you'd automatically get:
+
+```ruby
+Payment.pending # => Mongoid::Criteria
+Payment.approved # => Mongoid::Criteria
+Payment.declined # => Mongoid::Criteria
+```
+
+
+# Options
+
+## Default value
+
+If not specified, the default will be the first in your list of values
+(`:pending` in the example above). You can override this with the
+`:default` option:
+
+```ruby
+enum :roles, [:manager, :administrator], :default => ""
+```
+
+## Multiple values
+
+Sometimes you'll need to store multiple values from your list, this
+couldn't be easier:
+
+```ruby
+enum :roles, [:basic, :manager, :administrator], :multiple => true
+
+# ...
+
+user = User.create
+user.roles << :basic
+user.roles << :manager
+user.save!
+
+user.manager? # => true
+user.administrator? # => false
+user.roles # => [:basic, :manager]
+```
+
+Since the underlying datatype for storing values is an array, if you 
+need to specify default(s), ensure you use an array:
+
+```ruby
+enum :roles, [:noob, :author, :editor], :multiple => true, :default => [:author, :editor] # two defaults
+enum :roles, [:noob, :author, :editor], :multiple => true, :default => [] # no default
+```
+
+## Validations
+
+Validations are baked in by default, and ensure that the value(s) set in
+your field are always from your list of options. If you need more
+complex validations, or you just want to throw caution to the wind, you
+can turn them off:
+
+```ruby
+enum :status, [:up, :down], :validate => false
+```
+
+# Issues and Feature Requests
+
+If you have any problems, or you have a suggestion, please [submit an
+issue](https://github.com/thetron/mongoid-enum/issues) (and a failing
+test, if you can). Pull requests and feature requests are alwasy welcome
+and greatly appreciated.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid/enum/logn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongoid/enum/configuration.rb

@@ -0,0 +1,19 @@
+module Mongoid
+  module Enum
+    class Configuration
+      attr_accessor :field_name_prefix
+
+      def initialize
+        self.field_name_prefix = "_"
+      end
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration) if block_given?
+    end
+  end
+end

data/lib/mongoid/enum/validators/multiple_validator.rb

@@ -0,0 +1,29 @@
+module Mongoid
+  module Enum
+    module Validators
+      class MultipleValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, values)
+          values = Array(values)
+
+          if options[:allow_nil]
+            add_error_message record, attribute if !all_included?(values, options[:in])
+          else
+            add_error_message record, attribute if values.empty? || !all_included?(values, options[:in])
+          end
+        end
+
+        def add_error_message(record, attribute)
+          record.errors[attribute] << (options[:message] || "is not in #{options[:in].join ", "}")
+        end
+
+        def all_included?(values, allowed)
+          (values - allowed).empty?
+        end
+
+        def self.kind
+          :custom
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/enum/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Enum
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/mongoid/enum.rb

@@ -0,0 +1,93 @@
+require "mongoid/enum/version"
+require "mongoid/enum/validators/multiple_validator"
+require "mongoid/enum/configuration"
+
+module Mongoid
+  module Enum
+    extend ActiveSupport::Concern
+    module ClassMethods
+
+      def enum(name, values, options = {})
+        field_name = :"#{Mongoid::Enum.configuration.field_name_prefix}#{name}"
+        options = default_options(values).merge(options)
+
+        set_values_constant name, values
+
+        create_field field_name, options
+
+        create_validations field_name, values, options
+        define_value_scopes_and_accessors field_name, values, options
+        define_field_accessor name, field_name, options
+      end
+
+      private
+      def default_options(values)
+        {
+          :multiple => false,
+          :default  => values.first,
+          :required => true,
+          :validate => true
+        }
+      end
+
+      def set_values_constant(name, values)
+        const_name = name.to_s.upcase
+        const_set const_name, values
+      end
+
+      def create_field(field_name, options)
+        type = options[:multiple] && Array || Symbol
+        field field_name, :type => type, :default => options[:default]
+      end
+
+      def create_validations(field_name, values, options)
+        if options[:multiple] && options[:validate]
+          validates field_name, :'mongoid/enum/validators/multiple' => { :in => values.map(&:to_sym), :allow_nil => !options[:required] }
+        #FIXME: Shouldn't this be `elsif options[:validate]` ???
+        elsif validate
+          validates field_name, :inclusion => {:in => values.map(&:to_sym)}, :allow_nil => !options[:required]
+        end
+      end
+
+      def define_value_scopes_and_accessors(field_name, values, options)
+        values.each do |value|
+          scope value, ->{ where(field_name => value) }
+
+          if options[:multiple]
+            define_array_accessor(field_name, value)
+          else
+            define_string_accessor(field_name, value)
+          end
+        end
+      end
+
+      def define_field_accessor(name, field_name, options)
+        if options[:multiple]
+          define_array_field_accessor name, field_name
+        else
+          define_string_field_accessor name, field_name
+        end
+      end
+
+      def define_array_field_accessor(name, field_name)
+        class_eval "def #{name}=(vals) self.write_attribute(:#{field_name}, Array(vals).compact.map(&:to_sym)) end"
+        class_eval "def #{name}() self.read_attribute(:#{field_name}) end"
+      end
+
+      def define_string_field_accessor(name, field_name)
+        class_eval "def #{name}=(val) self.write_attribute(:#{field_name}, val && val.to_sym || nil) end"
+        class_eval "def #{name}() self.read_attribute(:#{field_name}) end"
+      end
+
+      def define_array_accessor(field_name, value)
+        class_eval "def #{value}?() self.#{field_name}.include?(:#{value}) end"
+        class_eval "def #{value}!() update_attributes! :#{field_name} => (self.#{field_name} || []) + [:#{value}] end"
+      end
+
+      def define_string_accessor(field_name, value)
+        class_eval "def #{value}?() self.#{field_name} == :#{value} end"
+        class_eval "def #{value}!() update_attributes! :#{field_name} => :#{value} end"
+      end
+    end
+  end
+end

data/mongoid-enum-logn.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-enum-logn"
+  spec.version       = Mongoid::Enum::VERSION
+  spec.authors       = ['kennethrosales']
+  spec.email         = ['kenneth@lognllc.com']
+
+  spec.description   = "Heavily inspired by DDH's ActiveRecord::Enum, this little library is there to help you cut down the cruft in your models and make the world a happier place at the same time."
+  spec.summary       = 'Sweet enum sugar for your Mongoid documents'
+  spec.homepage      = 'https://github.com/thetron/mongoid-enum'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mongoid', '>= 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6.2'
+  spec.add_development_dependency 'mongoid-rspec', '~> 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/spec/mongoid/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Mongoid::Enum::Configuration do
+  subject { Mongoid::Enum::Configuration.new }
+
+  describe "field_name_prefix" do
+    it "has '_' as default value" do
+      expect(subject.field_name_prefix).to eq "_"
+    end
+  end
+end

data/spec/mongoid/enum/validators/multiple_validator_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Mongoid::Enum::Validators::MultipleValidator do
+  subject { Mongoid::Enum::Validators::MultipleValidator }
+  let(:values) { [:lorem, :ipsum, :dolor, :sit] }
+  let(:attribute) { :word }
+  let(:record) { OpenStruct.new(:errors => {attribute => []}, attribute => values.first) }
+  let(:allow_nil) { false }
+  let(:validator) { subject.new(:attributes => attribute, :in => values, :allow_nil => allow_nil) }
+
+  describe ".validate_each" do
+    context "when allow_nil: true" do
+      let(:allow_nil) { true }
+
+      context "and value is nil" do
+        before(:each) { validator.validate_each(record, attribute, nil) }
+        it "validates" do
+          expect(record.errors[attribute].empty?).to be true
+        end
+      end
+
+      context "and value is []" do
+        before(:each) { validator.validate_each(record, attribute, []) }
+        it "validates" do
+          expect(record.errors[attribute].empty?).to be true
+        end
+      end
+    end
+
+    context "when allow_nil: false" do
+      context "and value is nil" do
+        before(:each) { validator.validate_each(record, attribute, nil) }
+        it "won't validate" do
+          expect(record.errors[attribute].any?).to be true
+          expect(record.errors[attribute]).to eq ["is not in #{values.join ", "}"]
+        end
+      end
+      context "and value is []" do
+        before(:each) { validator.validate_each(record, attribute, []) }
+        it "won't validate" do
+          expect(record.errors[attribute].any?).to be true
+          expect(record.errors[attribute]).to eq ["is not in #{values.join ", "}"]
+        end
+      end
+    end
+
+    context "when value is included" do
+      let(:allow_nil) { rand(2).zero? }
+      before(:each) { validator.validate_each(record, attribute, [values.sample]) }
+      it "validates" do
+        expect(record.errors[attribute].empty?).to be true
+      end
+    end
+
+    context "when value is not included" do
+      let(:allow_nil) { rand(2).zero? }
+      before(:each) { validator.validate_each(record, attribute, [:amet]) }
+      it "won't validate" do
+        expect(record.errors[attribute].any?).to be true
+      end
+    end
+
+    context "when multiple values included" do
+      let(:allow_nil) { rand(2).zero? }
+      before(:each) { validator.validate_each(record, attribute, [values.first, values.last]) }
+      it "validates" do
+        expect(record.errors[attribute].empty?).to be true
+      end
+    end
+
+    context "when one value is not included "do
+      let(:allow_nil) { rand(2).zero? }
+      before(:each) { validator.validate_each(record, attribute, [values.first, values.last, :amet]) }
+      it "won't validate" do
+        expect(record.errors[attribute].any?).to be true
+      end
+    end
+  end
+end

data/spec/mongoid/enum_spec.rb

@@ -0,0 +1,267 @@
+require 'spec_helper'
+require 'mongoid/enum/configuration'
+
+class User
+  include Mongoid::Document
+  include Mongoid::Enum
+
+  enum :status, [:awaiting_approval, :approved, :banned]
+  enum :roles, [:author, :editor, :admin], :multiple => true, :default => [], :required => false
+end
+
+describe Mongoid::Enum do
+  let(:klass) { User }
+  let(:instance) { User.new }
+  let(:alias_name) { :status }
+  let(:field_name) { :"_#{alias_name}" }
+  let(:values) { [:awaiting_approval, :approved, :banned] }
+  let(:multiple_field_name) { :"_roles" }
+
+  describe "field" do
+    it "is defined" do
+      expect(klass).to have_field(field_name)
+    end
+
+    it "uses prefix defined in configuration" do
+      old_field_name_prefix = Mongoid::Enum.configuration.field_name_prefix
+      Mongoid::Enum.configure do |config|
+        config.field_name_prefix = "___"
+      end
+      UserWithoutPrefix = Class.new do
+        include Mongoid::Document
+        include Mongoid::Enum
+
+        enum :status, [:awaiting_approval, :approved, :banned]
+      end
+      expect(UserWithoutPrefix).to have_field "___status"
+      Mongoid::Enum.configure do |config|
+        config.field_name_prefix = old_field_name_prefix
+      end
+    end
+
+    it "is aliased" do
+      expect(instance).to respond_to alias_name
+      expect(instance).to respond_to :"#{alias_name}="
+      expect(instance).to respond_to :"#{alias_name}"
+    end
+
+    describe "type" do
+      context "when multiple" do
+        it "is an array" do
+          expect(klass).to have_field(multiple_field_name).of_type(Array)
+        end
+
+        it "validates using a custom validator" do
+          expect(klass).to custom_validate(multiple_field_name).with_validator(Mongoid::Enum::Validators::MultipleValidator)
+        end
+      end
+
+      context "when not multiple" do
+        it "is a symbol" do
+          expect(klass).to have_field(field_name).of_type(Symbol)
+        end
+
+        it "validates inclusion in values" do
+          expect(klass).to validate_inclusion_of(field_name).to_allow(values)
+        end
+      end
+    end
+  end
+
+  describe "'required' option" do
+    context "when true" do
+      let(:instance) { User.new status: nil }
+      it "is not valid with nil value" do
+        expect(instance).to_not be_valid
+      end
+    end
+
+    context "when false" do
+      let(:instance) { User.new roles: nil }
+      it "is valid with nil value" do
+        expect(instance).to be_valid
+      end
+    end
+  end
+
+  describe "constant" do
+    it "is set to the values" do
+      expect(klass::STATUS).to eq values
+    end
+  end
+
+  describe "accessors" do
+    context "when singular" do
+      describe "setter" do
+        it "accepts strings" do
+          instance.status = 'banned'
+          expect(instance.status).to eq :banned
+        end
+
+        it "accepts symbols" do
+          instance.status = :banned
+          expect(instance.status).to eq :banned
+        end
+      end
+
+      describe "{{value}}!" do
+        it "sets the value" do
+          instance.save
+          instance.banned!
+          expect(instance.status).to eq :banned
+        end
+      end
+
+      describe "{{value}}?" do
+        context "when {{enum}} == {{value}}" do
+          it "returns true" do
+            instance.save
+            instance.banned!
+            expect(instance.banned?).to eq true
+          end
+        end
+        context "when {{enum}} != {{value}}" do
+          it "returns false" do
+            instance.save
+            instance.banned!
+            expect(instance.approved?).to eq false
+          end
+        end
+      end
+    end
+
+    context "when multiple" do
+      describe "setter" do
+        it "accepts strings" do
+          instance.roles = "author"
+          expect(instance.roles).to eq [:author]
+        end
+
+        it "accepts symbols" do
+          instance.roles = :author
+          expect(instance.roles).to eq [:author]
+        end
+
+        it "accepts arrays of strings" do
+          instance.roles = ['author', 'editor']
+          instance.save
+          puts instance.errors.full_messages
+          instance.reload
+          expect(instance.roles).to include(:author)
+          expect(instance.roles).to include(:editor)
+        end
+
+        it "accepts arrays of symbols"  do
+          instance.roles = [:author, :editor]
+          expect(instance.roles).to include(:author)
+          expect(instance.roles).to include(:editor)
+        end
+      end
+
+      describe "{{value}}!" do
+        context "when field is nil" do
+          it "creates an array containing the value" do
+            instance.roles = nil
+            instance.save
+            instance.author!
+            expect(instance.roles).to eq [:author]
+          end
+        end
+
+        context "when field is not nil" do
+          it "appends the value" do
+            instance.save
+            instance.author!
+            instance.editor!
+            expect(instance.roles).to eq [:author, :editor]
+          end
+        end
+      end
+
+      describe "{{value}}?" do
+        context "when {{enum}} contains {{value}}" do
+          it "returns true" do
+            instance.save
+            instance.author!
+            instance.editor!
+            expect(instance.editor?).to be true
+            expect(instance.author?).to be true
+          end
+        end
+
+        context "when {{enum}} does not contain {{value}}" do
+          it "returns false" do
+            instance.save
+            expect(instance.author?).to be false
+          end
+        end
+      end
+    end
+  end
+
+  describe "scopes" do
+    context "when singular" do
+      it "returns the corresponding documents" do
+        instance.save
+        instance.banned!
+        expect(User.banned.to_a).to eq [instance]
+      end
+    end
+
+    context "when multiple" do
+      context "and only one document" do
+        it "returns that document" do
+          instance.save
+          instance.author!
+          instance.editor!
+          expect(User.author.to_a).to eq [instance]
+        end
+      end
+
+      context "and more than one document" do
+        it "returns all documents with those values" do
+          instance.save
+          instance.author!
+          instance.editor!
+          instance2 = klass.create
+          instance2.author!
+          expect(User.author.to_a).to eq [instance, instance2]
+          expect(User.editor.to_a).to eq [instance]
+        end
+      end
+    end
+  end
+
+  describe "default values" do
+    context "when not specified" do
+      it "uses the first value" do
+        instance.save
+        expect(instance.status).to eq values.first
+      end
+    end
+
+    context "when specified" do
+      it "uses the specified value" do
+        instance.save
+        expect(instance.roles).to eq []
+      end
+    end
+  end
+
+  describe ".configuration" do
+    it "returns Configuration object" do
+      expect(Mongoid::Enum.configuration)
+          .to be_instance_of Mongoid::Enum::Configuration
+    end
+    it "returns same object when called multiple times" do
+      expect(Mongoid::Enum.configuration).to be Mongoid::Enum.configuration
+    end
+  end
+
+  describe ".configure" do
+    it "yields configuration if block is given" do
+      expect { |b| Mongoid::Enum.configure &b }
+          .to yield_with_args Mongoid::Enum.configuration
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'mongoid'
+require "mongoid/rspec"
+require 'mongoid/enum'
+
+ENV['MONGOID_ENV'] = "test"
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+
+  config.before(:each) do
+    Mongoid.purge!
+  end
+end
+
+Mongoid.load!(File.expand_path("../support/mongoid.yml", __FILE__), :test)
+Mongo::Logger.logger.level = ::Logger::INFO

data/spec/support/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  clients:
+    default:
+      database: mongoid-enum_test
+      hosts:
+        - localhost:<%= ENV['BOXEN_MONGODB_PORT'] || 27017 %>

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-enum-logn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kennethrosales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Heavily inspired by DDH's ActiveRecord::Enum, this little library is
+  there to help you cut down the cruft in your models and make the world a happier
+  place at the same time.
+email:
+- kenneth@lognllc.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".autotest"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid/enum.rb
+- lib/mongoid/enum/configuration.rb
+- lib/mongoid/enum/validators/multiple_validator.rb
+- lib/mongoid/enum/version.rb
+- mongoid-enum-logn.gemspec
+- spec/mongoid/configuration_spec.rb
+- spec/mongoid/enum/validators/multiple_validator_spec.rb
+- spec/mongoid/enum_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml
+homepage: https://github.com/thetron/mongoid-enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Sweet enum sugar for your Mongoid documents
+test_files:
+- spec/mongoid/configuration_spec.rb
+- spec/mongoid/enum/validators/multiple_validator_spec.rb
+- spec/mongoid/enum_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml