mongoid_bitfield 0.0.1

data/.rspec

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

data/.rvmrc

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+environment_id="ruby-1.9.3-p0@mongoid_bitfield"
+
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi

data/.travis.yml

@@ -0,0 +1,17 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - ruby-head
+  - rbx-18mode
+  - rbx-19mode
+
+branches:
+  only:
+    - develop
+    - master
+
+notifications:
+  email:
+    - chris@dinarrr.com

data/Gemfile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+gem "bson_ext"
+gem "mongoid"
+gem "activesupport"
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "database_cleaner"
+  gem "jeweler"
+
+  gem "pry"
+  gem "pry-doc"
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.5.2)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    coderay (1.0.5)
+    database_cleaner (0.7.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    method_source (0.7.0)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.4.4)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.1.0)
+    pry (0.9.8.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7)
+      slop (>= 2.4.4, < 3)
+    pry-doc (0.4.0)
+      pry (>= 0.9.0)
+      yard (~> 0.7.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    slop (2.4.4)
+    tzinfo (0.3.31)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bson_ext
+  database_cleaner
+  jeweler
+  mongoid
+  pry
+  pry-doc
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Christoph 'asaaki' Grabo
+
+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,66 @@
+# Mongoid::Bitfield
+
+## About
+
+This tiny gem provides a bitfield or a collection of boolean bits/flags.
+
+This bitfield will be stored as an integer value in the mongodb database.
+
+## Install
+
+```shell
+gem install mongoid_bitfield
+```
+
+or
+
+Gemfile:
+
+```ruby
+gem "mongoid_bitfield"
+```
+
+## Usage
+
+### Model setup
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Bitfield
+
+  bitfield :flags, :is_admin, :adult, :drinker
+end
+```
+
+### Instance
+
+**without automatic saving**
+
+```ruby
+user = User.new
+
+user.is_admin #=> false
+
+user.is_admin = true
+
+user.is_admin #=> true
+```
+
+**atomic saving of changes**
+
+```ruby
+user = User.create!
+
+user.drinker_enable!
+
+user.reload
+
+user.drinker #=> true
+```
+
+## License
+
+MIT/X11
+
+Copyright (c) 2012 Christoph 'asaaki' Grabo

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require "rubygems"
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require "rake"
+require "jeweler"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "mongoid/bitfield/version"
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongoid_bitfield"
+  gem.version = Mongoid::Bitfield::VERSION
+  gem.homepage = "http://github.com/asaaki/mongoid_bitfield"
+  gem.license = "MIT"
+  gem.summary = %Q{Mongoid::Bitfield stores boolean flags as single property in DB.}
+  gem.description = %Q{Mongoid::Bitfield stores boolean flags as single property in MongoDB.}
+  gem.email = "chris@dinarrr.com"
+  gem.authors = ["Christoph Grabo"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid/bitfield.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid
+  module Bitfield
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def bitfield fieldname, *bits
+        field fieldname.to_sym, :type => Integer
+
+        bits.each do |bitname|
+          define_method bitname do
+            current = send(fieldname.to_sym) || 0
+            current[bits.index(bitname.to_sym)] == 1 ? true : false
+          end
+
+          define_method :"#{bitname}=" do |boolean|
+            unless boolean == send(bitname.to_sym)
+              cur_value = send(fieldname.to_sym) || 0
+              bit_value = (1 << bits.index(bitname.to_sym))
+              new_value = (cur_value ^ bit_value)
+              send(:"#{fieldname}=", new_value)
+            end
+          end
+
+          define_method :"#{bitname}_enable!" do
+            send(:"#{bitname}=", true)
+            set(fieldname.to_sym, (send(fieldname.to_sym) || 0))
+          end
+
+          define_method :"#{bitname}_disable!" do
+            send(:"#{bitname}=", false)
+            set(fieldname.to_sym, (send(fieldname.to_sym) || 0))
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/bitfield/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Mongoid
+  module Bitfield
+    VERSION = "0.0.1"
+  end
+end

data/lib/mongoid_bitfield.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "mongoid/bitfield"

data/mongoid_bitfield.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "mongoid_bitfield"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Grabo"]
+  s.date = "2012-02-19"
+  s.description = "Mongoid::Bitfield stores boolean flags as single property in MongoDB."
+  s.email = "chris@dinarrr.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".rvmrc",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "lib/mongoid/bitfield.rb",
+    "lib/mongoid/bitfield/version.rb",
+    "lib/mongoid_bitfield.rb",
+    "mongoid_bitfield.gemspec",
+    "spec/mongoid_bitfield_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/asaaki/mongoid_bitfield"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Mongoid::Bitfield stores boolean flags as single property in DB."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<pry-doc>, [">= 0"])
+    else
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<pry-doc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<pry-doc>, [">= 0"])
+  end
+end
+

data/spec/mongoid_bitfield_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class TestDoc
+  include Mongoid::Document
+  include Mongoid::Bitfield
+
+  bitfield :flags, :is_admin, :adult, :drinker
+end
+
+describe Mongoid::Bitfield do
+
+  let(:doc) { TestDoc.new }
+
+  it ".bitfield sets a mongoid_field with provided name" do
+    doc.should respond_to(:flags)
+    doc.should respond_to(:flags=)
+  end
+
+  it ".bitfield sets getters and setters for each provided bit" do
+    [:is_admin, :adult, :drinker].each do |bit|
+      doc.should respond_to(bit)
+      doc.should respond_to(:"#{bit}=")
+    end
+  end
+
+  context "setting and getting bits" do
+    it "sets a single bit correctly" do
+      doc.is_admin = true
+      doc.flags.should == 1 # is_admin is first bit => 1
+    end
+
+    it "sets multiple bits correctly" do
+      doc.is_admin = true
+      doc.drinker  = true
+      doc.flags.should == (1 + 4) # is_admin = 1, drinker = 4
+    end
+
+    it "gets a single bit" do
+      doc.adult = true
+      doc.is_admin.should be_false
+      doc.drinker.should  be_false
+      doc.adult.should    be_true
+    end
+  end
+
+  context "enabler and disabler" do
+    before do
+      TestDoc.destroy_all
+    end
+
+    it "enables a flag and save this state (atomically!)" do
+      td = TestDoc.create!(:flags => 0)
+      td.is_admin_enable!
+
+      TestDoc.first.is_admin.should be_true
+    end
+
+    it "disables a flag and save this state (atomically!)" do
+      td = TestDoc.create!(:flags => (1+2+4)) # all flags enabled
+      td.drinker_disable!
+
+      TestDoc.first.drinker.should be_false
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path("../../lib",__FILE__))
+
+require "database_cleaner"
+require "mongoid"
+require "mongoid_bitfield"
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_bitfield_test")
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_bitfield
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christoph Grabo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &23155860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23155860
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &23155240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23155240
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &23154700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23154700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &23170040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23170040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &23168780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23168780
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &23167480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23167480
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &23166720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23166720
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &23166180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23166180
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: &23165580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23165580
+description: Mongoid::Bitfield stores boolean flags as single property in MongoDB.
+email: chris@dinarrr.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid/bitfield.rb
+- lib/mongoid/bitfield/version.rb
+- lib/mongoid_bitfield.rb
+- mongoid_bitfield.gemspec
+- spec/mongoid_bitfield_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/asaaki/mongoid_bitfield
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1866884813548414577
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Mongoid::Bitfield stores boolean flags as single property in DB.
+test_files: []