mongoid_enum 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b67dcfd5fb5d061dd20797d9ebe7dc54114030d2
-  data.tar.gz: 982b2d073dd01bb563f8446b05f37a9e30dee7a7
+  metadata.gz: 7322c753d62aa63f83857466b28c7893b25a813d
+  data.tar.gz: 833b534f7c445d679d7765d3298b42b1a26da430
 SHA512:
-  metadata.gz: 19171e4d95f8c56c387306f2745af4a685ac3122e5d9804dfe9bc1db84866a32fdde3fa90f5d2805abe8a6522f9d44d2d63122c94739412a24378bccbd92f13d
-  data.tar.gz: 0732be4b09f52e3b8a6b3896d52c61b51aa5fbdcf31a3d9212ca7b26e7bc92e8f06733c22b30a251025119b5150309981a638d5ea23c91122c025cb16cd55ebe
+  metadata.gz: e0c1bf3e5d739ec44ff977f702d5c5deb52b45fba80f5ae8dbe0ed35f08db020cb0679363cb7ea6d5d0d4747661873d6a3ee39df19b5cf0663aa1aa6c4687132
+  data.tar.gz: a98fb0dfd5d5b458f1d0b4079680e6810c241c00704da5a4d87156456f344097bfc5b7a74bac2bddb39c5200bc26a1d9cca229f5118a1c89b9b3b5c4490cb835

data/README.md

@@ -34,6 +34,8 @@ the enum mapping:
     end
 
     part = Part.qc_pending.first
+    part.qc_pending?        # true
+    part["quality_control"] # nil
     part.quality_control    # "pending"
     part.qc_passed!
     part.quality_control    # "passed"
@@ -50,6 +52,8 @@ Constant name is a pluralized field name set in SCREAMING\_SNAKE\_CASE.
     Part::QUALITY_CONTROLS["passed"] # true
     Part::QUALITY_CONTROLS[:failed]  # false
 
+Read more in [documentation](http://www.rubydoc.info/gems/mongoid_enum/Mongoid/Enum).
+
 # Differences from ActiveRecord
 
 1. Default values are strings, not integers. I think it fits MongoDB better.

data/lib/mongoid/enum.rb

@@ -26,43 +26,37 @@ module Mongoid # :nodoc:
   #   conversation.status.nil? # => true
   #   conversation.status      # => nil
   #
-  # Scopes based on the allowed values of the enum field will be provided
-  # as well. With the above example:
-  #
-  #   Conversation.active
-  #   Conversation.archived
-  #
-  # Of course, you can also query them directly if the scopes don't fit your
-  # needs:
   #
-  #   Conversation.where(status: [:active, :archived])
-  #   Conversation.not.where(status: :active)
-  #
-  # You can set the default value:
+  # By default the whole label name is saved in the database as string, but you can
+  # explicitly declare values for each label. Strings, numbers, booleans, nil and some
+  # others types are allowed.
   #
   #   class Conversation
   #     include Mongoid::Document
   #     include Mongoid::Enum
   #
-  #     enum status: [ :active, :archived ], _default: :active
+  #     enum status: { active: 0, archived: 1 }, _default: :active
   #   end
   #
-  # Finally, it's also possible to explicitly map the relation between attribute and
-  # values stored in the database with a hash. The values don't even need to be Strings.
-  # Numbers, Booleans, nil and some others are allowed.
+  # The mappings are exposed through a class constant with the pluralized field name.
+  # It defines the mapping using +HashWithIndifferentAccess+:
   #
-  #   class Conversation
-  #     include Mongoid::Document
-  #     include Mongoid::Enum
+  #   Conversation::STATUSES[:active]    # => 0
+  #   Conversation::STATUSES["archived"] # => 1
   #
-  #     enum status: { active: 0, archived: 1 }
-  #   end
   #
-  # The mappings are exposed through a class constant with the pluralized attribute
-  # name. It defines the mapping in a +HashWithIndifferentAccess+:
+  # Scopes based on the allowed values of the enum field will be provided
+  # as well. With the above example:
+  #
+  #   Conversation.active
+  #   Conversation.archived
+  #
+  # Of course, you can also query them directly if the scopes don't fit your
+  # needs:
+  #
+  #   Conversation.where(status: [:active, :archived])
+  #   Conversation.not.where(status: :active)
   #
-  #   Conversation::STATUSES[:active]    # => 0
-  #   Conversation::STATUSES["archived"] # => 1
   #
   # Defining an enum automatically adds a validator on its field. Assigning values
   # not included in enum definition will make the document invalid.
@@ -78,7 +72,7 @@ module Mongoid # :nodoc:
   #     include Mongoid::Document
   #     include Mongoid::Enum
   #
-  #     enum status: { active: 0, archived: 1 }
+  #     enum status: { active: 0, archived: 1 }, _default: :active
   #
   #     validates :status, presence: true
   #   end
@@ -106,6 +100,7 @@ module Mongoid # :nodoc:
   #   conversation.comments_inactive!
   #   conversation.comments_active? # => false
   #
+  #
   # If you want to you can give nil value an explicit label.
   #
   #   class Part
@@ -116,9 +111,12 @@ module Mongoid # :nodoc:
   #   end
   #
   #   part = Part.qc_pending.first
-  #   part.qc_pending? # true
+  #   part.qc_pending?        # true
+  #   part["quality_control"] # nil
+  #   part.quality_control    # "pending"
   #   part.qc_passed!
-  #   part.qc_pending? # false
+  #   part.quality_control    # "passed"
+  #   part["quality_control"] # true
   module Enum
     extend ActiveSupport::Concern
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Adam Wróbel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid