mongoid-enum 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTJkYTBhNGI1MDQ1OTAyMDdmZDU1NGMxODFkNjI5YTBlNTczNTQwNA==
-  data.tar.gz: !binary |-
-    MzgxMTU4ZjJhYzA0ZTg5ZWZjY2QzOGM5YWM4N2NmNDZiODBjYThkZQ==
+  metadata.gz: c0380dc80b62126bdaec73b7b84f45eff8ecc607
+  data.tar.gz: 1ea999b331c3500038eaa3e22309ba67fd1f6b51
 SHA512:
-  metadata.gz: !binary |-
-    ZTExODM0ZDEwN2I1MGZhNzZmMjNmOGM3MjFkOGNlYWI2ZWFlNjY2NGI5YTEx
-    ZDdiMTU2OTJjMmFmMTQzZThhODhkNmJkMDUzYTJlODI1YWExOWU0ZmU1OGYy
-    ZTYwNmFlNDZiZGEwZGM0MmNkODNlM2IzYWViNTJlNGJjNjZmODY=
-  data.tar.gz: !binary |-
-    MWVkNDk1ODg1YWVjZWM5Y2U5NzQ3NmFlNjY4N2Y2N2Y2OTQyMzQ5Y2U5N2Zh
-    MTExODgyNzQxYThiMGQxZjQwMzYzY2Q1MzFjZjIxZWE2NmMzZDE5ZmI2MDdl
-    NDVjYmQwODBlYmJkZWViY2JjY2MyZTdhMjljMWYwYTk2NDYyODU=
+  metadata.gz: 63a8a27751a95d12b23fa52619810079782218ca18d72febcc6dcc1baff257d7aefe9f01eb27eb8a2918b0cac75d7de7a6c65f7c95f0e47d2124059a9b864249
+  data.tar.gz: 6a3d706e2115b79da8a51925a7d57ba385953b1d24c3ea196e563bb88ce24b914ce5fe08d346643747d5b02fa16c9ec7b3521e5d5d075feaabd580fc4657a85b

data/.travis.yml

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

data/README.md

@@ -2,6 +2,7 @@
 
 [![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
@@ -16,25 +17,27 @@ and a few other bits-and-bobs.
 
 Add this to your Gemfile:
 
-    gem "mongoid-enum"
+```ruby
+gem "mongoid-enum"
+```
 
 And then run `bundle install`.
 
 
 # Usage
 
-````
+```ruby
 class Payment
   include Mongoid::Document
   include Mongoid::Enum
 
-  enum :status, [:pending, :approved, :declined], 
+  enum :status, [:pending, :approved, :declined]
 end
-````
+```
 
 Aaaaaaand then you get things like:
 
-````
+```ruby
 payment = Payment.create
 
 payment.status
@@ -49,7 +52,7 @@ payment.pending?
 Payment.approved
 # => Mongoid::Criteria for payments with status == :approved
 
-````
+```
 
 # Features
 
@@ -64,13 +67,13 @@ convenience.
 ## Accessors
 
 Your enums will get getters-and-setters with the same name. So using the
-'Payment' example above:
+`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).
@@ -82,10 +85,10 @@ 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
@@ -99,11 +102,11 @@ disable this behaviour (see [below](#options)).
 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
@@ -114,25 +117,37 @@ 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 => ""
-
+```ruby
+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
+```ruby
+enum :roles, [:basic, :manager, :administrator], :multiple => true
+
+# ...
 
-    user = User.create
-    user.roles << :basic
-    user.roles << :manager
-    user.save!
+user = User.create
+user.roles << :basic
+user.roles << :manager
+user.save!
 
-    user.manager? # => true
-    user.administrator? # => false
-    user.roles # => [:basic, :manager]
+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
 
@@ -141,8 +156,9 @@ 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], :validate => false
-
+```ruby
+enum :status, [:up, :down], :validate => false
+```
 
 # Issues and Feature Requests
 

data/lib/mongoid/enum.rb

@@ -5,38 +5,69 @@ 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]
-        validate = options[:validate].nil? || options[:validate]
+        options = default_options(values).merge(options)
 
-        const_set const_name, values
+        set_values_constant name, values
 
-        type = multiple && Array || Symbol
-        field field_name, :type => type, :default => default
+        create_field field_name, options
         alias_attribute name, field_name
 
-        if multiple && validate
-          validates field_name, :'mongoid/enum/validators/multiple' => { :in => values, :allow_nil => !required }
+        create_validations field_name, values, options
+        define_value_scopes_and_accessors field_name, values, 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, :allow_nil => !options[:required] }
         elsif validate
-          validates field_name, :inclusion => {:in => values}, :allow_nil => !required
+          validates field_name, :inclusion => {:in => values}, :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)
+          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"
+          if options[:multiple]
+            define_array_accessor(field_name, value)
           else
-            class_eval "def #{value}?() self.#{field_name} == :#{value} end"
-            class_eval "def #{value}!() update_attributes! :#{field_name} => :#{value} end"
+            define_string_accessor(field_name, value)
           end
         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/lib/mongoid/enum/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Enum
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/mongoid-enum.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "mongoid", "~>3.1"
+  spec.add_runtime_dependency "mongoid", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicholas Bruning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2014-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sweet enum sugar for your Mongoid documents