bitarray 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6fcf6acdc1a14446a50e3cca4c8f96da1f36ab10
-  data.tar.gz: dc2cc9af844024134c930ab9678be08731458a7a
+SHA256:
+  metadata.gz: 5f87879a065d489418062f6fb66b5fdf3e9b07360e60491ed7a9908a2c0ac59f
+  data.tar.gz: eec43c2f9a2589e0d3ca49888229eb54cbf37195f5ea5d2ecd237faca24753a9
 SHA512:
-  metadata.gz: 3ed10001a59707f9837e62727cf3fbd338c7d5c14af834862d04338800a69639a178a824d0ab629883451f89cdda006d27d9c8116b5751fc351dd17c33878d6a
-  data.tar.gz: 446232b243b040be2e7627b042ff5dc03db7c8ebd13ce4060ac2400299954d940c9aa97349a906a73170f5a1f401e3f7b5505d0d1f680c71781f114f1fa5d94e
+  metadata.gz: 83149918dc115df376c8cf01432d0573b26524aac7fdbfac64d229ac70d881f64e60cbbcf15ec9a978acb60c9bfbef62b253165d8f22e5e621c3b374b9389a9a
+  data.tar.gz: 54c18727b4264b934ef16529b6098ae221f9d10b74a1b39f0ed3d825c42120c8bf79cd95433192f72729b340e17e77cdf1738c9463c75b21bfaf4b57007bea94

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2007-2024 Peter Cooper
+
+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

@@ -1,13 +1,15 @@
-# BitArray: A simple bit-array/bitfield library in pure Ruby
+# BitArray: Pure Ruby bit-array/bitfield library
 
-A simple, pure-Ruby 'bit field' object. Works well for Bloom filters (the use case for which I originally wrote it).
+A simple, pure-Ruby 'bit field' object.
 
-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.
+Originally built to help power a bloom filter, although there are other higher level libraries for that task now (https://github.com/igrigorik/bloomfilter-rb is a popular one.)
+
+BitArray has changed little over the years, but has been maintained to work within a typical, modern Ruby environment and, as of February 2024, is confirmed to work with both Ruby 3.0.1 and Ruby 3.3.0.
 
 ## Installation
 
 ```ruby
-gem install bitarray
+bundle add bitarray
 ```
 
 ## Examples
@@ -61,8 +63,9 @@ ba = BitArray.new(16, ["0000111111110000"].pack('B*'), reverse_byte: false)
 ba.to_s # "0000111111110000"
 ```
 
-
 ## History
+- 1.3.1 in 2024 (no changes other than adding license to gemspec)
+- 1.3 in 2022 (cleanups and a minor perf tweak)
 - 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)
@@ -77,8 +80,8 @@ ba.to_s # "0000111111110000"
 
 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, @dalibor and @m1lt0n for pull requests.
+Further thanks to @tdeo, @JoshuaSP, @dalibor, @yegct and @m1lt0n for pull requests.
 
 ## License
 
-MIT licensed. Copyright 2007-2018 Peter Cooper.
+MIT licensed. Copyright 2007-2024 Peter Cooper.

data/bitarray.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/peterc/bitarray"
   s.summary     = %q{A simple, pure Ruby bit-array / bitfield implementation.}
   s.description = %q{A simple, pure Ruby bit-array / bitfield implementation.}
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/bitarray/bit_array.rb

@@ -0,0 +1,58 @@
+class BitArray
+  attr_reader :field, :reverse_byte, :size
+  include Enumerable
+
+  VERSION = "1.3.1"
+
+  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 << (byte_position(position) % 8)))
+    else
+      @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 << (byte_position(position) % 8))) > 0 ? 1 : 0
+  end
+
+  # Iterate over each bit
+  def each
+    return to_enum(:each) unless block_given?
+    @size.times { |position| yield self[position] }
+  end
+
+  # Returns the field as a string like "0101010100111100," etc.
+  def to_s
+    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
+
+  # Iterates over each byte
+  def each_byte
+    return to_enum(:each_byte) unless block_given?
+    @field.bytes.each{ |byte| yield byte }
+  end
+
+  # Returns the total number of bits that are set
+  # Use Brian Kernighan's way, see
+  # https://graphics.stanford.edu/~seander/bithacks.html#CountBitsSetKernighan
+  def total_set
+    @field.each_byte.inject(0) { |a, byte| (a += 1; byte &= byte - 1) while byte > 0 ; a }
+  end
+
+  private def byte_position(position)
+    @reverse_byte ? position : 7 - position
+  end
+end

data/lib/bitarray.rb

@@ -1,51 +1 @@
-class BitArray
-  attr_reader :size
-  attr_reader :field
-  include Enumerable
-
-  VERSION = "1.2.0"
-
-  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 << (byte_position(position) % 8)))
-    else
-      @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 << (byte_position(position) % 8))) > 0 ? 1 : 0
-  end
-
-  # Iterate over each bit
-  def each(&block)
-    @size.times { |position| yield self[position] }
-  end
-
-  # Returns the field as a string like "0101010100111100," etc.
-  def to_s
-    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
-  # (The technique used here is about 6 times faster than using each or inject direct on the bitfield)
-  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
+require_relative "bitarray/bit_array"

data/test/{test_bitarray.rb → test_bit_array.rb}

@@ -1,5 +1,5 @@
 require "minitest/autorun"
-require "bitarray"
+require_relative "../lib/bitarray"
 
 class TestBitArray < Minitest::Test
   def setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitarray
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Peter Cooper
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,18 +47,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bitarray.gemspec
-- lib/bitarray-array.rb
 - lib/bitarray.rb
+- lib/bitarray/bit_array.rb
 - memory-test.rb
-- test/test_bitarray.rb
+- test/test_bit_array.rb
 homepage: https://github.com/peterc/bitarray
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,10 +74,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A simple, pure Ruby bit-array / bitfield implementation.
 test_files:
-- test/test_bitarray.rb
+- test/test_bit_array.rb

data/Gemfile.lock

@@ -1,21 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bitarray (1.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.10.1)
-    rake (12.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bitarray!
-  minitest
-  rake
-
-BUNDLED WITH
-   1.16.3

data/lib/bitarray-array.rb

@@ -1,43 +0,0 @@
-class BitArray
-  attr_reader :size
-  attr_reader :field
-  include Enumerable
-
-  VERSION = "1.2.0"
-  ELEMENT_WIDTH = 32
-
-  def initialize(size, field = nil)
-    @size = size
-    @field = field || Array.new(((size - 1) / ELEMENT_WIDTH) + 1, 0)
-  end
-
-  # Set a bit (1/0)
-  def []=(position, value)
-    if value == 1
-      @field[position / ELEMENT_WIDTH] |= 1 << (position % ELEMENT_WIDTH)
-    elsif (@field[position / ELEMENT_WIDTH]) & (1 << (position % ELEMENT_WIDTH)) != 0
-      @field[position / ELEMENT_WIDTH] ^= 1 << (position % ELEMENT_WIDTH)
-    end
-  end
-
-  # Read a bit (1/0)
-  def [](position)
-    @field[position / ELEMENT_WIDTH] & 1 << (position % ELEMENT_WIDTH) > 0 ? 1 : 0
-  end
-
-  # Iterate over each bit
-  def each(&block)
-    @size.times { |position| yield self[position] }
-  end
-
-  # Returns the field as a string like "0101010100111100," etc.
-  def to_s
-    @field.collect{|ea| ("%0#{ELEMENT_WIDTH}b" % ea).reverse}.join[0..@size-1]
-  end
-
-  # Returns the total number of bits that are set
-  # (The technique used here is about 6 times faster than using each or inject direct on the bitfield)
-  def total_set
-    @field.inject(0) { |a, byte| a += byte & 1 and byte >>= 1 until byte == 0; a }
-  end
-end