mongoid-enum 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmRmYzVkMTg5OTZiZjlmNDVkMjk2NDk1ODIxNDI0Zjc2NWZkNGNhMg==
+  data.tar.gz: !binary |-
+    MjU1MDU0MDJkZjE3YjIxM2M2MjY1NWE2NDNiN2UzNjMyOWY5Nzg4Nw==
+SHA512:
+  metadata.gz: !binary |-
+    MDU1Yjc2NmZjNTkxZTc1NTVkNjk2NjA0YTRkYjVjNzRjNDgyNzIzYzIzZmVl
+    NDNjZDQwMWJlZTNhZTI3OWYzYTg5M2NhMWRmZjNmYzFlYzM5MjY1MDc5NWY5
+    M2EyYmJjZjYwMThlZWI3Y2M1ZGUzZTA4YTUwNzc5ZWRlNWUxYzA=
+  data.tar.gz: !binary |-
+    OGRmOWM1OGY2NDljNmUzOWJiNTEwMjA4NDBmODc0YjMyZDgzNmRkNWMyZDlj
+    MjVmNzE4MTY0Yzk0MDNhMjhjMWUwZGNkOGY3MDJhOGE3ODliZTY4OGVkZjA3
+    OTMxNWYwYTllOGRjZjA4YmRmNmJiNjk1ZGE5M2ZlYzVjNmIwMzE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+script: "bundle exec rspec spec"
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+gemfile:
+  - Gemfile
+notifications:
+  recipients:
+    - nicholas@bruning.com.au
+services:
+  - mongodb

data/Gemfile

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

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,144 @@
+# Mongoid::Enum
+
+[![Build
+Status](https://travis-ci.org/thetron/mongoid-enum.png)](https://travis-ci.org/thetron/mongoid-enum)
+
+Heavily inspired by [DHH's
+ActiveRecord::Enum](https://github.com/rails/rails/commit/db41eb8a6ea88b854bf5cd11070ea4245e1639c5), this little library is
+just 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:
+
+    gem "mongoid-enum"
+
+And then run `bundle install`.
+
+
+# Usage
+
+````
+class Payment
+  include Mongoid::Document
+  include Mongoid::Enum
+
+  enum :status, [:pending, :approved, :declined], 
+end
+````
+
+Aaaaaaand then you get things like:
+
+````
+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:
+
+````
+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:
+
+````
+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:
+
+````
+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:
+
+    enum :roles, [:manager, :administrator], :default => ""
+
+
+## Multiple values
+
+Sometimes you'll need to store multiple values from your list, this
+couldn't be easier:
+
+    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]
+
+
+## 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:
+
+    enum :status => [:up, :down], :validation => false

data/Rakefile

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

data/lib/mongoid/enum.rb

@@ -0,0 +1,41 @@
+require "mongoid/enum/version"
+require "mongoid/enum/validators/multiple_validator"
+
+module Mongoid
+  module Enum
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def enum(name, values, options = {})
+        field_name = :"_#{name}"
+        const_name = name.to_s.upcase
+        multiple = options[:multiple] || false
+        default = options[:default].nil? && values.first || options[:default]
+        required = options[:required].nil? || options[:required]
+
+        const_set const_name, values
+
+        type = multiple && Array || Symbol
+        field field_name, :type => type, :default => default
+        alias_attribute name, field_name
+
+        if multiple
+          validates field_name, :'mongoid/enum/validators/multiple' => { :in => values, :allow_nil => !required }
+        else
+          validates field_name, :inclusion => {:in => values}, :allow_nil => !required
+        end
+
+        values.each do |value|
+          scope value, where(field_name => value)
+
+          if multiple
+            class_eval "def #{value}?() self.#{field_name}.include?(:#{value}) end"
+            class_eval "def #{value}!() update_attributes! :#{field_name} => (self.#{field_name} || []) + [:#{value}] end"
+          else
+            class_eval "def #{value}?() self.#{field_name} == :#{value} end"
+            class_eval "def #{value}!() update_attributes! :#{field_name} => :#{value} end"
+          end
+        end
+      end
+    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.1.0"
+  end
+end

data/mongoid-enum.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-enum"
+  spec.version       = Mongoid::Enum::VERSION
+  spec.authors       = ["Nicholas Bruning"]
+  spec.email         = ["nicholas@bruning.com.au"]
+  spec.description   = %q{Heavily inspired by DDH's ActiveRecord::Enum, this little library is just there to help you cut down the cruft in your models and make the world a happier place at the same time.}
+  spec.summary       = %q{Sweet enum sugar for your Mongoid documents}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "mongoid", "~>3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.0.3"
+  spec.add_development_dependency "database_cleaner", "~> 1.2.0"
+  spec.add_development_dependency "mongoid-rspec", "~> 1.5.1"
+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,177 @@
+require 'spec_helper'
+
+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 "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 "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 "{{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 "{{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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'database_cleaner'
+require 'mongoid'
+require 'mongoid-rspec'
+require 'mongoid/enum'
+
+ENV['MONGOID_ENV'] = "test"
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+    Mongoid.purge!
+  end
+end
+
+Mongoid.load!(File.expand_path("../support/mongoid.yml", __FILE__), :test)

data/spec/support/mongoid.yml

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Bruning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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: 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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Heavily inspired by DDH's ActiveRecord::Enum, this little library is
+  just there to help you cut down the cruft in your models and make the world a happier
+  place at the same time.
+email:
+- nicholas@bruning.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/enum.rb
+- lib/mongoid/enum/validators/multiple_validator.rb
+- lib/mongoid/enum/version.rb
+- mongoid-enum.gemspec
+- spec/mongoid/enum/validators/multiple_validator_spec.rb
+- spec/mongoid/enum_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml
+homepage: ''
+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.1.1
+signing_key: 
+specification_version: 4
+summary: Sweet enum sugar for your Mongoid documents
+test_files:
+- spec/mongoid/enum/validators/multiple_validator_spec.rb
+- spec/mongoid/enum_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml