bytes 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bcdcc67a741e1c05bdd45da43251f2db46efe804
-  data.tar.gz: 0ed1603a9adb971ccd2c7b382a43cb34b1274c99
+SHA256:
+  metadata.gz: a17c54ac2788c884d6e1d8605b54621fe1707cf3252bbc6c81ad062e4dda6ca2
+  data.tar.gz: 23189f40e8c5459ccd8d53a2796524d0b3b217dd13749e48f406652683b3367d
 SHA512:
-  metadata.gz: 2679e2dc3b63c14c532e869a61c79949dfc06cb0d398c1b7e8297d755d2500728df7bd716c24a7f3eeb28a3812def9b608ed71e431f4c0bf128c32ac9d25a1e4
-  data.tar.gz: ffe4c1db890f1089bee3abcd462b4ead7412644f4a4a2f6a0f80f774f95935dcac4ab9b66093344d3c8913c78969fe6f3147ff0423a14d5edd81dddc40c37182
+  metadata.gz: 6203bdf2072f6fc54b01029a1de95896bc7d5eb37690b30f0186dc5615bc87ed098fb9b2542d9e9c29e6c2571f3bb8bc1793d802851de0da4910163fa74a75c1
+  data.tar.gz: e1aa00e67da7a420a6f791a7ed7954a0c229d553b1c1b9e284968e69b860c85150409cacd79fe1e4bf3e16a1d954b6c2ed8dee6c380404f4e89841835cbd00b7

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-### 0.0.1 / 2019-04-16
-
-* Everything is new. First release
+### 0.0.1 / 2019-04-16
+
+* Everything is new. First release

data/Manifest.txt

@@ -1,9 +1,6 @@
 CHANGELOG.md
-LICENSE.md
 Manifest.txt
 README.md
 Rakefile
 lib/bytes.rb
 lib/bytes/version.rb
-test/helper.rb
-test/test_string.rb

data/README.md

@@ -1,14 +1,14 @@
-
 # Bytes
 
-bytes gem / library -
+bytes - bits 'n' bytes made easy/easier incl. new buffer helper / wrapper class to help with the string byte vs character dichotomy
 
-* home  :: [github.com/s6ruby/programming-bits-bytes](https://github.com/s6ruby/programming-bits-bytes)
-* bugs  :: [github.com/s6ruby/programming-bits-bytes/issues](https://github.com/s6ruby/programming-bits-bytes/issues)
+* 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/bytes](https://rubygems.org/gems/bytes)
 * rdoc  :: [rubydoc.info/gems/bytes](http://rubydoc.info/gems/bytes)
 
 
+
 ## Usage
 
 To be done

data/Rakefile

@@ -1,29 +1,31 @@
-require 'hoe'
-require './lib/bytes/version.rb'
-
-Hoe.spec 'bytes' do
-
-  self.version = Bytes::VERSION
-
-  self.summary = "bytes"
-  self.description = summary
-
-  self.urls    = ['https://github.com/s6ruby/programming-bits-bytes']
-
-  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.2.2'
-  }
-
-end
+require 'hoe'
+require './lib/bytes/version.rb'
+
+
+Hoe.spec 'bytes' do
+
+  self.version = Cocos::Module::Bytes::VERSION
+
+  self.summary = "bytes"
+  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.2.2'
+  }
+
+end

data/lib/bytes/version.rb

@@ -1,24 +1,25 @@
-# encoding: utf-8
-
-
-
-class Bytes
-
-  MAJOR = 0
-  MINOR = 0
-  PATCH = 1
-  VERSION = [MAJOR,MINOR,PATCH].join('.')
-
-  def self.version
-    VERSION
-  end
-
-  def self.banner
-    "bytes/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
-
-  def self.root
-    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
-  end
-
-end # class Bytes
+
+module Cocos
+module Module
+module Bytes
+
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "bytes/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+
+end # module Bytes
+end # module Module
+end # module Cocos

data/lib/bytes.rb

@@ -1,10 +1,134 @@
-# encoding: utf-8
-
-require 'pp'
-
-## our own code
-require 'bytes/version'    # note: let version always go first
-
-
-
-puts Bytes.banner    ## say hello
+require 'pp'
+require 'forwardable'
+
+
+## our own code
+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!!!!
+    raise TypeError, "BytesHelper.hex_to_bin - non-hexadecimal digit found in >#{hex}<" unless is_hex?( hex )
+
+    ## note: assume pack always returns string with BINARY/ASCII-8BIT encoding!!!
+    if ['0x', '0X'].include?( hex[0,2] )   ## cut-of leading 0x or 0X if present
+      [hex[2..-1]].pack('H*')
+    else
+      [hex].pack('H*')
+    end
+  end
+  alias_method :hex_to_bytes, :hex_to_bin
+  alias_method :h_to_b,       :hex_to_bin
+  alias_method :htob,         :hex_to_bin
+
+
+  def bin_to_hex( bin )
+    # note: unpack returns string with <Encoding:US-ASCII>
+    # convert to default encoding
+    ##  todo/fix: do NOT hardcode UTF-8 - use default encoding - why? why not?
+    hex = bin.unpack('H*').first
+    ## note: hexdigits/chars (0-9a-f) should be safe, that is, always ASCII-7BIT/UTF_8 with needing to change any char codes
+    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 :btoh,         :bin_to_hex
+
+
+ ########
+  # more helpers
+  ## check if it is a hex (string)
+  ##  - allow optiona 0x or 0X  and allow abcdef and ABCDEF
+  HEX_RE = /\A(?:0x)?[0-9a-f]*\z/i
+  def is_hex?( str )  !HEX_RE.match( str ).nil?; end
+end   # module BytesHelper
+
+
+
+
+class Bytes
+  extend BytesHelper
+  ## e.g. lets you use
+  ##       Bytes.hex_to_bin( hex )
+  ##       Bytes.bin_to_hex( bin )  etc.
+
+
+  def self.from_hex( hex ) new( hex_to_bin( hex ) );  end
+
+  ##  "semantic" constructor for wrapping (binary) strings e.g. same as Bytes.new(bin)
+  def self.wrap( bin ) new( bin );  end
+
+
+  def initialize( bin=String.new )
+    ## note: for now will NOT dup(licate) passed in binary array
+    ##    you only get a new binary array if no arg passed in e.g. Bytes.new
+    raise ArgumentError, "Bytes.new - BINARY/ASCII-8BIT encoding expected; got: #{bin.encoding} for string >#{bin}<"  if bin.encoding != Encoding::ASCII_8BIT
+    @bin = bin
+  end
+
+
+  ## add more string methods - why? why not?
+  extend Forwardable
+  def_delegators :@bin, :encoding,
+                        :size, :length
+
+
+  def to_s() Bytes.bin_to_hex( @bin ); end
+  alias_method :to_hex, :to_s
+
+  def b()  @bin; end
+
+  ## add to_a  alias for @bin.bytes() - why? why not?
+
+
+  def ==(other)
+    self.class == other.class && @bin == other.b
+  end
+
+
+
+  def self.convert( arg )
+    ## used by Bytes() in global Kernel converter method
+      if arg.is_a?( Bytes )
+        arg   ## pass-through as is
+      elsif arg.is_a?( String )
+        ## todo/fix: use coerce to_str if arg is NOT a string - why? why not
+        ##
+        if arg.encoding == Encoding::ASCII_8BIT
+          ## assume it's binary data - use as is (no hexstring conversion)
+          Bytes.wrap( arg )   ## todo/check: return str as-is (without new) - why? why not?
+        else    ## assume it's a hexstring
+          Bytes.from_hex( arg )
+        end
+      else
+       ## check for array or such e.g if arg.is_a? Array
+          ## raise TypeError - why? why not?
+         raise ArgumentError, "Bytes() expected String; got #{arg.class.name}"
+      end
+  end
+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?
+
+  ## note: built-in String#hex returns string converted
+  ##                    to Integer  -same as String.to_i(16) !!!!
+end
+
+
+
+
+module Kernel
+  def Bytes( arg )  Bytes.convert( arg ); end
+end
+
+
+
+
+
+puts Cocos::Module::Bytes.banner      ## say hello

metadata

@@ -1,67 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: bytes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2022-12-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.16'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.23'
 description: bytes
 email: wwwmake@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
-- LICENSE.md
 - Manifest.txt
 - README.md
 files:
 - CHANGELOG.md
-- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/bytes.rb
 - lib/bytes/version.rb
-- test/helper.rb
-- test/test_string.rb
-homepage: https://github.com/s6ruby/programming-bits-bytes
+homepage: https://github.com/rubycocos/core
 licenses:
 - Public Domain
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -78,9 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: bytes
 test_files: []

data/LICENSE.md

@@ -1,116 +0,0 @@
-CC0 1.0 Universal
-
-Statement of Purpose
-
-The laws of most jurisdictions throughout the world automatically confer
-exclusive Copyright and Related Rights (defined below) upon the creator and
-subsequent owner(s) (each and all, an "owner") of an original work of
-authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for the
-purpose of contributing to a commons of creative, cultural and scientific
-works ("Commons") that the public can reliably and without fear of later
-claims of infringement build upon, modify, incorporate in other works, reuse
-and redistribute as freely as possible in any form whatsoever and for any
-purposes, including without limitation commercial purposes. These owners may
-contribute to the Commons to promote the ideal of a free culture and the
-further production of creative, cultural and scientific works, or to gain
-reputation or greater distribution for their Work in part through the use and
-efforts of others.
-
-For these and/or other purposes and motivations, and without any expectation
-of additional consideration or compensation, the person associating CC0 with a
-Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
-and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
-and publicly distribute the Work under its terms, with knowledge of his or her
-Copyright and Related Rights in the Work and the meaning and intended legal
-effect of CC0 on those rights.
-
-1. Copyright and Related Rights. A Work made available under CC0 may be
-protected by copyright and related or neighboring rights ("Copyright and
-Related Rights"). Copyright and Related Rights include, but are not limited
-to, the following:
-
-  i. the right to reproduce, adapt, distribute, perform, display, communicate,
-  and translate a Work;
-
-  ii. moral rights retained by the original author(s) and/or performer(s);
-
-  iii. publicity and privacy rights pertaining to a person's image or likeness
-  depicted in a Work;
-
-  iv. rights protecting against unfair competition in regards to a Work,
-  subject to the limitations in paragraph 4(a), below;
-
-  v. rights protecting the extraction, dissemination, use and reuse of data in
-  a Work;
-
-  vi. database rights (such as those arising under Directive 96/9/EC of the
-  European Parliament and of the Council of 11 March 1996 on the legal
-  protection of databases, and under any national implementation thereof,
-  including any amended or successor version of such directive); and
-
-  vii. other similar, equivalent or corresponding rights throughout the world
-  based on applicable law or treaty, and any national implementations thereof.
-
-2. Waiver. To the greatest extent permitted by, but not in contravention of,
-applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
-unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
-and Related Rights and associated claims and causes of action, whether now
-known or unknown (including existing as well as future claims and causes of
-action), in the Work (i) in all territories worldwide, (ii) for the maximum
-duration provided by applicable law or treaty (including future time
-extensions), (iii) in any current or future medium and for any number of
-copies, and (iv) for any purpose whatsoever, including without limitation
-commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
-the Waiver for the benefit of each member of the public at large and to the
-detriment of Affirmer's heirs and successors, fully intending that such Waiver
-shall not be subject to revocation, rescission, cancellation, termination, or
-any other legal or equitable action to disrupt the quiet enjoyment of the Work
-by the public as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback. Should any part of the Waiver for any reason be
-judged legally invalid or ineffective under applicable law, then the Waiver
-shall be preserved to the maximum extent permitted taking into account
-Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
-is so judged Affirmer hereby grants to each affected person a royalty-free,
-non transferable, non sublicensable, non exclusive, irrevocable and
-unconditional license to exercise Affirmer's Copyright and Related Rights in
-the Work (i) in all territories worldwide, (ii) for the maximum duration
-provided by applicable law or treaty (including future time extensions), (iii)
-in any current or future medium and for any number of copies, and (iv) for any
-purpose whatsoever, including without limitation commercial, advertising or
-promotional purposes (the "License"). The License shall be deemed effective as
-of the date CC0 was applied by Affirmer to the Work. Should any part of the
-License for any reason be judged legally invalid or ineffective under
-applicable law, such partial invalidity or ineffectiveness shall not
-invalidate the remainder of the License, and in such case Affirmer hereby
-affirms that he or she will not (i) exercise any of his or her remaining
-Copyright and Related Rights in the Work or (ii) assert any associated claims
-and causes of action with respect to the Work, in either case contrary to
-Affirmer's express Statement of Purpose.
-
-4. Limitations and Disclaimers.
-
-  a. No trademark or patent rights held by Affirmer are waived, abandoned,
-  surrendered, licensed or otherwise affected by this document.
-
-  b. Affirmer offers the Work as-is and makes no representations or warranties
-  of any kind concerning the Work, express, implied, statutory or otherwise,
-  including without limitation warranties of title, merchantability, fitness
-  for a particular purpose, non infringement, or the absence of latent or
-  other defects, accuracy, or the present or absence of errors, whether or not
-  discoverable, all to the greatest extent permissible under applicable law.
-
-  c. Affirmer disclaims responsibility for clearing rights of other persons
-  that may apply to the Work or any use thereof, including without limitation
-  any person's Copyright and Related Rights in the Work. Further, Affirmer
-  disclaims responsibility for obtaining any necessary consents, permissions
-  or other rights required for any use of the Work.
-
-  d. Affirmer understands and acknowledges that Creative Commons is not a
-  party to this document and has no duty or obligation with respect to this
-  CC0 or use of the Work.
-
-For more information, please see
-<http://creativecommons.org/publicdomain/zero/1.0/

data/test/helper.rb

@@ -1,8 +0,0 @@
-## minitest setup
-
-require 'minitest/autorun'
-
-
-## our own code
-
-require 'bytes'

data/test/test_string.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_string.rb
-
-
-require 'helper'
-
-
-class TestString < MiniTest::Test
-
-  def test_string
-     ####
-     # note:  1) String.new gets you String with "binary" encoding
-     #        2) String Literal "" and String.new("")
-     #              gets you String with default encoding (utf-8)
-
-     assert Encoding::ASCII_8BIT == String.new.encoding
-     assert Encoding::ASCII_8BIT == String.new("".b).encoding
-     assert Encoding::ASCII_8BIT == "".b.encoding
-
-     assert Encoding::BINARY == Encoding::ASCII_8BIT
-     assert Encoding::BINARY == String.new.encoding
-     assert Encoding::BINARY == String.new("".b).encoding
-     assert Encoding::BINARY == "".b.encoding
-
-     assert Encoding::UTF_8 == "".encoding
-     assert Encoding::UTF_8 == String.new("").encoding
-  end
-
-end  # class TestString