hexutils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58d93d37042b54496a85566264d827f2852ed034ecf6356b63ec121561230347
+  data.tar.gz: 999e485f063f2e1753f9541e94bd34deb2a0c609bb26b03e551be0b234ffe7c9
+SHA512:
+  metadata.gz: 04aeca2de8a683f4d3a5080e23cb10ceb3d38aa580bbaa127b267315e59fe38bd4da3de416cdf6081d233395d35772091b6389e1fe5f1d2750c84849e80145dc
+  data.tar.gz: 5f978fc664a4398e8148c96812875910a6db8629e1448acec559efe76c368efa79f8d4c30c3accb55fb480069a270cab00eb6eac6ac2ad34111a685f94590583

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2023-01-10
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,6 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/hex.rb
+lib/hexutils.rb

data/README.md

@@ -0,0 +1,32 @@
+#  Hex(adecimal) Encode / Decode Helpers - From Hex(adecimal) String to Bin(ary) String And Back
+
+hexutils - hex(adecimal) encode/decode helpers 'n' more for String, NilClass, Kernel and more
+
+
+* home  :: [github.com/rubycocos/core](https://github.com/rubycocos/core)
+* bugs  :: [github.com/rubycocos/core/issues](https://github.com/rubycocos/core/issues)
+* gem   :: [rubygems.org/gems/hexutils](https://rubygems.org/gems/hexutils)
+* rdoc  :: [rubydoc.info/gems/hexutils](http://rubydoc.info/gems/hexutils)
+
+
+
+
+
+## Usage
+
+To be done
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+
+
+## Questions? Comments?
+
+Send them along to the [wwwmake forum](http://groups.google.com/group/wwwmake).
+Thanks!
+

data/Rakefile

@@ -0,0 +1,30 @@
+require 'hoe'
+
+
+Hoe.spec 'hexutils' do
+
+  self.version = '0.0.1'
+
+  self.summary = "hexutils - hex(adecimal) encode/decode helpers 'n' more for String, NilClass, Kernel and more"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycocos/core' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/lib/hex.rb

@@ -0,0 +1,3 @@
+require_relative 'hexutils'  ## lets you use require 'hex' too
+
+

data/lib/hexutils.rb

@@ -0,0 +1,95 @@
+
+
+
+##
+##  todo/check:
+##    allow/ignore whitespaces [ \t\n\r] in hex strings why? why not?
+##
+##  or add option with ignore e.g. ':' or such - why? why not?
+
+class String
+  ## use deprecated_hex or legacy_hex
+  ##   or ??? such? - why? why not?
+   alias_method :old_hex, :hex
+   alias_method :hexnum,  :old_hex
+
+   def hex?
+      if self.empty?
+        ## make empty string (e.g.'') a valid hex string - why? why not?
+        ##   note:  0x (prefix only) is NOT a valid hex string
+         true
+      elsif self =~ /\A(0[xX])?[0-9a-fA-F]+\z/
+        ## note:  allow 0x0 or 0xf  too or 0xfff or 0x123
+        ##            that is uneven hexstrings
+        ##                 a byte assumes always two chars
+         true
+      else
+         false
+      end
+   end
+   alias_method :is_hex?, :hex?
+
+   def to_hex
+     if self.empty?
+        ## change encoding to utf_8 - why? why not?
+        ##  always return a new string  why? why not?
+       ''  ## note: assume utf_8 encoding for new string
+     else
+        ## note: always return a hex string with default encoding e.g. utf-8 - why? why not?
+        ### check if unpack always works on bytes (or .b required???)
+        self.unpack( 'H*' ).first.force_encoding( Encoding::UTF_8 )
+     end
+   end
+   alias_method :hex, :to_hex
+end  # class String
+
+
+class NilClass
+  def hex?() false; end
+  alias_method :is_hex?, :hex?
+
+##
+#  open question -  add hex/to_hex to NilClass too (along like to_s/to_i/etc.)
+#    why? why not?
+  def to_hex
+    ''   ## note: assume utf_8 encoding for new string
+  end
+  alias_method :hex, :to_hex
+end  # class NilClass
+
+
+
+module Kernel
+  def encode_hex( bin )   ## bin_to_hex
+    ## use ArgumentError or TypeError - why? why not?
+    raise TypeError, "Value must be a string" unless bin.is_a?( String )
+    ## note: always return a hex string with default encoding e.g. utf-8 - why? why not?
+    bin.hex
+  end
+
+
+  def decode_hex( hex )
+    ## use ArgumentError or TypeError - why? why not?
+    raise TypeError, "Value must be a string" unless hex.is_a?( String )
+    ##  note: for now allow whitespaces - get auto-removed - why? why not?
+    hex = hex.gsub( /[ \t\r\n]/, '' )
+    if hex.empty?   ## special case - empty string
+      ''.b
+    else
+      raise TypeError, 'Non-hexadecimal char found' unless hex =~ /\A(0[xX])?[0-9a-fA-F]+\z/
+
+      ## allow optional starting 0x - why? why not?
+      hex = hex[2..-1]    if ['0x', '0X'].include?( hex[0,2] )
+
+      hex = '0'+hex    if hex.size.odd?
+      [hex].pack('H*')
+    end
+  end
+  alias_method :hex, :decode_hex
+
+## open question - add "global" bin_to_hex and hex_to_bin alias to - why? why not?
+
+#  alias_method :bin_to_hex, :encode_hex   ## add bin_to_hex alias - why? why not?
+#  alias_method :hex_to_bin, :decode_hex    ## add hex_to_bin alias - why? why not?
+end  # module Kernel
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: hexutils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: hexutils - hex(adecimal) encode/decode helpers 'n' more for String, NilClass,
+  Kernel and more
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/hex.rb
+- lib/hexutils.rb
+homepage: https://github.com/rubycocos/core
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: hexutils - hex(adecimal) encode/decode helpers 'n' more for String, NilClass,
+  Kernel and more
+test_files: []