bin_struct 0.1.0

data/lib/bin_struct/string.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# This file is part of BinStruct
+# see https://github.com/lemontree55/bin_struct for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
+# This program is published under MIT license.
+
+require 'forwardable'
+
+module BinStruct
+  # This class mimics regular String, but it is {Fieldable}.
+  # @author Sylvain Daubert
+  # @since 3.1.6 no more a subclass or regular String
+  class String
+    extend Forwardable
+    include Fieldable
+    include LengthFrom
+
+    def_delegators :@string, :[], :to_s, :length, :size, :inspect, :==,
+                   :unpack, :force_encoding, :encoding, :index, :empty?,
+                   :encode, :slice, :slice!, :[]=
+
+    # @return [::String]
+    attr_reader :string
+    # @return [Integer]
+    attr_reader :static_length
+
+    # @param [Hash] options
+    # @option options [Types::Int,Proc] :length_from object or proc from which
+    #   takes length when reading
+    # @option options [Integer] :static_length set a static length for this string
+    def initialize(options = {})
+      register_internal_string(+'')
+      initialize_length_from(options)
+      @static_length = options[:static_length]
+    end
+
+    def initialize_copy(_orig)
+      @string = @string.dup
+    end
+
+    # @param [::String] str
+    # @return [String] self
+    def read(str)
+      s = read_with_length_from(str)
+      register_internal_string s
+      self
+    end
+
+    alias old_sz_to_read sz_to_read
+    private :old_sz_to_read
+
+    # Size to read.
+    # Computed from static_length or length_from, if defined.
+    # @return [Integer]
+    # @since 3.1.6
+    def sz_to_read
+      return static_length if static_length?
+
+      old_sz_to_read
+    end
+
+    # Say if a static length is defined
+    # @return [Boolean]
+    # @since 3.1.6
+    def static_length?
+      !static_length.nil?
+    end
+
+    def format_inspect
+      inspect
+    end
+
+    # Append the given string to String
+    # @param [#to_s] str
+    # @return [self]
+    def <<(str)
+      @string << str.to_s
+      self
+    end
+
+    alias sz length
+    alias to_human to_s
+    alias from_human read
+
+    private
+
+    def register_internal_string(str)
+      @string = str
+      BinStruct.force_binary(@string)
+    end
+  end
+end

data/lib/bin_struct/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# This file is part of BinStruct
+# see https://github.com/lemontree55/bin_struct for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
+# This program is published under MIT license.
+
+module BinStruct
+  VERSION = '0.1.0'
+end

data/lib/bin_struct.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# This file is part of BinStruct
+# see https://github.com/lemontree55/bin_struct for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
+# This program is published under MIT license.
+
+require_relative 'bin_struct/version'
+
+# BinStruct module
+# @author LemonTree55
+module BinStruct
+  # BinStruct error class
+  class Error < StandardError; end
+
+  # Force binary encoding for +str+
+  # @param [String] str
+  # @return [String] binary encoded string
+  def self.force_binary(str)
+    str.dup.force_encoding(Encoding::BINARY)
+  end
+end
+
+require_relative 'bin_struct/fieldable'
+require_relative 'bin_struct/int'
+require_relative 'bin_struct/enum'
+require_relative 'bin_struct/fields'
+require_relative 'bin_struct/length_from'
+require_relative 'bin_struct/abstract_tlv'
+require_relative 'bin_struct/array'
+require_relative 'bin_struct/string'
+require_relative 'bin_struct/cstring'
+require_relative 'bin_struct/int_string'
+require_relative 'bin_struct/oui'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: bin_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- LemonTree55
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-16 00:00:00.000000000 Z
+dependencies: []
+description: 'BinStruct is a binary dissector and generator. It eases manipulating
+  complex binary data.
+
+  '
+email:
+- lenontree@proton.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- README.md
+- lib/bin_struct.rb
+- lib/bin_struct/abstract_tlv.rb
+- lib/bin_struct/array.rb
+- lib/bin_struct/cstring.rb
+- lib/bin_struct/enum.rb
+- lib/bin_struct/fieldable.rb
+- lib/bin_struct/fields.rb
+- lib/bin_struct/int.rb
+- lib/bin_struct/int_string.rb
+- lib/bin_struct/length_from.rb
+- lib/bin_struct/oui.rb
+- lib/bin_struct/string.rb
+- lib/bin_struct/version.rb
+homepage: https://github.com/lemontree55/bin_struct
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lemontree55/bin_struct
+  source_code_uri: https://github.com/lemontree55/bin_struct
+  bug_tracker_uri: https://github.com/lemontree55/bin_struct/issues
+post_install_message:
+rdoc_options:
+- "--title"
+- BinStruct
+- "--main"
+- README.md
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Binary dissector and generator
+test_files: []