bytes 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a8baa99382e45238e96527a5aab45a04daf4b73a2d4e1f64b3bf87530e14a7d
-  data.tar.gz: ec170b28a4efd3d7b0cdf45094831a68a86d60785f313668baa24cbf5a106085
+  metadata.gz: 4d93d96204652bc075816b6b9a32220b7f1f72fa3765379012ecea3dfc4485c3
+  data.tar.gz: ba15bcb1f6939fd5ddb4d42da815a9ecb7edfc42e785c81bc8845101dc819b9a
 SHA512:
-  metadata.gz: 8f62ad42592bfd8e69fb9bf53526ba19e3568b7140f88bfa9bf524ee1ac8af3258dd2d156f6080d08e63ecbcb92cf0e8f531f56f4c3b32faad8477b7efdf8423
-  data.tar.gz: 728487df6ca9ad9cbe4aedcc2ae76c3f7018c195a780a5e4ef7ee487602cf0ac7fadff8b5c31b38a6e18f6a324947a1ae7e51f3c693bb65ae000ce6461a54969
+  metadata.gz: d3f41e967326e54022df7c16257fab59dc8bfe3d0402ba74670b16532d086162b74156937e3b4f40f2a09aee5a73521e1399b0329232da418a18599a48cfcfe1
+  data.tar.gz: 71726839412c32893a6f1a243cf4d00d84ba1558379f39e2e355940b645a5970a72c07a249481f11046486853926d8afd44aa28b4ef7ebc90afc9674534eaeb0

data/README.md

@@ -246,12 +246,72 @@ To be continued ...
 
 
 
+## Usage
 
+### BytesHelper  - From Bytes (Binary String) to Hex(adecimal) String and Back
+
+``` ruby
+require 'bytes
+
+Bytes.bin_to_hex( "\x61\x62".b )
+#=> '6162'
+
+Bytes.hex_to_bin( '6162' )     # or
+Bytes.hex_to_bin( '0x6162' )   # or
+#=> "\x61\x62".b
+
+Bytes.is_hex?( '6162' )
+Bytes.is_hex?( '0x6162' )
+Bytes.is_hex?( '' )     # empty string or
+Bytes.is_hex?( '0x' )   # empty hex string
+#=> true
+
+Bytes.is_hex?( 'xyz' )
+Bytes.is_hex?( '0xyz' )
+#=> false
+
+Bytes.hex_to_bin( 'xzy' )  # or
+Bytes.hex_to_bin( '0xxzy' )
+#=>  raises TypeError - non-hexadecimal digit found
+```
+
+Note:  You can use the shorter alternate alias
+names  `btoh` or `htob`
+for `bin_to_hex` and `hex_to_bin`.
+
+
+Or use the mixed-in String class variants. Example:
+
+``` ruby
+"\x61\x62".b.bin_to_hex   # or
+"\x61\x62".b.btoh
+#=> '6162'
+
+'6162'.hex_to_bin      # or
+'6162'.htob            # or
+'0x6162'.hex_to_bin    # or
+'0x6162'.htob          # or
+#=> "\x61\x62".b
+
+'6162'.is_hex?
+'0x6162'is_hex?
+''.is_hex?        # empty string or
+'0x'.is_hex?      # empty hex string
+#=> true
+
+'xyz'is_hex?
+'0xyz'.is_hex?
+#=> false
+
+'xzy'.htob   # or
+'0xxzy'.htob
+#=>  raises TypeError - non-hexadecimal digit found
+```
+
+and so on.
 
 
-## Usage
 
-To be done
 
 
 ## License

data/Rakefile

@@ -6,7 +6,7 @@ Hoe.spec 'bytes' do
 
   self.version = Cocos::Module::Bytes::VERSION
 
-  self.summary = "bytes"
+  self.summary = "bytes - bits 'n' bytes made easy/easier incl. new buffer helper / wrapper class to help with the string byte vs character dichotomy"
   self.description = summary
 
 

data/lib/bytes/version.rb

@@ -3,8 +3,8 @@ module Cocos
 module Module
 module Bytes
 
-  MAJOR = 0
-  MINOR = 2
+  MAJOR = 1
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/lib/bytes.rb

@@ -6,6 +6,7 @@ require 'forwardable'
 require_relative 'bytes/version'    # note: let version always go first
 
 
+
 module BytesHelper
   def hex_to_bin( hex )
     ## todo/fix:  do an argument regex hex check!!!!
@@ -18,8 +19,8 @@ module BytesHelper
       [hex].pack('H*')
     end
   end
-  alias_method :hex_to_bytes, :hex_to_bin
-  alias_method :h_to_b,       :hex_to_bin
+  ## alias_method :hex_to_bytes, :hex_to_bin
+  ## alias_method :h_to_b,       :hex_to_bin
   alias_method :htob,         :hex_to_bin
 
 
@@ -32,8 +33,8 @@ module BytesHelper
     hex.encode!( Encoding::UTF_8 )
     hex
   end
-  alias_method :bytes_to_hex, :bin_to_hex
-  alias_method :b_to_h,       :bin_to_hex
+  ## alias_method :bytes_to_hex, :bin_to_hex
+  ## alias_method :b_to_h,       :bin_to_hex
   alias_method :btoh,         :bin_to_hex
 
 
@@ -81,8 +82,8 @@ class Bytes
                         :size, :length
 
 
-  def to_s() Bytes.bin_to_hex( @bin ); end
-  alias_method :to_hex, :to_s
+  def to_hex() Bytes.bin_to_hex( @bin ); end
+  alias_method :to_s, :to_hex
 
   def b()  @bin; end
 
@@ -119,12 +120,15 @@ end
 
 
 class String
-  def to_hex()  Bytes.bin_to_hex( self ); end
-  ## add more aliases e.g. bin_to_hex or btoh or b_to_h or such - why? why not?
-
+  def bin_to_hex()  Bytes.bin_to_hex( self ); end
+  alias_method :btoh,   :bin_to_hex
+  alias_method :to_hex, :bin_to_hex
   ## note: built-in String#hex returns string converted
-  ##                    to Integer  -same as String.to_i(16) !!!!
-end
+  ##                    to Integer  - same as String.to_i(16) !!!!
+
+  def hex_to_bin()  Bytes.hex_to_bin( self ); end
+  alias_method :htob, :hex_to_bin
+end   # class String
 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bytes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-10 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -44,7 +44,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: bytes
+description: bytes - bits 'n' bytes made easy/easier incl. new buffer helper / wrapper
+  class to help with the string byte vs character dichotomy
 email: wwwmake@googlegroups.com
 executables: []
 extensions: []
@@ -83,5 +84,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: bytes
+summary: bytes - bits 'n' bytes made easy/easier incl. new buffer helper / wrapper
+  class to help with the string byte vs character dichotomy
 test_files: []