bitmask 0.0.1

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 bitmask.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Amiel Martin
+
+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,56 @@
+# Bitmask
+
+Bitmask represents a set of boolean values as an Integer.
+
+This bitmask gem was extracted from [amiel/has_bitmask_attributes](https://github.com/amiel/has_bitmask_attributes)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitmask'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitmask
+
+## Usage
+
+
+Examples:
+
+```ruby
+  masks = {
+            :cat  => 0b0001,
+            :dog  => 0b0010,
+            :fish => 0b0100,
+          }
+
+  bitmask = Bitmask.new(masks, {:cat => true})
+  bitmask.to_i            # => 1
+  bitmask.get :cat        # => true
+  bitmask.get :dog        # => false
+  bitmask.set :dog, true
+  bitmask.get :dog        # => true
+  bitmask.to_i            # => 3
+  bitmask.to_h            # => { :cat => true, :dog => true, :fish => false }
+
+  bitmask = Bitmask.new(masks, 0b101)
+  bitmask.to_h            # => { :cat => true, :dog => false, :fish => true }
+  bitmask.to_i            # => 5
+  bitmask.to_i.to_s(2)    # => "101"
+
+  Bitmask.new(masks, 5) == Bitmask.new(masks, { :cat => true, :dog => false, :fish => true }) # => true
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end

data/bitmask.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bitmask/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Amiel Martin"]
+  gem.email         = ["amiel@carnesmedia.com"]
+  gem.description   = %q{Represents a set of boolean values as an Integer}
+  gem.summary       = <<-SUMMARY
+    Bitmask represents a set of boolean values as an Integer using bitwise arithmetic.
+
+    This allows, for example, for a set of boolean settings to be stored in one
+    integer column in a database.
+  SUMMARY
+  gem.homepage      = "https://github.com/amiel/bitmask"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test)/})
+  gem.name          = "bitmask"
+  gem.require_paths = ["lib"]
+  gem.version       = Bitmask::VERSION
+end

data/lib/bitmask/version.rb

@@ -0,0 +1,3 @@
+class Bitmask
+  VERSION = "0.0.1"
+end

data/lib/bitmask.rb

@@ -0,0 +1,93 @@
+require "bitmask/version"
+
+# Bitmask represents a set of boolean values as an Integer.
+#
+# Examples:
+#
+#   masks = {
+#           :cat  => 0b0001,
+#           :dog  => 0b0010,
+#           :fish => 0b0100
+#         }
+#
+#   bitmask = Bitmask.new(masks, {:cat => true})
+#   bitmask.to_i            # => 1
+#   bitmask.get :cat        # => true
+#   bitmask.get :dog        # => false
+#   bitmask.set :dog, true
+#   bitmask.get :dog        # => true
+#   bitmask.to_i            # => 3
+#   bitmask.to_h            # => { :cat => true, :dog => true, :fish => false }
+#
+#   bitmask = Bitmask.new(masks, 0b101)
+#   bitmask.to_h            # => { :cat => true, :dog => false, :fish => true }
+#   bitmask.to_i            # => 5
+#   bitmask.to_i.to_s(2)    # => "101"
+#
+#   Bitmask.new(masks, 5) == Bitmask.new(masks, { :cat => true, :dog => false, :fish => true }) # => true
+#
+class Bitmask
+
+  def ==(other)
+    other.masks == @masks && other.to_i == self.to_i
+  end
+
+  # create an object with which to manipulate an integer as a set of boolean values
+  #
+  # arguments
+  # masks::  a Hash where the key is the boolean attribute and the value is the bitmask.
+  #             { :some_attribute => 0b0001, :another_attribute => 0b0010 }
+  # arg::    can be a Hash or Integer
+  def initialize(masks, arg)
+    @masks = masks
+    case arg
+    when Hash
+      @data = 0
+      arg.each do |attr, value|
+        set attr, value
+      end
+    else
+      @data = arg.to_i
+    end
+  end
+
+  attr_reader :masks
+
+  def to_i
+    @data
+  end
+
+  def to_a
+    @masks.keys.sort { |a,b| @masks[a] <=> @masks[b] }.collect { |k| [k, get(k)] }
+  end
+
+  def each(&blk)
+    to_a.each(&blk)
+  end
+
+  def to_h
+    @masks.keys.inject({}) { |h, k| h[k] = get k; h }
+  end
+
+  # returns boolean value
+  def get(attr)
+    (@data & @masks[attr]) == @masks[attr]
+  end
+
+  # expects a boolean value
+  def set(attr, value)
+    raise ArgumentError, "unknown attribute: #{attr}" unless @masks[attr]
+    case value
+    when true
+      @data |=  @masks[attr]
+    when false
+      @data &= ~@masks[attr]
+    end
+  end
+
+  def set_array(array)
+    @masks.each do |attr, value|
+      set attr, array.include?(attr)
+    end
+  end
+end

data/test/bitmask_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class BitmaskTest < Test::Unit::TestCase
+  TEST_MASKS = {
+    :phone    => 0b0000001,
+    :name     => 0b0000010,
+    :gender   => 0b0000100,
+    :email    => 0b0001000,
+    :birthday => 0b0100000,
+    :location => 0b1000000,
+  }
+  # Replace this with your real tests.
+  def test_get
+    bitmask = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => true
+    assert bitmask.get(:phone)
+    assert bitmask.get(:name)
+    assert bitmask.get(:email)
+    assert !bitmask.get(:gender)
+    assert !bitmask.get(:birthday)
+    assert !bitmask.get(:location)
+  end
+
+  def test_set
+    bitmask = Bitmask.new TEST_MASKS, 0
+    assert !bitmask.get(:phone)
+    bitmask.set(:phone, true)
+    assert bitmask.get(:phone)
+    assert !bitmask.get(:email)
+    bitmask.set(:email, true)
+    assert bitmask.get(:email)
+  end
+
+  def test_to_h
+    bitmask = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => true
+    assert_equal({:phone => true, :name => true, :email => true, :gender => false, :birthday => false, :location => false}, bitmask.to_h)
+  end
+
+  def test_to_a
+    bitmask = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => true
+    assert_equal([
+      [:phone,     true ],
+      [:name,      true ],
+      [:gender,    false],
+      [:email,     true ],
+      [:birthday,  false],
+      [:location,  false]
+    ], bitmask.to_a)
+  end
+
+  def test_defaults
+    bitmask = Bitmask.new(TEST_MASKS, nil || {:phone => true, :email => true})
+    assert  bitmask.get(:phone)
+    assert !bitmask.get(:name)
+    assert  bitmask.get(:email)
+    assert !bitmask.get(:gender)
+    assert !bitmask.get(:birthday)
+    assert !bitmask.get(:location)
+  end
+
+  def test_to_i_and_create_from_integer
+    bitmask = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => true
+    bitmask_two = Bitmask.new(TEST_MASKS, bitmask.to_i)
+    assert_equal(bitmask_two.to_h, {:phone => true, :name => true, :email => true, :gender => false, :birthday => false, :location => false})
+  end
+
+  def test_equality
+    bitmask_one   = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => true
+    bitmask_two   = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => true
+    bitmask_three = Bitmask.new TEST_MASKS, :phone => true, :name => true, :email => false
+    assert bitmask_one == bitmask_two
+    assert bitmask_two != bitmask_three
+  end
+
+  def test_set_array
+    bitmask = Bitmask.new TEST_MASKS, :phone => true, :name => true
+    bitmask.set_array [:phone, :email]
+    assert_equal(bitmask.to_h, {:phone => true, :name => false, :email => true, :gender => false, :birthday => false, :location => false})
+  end
+
+  def test_set_raises
+    bitmask = Bitmask.new TEST_MASKS, 0
+    assert_raises ArgumentError do
+      bitmask.set :foo, true
+    end
+  end
+
+  def test_set_array_doesnt_raise
+    bitmask = Bitmask.new TEST_MASKS, :phone => true, :name => true
+    assert_nothing_raised do
+      bitmask.set_array [:phone, :email, :foodebar]
+    end
+    assert_equal(bitmask.to_h, {:phone => true, :name => false, :email => true, :gender => false, :birthday => false, :location => false})
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+
+require 'bitmask'
+
+require 'test/unit'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: bitmask
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Amiel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies: []
+description: Represents a set of boolean values as an Integer
+email:
+- amiel@carnesmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bitmask.gemspec
+- lib/bitmask.rb
+- lib/bitmask/version.rb
+- test/bitmask_test.rb
+- test/test_helper.rb
+homepage: https://github.com/amiel/bitmask
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Bitmask represents a set of boolean values as an Integer using bitwise arithmetic.  This
+  allows, for example, for a set of boolean settings to be stored in one integer column
+  in a database.
+test_files:
+- test/bitmask_test.rb
+- test/test_helper.rb