aukan-bitmask 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2012-11-12
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.md
+README.rdoc
+Rakefile
+lib/aukan-bitmask.rb
+lib/bitmask.rb
+lib/bitmask_attribute.rb

data/README.md

@@ -0,0 +1,79 @@
+aukan-bitmask
+=============
+
+Agnostic Bitmask Attribute
+
+# Installation
+
+``` sh
+gem install aukan-bitmask
+```
+
+# Bitmask
+
+Usage:
+
+```rb
+flags = Bitmask.new({
+  :bit_ids => [:flag1, :flag2, :flag3],
+  :value => 0
+})
+
+# Setting the value of a bit
+flags.set :flag2, true
+
+flags.get :flag1 # false
+flags.get :flag2 # true
+flags.get :flag3 # false
+
+flags.value         # 2
+flags.value.to_s(2) # "10"
+```
+
+Reseting the mask value:
+
+```rb
+flags.value = 5
+
+flags.get :flag1 # true
+flags.get :flag2 # false
+flags.get :flag3 # true
+```
+
+Changing the bit ids:
+
+```rb
+flags.value = 5
+
+flags.bit_ids = [:flag1, :flag3, :flag2]  # Switching flag2 for flag3
+
+flags.get :flag1 # true
+flags.get :flag2 # true
+flags.get :flag3 # false
+```
+
+# BitmaskAttribute
+
+Uses Bitmask to decorate a class attribute. Can be used on ActiveRecord or any ORM.
+
+Usage:
+
+```rb
+class Something
+  attr_accessor :flags
+
+  include BitmaskAttribute
+  bitmask_attribute :flags, {
+    :bit_ids => [
+      :flag1, :flag2, :flag3
+    ],
+    :default_value => 3
+  }
+end
+
+algo = Something.new
+algo.flags_bitmask.set(:flag1, false)
+
+algo.flags_bitmask.get(:flag1) # false
+algo.flags_bitmask.get(:flag2) # true
+```

data/README.rdoc

@@ -0,0 +1,48 @@
+= aukan-bitmask
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/bitmask'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'aukan-bitmask' do
+  self.developer 'Pablo Antonio Gonzalez Cervantes', 'pbglezc@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.version              = '0.0.2'
+  self.summary              = 'Agnostic Bitmask and BitmaskAttribute.'
+  self.description          = 'This gem includes Bitmask for standalone usage, and BitmaskAttribute to decorate an existing attribute on any class.'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/aukan-bitmask.rb

@@ -0,0 +1,6 @@
+require 'bitmask'
+require 'bitmask_attribute'
+
+module AukanBitmask
+  VERSION = '0.0.1'
+end

data/lib/bitmask.rb

@@ -0,0 +1,53 @@
+class Bitmask
+
+  attr_accessor :bit_ids, :after_change
+  attr_reader   :value
+
+  def initialize ( options = {} )
+    default_values = {
+      :value => 0,
+      :bit_ids => []
+    }
+    options = default_values.merge(options)
+
+    # Events
+    @after_change = options[:after_change]
+
+    @value   = options[:value].to_i
+    @bit_ids = options[:bit_ids]
+  end
+
+  def get ( bit_id )
+    position = @bit_ids.index( bit_id )
+
+    if position == nil
+      raise "#{bit_id.inspect} was not included on bit_ids array"
+    end
+
+    return (@value & (2 ** position)) > 0
+  end
+
+  def set ( bit_id, val )
+    position = @bit_ids.index( bit_id )
+
+    if position == nil
+      raise "#{bit_id.inspect} was not included on bit_ids array"
+    end
+
+    if val == true
+      self.value |= (2 ** position)
+    else
+      self.value &= ~(2 ** position)
+    end
+
+    @after_change.call(self) if @after_change
+
+    return self.value
+  end
+
+  def value= ( val )
+    @value = val
+    @after_change.call(self) if @after_change
+  end
+
+end

data/lib/bitmask_attribute.rb

@@ -0,0 +1,33 @@
+module BitmaskAttribute
+
+  def self.included (base)
+    base.extend( ClassMethods )
+  end
+
+  module ClassMethods
+
+    def bitmask_attribute ( attribute_name, options = {} )
+      default_options = {
+        :bitmask_object => attribute_name.to_s + '_bitmask',
+        :bit_ids => []
+      }
+      options = default_options.merge(options)
+
+      bitmask_obj = options[:bitmask_object]
+      class_eval <<-ADD_METHOD
+        def #{options[:bitmask_object]}
+          @_#{options[:bitmask_object]} ||= Bitmask.new({
+            :bit_ids => #{options[:bit_ids].inspect},
+            :value => @#{attribute_name},
+            :after_change => Proc.new { |bitmask|
+              @#{attribute_name} = bitmask.value
+            }
+          })
+        end
+      ADD_METHOD
+
+    end
+
+  end
+
+end

data/test/test_bitmask.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBitmask < Test::Unit::TestCase
+
+  def setup
+    @bitmask = Bitmask.new({
+      :bit_ids => [:flag1, :flag2, :flag3]
+    })
+  end
+
+  def test_default_value_is_zero
+    assert @bitmask.value == 0
+  end
+
+  def test_initializig_with_a_value
+    @bitmask = Bitmask.new({
+      :value => 3
+    })
+    assert @bitmask.value == 3
+  end
+
+  def test_initializing_with_bit_ids
+    assert @bitmask.bit_ids == [:flag1, :flag2, :flag3]
+  end
+
+  def test_all_flags_are_false
+    assert @bitmask.get(:flag1) == false
+    assert @bitmask.get(:flag2) == false
+    assert @bitmask.get(:flag3) == false
+  end
+
+  def test_raising_a_flag
+    @bitmask.set(:flag1, true)
+    assert @bitmask.get(:flag1) == true
+  end
+
+  def test_raising_all_flags_by_setting_the_value
+    @bitmask.value = 7
+    assert @bitmask.get(:flag2) == true
+    assert @bitmask.get(:flag1) == true
+    assert @bitmask.get(:flag3) == true
+  end
+
+  def test_after_change_event_on_set
+    number = 0
+    @bitmask.after_change = Proc.new { |bitmask| number = 5 }
+
+    assert number == 0
+    @bitmask.set :flag1, true
+    assert number == 5
+  end
+
+  def test_after_change_on_initialization
+    number = 0
+    @bitmask = Bitmask.new({
+      :after_change => Proc.new { |bitmask| number = 5 },
+      :bit_ids => [:flag1]
+    })
+
+    assert number == 0
+    @bitmask.set :flag1, true
+    assert number == 5
+  end
+
+  def test_after_change_event_when_changing_value
+    number = 0
+    @bitmask.after_change = Proc.new { |bitmask| number = 5 }
+
+    assert number == 0
+    @bitmask.value = 1
+    assert number == 5
+  end
+end

data/test/test_bitmask_attribute.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBitmaskAttribute < Test::Unit::TestCase
+
+  class Something
+    attr_accessor :flags
+
+    include BitmaskAttribute
+    bitmask_attribute :flags, {
+      :bit_ids => [:flag1, :flag2, :flag3]
+    }
+  end
+
+  def setup
+    @something = Something.new
+    @something.flags = nil
+  end
+
+  def test_initialization_respects_the_attribute
+    assert @something.flags == nil
+  end
+
+  def test_setting_a_flag_updates_the_attribute
+    @something.flags_bitmask.set :flag1, true
+    assert @something.flags == 1
+  end
+
+  def test_setting_the_value_updates_the_attribute
+    @something.flags_bitmask.value = 3
+    assert @something.flags == 3
+  end
+
+  def test_bit_ids
+    assert @something.flags_bitmask.bit_ids == [:flag1, :flag2, :flag3]
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/bitmask'
+require File.dirname(__FILE__) + '/../lib/bitmask_attribute'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: aukan-bitmask
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Pablo Antonio Gonzalez Cervantes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  name: rdoc
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  name: newgem
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 2
+        version: "3.2"
+  name: hoe
+  prerelease: false
+  type: :development
+  requirement: *id003
+description: This gem includes Bitmask for standalone usage, and BitmaskAttribute to decorate an existing attribute on any class.
+email: 
+- pbglezc@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.md
+- README.rdoc
+- Rakefile
+- lib/aukan-bitmask.rb
+- lib/bitmask.rb
+- lib/bitmask_attribute.rb
+- test/test_bitmask_attribute.rb
+- test/test_bitmask.rb
+- test/test_helper.rb
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/#{github_username}/#{project_name}
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: aukan-bitmask
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Agnostic Bitmask and BitmaskAttribute.
+test_files: 
+- test/test_bitmask_attribute.rb
+- test/test_bitmask.rb
+- test/test_helper.rb