bitfield-rb 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec149110915b30e5f2a3f8f2ff5729961fb1bf7ea64265dbb655c9063be8108e
+  data.tar.gz: 760e0eb296542267085255ed973246652c1baac8561cde7bb66b77cc7ce9b53a
+SHA512:
+  metadata.gz: 618a8407480299dbb1da19f30c73a4d3d1d427aa28d79af47ba37bfb9f39af47e7f8aa038b5902f8eff63cc2e17b0077dc2d1e803851f2acb8b51a4f69e4f859
+  data.tar.gz: 321cabf3ab4d97dadfb7e077bc963b453fcf6356c56ff72999a7ff8b69f86ca2851bea352650e879ac923283b4b2a810395cca8c93bc2588931f44af2c24d905

data/lib/bitfield.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# A BitField is a small 8-bit object whose bits can be modified and retrieved. It serves as a (hopefully) reliable, memory efficient, constrained collection of flags.
+class BitField
+
+  # Constructs a new BitField
+  # @return [BitField] the constructed BitField.
+  def initialize
+    @source = [0xff].pack('C')
+  end
+
+  # Toggles the bit at the specified index.
+  # @param bit_idx [Integer] the bit index
+  def set(bit_idx)
+    current = to_bin_str
+    current[bit_idx] = current[bit_idx] == '0' ? '1' : '0'
+    @source = [from_bin_rep(current.reverse)].pack('C')
+    nil
+  end
+
+  alias toggle set
+
+  # Retrieves the bit at the specified index
+  # @param bit_idx [Integer] the bit index
+  # @return [Boolean] bit value
+  def get(bit_idx)
+    to_bin_rep(to_int).reverse[bit_idx] == '0'
+  end
+
+  alias retrieve get
+
+  private
+
+  # Uses {String#unpack} to convert a String type to a 8-bit unsigned char
+  # @return [Integer] the integer
+  def to_int
+    @source.unpack1('C')
+  end
+
+  # Returns a String representation of the binary source.
+  # @return [String] the string
+  def to_bin_str
+    to_bin_rep(to_int).reverse
+  end
+
+  # Returns a binary representation in the form of an array of 1's and 0's in their respective digits.
+  # @return [String] the binary representation
+  def to_bin_rep(value)
+    Kernel.sprintf('%08b', value)
+  end
+
+  # Returns a base 2 integer provided a representation.
+  # @param representation [String] the representation
+  def from_bin_rep(representation)
+    representation.to_i(2)
+  end
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: bitfield-rb
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Patrick W.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-10 00:00:00.000000000 Z
+dependencies: []
+description:
+email: Sickday@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bitfield.rb
+homepage: https://git.repos.pw/Sickday/bitfield-rb
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://git.repos.pw/Sickday/bitfield-rb
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: String-backed BitField object written in Ruby.
+test_files: []