bis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f97157ab82377beef29d536741bb736d150c429
+  data.tar.gz: 82d5750520e4f6f123518d6132228a2105def5cb
+SHA512:
+  metadata.gz: 19ef835409a3461bfc4b28548369d5e810295dc29794ae4fa69489d9d6382f98c27da9dff9c2888999b0d0c8e55a8b9ed0ca38d6e1cacd692dc9a7275fa7a023
+  data.tar.gz: 286ebeb190985e8651a2380661a07dad21bb814bfa4a9e058a58818598a9856d7a3d2af27485921d2cc74c662704b8af6f2f40f919918a366d2af723bf274ea3

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fuad Saud
+
+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,19 @@
+# Bis
+
+A pure ruby bitset implementation.
+
+## Installation
+
+    $ gem install bis
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: %i( spec rubocop )
+
+RSpec::Core::RakeTask.new
+Rubocop::RakeTask.new

data/lib/bis/conversion.rb

@@ -0,0 +1,19 @@
+class Bis
+  module Conversion
+    def Bis(obj)
+      if obj.kind_of? Bis
+        obj
+      elsif obj.kind_of? Enumerable
+        Bis.from_enum(obj)
+      elsif obj.respond_to? :to_i
+        Bis.new(Bis::WORD_SIZE, value: obj.to_i)
+      else
+        fail TypeError, "#{obj.class} can't be coerced to Bis"
+      end
+    end
+  end
+end
+
+module Kernel
+  include Bis::Conversion
+end

data/lib/bis/version.rb

@@ -0,0 +1,3 @@
+class Bis
+  VERSION = '0.1.0'
+end

data/lib/bis.rb

@@ -0,0 +1,176 @@
+require 'forwardable'
+
+require 'bis/conversion'
+require 'bis/version'
+
+class Bis
+  WORD_SIZE = 0.size * 8
+
+  attr_reader :size
+
+  def self.from_enum(enum)
+    Bis.new(enum.size, value: enum.join.to_i(2))
+  end
+
+  def initialize(size, value: 0)
+    unless size.kind_of?(Integer) && size > 0
+      fail ArgumentError, 'size must be a positive integer'
+    end
+
+    @size = size
+    @store = Array.new(words_needed_for(size), 0)
+
+    self.value = value if value != 0
+  end
+
+  def set(index)
+    change_bit_at(index).(1)
+  end
+
+  def clear(index)
+    change_bit_at(index).(0)
+  end
+
+  def [](index)
+    x, y = offset_for(index)
+
+    @store[x][y]
+  end
+
+  # Not sure if it's a good idead to implement this.
+  def []=(index, value)
+    with_valid_bit value do |bit|
+      case bit
+      when 1 then set index
+      when 0 then clear index
+      end
+    end
+  end
+
+  def ==(other)
+    to_i == other
+  end
+
+  def <=>(other)
+    to_i <=> Bis(other).to_i
+  end
+
+  def +(value)
+    with_valid_bit value do |bit|
+      new_bis = new.(size: size + 1)
+
+      case bit
+      when 1 then new_bis.(value: to_i << 1 | bit)
+      when 0 then new_bis.(value: to_i << 1)
+      end
+    end
+  end
+
+  def &(other)
+    new_with_same_size.(value: other & to_i)
+  end
+
+  def |(other)
+    new_with_same_size.(value: other | to_i)
+  end
+
+  def ^(other)
+    new_with_same_size.(value: other ^ to_i)
+  end
+
+  def <<(amount)
+    new_with_same_size.(value: to_i << amount)
+  end
+
+  def >>(amount)
+    new_with_same_size.(value: to_i >> amount)
+  end
+
+  def each
+    return enum_for :each unless block_given?
+
+    size.times.reverse_each do |bit|
+      yield self[bit]
+    end
+  end
+
+  def to_a
+    each.to_a
+  end
+
+  def to_i
+    each.reduce(0) { |a, e| (a << 1) | e }
+  end
+
+  def to_s
+    to_a.join
+  end
+
+  def inspect
+    "<<#{ to_s }>> #{ to_i }"
+  end
+
+  protected
+
+  def store=(store)
+    @store = store
+  end
+
+  private
+
+  def value=(value)
+    @store.each_with_index do |_, i|
+      @store[i] |= Integer(value >> (i * WORD_SIZE))
+    end
+  end
+
+  def offset_for(index)
+    if index >= size
+      fail ArgumentError, "index #{index} out of boudaries for #{self}"
+    end
+
+    [index / WORD_SIZE, index % WORD_SIZE]
+  end
+
+
+  def words_needed_for(bits)
+    (bits - 1) / WORD_SIZE + 1
+  end
+
+  def with_valid_bit(bit)
+    case bit
+    when 0..1 then yield bit
+    else fail ArgumentError, 'bit must be either 0 or 1'
+    end
+  end
+
+  def change_bit_at(index)
+    ->(bit) {
+      return self if self[index] == bit
+
+      x, y = offset_for(index)
+
+      new_with_same_size.().tap { |bis|
+        bis.store = @store.dup.tap { |s|
+          s[x] = s[x].send(change_operation_for(bit), 1 << y)
+        }
+      }
+    }
+  end
+
+  def change_operation_for(bit)
+    bit.zero? ? :^ : :|
+  end
+
+  def new_with_same_size
+    new.(size: size)
+  end
+
+  def new(factory = self.class)
+    ->(size: size) {
+      ->(value: 0) {
+        factory.new(size, value: value)
+      }
+    }
+  end
+end

data/spec/bis/conversion_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Bis::Conversion do
+  describe '#Bis' do
+    subject { Bis(obj) }
+
+    context 'given a Bis object' do
+      let(:obj) { Bis.new(10, value: 7) }
+
+      it 'returns the given object' do
+        expect(subject).to eq obj
+      end
+    end
+
+    context 'given an Enumerable' do
+      let(:obj) { [0, 1, 1, 0, 1, 1, 0] }
+
+      it 'treats the enumerable as a list of bits' do
+        expect(subject).to eq 0b0110110
+      end
+    end
+
+    context 'given an object that quacks like an Integer' do
+      let(:obj) { 26 }
+
+      it 'returns a Bis with the internal value set to the given number' do
+        expect(subject).to eq 0b11010
+      end
+    end
+  end
+end

data/spec/bis_spec.rb

@@ -0,0 +1,267 @@
+require 'spec_helper'
+
+describe Bis do
+  let(:size) { Bis::WORD_SIZE }
+
+  it('has a version') { expect(Bis::VERSION).to be_a String }
+
+  describe '.new' do
+    context 'with size' do
+      let(:size) { 8 }
+
+      subject { Bis.new(size) }
+
+      it 'is as big as the passed size' do
+        expect(subject.size).to eq size
+      end
+
+      it 'has all bits off' do
+        expect(subject).to eq 0
+      end
+    end
+
+    context 'with size and value' do
+      let(:value) { 10 }
+
+      subject { Bis.new(size, value: value) }
+
+      it 'is as big as the passed size' do
+        expect(subject.size).to eq size
+      end
+
+      it 'has the bits set to the given value' do
+        expect(subject).to eq value
+      end
+    end
+  end
+
+  describe '#==' do
+    context 'with an integer' do
+      let(:value) { 16 }
+
+      subject { Bis.new(size, value: value) }
+
+      it 'compares to the bitset' do
+        expect(subject).to eq value
+      end
+
+      it 'compares properly' do
+        expect(subject).to_not eq value - 1
+      end
+    end
+  end
+
+  describe '#[]' do
+    context 'invalid index' do
+      let (:size) { 10 }
+
+      subject { Bis.new(size) }
+
+      it 'fails' do
+        expect { subject[11] }.to raise_error
+      end
+    end
+
+    context 'small numbers' do
+      let(:value) { 10 }
+
+      subject { Bis.new(size, value: value) }
+
+      it 'returns the bit at the given position' do
+        expect(subject[3]).to eq 1
+      end
+    end
+
+    context 'large numbers' do
+      let(:size) { 65 }
+
+      subject { Bis.new(size).set(64) }
+
+      it 'returns the bit at the given position' do
+        expect(subject[64]).to eq 1
+      end
+    end
+  end
+
+  describe '#[]=', pending: "Not sure if it's a good idea to implement this" do
+    context 'invalid argument' do
+      subject { Bis.new(size) }
+
+      it 'fails' do
+        expect { subject[4] = 'lol' }.to raise_error
+      end
+    end
+
+    context 'valid argument' do
+      let(:value) { 7 }
+
+      subject { Bis.new(size, value: 7)[index] = argument }
+
+      context '1' do
+        let(:index) { 4 }
+        let(:argument) { 1 }
+
+        it 'sets the given bit' do
+          expect(subject).to eq(value | (argument << index))
+        end
+      end
+
+      context '0' do
+        let(:index) { 1 }
+        let(:argument) { 0 }
+
+        it 'clears the given bit' do
+          expect(subject).to eq(value ^ (1 << index))
+        end
+      end
+    end
+  end
+
+  describe '#set' do
+    let(:before) { 0b101 }
+    let(:after) { 0b111 }
+
+    subject { Bis.new(size, value: before) }
+
+    it 'returns a new bitset with the given bit on' do
+      expect(subject.set(1)).to eq after
+    end
+  end
+
+  describe '#clear' do
+    let(:before) { 0b111 }
+    let(:after) { 0b101 }
+
+    subject { Bis.new(size, value: before) }
+
+    it 'returns a new bitset with the given bit off' do
+      expect(subject.clear(1)).to eq after
+    end
+  end
+
+  describe '#to_a' do
+    let(:size) { 8 }
+
+    subject { Bis.new(size, value: 0b01010110).to_a }
+
+    it 'returns a binary array representation of itself' do
+      expect(subject).to eq [0, 1, 0, 1, 0, 1, 1, 0]
+    end
+  end
+
+  describe '#to_i' do
+    let(:size) { 4 }
+
+    subject { Bis.new(size, value: 0b100) }
+
+    it "returns it's integer representation" do
+      expect(subject).to eq 4
+    end
+  end
+
+  describe '#to_s' do
+    let(:size) { 8 }
+
+    subject { Bis.new(size, value: 0b01010110).to_s }
+
+    it 'returns a binary array representation of itself' do
+      expect(subject).to eq '01010110'
+    end
+  end
+
+  shared_examples 'pushing a bit' do
+    it 'increases the size' do
+      expect(subject.size).to eq size + 1
+    end
+
+    it 'pushes the new bit to the end of the new bitset' do
+      expect(subject).to eq new_value
+    end
+  end
+  
+  describe '#+' do
+    let(:size) { 8 }
+    let(:value) { 10 }
+
+    subject { Bis.new(size, value: value) + argument }
+
+    context '1' do
+      let(:argument) { 1 }
+      let(:new_value) { (value << 1) | argument }
+
+      it_behaves_like 'pushing a bit'
+    end
+
+    context '0' do
+      let(:argument) { 0 }
+      let(:new_value) { value << 1 }
+
+      it_behaves_like 'pushing a bit'
+    end
+  end
+
+  describe '#&' do
+    it 'evaluates to logic AND of the two bitsets' do
+      expect(Bis.new(size, value: 0b1100) &
+             Bis.new(size, value: 0b0101)).to eq Bis.new(size, value: 0b0100)
+    end
+  end
+
+  describe '#|' do
+    it 'evaluates to logic OR of the two bitsets' do
+      expect(Bis.new(size, value: 0b1100) |
+             Bis.new(size, value: 0b0110)).to eq Bis.new(size, value: 0b1110)
+    end
+  end
+
+  describe '#^' do
+    it 'evaluates to logic XOR of the two bitsets' do
+      expect(Bis.new(size, value: 0b1100) ^
+             Bis.new(size, value: 0b0110)).to eq Bis.new(size, value: 0b1010)
+    end
+  end
+
+  describe '#>>' do
+    let(:shift) { 1 }
+
+    context 'zero value' do
+      subject { Bis.new(size) }
+
+      it 'remains zero' do
+        expect(subject >> shift).to eq 0
+      end
+    end
+
+    context 'non-zero value' do
+      let(:value) { 10 }
+
+      subject { Bis.new(size, value: value) }
+
+      it 'shifts the internal value properly' do
+        expect(subject >> shift).to eq value >> shift
+      end
+    end
+  end
+
+  describe '#<<' do
+    let(:shift) { 1 }
+
+    context 'zero value' do
+      subject { Bis.new(size) }
+
+      it 'remains zero' do
+        expect(subject << shift).to eq 0
+      end
+    end
+
+    context 'non-zero value' do
+      let(:value) { 10 }
+
+      subject { Bis.new(size, value: value) }
+
+      it 'shifts the internal value properly' do
+        expect(subject << shift).to eq value << shift
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+require_relative File.join(__dir__, '../lib/bis')
+
+RSpec.configure do |config|
+  config.include Bis::Conversion
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: bis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fuad Saud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: |2
+    Feed me.
+email: fuadksd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- LICENSE.md
+- lib/bis/conversion.rb
+- lib/bis/version.rb
+- lib/bis.rb
+- spec/bis/conversion_spec.rb
+- spec/bis_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fuadsaud/bis
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Pure ruby bitset implementation
+test_files: []
+has_rdoc: false