mongoid-state_bits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cff50fbda762d896f4348e08bce7958ab8c9bff3
+  data.tar.gz: dcedf6d0e7d88495736dc7ff5f3ea8d582f40a9a
+SHA512:
+  metadata.gz: 081e8a5c312fda195735f338af53feae57751b3a8954234ccc97aee6956144aab29258b98a00ededb80b505a65d84ca74736848694308c44ec2ad5faf091040a
+  data.tar.gz: ed79e03c1001c9dd6bdc5f9454e2946f19a25d7b6a19bdc3a000ebbbf186c4121e43b121b4230e28b9844eeb964b89f1646a31f23707a6cc50f207328af31be4

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 binz
+
+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,42 @@
+# 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.
+
+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.
+
+Mongoid::StateBits provides an elegant way to manage such situation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-state_bits'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-state_bits
+
+## Usage
+Use the follwing code:
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::StateBits
+      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.
+
+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.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc 'Run tests'
+task :test do
+  system "bundle exec rspec spec"
+end

data/lib/mongoid/state_bits/version.rb

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

data/lib/mongoid/state_bits.rb

@@ -0,0 +1,42 @@
+require "mongoid/state_bits/version"
+
+# class Post
+#   include Mongoid::Document
+#   include Mongoid::StateBits
+#   state_bits %w{public commentable original}
+# end
+# =====================================
+
+module Mongoid
+  module StateBits
+    
+    extend ActiveSupport::Concern
+
+    included do
+      field :state_bits, type: Integer, default: 0
+      index :state_bits => -1
+    end
+    
+    module ClassMethods
+      def state_bits(bits)
+        bits.each_with_index do |bit, index|
+          define_method "#{bit}=" do |bool|
+            if bool
+              self.state_bits |= 2**index
+            else
+              self.state_bits -= (self.state_bits & 2**index)
+            end
+          end
+          define_method "#{bit}?" do
+            self.state_bits & 2**index != 0
+          end
+          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")}
+        end
+      end
+    end #ClassMethods
+
+  end
+end

data/mongoid-state_bits.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/state_bits/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-state_bits"
+  spec.version       = Mongoid::StateBits::VERSION
+  spec.authors       = ["Binz"]
+  spec.email         = ["xinkiang@gmail.com"]
+  spec.summary       = %q{Use one field to generate multiple boolean fields transparently.}
+  spec.description   = %q{Merge multiple boolean fields into one field.}
+  spec.homepage      = "http://creatist.cn/blog/201308/mongoidstatebits/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "mongoid"
+end

data/spec/mongoid-state_bits_spec.rb

@@ -0,0 +1,25 @@
+require 'mongoid'
+require 'mongoid/state_bits'
+
+class Post
+  include Mongoid::Document
+  include Mongoid::StateBits
+  state_bits %w{deleted commentable original}
+end
+
+describe Mongoid::StateBits do 
+  it "should generate specified fields" do
+    p = Post.new
+    p.commentable.should be_false
+    p.commentable = true
+    p.commentable.should be_true
+  end
+
+  it "state_bits field sholud record state bits" do
+    p = Post.new
+    p.original = true
+    p.commentable = false
+    p.deleted = true
+    p.state_bits.should eq(5)
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-state_bits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Binz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Merge multiple boolean fields into one field.
+email:
+- xinkiang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/state_bits.rb
+- lib/mongoid/state_bits/version.rb
+- mongoid-state_bits.gemspec
+- spec/mongoid-state_bits_spec.rb
+homepage: http://creatist.cn/blog/201308/mongoidstatebits/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Use one field to generate multiple boolean fields transparently.
+test_files:
+- spec/mongoid-state_bits_spec.rb