bitarray 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a056ce9816063f7e51c6fce69fb88c4644336236545613d4224977a01c50df8
-  data.tar.gz: f9f05b2a142f7cea4f529f9ebfbf9e053f635bb75d4ba44a10bdb6a2864c3f0d
+  metadata.gz: 5f87879a065d489418062f6fb66b5fdf3e9b07360e60491ed7a9908a2c0ac59f
+  data.tar.gz: eec43c2f9a2589e0d3ca49888229eb54cbf37195f5ea5d2ecd237faca24753a9
 SHA512:
-  metadata.gz: 7373fc1fc97187412eee8e854839961b7647f880afbffa8d4f0e261830d214edc4626763a100dcd71a8ce4dd05c2892522594d63c6d21f95be7bc413afc26c87
-  data.tar.gz: f884ad42cba8ce15fa2c3810427f510028db459f14080ca9bda02f823b35d27e00769e941cb5232fb6e0220ddc494d55e00843e5186d4d96a41e5b250754cfc5
+  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,8 +1,10 @@
 # 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, although there are numerous good libraries for that task now).
+A simple, pure-Ruby 'bit field' object.
 
-Despite its age, BitArray has been updated to work within a typical, modern Ruby environment, but is only 'mildly' maintained.
+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
 
@@ -61,8 +63,8 @@ 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)
@@ -82,4 +84,4 @@ Further thanks to @tdeo, @JoshuaSP, @dalibor, @yegct and @m1lt0n for pull reques
 
 ## License
 
-MIT licensed. Copyright 2007-2022 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,59 +1 @@
-class BitArray
-  attr_reader :size
-  attr_reader :field
-  include Enumerable
-
-  VERSION = "1.3.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
-    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
-
-  def byte_position(position)
-    @reverse_byte ? position : 7 - position
-  end
-end
+require_relative "bitarray/bit_array"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitarray
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Peter Cooper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,15 +47,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- 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:
 rdoc_options: []
@@ -72,9 +74,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+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/lib/bitarray-array.rb

@@ -1,51 +0,0 @@
-class BitArray
-  attr_reader :size
-  attr_reader :field
-  include Enumerable
-
-  VERSION = "1.3.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
-    return to_enum unless block_given?
-    @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
-  
-  # Iterate over each byte
-  def each_byte
-    return to_enum(:each_byte) unless block_given?
-    @field.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
-end