bytemapper 1.0.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7915e2b8be3bcd3f677ed08c5a82e8fd135ab941ff9ab8b04c2148cfc7b8441
+  data.tar.gz: c44bf0499a0d15dc77728770edf55a995a12b00987e76ea651eb249c09f0d2e7
+SHA512:
+  metadata.gz: ea2aa731fde9ad3ef8f22a08d1b0abfa4de8803e7d7849af1ad1c0aebc9c865640e9e62f1ebc91293025c1b76b21cb5bd1b469d510005dead3a6723a6b4ef314
+  data.tar.gz: 9cbb50a69eea518d210ac6fb7bcaeeb9a74ff8b0e6ad3a9ade5f68988d6839c7d2464e9c276781d45fac856704de011352463c60a3b03d563ff90fec16ccf488

data/lib/bytemapper.rb

@@ -0,0 +1,69 @@
+# Bytemapper - Model arbitrary bytestrings as Ruby objects.  
+# Copyright (C) 2020 Jefferson Hudson
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+module Bytemapper
+  require 'bytemapper/registry'
+  require 'bytemapper/nameable'
+  require 'bytemapper/flattenable'
+  require 'bytemapper/chunk'
+
+  @@registry = Registry.new
+
+  def self.wrap(obj, name = nil, wrapper = {})
+    if (obj.is_a?(Array) || obj.is_a?(String) || obj.is_a?(Symbol))
+      obj = registry.get(obj, name)
+      raise ArgumentError.new "Failed to resolve symbol #{name}" if obj.nil?
+    elsif obj.is_a?(Hash)
+      obj.each do |k, v|
+        wrapper[k] = wrap(v, k)
+        wrapper.define_singleton_method(k) { self.send(:fetch, k) }
+      end
+      wrapper.extend(Flattenable)
+      obj = registry.put(wrapper, name)
+    else
+      raise ArgumentError.new "Invalid object"
+    end
+    obj
+  end
+
+  def self.map(bytes, shape, name = nil)
+    bytes.force_encoding(Encoding::ASCII_8BIT)
+    bytes = StringIO.new(bytes)
+    wrapper = self.wrap(shape, name)
+    Chunk.new(bytes, wrapper, name)
+  end
+
+  def self.registry
+    @@registry
+  end
+
+  def reset(with_basic_types = true)
+    [
+      [:uint8_t, [8,'C']],
+      [:bool, [8,'C']],
+      [:uint16_t, [16,'S']],
+      [:uint32_t, [32,'L']],
+      [:uint64_t, [64,'Q']],
+      [:int8_t, [8,'c']],
+      [:int16_t, [16,'s']],
+      [:int32_t, [32,'l']],
+      [:int64_t, [64,'q']]
+    ].each do |name, type|
+      @@registry.put(type, name)
+    end
+    @@registry
+  end
+end

data/lib/bytemapper/chunk.rb

@@ -0,0 +1,54 @@
+# Bytemapper - Model arbitrary bytestrings as Ruby objects.  
+# Copyright (C) 2020 Jefferson Hudson
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+module Bytemapper
+  class Chunk
+    attr_reader :bytes, :shape, :name
+
+    def initialize(bytes, shape, name)
+      @bytes = bytes 
+      @shape = shape
+      @name = name
+
+      shape.flatten.each do |k,v|
+        singleton_class.instance_eval { attr_reader k }
+        instance_variable_set("@#{k.to_s}", unpack(v))
+      end
+    end
+
+    def string
+      bytes.string
+    end
+
+    def ord
+      bytes.string.split(//).map(&:ord)
+    end
+
+    def chr
+      bytes.string.split(//).map(&:chr)
+    end
+
+    def size
+      @bytes.size
+    end
+
+    def unpack(value, endian = nil)
+      num_bytes, flag = value
+      _bytes = bytes.read(num_bytes >> 3)
+      _bytes.unpack("#{flag}#{endian}")[0] unless _bytes.nil?
+    end
+  end
+end

data/lib/bytemapper/flattenable.rb

@@ -0,0 +1,35 @@
+# Bytemapper - Model arbitrary bytestrings as Ruby objects.  
+# Copyright (C) 2020 Jefferson Hudson
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+module Bytemapper
+  module Flattenable
+    def flatten(flattened = {}, prefix = nil)
+      each do |k,v|
+        k = prefix.nil? ?  k : "#{prefix}_#{k}".to_sym
+        if v.is_a?(Hash)
+          v.flatten(flattened, k)
+        else
+          flattened[k] = v
+        end
+      end
+      flattened
+    end
+
+    def size
+      flatten.values.map(&:first).reduce(:+) >> 3
+    end
+  end
+end

data/lib/bytemapper/nameable.rb

@@ -0,0 +1,21 @@
+# Bytemapper - Model arbitrary bytestrings as Ruby objects.  
+# Copyright (C) 2020 Jefferson Hudson
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+module Bytemapper
+  module Nameable
+    attr_accessor :names
+    alias :name :names
+  end
+end

data/lib/bytemapper/registry.rb

@@ -0,0 +1,177 @@
+# Bytemapper - Model arbitrary bytestrings as Ruby objects.  
+# Copyright (C) 2020 Jefferson Hudson
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+module Bytemapper
+  class Registry
+    require 'bytemapper/nameable'
+
+    attr_reader :names
+    attr_reader :objects
+
+    def initialize(with_basic_types = true)
+      @objects = {}
+      @names = {}
+      register_basic_types unless with_basic_types == false
+    end
+
+    def empty?
+      @objects.size.zero? && @names.size.zero?
+    end
+
+    def flush
+      @objects = {}
+      @names = {}
+    end
+
+    def registered?(obj)
+      names.key?(obj) || objects.key?(obj.hash)
+    end
+
+    def get(obj, name = nil)
+      if (obj.is_a?(String) || obj.is_a?(Symbol))
+        name = obj
+        key = @names[obj]
+      elsif (obj.is_a?(Array) || obj.is_a?(Hash))
+        put(obj, name)
+        key = obj.hash
+      else
+        raise ArgumentError "Invalid obj"
+      end
+      @objects[key]
+    end
+
+    def put(obj, name = nil)
+      obj = register_obj(obj)
+      register_name(obj, name)
+      obj
+    end
+
+    def registered_name?(name)
+      @names.key?(name) 
+    end
+
+    def registered_obj?(obj)
+      @objects.key?(obj.hash) 
+    end
+
+    def register_obj(obj)
+      unless registered_obj?(obj)
+        obj.extend(Nameable)
+        obj.names = Set.new
+      end
+      @objects[obj.hash] ||= obj
+    end
+
+    def register_name(obj, name)
+      unless name.nil?
+        if registered_name?(name) && get(name) != obj
+          raise ArgumentError.new 'Name is already registered' 
+        else
+          name = name.to_sym
+          @names[name] ||= obj.hash
+          obj.names << name
+        end
+      end
+      obj
+    end
+
+    def print
+      puts to_s
+    end
+
+    def to_s
+      return "" if @objects.empty?
+
+      # Buffer to build up output.
+      buf = StringIO.new
+
+      # Calculate the width of each column.
+      widths = [
+        @names.keys.size.zero? ? 0 : @names.keys.map(&:size).max + 1, # add space for the `:`
+        7, # length of ID to print
+        @objects.values.map { |o| o.class.to_s.size }.max,
+        @objects.values.map { |v| v.to_s.size }.max
+      ]
+
+      # Add an extra space at the beginning and end of each column.
+      widths = widths.map { |p| p += 2 }
+
+      buf << "+"
+      # Build the header line.
+      widths.each do |w|
+        buf << "#{'-' * w}+"
+      end
+      buf << "\n"
+
+      # Build the rows of the table.
+      @objects.each do |id, obj|
+        names = @names.filter { |k,v| v == id }.keys
+        names << '' if names.empty?
+        # Create an entry for each object alias.
+        names.each do |name|
+          buf << "|"
+
+          # Fixup the id string so it pads nicely
+          idstr = id.positive? ? id.to_s[..5] : id.to_s[..6]
+          idstr = id.positive? ? "  #{idstr}" : " #{idstr}"
+
+          # Wrap each column value with whitespace.
+          values = [
+          name.empty? ? name : " :#{name} ",
+          idstr,
+          " #{obj.class.to_s} ",
+          " #{obj.to_s} "
+          ]
+          
+          # Calculate padding for each column.
+          pads = widths.zip(values).map { |a,b| a - b.size }
+
+          values.size.times do |i|
+            buf << "#{values[i]}#{' '*pads[i]}|"
+          end
+          buf << "\n"
+        end
+      end
+
+      # Build the trailing line.
+      buf << "+"
+      widths.each do |w|
+        buf << "#{'-' * w}+"
+      end
+      buf << "\n"
+      buf.string
+    end
+
+    def reset(with_basic_types = true)
+      flush
+      register_basic_types unless with_basic_types == false
+    end
+
+    private
+    def register_basic_types
+      [
+        [:uint8_t, [8,'C']],
+        [:bool, [8,'C']],
+        [:uint16_t, [16,'S']],
+        [:uint32_t, [32,'L']],
+        [:uint64_t, [64,'Q']],
+        [:int8_t, [8,'c']],
+        [:int16_t, [16,'s']],
+        [:int32_t, [32,'l']],
+        [:int64_t, [64,'q']]
+      ].each { |name, type| put(type, name) }
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: bytemapper
+version: !ruby/object:Gem::Version
+  version: 1.0.13
+platform: ruby
+authors:
+- Jefferson Hudson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-26 00:00:00.000000000 Z
+dependencies: []
+description: Model and interact with bytestrings using Ruby objects.
+email: jefferson.hudson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bytemapper.rb
+- lib/bytemapper/chunk.rb
+- lib/bytemapper/flattenable.rb
+- lib/bytemapper/nameable.rb
+- lib/bytemapper/registry.rb
+homepage: https://github.com/l4cr0ss/bytemapper
+licenses:
+- AGPL-3.0-or-later
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Map byte strings to Ruby objects
+test_files: []