bitary 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee481b52a264fe1e578b65f0228e9a9c6e4eb57a7fa7fb224fb4c1dd31d60f0c
-  data.tar.gz: 2529e365b65266446aace9bce47369f49615869c4c4ab6ffe134b90c61422535
+  metadata.gz: cc3397b948d902fe5cba56205955a01b7ad9f0d5d6eb7a1bf74984005f693114
+  data.tar.gz: af6673d27575273094dc34a4c67c67fbaa603de8a4e04375b0719e247f8cbcd9
 SHA512:
-  metadata.gz: 1b549423b7cbe533c07fc54b5a4f938612889508703530336b048206f4681356fbbcb04065b7d04a887ed3f03db6ad6cb94538a4b047a6e2e7eeb4904d0af5f9
-  data.tar.gz: 4e4831d9dcb860c06067ca92e63b41d81ac90e0d3e7aa2f0ddfd48f80f8b8352bf77c6cedbc8b5002285d29f2c6c33b9e96b1456175b1a7ebb41a272a015ce87
+  metadata.gz: e44836498539b643e9b75ead2d63c9b91beda96008bc11d5e10a3b354d67ad4f604b1ceee4740665c60a7eeca7ca898e3f05b22aa48d2845f10fa71914a22998
+  data.tar.gz: 2cc01a7ba3ab7463ab64283fb6e4f82ab8dab61865595f93bbea1efdbf966463008faf2d9dab42f8e304e1f9e6bfa57d597b7d1826ef8521e7f480d2749403f1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
-## [Unreleased]
+## [0.1.2] - 2024-03-29
+
+- internal refactoring of the Bitary class
+- addition of integer size enum
+
+## [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/README.md

@@ -2,7 +2,7 @@
 
 Ruby-based implementation of the bit array data structure.
 
-It's still under development, but as of now, it implements simple and well-optimized logic allowing you to set, unset and retrieve bits.
+It's still under development, but as of now, it implements simple and well-optimized logic allowing you to set, unset and retrieve bits (as well as some extra features, see below).
 
 ## Installation
 
@@ -24,10 +24,12 @@ Documentation still needs to be written, but here is a breakdown
 of the main capabilities brought by the current bit array implementation:
 
 ```ruby
+require 'bitary'
+
 bit_array_sz = Bitary.new(128) # give an explicit size. Defaults to 64 bits used per item
 bit_array_ar = Bitary.new(
   [255, 10, 20],
-  bits_per_item: 8
+  bits_per_item: Bitary::Size::BYTE # 8 bits
 ) # create based on some integer array
 
 bit_array_sz.bits_per_item # 64
@@ -55,13 +57,13 @@ bit_array_ar.to_a # [127, 10, 20]
 bit_array_ar.to_s # "01111111 00001010 00010100"
 
 # increase/decrease bits used per item
-bit_array_ar.bits_per_item = 64
+bit_array_ar.bits_per_item = Bitary::Size::LONG # 64 bits
 bit_array_ar.to_a # [8_325_652]
 bit_array_ar.to_s # "0000000000000000000000000000000000000000011111110000101000010100"
 
 bit_array_sz.bits_per_item # 64
 bit_array_sz.to_a # [1_099_511_627_776, 0]
-bit_array_sz.bits_per_item = 32
+bit_array_sz.bits_per_item = Bitary::Size::INT # 32 bits
 bit_array_sz.to_a # [256, 0, 0, 0]
 ```
 

data/lib/bitary/deptainer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Bitary
+  class Deptainer
+    def initialize
+      @store = {}
+    end
+
+    def [](key)
+      raise ArgumentError unless key.is_a?(Symbol)
+
+      @store[key]
+    end
+
+    def []=(key, value)
+      raise ArgumentError unless key.is_a?(Symbol)
+
+      @store[key] = value
+    end
+
+    def has?(key)
+      raise ArgumentError unless key.is_a?(Symbol)
+
+      @store.key?(key)
+    end
+  end
+end

data/lib/bitary/factory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'deptainer'
+
+class Bitary
+  class Factory
+    private_class_method :new
+    @container = Deptainer.new
+
+    def self.make(name, *, **)
+      raise ArgumentError unless name.is_a?(String)
+
+      name.split('::').reduce(Bitary) do |cls, str|
+        cls.const_get(str)
+      end.new(*, **)
+    end
+
+    def self.make_memo(name, *args, **kwargs)
+      raise ArgumentError unless name.is_a?(String)
+      if @container.has?(name.to_sym) && !args.empty? && !kwargs.empty?
+        raise ArgumentError
+      end
+
+      @container[name.to_sym] ||= make(name, *args, **kwargs)
+    end
+  end
+end

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,22 @@
+# frozen_string_literal: true
+
+require_relative 'handler/set'
+require_relative 'handler/unset'
+require_relative 'handler/get'
+require_relative 'handler/append'
+
+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.3'
 end

data/lib/bitary.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'bitary/size'
 require_relative 'bitary/version'
+require_relative 'bitary/handler'
+require_relative 'bitary/factory'
+require_relative 'bitary/deptainer'
 
 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 +24,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)
+    Factory.make('Handler::Get', item).execute(
+      index: index % @bits_per_item,
+      size: item_bit_size
+    )
   end
 
   def []=(index, value)
@@ -29,22 +38,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)
+        Factory.make('Handler::Set', item).execute(
+          index: index % @bits_per_item,
+          size: item_bit_size
+        )
       else
-        unset_bit(
-          @internal_array[item_index],
-          offset,
-          item_bit_size
+        Factory.make('Handler::Unset', 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 +78,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 +129,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 +139,10 @@ class Bitary
         processed_bits = 0
       end
 
-      acc[-1] = append_bits(acc[-1], offset, item)
+      acc[-1] = Factory.make('Handler::Append', acc[-1]).execute(
+        offset:,
+        value:
+      )
       processed_bits += bpi
     end
   end
@@ -165,5 +167,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.3
 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,14 @@ files:
 - README.md
 - Rakefile
 - lib/bitary.rb
+- lib/bitary/deptainer.rb
+- lib/bitary/factory.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