bitary 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3a73becac006670efcdd4a87b36aee0c3c9bc48c50f5cf48d68e47e1e7cad3
-  data.tar.gz: e398cc62cdbfc33cf1f48146b59fe655f832b33d59caf8556a7898df1ef4e20d
+  metadata.gz: 537a58c702f90bfeade22439d4134d921df709d4d474279f29adae869ff08b0d
+  data.tar.gz: 90910632d7a7f40f89774a8d0ba2b1a6bbf04f5b281454ab18313359151f58b0
 SHA512:
-  metadata.gz: 5f6d8328faf7a368daf44fc5dafedcfc4456369d2ae48b7a2e3736ad48bea686d76444b3fdd8c7c8d6b34774906e7544cf61cd78905350cfb60c94205916d832
-  data.tar.gz: 86f6f32038489a43a9dc18613c536110af4e7aed65e228f2d763f6c472037aba0518ba382566bbe6edeec3ff76491584971c6a0bad64f4efe5dc1d68e443bca4
+  metadata.gz: 3c65d9bcd2b757bf0a3e2d8b25b51b6a50b239e589efba142eb3c1c7539d42ac88c311361aa934f6ecf5be06c18da53c4e3c138dda801f0c89330da7c030a745
+  data.tar.gz: 10169aa8520c4d2dc4ddc92e419b77b745688c14bc08214770f9da25ed35b66d66655db37ef32daa7967119514ad3cacb618d06be5bd3c69df45e2ed435e9fb1

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   NewCops: enable
+  Exclude:
+    - 'bin/**/*'
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.6] - 2024-03-31
+
+- enhance global perf by remove useless and heavy error handling
+
+## [0.1.5] - 2024-03-31
+
+- enhance performance of #each_byte (4 seconds faster on average)
+
 ## [0.1.4] - 2024-03-31
 
 - more refactoring of Bitary class

data/lib/bitary/bitwarr.rb

@@ -2,132 +2,78 @@
 
 class Bitary
   class Bitwarr
-    attr_reader :bpi
+    attr_reader :bpi, :bitsize
 
     def initialize(initial_data, bpi: Bitary::LONG)
-      check_initial_data(initial_data)
-      check_bpi(bpi)
+      @bitsize = init_bitsize(initial_data, bpi)
+      @array = init_array(initial_data, @bitsize, bpi)
+      @bpi = init_bpi(initial_data, bpi)
 
-      @bpi = bpi
-      @bitsize = init_bitsize(initial_data)
-      @array = init_array(initial_data)
+      self.bpi = bpi
     end
 
-    def method_missing(method, *, &)
-      @array.respond_to?(method) ? @array.send(method, *, &) : super
-    end
-
-    def respond_to_missing?(method, include_all = false)
-      @array.respond_to?(method, include_all) || super
-    end
-
-    def bitsize(bit_index = nil)
-      if bit_index.nil?
-        @bitsize
-      else
-        check_bit_index(bit_index)
-
-        last_index = @array.length - 1
-        if item_index(bit_index) == last_index
-          @bitsize - (last_index * @bpi)
-        else
-          @bpi
-        end
-      end
-    end
-
-    def [](bit_index)
-      @array[item_index(bit_index)]
-    end
+    def [](bit_index) = @array[item_index(bit_index)]
+    def bit_at(index) = operate_bit_at(:get, index)
+    def bit_at!(index) = operate_bit_at!(:set, index)
+    def unbit_at!(index) = operate_bit_at!(:unset, index)
+    def to_s = @array.map { |item| to_binstr(item) }.join(' ')
 
     def []=(bit_index, value)
-      raise ArgumentError unless value.is_a?(Integer)
-
       @array[item_index(bit_index)] = value
     end
 
-    def relative_bit_index(bit_index)
-      check_bit_index(bit_index)
-
-      bit_index % @bpi
-    end
-
-    def item_index(bit_index)
-      check_bit_index(bit_index)
-
-      bit_index / @bpi
-    end
-
-    def bit_at(index)
-      operate_bit_at(:get, index)
-    end
-
-    def bit_at!(index)
-      operate_bit_at!(:set, index)
-    end
-
-    def unbit_at!(index)
-      operate_bit_at!(:unset, index)
-    end
-
-    def each_byte
+    def each_byte(&proc)
       @array.each do |item|
-        (@bpi / Bitary::BYTE).times do |i|
-          byte = (item >> (@bpi - (Bitary::BYTE * (i + 1))))
-          yield byte
-        end
+        explode_item(item, Bitary::BYTE, @bpi, &proc)
       end
     end
 
-    def to_s
-      @array.map { |item| format("%0#{@bpi}d", item.to_s(2)) }.join(' ')
-    end
-
     def bpi=(value)
-      check_bpi(value)
+      return if value == @bpi
 
       update_items_size!(value)
-
       @bpi = value
     end
 
+    def method_missing(method, *, &)
+      @array.respond_to?(method) ? @array.send(method, *, &) : super
+    end
+
+    def respond_to_missing?(method, include_all = false)
+      @array.respond_to?(method, include_all) || super
+    end
+
     private
 
-    def init_bitsize(initial_data)
-      initial_data.is_a?(Array) ? @bpi * initial_data.length : initial_data
+    def init_bpi(initial_data, bpi)
+      initial_data.is_a?(Array) ? Bitary::BYTE : bpi
+    end
+
+    def init_bitsize(initial_data, bpi)
+      initial_data.is_a?(Array) ? bpi * initial_data.length : initial_data
     end
 
-    def init_array(initial_data)
+    def init_array(initial_data, bitsize, bpi)
       if initial_data.is_a?(Array)
         initial_data.clone
       else
-        [0] * (@bitsize / @bpi.to_f).ceil
+        [0] * (bitsize / bpi.to_f).ceil
       end
     end
 
-    def check_initial_data(initial_data)
-      raise ArgumentError unless [Array, Integer].include?(initial_data.class)
-    end
-
-    def check_bit_index(bit_index)
-      raise ArgumentError unless bit_index.is_a?(Integer)
-      raise IndexError if bit_index.negative? || bit_index >= @bitsize
+    def item_index(bit_index)
+      bit_index / @bpi
     end
 
-    def check_bpi(bpi)
-      raise ArgumentError unless [
-        Bitary::BYTE,
-        Bitary::SHORT,
-        Bitary::INT,
-        Bitary::LONG
-      ].include?(bpi)
+    def to_binstr(item)
+      format("%0#{@bpi}d", item.to_s(2))
     end
 
     def operate_bit_at(operation, index)
       Factory
         .make("Handler::#{operation.capitalize}", self[index])
         .execute(
-          index: relative_bit_index(index),
+          index: index % @bpi,
           size: @bpi
         )
     end
@@ -137,29 +83,34 @@ class Bitary
     end
 
     def update_items_size!(value)
-      if value > @bpi
-        increase_items_size!(value)
-      else
-        decrease_items_size!(value)
-      end
+      value > @bpi ? increase_items_size!(value) : decrease_items_size!(value)
+    end
+
+    def append_bits(item, bpi, addend)
+      Factory.make('Handler::Append', item).execute(
+        offset: bpi,
+        value: addend
+      )
     end
 
     def increase_items_size(array, new_size, bpi)
       processed_bits = 0
-      array.each_with_object([0]) do |value, acc|
-        offset = bpi
-        if processed_bits >= new_size
-          offset = 0
+      res = array.each_with_object([0]) do |item, acc|
+        if processed_bits == new_size
           acc << 0
           processed_bits = 0
         end
 
-        acc[-1] = Factory.make('Handler::Append', acc[-1]).execute(
-          offset:,
-          value:
-        )
+        acc[-1] = append_bits(acc[-1], bpi, item)
         processed_bits += bpi
       end
+
+      while processed_bits < new_size
+        res[-1] = append_bits(res[-1], bpi, 0)
+        processed_bits += bpi
+      end
+
+      res
     end
 
     def increase_items_size!(value)
@@ -168,7 +119,9 @@ class Bitary
 
     def decrease_items_size(array, new_size, bpi)
       array.each_with_object([]) do |item, acc|
-        acc.concat(explode_item(item, new_size, bpi))
+        explode_item(item, new_size, bpi) do |new_item|
+          acc << new_item
+        end
       end
     end
 
@@ -177,16 +130,10 @@ class Bitary
     end
 
     def explode_item(item, new_size, bpi)
-      res = []
-      offset = bpi
       mask = (2**new_size) - 1
-
-      while offset.positive?
-        offset -= new_size
-        res << ((item >> offset) & mask)
+      (bpi / new_size).times do |i|
+        yield ((item >> (bpi - (new_size * (i + 1)))) & mask)
       end
-
-      res
     end
   end
 end

data/lib/bitary/decorator/single_method.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'single_method/non_nil_enforcer'
-require_relative 'single_method/truthy_enforcer'
 
 class Bitary
   class Decorator

data/lib/bitary/decorator.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'decorator/kwargs_validator'
 require_relative 'decorator/single_method'
 
 class Bitary

data/lib/bitary/handler/append.rb

@@ -3,17 +3,6 @@
 class Bitary
   class Handler
     class Append < Bitary::Handler
-      SPEC = {
-        offset: {
-          required: true,
-          type: Integer
-        },
-        value: {
-          required: true,
-          type: Integer
-        }
-      }.freeze
-
       def execute(**kwargs)
         (@value << kwargs[:offset]) | kwargs[:value]
       end

data/lib/bitary/handler/get.rb

@@ -3,23 +3,6 @@
 class Bitary
   class Handler
     class Get < Bitary::Handler
-      SPEC = {
-        index: {
-          required: true,
-          type: Integer,
-          predicate: {
-            callback: lambda do |**kwargs|
-              kwargs[:index] >= 0 && kwargs[:index] < kwargs[:size]
-            end,
-            error: IndexError
-          }
-        },
-        size: {
-          required: true,
-          type: Integer
-        }
-      }.freeze
-
       def execute(**kwargs)
         (@value >> (kwargs[:size] - kwargs[:index] - 1)) & 0x1
       end

data/lib/bitary/handler/set.rb

@@ -3,23 +3,6 @@
 class Bitary
   class Handler
     class Set < Bitary::Handler
-      SPEC = {
-        index: {
-          required: true,
-          type: Integer,
-          predicate: {
-            callback: lambda do |**kwargs|
-              kwargs[:index] >= 0 && kwargs[:index] < kwargs[:size]
-            end,
-            error: IndexError
-          }
-        },
-        size: {
-          required: true,
-          type: Integer
-        }
-      }.freeze
-
       def execute(**kwargs)
         @value | (2**(kwargs[:size] - kwargs[:index] - 1))
       end

data/lib/bitary/handler/unset.rb

@@ -3,28 +3,10 @@
 class Bitary
   class Handler
     class Unset < Bitary::Handler
-      SPEC = {
-        index: {
-          required: true,
-          type: Integer,
-          predicate: {
-            callback: lambda do |**kwargs|
-              kwargs[:index] >= 0 && kwargs[:index] < kwargs[:size]
-            end,
-            error: IndexError
-          }
-        },
-        size: {
-          required: true,
-          type: Integer
-        }
-      }.freeze
-
       def execute(**kwargs)
-        mask =
-          (2**kwargs[:size]) - 1 - (2**(kwargs[:size] - kwargs[:index] - 1))
-
-        @value & mask
+        size = kwargs[:size]
+        index = kwargs[:index]
+        @value & ((2**size) - 1 - (2**(size - index - 1)))
       end
     end
   end

data/lib/bitary/handler.rb

@@ -7,20 +7,9 @@ require_relative 'handler/append'
 
 class Bitary
   class Handler
-    SPEC = {}.freeze
-
     attr_reader :value
 
-    def self.new(*arg, **kwargs)
-      Decorator::SingleMethod::KwargsValidator.new(
-        super,
-        { execute: self::SPEC }
-      )
-    end
-
     def initialize(value)
-      raise ArgumentError unless value.is_a?(Integer)
-
       @value = value
     end
 

data/lib/bitary/version.rb

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

data/lib/bitary.rb

@@ -12,17 +12,24 @@ class Bitary
   include Size
 
   def initialize(initial_data, bpi: LONG)
-    @internal_array = Bitwarr.new(initial_data, bpi:)
+    check_initial_data(initial_data)
+    check_bpi(bpi)
+
+    @bitwarr = Factory.make('Bitwarr', initial_data, bpi:)
   end
 
   def [](index)
-    @internal_array.bit_at(index)
+    check_bit_index(index)
+
+    @bitwarr.bit_at(index)
   end
 
   def []=(index, value)
-    case Mapper::ObjToBit.new.map(value)
-    when 0 then @internal_array.unbit_at!(index)
-    else @internal_array.bit_at!(index)
+    check_bit_index(index)
+
+    case Factory.make('Mapper::ObjToBit').map(value)
+    when 0 then @bitwarr.unbit_at!(index)
+    else @bitwarr.bit_at!(index)
     end
   end
 
@@ -35,27 +42,44 @@ class Bitary
   end
 
   def each_byte(&)
-    @internal_array.each_byte(&)
+    @bitwarr.each_byte(&)
   end
 
   def to_a
-    @internal_array.to_a
+    @bitwarr.to_a
   end
 
   def to_s
-    @internal_array.to_s
+    @bitwarr.to_s
   end
 
   def bpi=(value)
-    @internal_array.bpi = value
+    check_bpi(value)
+
+    @bitwarr.bpi = value
   end
 
   def size
-    @internal_array.bitsize
+    @bitwarr.bitsize
   end
 
   def bpi
-    @internal_array.bpi
+    @bitwarr.bpi
+  end
+
+  private
+
+  def check_initial_data(initial_data)
+    raise ArgumentError unless [Array, Integer].include?(initial_data.class)
+  end
+
+  def check_bpi(bpi)
+    raise ArgumentError unless [BYTE, SHORT, INT, LONG].include?(bpi)
+  end
+
+  def check_bit_index(bit_index)
+    raise ArgumentError unless bit_index.is_a?(Integer)
+    raise IndexError if bit_index.negative? || bit_index >= @bitwarr.bitsize
   end
 
   alias at []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitary
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Maximilien Ballesteros
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-31 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies: []
 description: Ruby-based implementation of the bit array data structure
 email:
@@ -26,10 +26,8 @@ files:
 - lib/bitary.rb
 - lib/bitary/bitwarr.rb
 - lib/bitary/decorator.rb
-- lib/bitary/decorator/kwargs_validator.rb
 - lib/bitary/decorator/single_method.rb
 - lib/bitary/decorator/single_method/non_nil_enforcer.rb
-- lib/bitary/decorator/single_method/truthy_enforcer.rb
 - lib/bitary/factory.rb
 - lib/bitary/handler.rb
 - lib/bitary/handler/append.rb

data/lib/bitary/decorator/kwargs_validator.rb

@@ -1,174 +0,0 @@
-# frozen_string_literal: true
-
-class Bitary
-  class Decorator
-    class KwargsValidator < Bitary::Decorator
-      SPEC_KEYS = %i[required default type predicate].freeze
-
-      def initialize(wrappee, spec)
-        super(wrappee) { |method| spec.key?(method) }
-        @spec = check_spec(@wrappee, spec)
-      end
-
-      protected
-
-      def precall(method, *, **)
-        super(method, *, **check_kwargs(@spec, method, **))
-      end
-
-      private
-
-      def check_spec(wrappee, spec)
-        raise ArgumentError unless spec.is_a?(Hash)
-
-        spec.each do |method, method_spec|
-          check_spec_method(wrappee, method)
-          check_spec_method_value(method_spec)
-        end
-      end
-
-      def check_kwargs(spec, method, **kwargs)
-        check_unexpected_user_kwargs(kwargs, spec[method])
-        check_kwargs_against_spec(kwargs, spec[method])
-      end
-
-      def check_spec_method(wrappee, method)
-        raise ArgumentError unless wrappee.respond_to?(method)
-      end
-
-      def check_spec_method_value(method_spec)
-        raise ArgumentError unless method_spec.is_a?(Hash)
-
-        method_spec.each_value do |arg_spec|
-          raise ArgumentError unless arg_spec.is_a?(Hash)
-
-          check_arg_spec(arg_spec)
-        end
-      end
-
-      def check_arg_spec(arg_spec)
-        raise ArgumentError unless arg_spec.keys.all? do |spec_key|
-          SPEC_KEYS.include?(spec_key)
-        end
-
-        arg_spec.each do |spec_key, spec_value|
-          check_arg_spec_entry(spec_key, spec_value)
-        end
-
-        return unless arg_spec.key?(:required) && arg_spec[:required]
-        raise ArgumentError if arg_spec.key?(:default)
-      end
-
-      def check_arg_spec_entry(key, value)
-        case key
-        when :required then check_required(value)
-        when :default then check_default(value)
-        when :type then check_type(value)
-        when :predicate then check_predicate(value)
-        end
-      end
-
-      def check_required(value)
-        raise ArgumentError unless [true, false].include?(value)
-      end
-
-      def check_default(value)
-        # NOTHING TODO
-      end
-
-      def check_type(value)
-        raise ArgumentError unless value.is_a?(Class)
-      end
-
-      def check_predicate(value)
-        raise ArgumentError unless value.is_a?(Hash)
-
-        check_predicate_keys(value)
-        check_predicate_values(value)
-      end
-
-      def check_predicate_keys(value)
-        available_keys = %i[callback error]
-
-        raise ArgumentError unless value.keys.all? do |key|
-          available_keys.include?(key)
-        end
-
-        raise KeyError unless value.key?(:callback) && value.key?(:error)
-      end
-
-      def check_predicate_values(value)
-        raise ArgumentError unless value[:callback].is_a?(Proc)
-        raise ArgumentError unless value[:error].is_a?(Class)
-        raise ArgumentError unless value[:error] < Exception
-      end
-
-      def check_unexpected_user_kwargs(user_kwargs, method_spec)
-        raise ArgumentError unless user_kwargs.keys.all? do |key|
-          method_spec.include?(key)
-        end
-      end
-
-      def check_kwargs_against_spec(user_kwargs, method_spec)
-        predicates = []
-
-        parsed_kwargs = method_spec.reduce({}) do |acc, entry|
-          kwarg_name, kwarg_spec = entry
-          loaded_spec = load_spec(kwarg_spec)
-
-          validate_required(user_kwargs, loaded_spec, kwarg_name)
-          validate_type(user_kwargs, loaded_spec, kwarg_name)
-          predicates << loaded_spec[:predicate]
-
-          acc.merge(
-            kwarg_name => compute_value(user_kwargs, loaded_spec, kwarg_name)
-          )
-        end
-
-        predicates.each do |predicate|
-          validate_predicate(parsed_kwargs, predicate)
-        end
-
-        parsed_kwargs
-      end
-
-      def load_spec(kwarg_spec)
-        {
-          required: kwarg_spec[:required] || false,
-          default: kwarg_spec[:default],
-          type: kwarg_spec[:type] || Object,
-          predicate: kwarg_spec[:predicate] || {
-            callback: ->(_value) { true },
-            error: ArgumentError
-          }
-        }
-      end
-
-      def validate_required(user_kwargs, spec, expected_key)
-        return unless spec[:required]
-
-        raise KeyError unless user_kwargs.key?(expected_key)
-      end
-
-      def validate_type(user_kwargs, spec, expected_key)
-        return unless user_kwargs.key?(expected_key)
-
-        raise ArgumentError unless user_kwargs[expected_key].is_a?(spec[:type])
-      end
-
-      def validate_predicate(parsed_kwargs, predicate)
-        return if predicate[:callback].call(**parsed_kwargs)
-
-        raise predicate[:error]
-      end
-
-      def compute_value(user_kwargs, spec, expected_key)
-        if user_kwargs.key?(expected_key)
-          user_kwargs[expected_key]
-        else
-          spec[:default]
-        end
-      end
-    end
-  end
-end

data/lib/bitary/decorator/single_method/truthy_enforcer.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-class Bitary
-  class Decorator
-    class SingleMethod < Bitary::Decorator
-      class TruthyEnforcer < Bitary::Decorator::SingleMethod
-        protected
-
-        def postcall(resp)
-          resp or raise TypeError
-        end
-      end
-    end
-  end
-end