bitary 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee481b52a264fe1e578b65f0228e9a9c6e4eb57a7fa7fb224fb4c1dd31d60f0c
-  data.tar.gz: 2529e365b65266446aace9bce47369f49615869c4c4ab6ffe134b90c61422535
+  metadata.gz: 80cd57b662219349dc57edd47612599f95f5aeca086dbec30af067adb10fe587
+  data.tar.gz: dc630c61a13c74a20e3472a90f244dd995f4c7196fb6146ca15973efe02e310d
 SHA512:
-  metadata.gz: 1b549423b7cbe533c07fc54b5a4f938612889508703530336b048206f4681356fbbcb04065b7d04a887ed3f03db6ad6cb94538a4b047a6e2e7eeb4904d0af5f9
-  data.tar.gz: 4e4831d9dcb860c06067ca92e63b41d81ac90e0d3e7aa2f0ddfd48f80f8b8352bf77c6cedbc8b5002285d29f2c6c33b9e96b1456175b1a7ebb41a272a015ce87
+  metadata.gz: 9adf435f35e798c71a3a81213f408da0c178b2d3137ecae3619c84e3c95d564e060a4985d24a4746b93a0fb8e2d73fc4a209a38908c7dad25d87dfd728e575da
+  data.tar.gz: a6f136e8e5f140ad9455c14b13d94232d40bfc37e09e62b6827857888d03dacbc53fb027a9da1901dfa2d2f966144680a3e2d0a5dd57c4af563d4bd09af99326

data/CHANGELOG.md

@@ -1,5 +1,10 @@
-## [Unreleased]
+## [0.1.1] - 2024-03-26
+
+- Change root namespace to a class, instead of a module
 
 ## [0.1.0] - 2024-03-26
 
 - Initial release
+- Basic implementation to set/unset/get bits from the bit array
+- Ability to traverse each byte of the structure
+- Increase/decrease the number of bits used internally per element

data/lib/bitary/handler/append.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Bitary
+  class Handler
+    class Append < Bitary::Handler
+      def execute(**kwargs)
+        raise ArgumentError unless kwargs.all? do |key, _value|
+          %i[offset value].include?(key)
+        end
+
+        offset = kwargs[:offset] or raise KeyError
+        value = kwargs[:value] or raise KeyError
+        raise ArgumentError unless offset.is_a?(Integer)
+        raise ArgumentError unless value.is_a?(Integer)
+
+        (@value << offset) | value
+      end
+    end
+  end
+end

data/lib/bitary/handler/get.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Bitary
+  class Handler
+    class Get < Bitary::Handler
+      def execute(**kwargs)
+        raise ArgumentError unless kwargs.all? do |key, _value|
+          %i[index size].include?(key)
+        end
+
+        index = kwargs[:index] or raise KeyError
+        size = kwargs[:size] or raise KeyError
+        raise ArgumentError unless index.is_a?(Integer)
+        raise ArgumentError unless size.is_a?(Integer)
+
+        raise IndexError if index.negative? || index >= size
+
+        (@value >> (size - index - 1)) & 0x1
+      end
+    end
+  end
+end

data/lib/bitary/handler/set.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Bitary
+  class Handler
+    class Set < Bitary::Handler
+      def execute(**kwargs)
+        raise ArgumentError unless kwargs.all? do |key, _value|
+          %i[index size].include?(key)
+        end
+
+        index = kwargs[:index] or raise KeyError
+        size = kwargs[:size] or raise KeyError
+        raise ArgumentError unless index.is_a?(Integer)
+        raise ArgumentError unless size.is_a?(Integer)
+
+        raise IndexError if index.negative? || index >= size
+
+        @value | (2**(size - index - 1))
+      end
+    end
+  end
+end

data/lib/bitary/handler/unset.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Bitary
+  class Handler
+    class Unset < Bitary::Handler
+      def execute(**kwargs)
+        raise ArgumentError unless kwargs.all? do |key, _value|
+          %i[index size].include?(key)
+        end
+
+        index = kwargs[:index] or raise KeyError
+        size = kwargs[:size] or raise KeyError
+        raise ArgumentError unless index.is_a?(Integer)
+        raise ArgumentError unless size.is_a?(Integer)
+
+        raise IndexError if index.negative? || index >= size
+
+        @value & (((2**size) - 1) - (2**(size - index - 1)))
+      end
+    end
+  end
+end

data/lib/bitary/handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'handler/set'
+
+class Bitary
+  class Handler
+    attr_reader :value
+
+    def initialize(value)
+      raise ArgumentError unless value.is_a?(Integer)
+
+      @value = value
+    end
+
+    def execute(**kwargs)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/bitary/size.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Bitary
+  module Size
+    BYTE  = 8
+    SHORT = 16
+    INT   = 32
+    LONG  = 64
+  end
+end

data/lib/bitary/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Bitary
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/bitary.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'bitary/size'
 require_relative 'bitary/version'
 
 class Bitary
+  include Size
+
   attr_reader :size, :bits_per_item
 
-  def initialize(initial_data, bits_per_item: 64)
-    raise ArgumentError unless [8, 16, 32, 64].include?(bits_per_item)
+  def initialize(initial_data, bits_per_item: LONG)
+    raise ArgumentError unless [BYTE, SHORT, INT, LONG].include?(bits_per_item)
 
     @size = init_size(initial_data, bits_per_item)
     @internal_array = init_internal_array(initial_data, @size, bits_per_item)
@@ -18,9 +21,12 @@ class Bitary
 
     item_index = compute_item_index(index)
     item_bit_size = compute_item_bit_size(item_index)
-    offset = compute_relative_offset(index, item_bit_size)
+    item = @internal_array[item_index]
 
-    get_bit(@internal_array[item_index], offset)
+    Handler::Get.new(item).execute(
+      index: index % @bits_per_item,
+      size: item_bit_size
+    )
   end
 
   def []=(index, value)
@@ -29,22 +35,32 @@ class Bitary
     bit = map_to_bit(value)
     item_index = compute_item_index(index)
     item_bit_size = compute_item_bit_size(item_index)
-    offset = compute_relative_offset(index, item_bit_size)
+    item = @internal_array[item_index]
 
     @internal_array[item_index] =
       if bit == 1
-        set_bit(@internal_array[item_index], offset)
+        Handler::Set.new(item).execute(
+          index: index % @bits_per_item,
+          size: item_bit_size
+        )
       else
-        unset_bit(
-          @internal_array[item_index],
-          offset,
-          item_bit_size
+        Handler::Unset.new(item).execute(
+          index: index % @bits_per_item,
+          size: item_bit_size
         )
       end
   end
 
+  def set(index)
+    self[index] = 1
+  end
+
+  def unset(index)
+    self[index] = 0
+  end
+
   def each_byte(&proc)
-    res = decrease_items_size(@internal_array, 8, @bits_per_item)
+    res = decrease_items_size(@internal_array, BYTE, @bits_per_item)
     proc ? res.each { |byte| proc.call(byte) } : res.each
   end
 
@@ -59,7 +75,7 @@ class Bitary
   end
 
   def bits_per_item=(value)
-    raise ArgumentError unless [8, 16, 32, 64].include?(value)
+    raise ArgumentError unless [BYTE, SHORT, INT, LONG].include?(value)
 
     @internal_array =
       if value > @bits_per_item
@@ -110,29 +126,9 @@ class Bitary
     index / @bits_per_item
   end
 
-  def compute_relative_offset(index, size)
-    size - (index % @bits_per_item) - 1
-  end
-
-  def set_bit(value, offset)
-    value | (2**offset)
-  end
-
-  def unset_bit(value, offset, size)
-    value & (((2**size) - 1) - (2**offset))
-  end
-
-  def get_bit(value, offset)
-    (value >> offset) & 0x1
-  end
-
-  def append_bits(value, offset, bits)
-    (value << offset) | bits
-  end
-
   def increase_items_size(array, new_size, bpi)
     processed_bits = 0
-    array.each_with_object([0]) do |item, acc|
+    array.each_with_object([0]) do |value, acc|
       offset = bpi
       if processed_bits >= new_size
         offset = 0
@@ -140,7 +136,7 @@ class Bitary
         processed_bits = 0
       end
 
-      acc[-1] = append_bits(acc[-1], offset, item)
+      acc[-1] = Handler::Append.new(acc[-1]).execute(offset:, value:)
       processed_bits += bpi
     end
   end
@@ -165,5 +161,4 @@ class Bitary
   end
 
   alias at []
-  alias set []=
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitary
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Maximilien Ballesteros
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies: []
 description: Ruby-based implementation of the bit array data structure
 email:
@@ -24,6 +24,12 @@ files:
 - README.md
 - Rakefile
 - lib/bitary.rb
+- lib/bitary/handler.rb
+- lib/bitary/handler/append.rb
+- lib/bitary/handler/get.rb
+- lib/bitary/handler/set.rb
+- lib/bitary/handler/unset.rb
+- lib/bitary/size.rb
 - lib/bitary/version.rb
 - sig/bitary.rbs
 homepage: https://github.com/Patacode/bitary