mongoid-state_bits 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cff50fbda762d896f4348e08bce7958ab8c9bff3
-  data.tar.gz: dcedf6d0e7d88495736dc7ff5f3ea8d582f40a9a
+  metadata.gz: 19044835ee724da47afa719178fcfb3bad1c51a2
+  data.tar.gz: ade16ed0092d23e1d3eab400603e832a9bfa3b3e
 SHA512:
-  metadata.gz: 081e8a5c312fda195735f338af53feae57751b3a8954234ccc97aee6956144aab29258b98a00ededb80b505a65d84ca74736848694308c44ec2ad5faf091040a
-  data.tar.gz: ed79e03c1001c9dd6bdc5f9454e2946f19a25d7b6a19bdc3a000ebbbf186c4121e43b121b4230e28b9844eeb964b89f1646a31f23707a6cc50f207328af31be4
+  metadata.gz: 68f38ced9d72c32f6721ef4d2cc9c58ebf0b7926d5839faf5dc65be076dbb8ce035a3e4ca6fb3a2b63090132eb2f4181320248a55045a316d5d85d275cfea833
+  data.tar.gz: 6a15429a9d66a481bed7e2e8e51f25b0812166f3e61bc791223e6dcf16940150ec3ca702789cab5c8e7d7e907fb0a4bbdcf601a97c1e40e6fcc383d62d918202

data/README.md

@@ -1,8 +1,8 @@
 # Mongoid::StateBits
 
-When making the database design, we often need to add a lot of Boolean type field, such as whether to open an article, whether to allow comments, whether original and so on. When only a Boolean field, direct statement of Boolean type is OK; When there are a lot of fields, it is clear eleven declarations harm than good, a waste of space and will bring a lot of duplicate code.
+When making the database design, we often need to add a lot of Boolean type field, such as whether to open an article, whether to allow comments, whether original and so on. When only a Boolean field, direct statement of Boolean type is OK; When there are a lot of field, it is clear eleven declarations harm than good, a waste of space and will bring a lot of duplicate code.
 
-A common practice is to these boolean fields are integrated into an integer field, a binary bit represents a Boolean field. For an article, if 1 (the first bit) means open, 2 (second bit) means commentable, 4 means original, then an open, commentable, original article was marked as 7 (1 +2 +4), open, does not allow comments, original articles marked as 5 (1 +0 +4). Fields can be marked with an integer instead of multiple Boolean attributes, obviously it is good, but doing so will cause inconvenience on code management. For a programmer to deal directly with these flag bits will be a headache, and such code does not look elegant.
+A common solution is that these boolean field are integrated into an integer field, a binary bit represents a Boolean field. For an article, if 1 (the first bit) means open, 2 (second bit) means commentable, 4 means original, then an open, commentable, original article was marked as 7 (1 +2 +4), open, does not allow comments, original articles marked as 5 (1 +0 +4). field can be marked with an integer instead of multiple Boolean attributes, obviously it is good, but doing so will cause inconvenience on code management. For a programmer to deal directly with these flag bits will be a headache, and such code does not look elegant.
 
 Mongoid::StateBits provides an elegant way to manage such situation.
 
@@ -29,13 +29,13 @@ Use the follwing code:
       state_bits %w{deleted commentable original}
     end
 
-Three state_bits statement of three boolean field will generate three methods for each one,  commentable/commentable?/commentable= () in `commentable` case, and also generate a `scope` corresponding to each field.
+Three state_bits statement of three boolean field will generate three methods for each one,  commentable()/commentable?()/commentable=() in `commentable` case, and also generate a `scope` corresponding to each field.
 
-If you need to increase the field in the array can be directly% w {deleted commentable original} which added that all field default values ​​are false.
+If you need to add field, just push it on to the end of this array %w{deleted commentable original}, the default value of all field ​​is false(Boolean).
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/mongoid-state_bits/fork )
+1. Fork it ( http://github.com/Slacken/mongoid-state_bits/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/mongoid/state_bits/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module StateBits
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/mongoid/state_bits.rb

@@ -4,21 +4,32 @@ require "mongoid/state_bits/version"
 #   include Mongoid::Document
 #   include Mongoid::StateBits
 #   state_bits %w{public commentable original}
+#or state_bits public: true, commentable: false
 # end
 # =====================================
 
 module Mongoid
   module StateBits
-    
     extend ActiveSupport::Concern
 
-    included do
-      field :state_bits, type: Integer, default: 0
+    included do      
       index :state_bits => -1
     end
     
     module ClassMethods
-      def state_bits(bits)
+      def state_bits(params)
+        if params.is_a? Array
+          bits = params
+          default = 0
+        elsif params.is_a? Hash
+          bits = params.keys
+          default = bits.each_with_index.inject(0){|sum, vi| sum + (params[vi[0]] ? 2**vi[1] : 0)}
+        else
+          raise "Invalid state_bits params: should be Array or Hash"
+        end
+        # declare the field
+        field :state_bits, type: Integer, default: default
+        # define methods
         bits.each_with_index do |bit, index|
           define_method "#{bit}=" do |bool|
             if bool
@@ -27,10 +38,10 @@ module Mongoid
               self.state_bits -= (self.state_bits & 2**index)
             end
           end
-          define_method "#{bit}?" do
+          define_method bit do
             self.state_bits & 2**index != 0
           end
-          alias_method("#{bit}", "#{bit}?")
+          alias_method "#{bit}?", "#{bit}"
           # then define scopes
           scope bit, ->{ where("this.state_bits & #{2**index}")}
           scope "non#{bit}", ->{ where("this.state_bits & #{2**index} == 0")}

data/spec/mongoid-state_bits_spec.rb

@@ -7,6 +7,12 @@ class Post
   state_bits %w{deleted commentable original}
 end
 
+class User
+  include Mongoid::Document
+  include Mongoid::StateBits
+  state_bits admin: true, deleted: false
+end
+
 describe Mongoid::StateBits do 
   it "should generate specified fields" do
     p = Post.new
@@ -22,4 +28,10 @@ describe Mongoid::StateBits do
     p.deleted = true
     p.state_bits.should eq(5)
   end
+
+  it "supports default value definition" do
+    u = User.new
+    u.admin.should be_true
+    u.deleted.should be_false
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-state_bits
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Binz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler