up bytes

Author: geraldb

README.md

@@ -2,6 +2,7 @@
 
 Gems:
 
+- [**bytes**](bytes) - bits 'n' bytes made easy/easier incl. new buffer helper / wrapper class to help with the string byte vs character dichotomy
 - [**enums**](enums) - safe enum / enumeration types - a set of symbolic keys bound to unique integer numbers (incl. bit flags option)
 
 <!-- break -->

bytes/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

bytes/CHANGELOG.md

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

bytes/Manifest.txt

@@ -0,0 +1,11 @@
+CHANGELOG.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+lib/bytes.rb
+lib/bytes/version.rb
+test/helper.rb
+test/test_bytes.rb
+test/test_hash.rb
+test/test_string.rb

bytes/README.md

@@ -0,0 +1,29 @@
+
+# Bytes
+
+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/typesigs/bytes](https://github.com/typesigs/bytes)
+* bugs :: [github.com/typesigs/bytes/issues](https://github.com/typesigs/bytes/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
+
+
+## License
+
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+The `bytes` 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!

bytes/Rakefile

@@ -0,0 +1,29 @@
+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/typesigs/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

bytes/lib/bytes.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+require 'pp'
+require 'digest'
+
+
+## our own code
+require 'bytes/version' # note: let version always go first
+
+
+class Bytes
+ def self.new( *args )
+ String.new( *args ).b
+ end
+
+ def self.from_hex( hexstr )
+ if ['0x', '0X'].include?( hexstr[0...2] )
+ [hexstr[2..-1]].pack('H*') ## cut-of leading 0x or 0X if present
+ else
+ [hexstr].pack('H*')
+ end
+ end
+
+ def self.to_hex( str )
+ # note: unpack returns string with <Encoding:US-ASCII>
+ # conver to default encoding
+ ## todo/fix: do NOT hardcode UTF-8 - use default encoding - how?
+ str.unpack('H*').first.encode("UTF-8")
+ end
+
+ def self.convert( *args )
+ ## used by Bytes() in global Kernel converter method
+ if args.size == 1
+ if args[0].is_a? Array
+ ## assume array of bytes
+ ## to be done
+ else ## assume String
+ ## todo/fix: use coerce to_str if arg is NOT a string - why? why not?
+ str = args[0]
+ ##
+ if str.encoding == Encoding::ASCII_8BIT
+ ## assume it's binary data - use as is (no hexstring conversion)
+ new( str ) ## todo/check: return str as-is (without new) - why? why not?
+ else ## assume it's a hexstring
+ from_hex( str )
+ end
+ end
+ else
+ ## todo/fix: throw argument error
+ end
+ end
+end
+
+
+class Buffer
+ def self.new( *args )
+ if args.size == 0
+ ## note: use "" to always use default encoding (and NOT binary)
+ String.new( "" )
+ else
+ String.new( *args )
+ end
+ end
+end
+
+
+module BytesHelper
+ def hex_to_bytes( hexstr ) Bytes.from_hex( hexstr); end
+ alias_method :h_to_b, :hex_to_bytes
+ alias_method :htob, :hex_to_bytes
+
+ def bytes_to_hex( str ) Bytes.to_hex( str ); end
+ alias_method :b_to_h, :bytes_to_hex
+ alias_method :btoh, :bytes_to_hex
+end
+
+
+
+class String
+ def h_to_b() Bytes.from_hex( self ); end
+ alias_method :htob, :h_to_b
+
+ def b_to_h() Bytes.to_hex( self ); end ## add .b-like shortcut
+ alias_method :btoh, :b_to_h
+ alias_method :h, :b_to_h
+end
+
+
+module HashHelper
+ def sha256( bytes )
+ ## todo/fix: check bytes.encoding - warn if not BINARY!!!!
+ Digest::SHA256.digest( bytes )
+ end
+
+ def ripemd160( bytes )
+ ## todo/fix: check bytes.encoding - warn if not BINARY!!!!
+ Digest::RMD160.digest( bytes )
+ end
+
+ def hash256( bytes )
+ ## double - uses sha256(sha256())
+ sha256(sha256( bytes ))
+ end
+
+ def hash160( bytes )
+ ## double - uses ripemd160(sha256())
+ ripemd160(sha256( bytes ))
+ end
+
+ ## convenience shortcut helpers
+ def sha256hex( bytes ) Bytes.to_hex(sha256( bytes )); end
+ def ripemd160hex( bytes ) Bytes.to_hex(ripemd160( bytes )); end
+ def hash256( bytes ) Bytes.to_hex(hash256( bytes )); end
+ def hash160( bytes ) Bytes.to_hex(hash160( bytes )); end
+end
+
+## make "global" for now - check if there's a better way (include in Kernel) - why? why ot?
+include HashHelper
+include BytesHelper
+
+
+
+module Kernel
+ def Bytes( *args ) Bytes.convert( *args ); end
+end
+
+puts Bytes.banner ## say hello

bytes/lib/bytes/version.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+
+
+class Bytes
+
+ MAJOR = 0
+ MINOR = 1
+ PATCH = 0
+ 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

bytes/test/helper.rb

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

bytes/test/test_bytes.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+###
+# to run use
+# ruby -I ./lib -I ./test test/test_bytes.rb
+
+
+require 'helper'
+
+
+class TestBytes < MiniTest::Test
+
+ def test_hex
+ assert String.new( "6162") == Bytes.to_hex( "ab" )
+ assert String.new( "6162") == bytes_to_hex( "ab" )
+ assert String.new( "6162") == "ab".b_to_h
+ assert String.new( "6162") == "ab".btoh
+ assert String.new( "6162") == "ab".h
+ assert String.new( "6162") == Bytes.to_hex( "\x61\x62" )
+ assert String.new( "6162") == bytes_to_hex( "\x61\x62" )
+ assert String.new( "6162") == "\x61\x62".b_to_h
+ assert String.new( "6162") == "\x61\x62".btoh
+ assert String.new( "6162") == "\x61\x62".h
+ assert Encoding::UTF_8 == Bytes.to_hex( "ab" ).encoding
+
+ assert Bytes.new( "ab" ) == Bytes.from_hex( "6162" )
+ assert Bytes.new( "ab" ) == hex_to_bytes( "6162" )
+ assert Bytes.new( "ab" ) == "6162".h_to_b
+ assert Bytes.new( "ab" ) == "6162".htob
+ assert Bytes.new( "ab" ) == Bytes.from_hex( "0x6162" )
+ assert Bytes.new( "ab" ) == hex_to_bytes( "0x6162" )
+ assert Bytes.new( "ab" ) == "0x6162".h_to_b
+ assert Bytes.new( "ab" ) == "0x6162".htob
+ assert Encoding::ASCII_8BIT == Bytes.from_hex( "6162" ).encoding
+
+ assert Bytes.new( "ab" ) == Bytes( "6162" )
+ assert Bytes.new( "ab" ) == Bytes( "0x6162" )
+ assert Bytes.new( "6162" ) == Bytes( "6162".b )
+ assert Bytes.new( "ab" ) == Bytes( "ab".b )
+ assert Bytes.new( "ab") == Bytes( "\x61\x62".b )
+ assert Encoding::ASCII_8BIT == Bytes( "6162" ).encoding
+ assert Encoding::ASCII_8BIT == Bytes( "6162".b ).encoding
+ assert Encoding::ASCII_8BIT == Bytes( "ab".b ).encoding
+ end
+
+end # class TestBytes