bitarray 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab9407668ddd315a33ed9cdee09c9fb26e8a7ad5
-  data.tar.gz: a9001387330d54c1285409ad9b6ae95a5c0325cc
+  metadata.gz: 6fcf6acdc1a14446a50e3cca4c8f96da1f36ab10
+  data.tar.gz: dc2cc9af844024134c930ab9678be08731458a7a
 SHA512:
-  metadata.gz: 944947fd82afbc27f2c2d1266875193fde0058f0409290bdc82b4fc57633749b0d486bcd306710f62b77c89b3f00b1b60b7bcdd99b9f9c67dcacc085e73532e3
-  data.tar.gz: 0b9a68f76af9b1ddcd81a6ea2949ef1a1080923b8977b713aae59982fd325e14b4fdf56025a68aee16744e6c817bd18b7a88b30f17abf9a6a496ca9328304aee
+  metadata.gz: 3ed10001a59707f9837e62727cf3fbd338c7d5c14af834862d04338800a69639a178a824d0ab629883451f89cdda006d27d9c8116b5751fc351dd17c33878d6a
+  data.tar.gz: 446232b243b040be2e7627b042ff5dc03db7c8ebd13ce4060ac2400299954d940c9aa97349a906a73170f5a1f401e3f7b5505d0d1f680c71781f114f1fa5d94e

data/README.md

@@ -1,6 +1,6 @@
 # BitArray: A simple bit-array/bitfield library in pure Ruby
 
-Basic, pure Ruby bit field. Works well for Bloom filters (the use case for which I originally wrote it).
+A simple, pure-Ruby 'bit field' object. Works well for Bloom filters (the use case for which I originally wrote it).
 
 Originally written in 2007 and left without significant update until 2017, it has now been updated to work within a typical, modern Ruby environment while maintaining the same API.
 
@@ -47,7 +47,23 @@ ba.total_set
 #=> 7
 ```
 
+Initializing `BitArray` with a custom field value:
+
+```ruby
+ba = BitArray.new(16, ["0000111111110000"].pack('B*'))
+ba.to_s # "1111000000001111"
+```
+
+`BitArray` by default stores the bits in reverse order for each byte. If for example, you are initializing `BitArray` with Redis raw value manipulated with `setbit` / `getbit` operations, you will need to tell `BitArray` to not reverse the bits in each byte using the `reverse_byte: false` option:
+
+```ruby
+ba = BitArray.new(16, ["0000111111110000"].pack('B*'), reverse_byte: false)
+ba.to_s # "0000111111110000"
+```
+
+
 ## History
+- 1.2 in 2018 (Added option to skip reverse the bits for each byte by @dalibor)
 - 1.1 in 2018 (fixed a significant bug)
 - 1.0 in 2017 (updated for modern Ruby, more efficient storage, and 10th birthday)
 - 0.0.1 in 2012 (original v5 released on GitHub)
@@ -61,7 +77,7 @@ ba.total_set
 
 Thanks to Michael Slade for encouraging me to update this library on its 10th birthday and for suggesting finally using String's getbyte and setbyte methods now that we're all on 1.9+ compatible implementations.
 
-Further thanks to @tdeo, @JoshuaSP, and @m1lt0n for pull requests.
+Further thanks to @tdeo, @JoshuaSP, @dalibor and @m1lt0n for pull requests.
 
 ## License
 

data/Rakefile

@@ -2,4 +2,10 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new
+
 task :default => :test
+
+desc "Open an irb session to work with bitarray"
+task :console do
+  sh "irb -rubygems -I lib -r bitarray"
+end

data/lib/bitarray-array.rb

@@ -3,7 +3,7 @@ class BitArray
   attr_reader :field
   include Enumerable
 
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
   ELEMENT_WIDTH = 32
 
   def initialize(size, field = nil)

data/lib/bitarray.rb

@@ -3,25 +3,26 @@ class BitArray
   attr_reader :field
   include Enumerable
 
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
-  def initialize(size, field = nil)
+  def initialize(size, field = nil, reverse_byte: true)
     @size = size
     @field = field || "\0" * (size / 8 + 1)
+    @reverse_byte = reverse_byte
   end
 
   # Set a bit (1/0)
   def []=(position, value)
     if value == 1
-      @field.setbyte(position >> 3, @field.getbyte(position >> 3) | (1 << (position % 8)))
+      @field.setbyte(position >> 3, @field.getbyte(position >> 3) | (1 << (byte_position(position) % 8)))
     else
-      @field.setbyte(position >> 3, @field.getbyte(position >> 3) & ~(1 << (position % 8)))
+      @field.setbyte(position >> 3, @field.getbyte(position >> 3) & ~(1 << (byte_position(position) % 8)))
     end
   end
 
   # Read a bit (1/0)
   def [](position)
-    (@field.getbyte(position >> 3) & (1 << (position % 8))) > 0 ? 1 : 0
+    (@field.getbyte(position >> 3) & (1 << (byte_position(position) % 8))) > 0 ? 1 : 0
   end
 
   # Iterate over each bit
@@ -31,7 +32,11 @@ class BitArray
 
   # Returns the field as a string like "0101010100111100," etc.
   def to_s
-    @field.bytes.collect{|ea| ("%08b" % ea).reverse}.join[0, @size]
+    if @reverse_byte
+      @field.bytes.collect { |ea| ("%08b" % ea).reverse }.join[0, @size]
+    else
+      @field.bytes.collect { |ea| ("%08b" % ea) }.join[0, @size]
+    end
   end
 
   # Returns the total number of bits that are set
@@ -39,4 +44,8 @@ class BitArray
   def total_set
     @field.bytes.inject(0) { |a, byte| a += byte & 1 and byte >>= 1 until byte == 0; a }
   end
+
+  def byte_position(position)
+    @reverse_byte ? position : 7 - position
+  end
 end

data/test/test_bitarray.rb

@@ -52,10 +52,26 @@ class TestBitArray < Minitest::Test
 
   def test_to_s
     ba = BitArray.new(35)
-    [1, 5, 6, 7, 10, 16, 33].each{|i|ba[i] = 1}
+    [1, 5, 6, 7, 10, 16, 33].each { |i| ba[i] = 1}
     assert_equal "01000111001000001000000000000000010", ba.to_s
   end
 
+  def test_field
+    ba = BitArray.new(35)
+    [1, 5, 6, 7, 10, 16, 33].each { |i| ba[i] = 1}
+    assert_equal "1110001000000100000000010000000000000010", ba.field.unpack('B*')[0]
+  end
+
+  def test_initialize_with_field
+    ba = BitArray.new(15, ["0100011100100001"].pack('B*'))
+
+    assert_equal [0, 1, 2, 6, 8, 13], 0.upto(15).select { |i| ba[i] == 1 }
+
+    ba[2] = 1
+    ba[12] = 1
+    assert_equal [0, 1, 2, 6, 8, 12, 13], 0.upto(15).select { |i| ba[i] == 1 }
+  end
+
   def test_total_set
     ba = BitArray.new(10)
     ba[1] = 1
@@ -64,3 +80,27 @@ class TestBitArray < Minitest::Test
     assert_equal 3, ba.total_set
   end
 end
+
+class TestBitArrayWhenNonReversedByte < Minitest::Test
+  def test_to_s
+    ba = BitArray.new(35, nil, reverse_byte: true)
+    [1, 5, 6, 7, 10, 16, 33].each { |i| ba[i] = 1}
+    assert_equal "01000111001000001000000000000000010", ba.to_s
+  end
+
+  def test_field
+    ba = BitArray.new(35, nil, reverse_byte: false)
+    [1, 5, 6, 7, 10, 16, 33].each { |i| ba[i] = 1}
+    assert_equal "0100011100100000100000000000000001000000", ba.field.unpack('B*')[0]
+  end
+
+  def test_initialize_with_field
+    ba = BitArray.new(15, ["0100011100100001"].pack('B*'), reverse_byte: false)
+
+    assert_equal [1, 5, 6, 7, 10, 15], 0.upto(15).select { |i| ba[i] == 1 }
+
+    ba[2] = 1
+    ba[12] = 1
+    assert_equal [1, 2, 5, 6, 7, 10, 12, 15], 0.upto(15).select { |i| ba[i] == 1 }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitarray
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Peter Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake