memory_io 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de5ed7bf7e1f8543bbb290ed472f008ed9d8f4c1af032a11831bd904378c11e
-  data.tar.gz: e99b29afb7cdcc7941bb6249bbe453cea2cb3a6cb6eab72a8965bfa5ef9802e3
+  metadata.gz: 0f287dc7b3453557bbcda2f2ce09e03d779d0dbff69f8ef059069f03c76da427
+  data.tar.gz: a471ab55f6abd70783a220d0939cdd8f84231f59a533a6470a9f64119c184a41
 SHA512:
-  metadata.gz: d4d3d9e60c649dd8d4e6f3c3dfe3bb777d2a7ffd2065699e3f86fef27f9ddf079b90acc7d7a5be244301d45ba46d9c713b950bbaa7a113843631287fb1e9653f
-  data.tar.gz: 2246f04654d036e8df50440cf2c3d9ebe50933921f5720bf5f69308648ab34849d869b3969f581579dba8930ae1fbd0e5a1d6e27246900129cef39212e2876bf
+  metadata.gz: 959a45d2dcab5ced28be35f6988a6c6fadbd1fd6510e21747727f16e87cabddf23e951ffba71d8deec4baa1be440ce5bd79b1fe54e1bad66a17deb9185c54db9
+  data.tar.gz: a1fe1e032d09a53ce4611e2738255ac1444b5a0283e959606a1da232db28c9d0d42a7277977b17d2bb8fcfa476cc58c53368ad64fa970d0b7b91a5536e59e79e

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 david942j
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,8 @@
-[![Build Status](https://travis-ci.org/david942j/memory_io.svg?branch=master)](https://travis-ci.org/david942j/memory_io)
 [![Gem Version](https://badge.fury.io/rb/memory_io.svg)](https://badge.fury.io/rb/memory_io)
-[![Maintainability](https://api.codeclimate.com/v1/badges/dc8da34c5a8ab0095530/maintainability)](https://codeclimate.com/github/david942j/memory_io/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/dc8da34c5a8ab0095530/test_coverage)](https://codeclimate.com/github/david942j/memory_io/test_coverage)
-[![Inline docs](https://inch-ci.org/github/david942j/memory_io.svg?branch=master)](https://inch-ci.org/github/david942j/memory_io)
+[![Build Status](https://github.com/david942j/memory_io/workflows/build/badge.svg)](https://github.com/david942j/memory_io/actions)
+[![Maintainability](https://qlty.sh/gh/david942j/projects/memory_io/maintainability.svg)](https://qlty.sh/gh/david942j/projects/memory_io)
+[![Code Coverage](https://qlty.sh/gh/david942j/projects/memory_io/coverage.svg)](https://qlty.sh/gh/david942j/projects/memory_io)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/david942j/memory_io/)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
 
 # MemoryIO
@@ -14,8 +14,8 @@ Read/Write complicated structures in memory easily.
 I usually need to dump a structure, say `string` in C++, from memory for debugging.
 This is not hard if using gdb.
 However, gdb doesn't support writing Ruby scripts
-(unless you use [gdb-ruby](https://github.com/david942j/gdb-ruby), which has dependency of **MemoryIO**).
-So I create this repo and want to make the debug procedure much easier.
+(unless you use [gdb-ruby](https://github.com/david942j/gdb-ruby), which has **MemoryIO** as its dependency).
+So I created this projected to make the debug procedure much easier.
 
 This repository has two main goals:
 
@@ -25,16 +25,14 @@ This repository has two main goals:
 ## Why
 
 It's not hard to read/write a process's memory (simply open the file `/proc/$PID/mem`),
-but it still worth to wrap it.
+but it's still worthy to make a utility.
 
-This repo also targets to collect all common structures, such as how to parse a C++/Rust/Python object from memory.
+This project also targets to collect all common structures, such as how to parse a C++/Rust/Python object from memory.
 Therefore, **Pull Requests of adding new structures** are welcome :D
 
 ## Supported Platform
 
 - Linux
-- (TODO) Windows
-- (TODO) MacOS
 
 ## Implemented Structures
 
@@ -122,7 +120,7 @@ string
 require 'memory_io'
 process = MemoryIO.attach(`pidof victim`.to_i)
 
-# An example that read a chunk of pt-malloc.
+# An example that reads a chunk of pt-malloc.
 read_chunk = lambda do |stream|
   _prev_size = stream.read(8)
   size = (stream.read(8).unpack('Q').first & -16) - 8

data/lib/memory_io/io.rb

@@ -183,7 +183,7 @@ module MemoryIO
     # @api private
     def to_proc(as, rw)
       ret = as.respond_to?(rw) ? as.method(rw) : as
-      ret = ret.respond_to?(:call) ? ret : MemoryIO::Types.get_proc(ret, rw)
+      ret = MemoryIO::Types.get_proc(ret, rw) unless ret.respond_to?(:call)
       raise ArgumentError, <<-EOERR.strip unless ret.respond_to?(:call)
 
 Invalid argument `as`: #{as.inspect}. It should be either a Proc or a supported type of MemoryIO::Types.

data/lib/memory_io/process.rb

@@ -16,11 +16,6 @@ module MemoryIO
     #
     # @note
     #   This class only supports procfs-based system. i.e. /proc is mounted and readable.
-    #
-    # @todo
-    #   Support MacOS
-    # @todo
-    #   Support Windows
     def initialize(pid)
       @pid = pid
       @mem = "/proc/#{pid}/mem"

data/lib/memory_io/types/basic/number.rb

@@ -37,8 +37,8 @@ module MemoryIO
         private
 
         def unpack(str)
-          val = str.unpack(@pack_str).first
-          val -= (2**(@bytes * 8)) if @signed && val >= (2**(@bytes * 8 - 1))
+          val = str.unpack1(@pack_str)
+          val -= (2**(@bytes * 8)) if @signed && val >= (2**((@bytes * 8) - 1))
           val
         end
 

data/lib/memory_io/types/cpp/string.rb

@@ -22,9 +22,7 @@ module MemoryIO
         # std::string uses inlined-buffer if string length isn't larger than {LOCAL_CAPACITY}.
         LOCAL_CAPACITY = 15
 
-        attr_reader :data # @return [::String]
-        attr_reader :capacity # @return [Integer]
-        attr_reader :dataplus # @return [Integer]
+        attr_reader :data, :capacity, :dataplus # @return [::String] # @return [Integer] # @return [Integer]
 
         # Instantiate a {CPP::String} object.
         #
@@ -33,6 +31,7 @@ module MemoryIO
         # @param [Integer] dataplus
         #   A pointer.
         def initialize(data, capacity, dataplus)
+          super()
           @data = data
           @capacity = capacity
           @dataplus = dataplus
@@ -57,15 +56,14 @@ module MemoryIO
         # Custom inspect view.
         #
         # @return [String]
-        #
-        # @todo
-        #   Let it be colorful in pry.
         def inspect
+          # rubocop:disable Lint/FormatParameterMismatch
           format("#<%s @data=%s, @capacity=%d, @dataplus=0x%0#{SIZE_T * 2}x>",
                  self.class.name,
                  data.inspect,
                  capacity,
                  dataplus)
+          # rubocop:enable Lint/FormatParameterMismatch
         end
 
         class << self
@@ -109,10 +107,10 @@ module MemoryIO
             write_size_t(stream, obj.length)
             pos = stream.pos
             if obj.length > LOCAL_CAPACITY
-              keep_pos(stream, pos: obj.dataplus) { |s| s.write(obj.data + "\x00") }
+              keep_pos(stream, pos: obj.dataplus) { |s| s.write("#{obj.data}\u0000") }
               write_size_t(stream, obj.capacity)
             else
-              stream.write(obj.data + "\x00")
+              stream.write("#{obj.data}\u0000")
             end
             stream.pos = pos + LOCAL_CAPACITY + 1
           end

data/lib/memory_io/types/record.rb

@@ -23,8 +23,8 @@ module MemoryIO
       # @option [Thread::Backtrace::Location] caller
       #   This option should present if and only if +object+ is a subclass of {Types::Type}.
       # @option [String] doc
-      #   Docstring.
-      #   Automatically parse from caller location if this parameter isn't present.
+      #   Doc-string.
+      #   Automatically parse from caller location if this parameter doesn't present.
       def initialize(object, keys, option = {})
         @obj = object
         @keys = keys
@@ -60,14 +60,14 @@ module MemoryIO
           str.strip!
           break unless str.start_with?('#')
 
-          strings.unshift(str[2..-1] || '')
+          strings.unshift(str[2..] || '')
         end
         trim_docstring(strings)
       end
 
       def trim_docstring(strings)
         strings = strings.drop_while { |s| s.start_with?('@') }.take_while { |s| !s.start_with?('@') }
-        strings.drop_while(&:empty?).reverse.drop_while(&:empty?).reverse.join("\n") + "\n"
+        "#{strings.drop_while(&:empty?).reverse.drop_while(&:empty?).reverse.join("\n")}\n"
       end
     end
   end

data/lib/memory_io/types/type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 require 'memory_io/types/record'
 require 'memory_io/util'
 
@@ -123,7 +121,7 @@ module MemoryIO
         #
         # @see .find
         def register(object, option = {})
-          @map ||= OpenStruct.new
+          @map ||= {}
           aliases = Array(option[:alias])
           reg_fail = ArgumentError.new(<<-EOS.strip)
 Register '#{object.inspect}' fails because another object with same name has been registered.
@@ -152,6 +150,7 @@ Specify an alias such as `register(MyClass, alias: :custom_alias_name)`.
         #
         # To record descendants.
         def inherited(klass)
+          super
           register(klass, caller: caller_locations(1, 1).first)
         end
 

data/lib/memory_io/types/types.rb

@@ -3,7 +3,7 @@
 require 'memory_io/types/type'
 require 'memory_io/util'
 
-Dir.glob(File.join(__dir__, '**', '*.rb')).sort.each { |f| require f unless f == __FILE__ }
+Dir.glob(File.join(__dir__, '**', '*.rb')).each { |f| require f unless f == __FILE__ }
 
 module MemoryIO
   # Module that includes multiple types.
@@ -33,7 +33,7 @@ module MemoryIO
     #   #=> #<MemoryIO::Types::Number:0x000055ecc017a310 @bytes=8, @pack_str="Q", @signed=false>
     def find(name)
       obj = Types::Type.find(name)
-      return obj.obj if obj
+      obj&.obj
     end
 
     # @api private

data/lib/memory_io/util.rb

@@ -1,11 +1,35 @@
 # frozen_string_literal: true
 
-require 'ostruct'
 require 'dentaku'
 
 module MemoryIO
   # Defines utility methods.
   module Util
+    # A simple class to be returned for getting file permissions.
+    class FilePermission
+      attr_reader :readable, :writable
+      # Alias the two methods to fit Ruby's method naming convention.
+      alias readable? readable
+      alias writable? writable
+
+      def initialize(file)
+        stat = File.stat(file)
+        @readable = stat.readable_real?
+        @writable = stat.writable_real?
+        # we do a trick here because /proc/[pid]/mem might be marked as writeable but fails at sysopen.
+        begin
+          @readable && File.open(file, 'rb').close
+        rescue Errno::EACCES
+          @readable = false
+        end
+        begin
+          @writable && File.open(file, 'wb').close
+        rescue Errno::EACCES
+          @writable = false
+        end
+      end
+    end
+
     module_function
 
     # Convert input into snake-case.
@@ -39,26 +63,12 @@ module MemoryIO
     # @param [String] file
     #   File name.
     #
-    # @return [#readable?, #writable?, nil]
-    #   Struct with two boolean method.
-    #   +nil+ for file not exists or is inaccessible.
+    # @return [MemoryIO::Util::FilePermission?]
+    #   +nil+ is returned if file does not exist or is inaccessible.
     def file_permission(file)
       return nil unless File.file?(file)
 
-      stat = File.stat(file)
-      # we do a trick here because /proc/[pid]/mem might be marked as readable but fails at sysopen.
-      os = OpenStruct.new(readable?: stat.readable_real?, writable?: stat.writable_real?)
-      begin
-        os.readable? && File.open(file, 'rb').close
-      rescue Errno::EACCES
-        os[:readable?] = false
-      end
-      begin
-        os.writable? && File.open(file, 'wb').close
-      rescue Errno::EACCES
-        os[:writable?] = false
-      end
-      os
+      FilePermission.new(file)
     end
 
     # Evaluate string safely.
@@ -97,7 +107,7 @@ module MemoryIO
     #   Util.unpack("@\xE2\x01\x00")
     #   #=> 123456
     def unpack(str)
-      str.bytes.reverse.reduce(0) { |s, c| s * 256 + c }
+      str.bytes.reverse.reduce(0) { |s, c| (s * 256) + c }
     end
 
     # Pack an integer into +b+ bytes.
@@ -135,9 +145,13 @@ module MemoryIO
     #   #=> 'libcrypto'
     #   Util.trim_libname('not_a_so')
     #   #=> 'not_a_so'
+    #   Util.trim_libname('ld-linux-x86-64.so.2')
+    #   #=> 'ld'
     def trim_libname(name)
+      return 'ld' if name.start_with?('ld-')
+
       type1 = '(-[\d.]+)?\.so$'
-      type2 = '\.so.\d+[\d.]+$'
+      type2 = '\.so.[\.\d]+$'
       name.sub(/#{type1}|#{type2}/, '')
     end
   end

data/lib/memory_io/version.rb

@@ -2,5 +2,5 @@
 
 module MemoryIO
   # Current gem version.
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,29 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: memory_io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - david942j
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 2025-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dentaku
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: '3'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +71,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -96,13 +109,14 @@ dependencies:
         version: '0.9'
 description: 'Read/Write complicated structures in memory easily.
 
-'
+  '
 email:
 - david942j@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/memory_io.rb
 - lib/memory_io/io.rb
@@ -118,8 +132,8 @@ files:
 homepage: https://github.com/david942j/memory_io
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -127,15 +141,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: memory_io
 test_files: []