bitint 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66e650638e0715aa47439d6fc808da63ab437cf8861b2d309c5205a44427ab24
-  data.tar.gz: 72dccf88fd548cfea40033fc32f1ff67d0408dff5c51fb67b61e64f663486921
+  metadata.gz: 75e3bf4db6ee1c4cfc212b8bff049cb1445aadd046a118ea3dab258265b8e8af
+  data.tar.gz: 3207dadb95f0dae0a7084dc73daf741b45400a96bd92736f16c73515ca5023ba
 SHA512:
-  metadata.gz: e0896c0813dd92ada9c2fda9c9a7cd72f03db1c7bce0f8729289b12ab564edc25d8369ae6a48109b35b6a23134612aa516b543e36c6abf99decbe1dcbf09ce24
-  data.tar.gz: 14489ac974de4591940baefc17516bffbf2bcf96ffb4f7c037aa73e836ba60f65f0edcbfb284f61548a5c021ca5917043b831292bfd48c942fa7d7617aa7f4ad
+  metadata.gz: fd10fb7e841befab6ebfacf89c7e339be37511b37489896896e1063c332cdb4b42171a067e461a759249887020d7ede860fa4a1d155d3aa7b2fb6ec5ee3736bb
+  data.tar.gz: f82d4513e9f79185152a37f8b15bf01fd5a55e27826a957f70404f30794af48be83b63f7159d343b493bf1c5714798d7e6f8d484cfb1dda23b2d79445dbdf6fa

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-num = BitInt::U8.new(0xfe)
+num = BitInt::U8.new(0xFE)
 num += 2
 puts num #=> 1
 ```

data/lib/bitint/bitint.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class BitInt < Numeric
+class BitInt
   # Indicates that +BitInt::new+ was called with an integer that was too large.
   class OverflowError < RuntimeError
     attr_reader :integer, :range
@@ -214,22 +214,34 @@ class BitInt < Numeric
   # :section:
 
   # Returns whether +self+ is a positive integer. Zero is not positive.
-  def positive? = @int.positive?
+  def positive?
+    @int.positive?
+  end
 
   # Return whether +self+ is a negative integer. Zero is not negative.
-  def negative? = @int.negative?
+  def negative?
+    @int.negative?
+  end
 
   # Returns whether +self+ is zero.
-  def zero? = @int.zero?
+  def zero?
+    @int.zero?
+  end
 
   # Returns a falsey value if zero, otherwise returns +self+.
-  def nonzero? = @int.nonzero? && self
+  def nonzero?
+    @int.nonzero? && self
+  end
 
   # Checks to see if +self+ is even.
-  def even? = @int.even?
+  def even?
+    @int.even?
+  end
 
   # Checks to see if +self+ is odd.
-  def odd? = @int.odd?
+  def odd?
+    @int.odd?
+  end
 
   ##################################
   # :section: Bit-level operations #
@@ -268,34 +280,39 @@ class BitInt < Numeric
 
   def size = (self.class::BITS / 8.0).ceil
 
+  PACK_FMT = {
+    [:native, 8,  false].freeze => 'C',
+    [:native, 16, false].freeze => 'S',
+    [:native, 32, false].freeze => 'L',
+    [:native, 64, false].freeze => 'Q',
+    [:native, 8,  true].freeze => 'c',
+    [:native, 16, true].freeze => 's',
+    [:native, 32, true].freeze => 'l',
+    [:native, 64, true].freeze => 'q',
+  }.freeze
+  private_constant :PACK_FMT
+
+  def bytes(endian = :native)
+    return to_enum(__method__, endian) unless block_given?
+
+    template = '_CS_L___Q'[self.class::BYTES]
+    if template.nil? || template == '_'
+      raise ArgumentError, 'bytes only works for sizes of 8, 16, 32, or 64.'
+    end
 
-  # PACK_FMT = {
-  #   [:native, 8,  false].freeze => 'C',
-  #   [:native, 16, false].freeze => 'S',
-  #   [:native, 32, false].freeze => 'L',
-  #   [:native, 64, false].freeze => 'Q',
-  #   [:native, 8,  true].freeze => 'c',
-  #   [:native, 16, true].freeze => 's',
-  #   [:native, 32, true].freeze => 'l',
-  #   [:native, 64, true].freeze => 'q',
-  # }.freeze
-  # private_constant :PACK_FMT
-
-  # def bytes(endian = :native)
-  #   size = {
-  #     8 => 'C',
-  #     16 => 'S',
-  #     32 => 'L',
-  #     64 => 'Q'
-  #   }[self.class::BITS] or raise ArgumentError, "bytes only works for 8, 16, 32, or 64 rn." or raise ArgumentError, "endian must be :big, :little, or :native"
-  #   size = {8=>'C', 16=>}
-  #   size = case self.class::BITS
-  #          when 8 then 'C'
-  #          when 8 then 'C'
-  #   # sprintf "%0#{self.class::BYTES * 2}x",
-  #   # mask = self.class::MASK_CHAR or raise ArgumentError, "bytes only works (rn) on "
-  #   # pack_char = self.class.pack_Char
-  #   # case endian
-  #   # when :native then 
-  # end
+    template.downcase! if self.class.signed?
+
+    case endian
+    when :native
+    when :little then template.concat '<'
+    when :big then template.concat '>'
+    else raise raise ArgumentError, 'endian must be :big, :little, or :native'
+    end
+
+    [to_i].pack(template).unpack('C*').map(&U8.method(:new))
+  end
+
+  def bytes_hex(...)
+    bytes(...).map(&:hex)
+  end
 end

data/lib/bitint/native.rb

@@ -6,14 +6,16 @@ class BitInt
   # `BitInt`s that correspond to underlying C integer sizes.
   module Native
     # On big-endian systems, the unpack will equal `0x00AA`.
-    @little_endian = [0xAA00].pack('S').unpack('S<') == [0xAA00]
+    IS_LITTLE_ENDIAN = [0xAA00].pack('S').unpack('S<') == [0xAA00]
+    private_constant :IS_LITTLE_ENDIAN
 
     module_function
 
     # Returns either `:little` or `:big` depending on the underlying system's endianness.
     def endianness
-      @little_endian ? :little : :big
+      @IS_LITTLE_ENDIAN ? :little : :big
     end
+
     class << self
       alias endian endianness
     end

data/lib/bitint/refinements.rb

@@ -20,81 +20,61 @@ class BitInt
       # If no arguments are given, this instead forwards to Numeric#i.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def i(bits = nil, ...)
-        return super if bits.nil?
+      def i(bits = bits_not_given=true, *a, **k, &b) # Support ruby-3.0
+        bits_not_given and return super
 
-        BitInt::i(bits, ...).new(self)
+        BitInt::i(bits, *a, **k, &b).new(self)
       end
 
       # Converts +self+ into an unsigned 8-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def u8(...)
-        u(8, ...)
-      end
+      def u8(...) = u(8, ...)
 
       # Converts +self+ into an unsigned 16-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def u16(...)
-        u(16, ...)
-      end
+      def u16(...) = u(16, ...)
 
       # Converts +self+ into an unsigned 32-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def u32(...)
-        u(32, ...)
-      end
+      def u32(...) = u(32, ...)
 
       # Converts +self+ into an unsigned 64-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def u64(...)
-        u(64, ...)
-      end
+      def u64(...) = u(64, ...)
 
       # Converts +self+ into an unsigned 128-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def u128(...)
-        u(128, ...)
-      end
+      def u128(...) = u(128, ...)
 
       # Converts +self+ into a signed 8-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def i8(...)
-        i(8, ...)
-      end
+      def i8(...) = i(8, ...)
 
       # Converts +self+ into a signed 16-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def i16(...)
-        i(16, ...)
-      end
+      def i16(...) = i(16, ...)
 
       # Converts +self+ into a signed 32-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def i32(...)
-        i(32, ...)
-      end
+      def i32(...) = i(32, ...)
 
       # Converts +self+ into a signed 64-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def i64(...)
-        i(64, ...)
-      end
+      def i64(...) = i(64, ...)
 
       # Converts +self+ into a signed 128-bit integer.
       #
       # Any additional arguments are forwarded to +BitInt#new+
-      def i128(...)
-        i(128, ...)
-      end
+      def i128(...) = i(128, ...)
     end
   end
 end

data/lib/bitint/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class BitInt
+class BitInt < Numeric
   # The current version of BitInt.
-  VERSION = '0.5.2'
+  VERSION = '0.6.1'
 end

data/lib/bitint.rb

@@ -6,5 +6,5 @@ end
 require_relative 'bitint/version'
 require_relative 'bitint/bitint'
 require_relative 'bitint/refinements'
-require_relative 'bitint/native'
 require_relative 'bitint/constants'
+require_relative 'bitint/native'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitint
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Sam Westerman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A 2's-complement integer of arbitrary length