memory_io 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e17e1f92566207d70c15b219aee13f363351c8e6
-  data.tar.gz: 6de663775256debf502563107010d6c058a9476c
+SHA256:
+  metadata.gz: 3de5ed7bf7e1f8543bbb290ed472f008ed9d8f4c1af032a11831bd904378c11e
+  data.tar.gz: e99b29afb7cdcc7941bb6249bbe453cea2cb3a6cb6eab72a8965bfa5ef9802e3
 SHA512:
-  metadata.gz: 0c5cc2882d17b308bcd2edd3bd298dc063555635e232f489c20cf378811272839dcce6fead1dd22605d6b77795acb3e08623e74d1650fadaa0ef62229083e8db
-  data.tar.gz: 937ba157cbf68e9e207aacefe2b00bcc1153cd128e41ec1fff1be1d00d3715c3ed6258d7e4eb5d3c0cab40fc2d486a0158f23ad73d8b98c12d4fff76408e7c6c
+  metadata.gz: d4d3d9e60c649dd8d4e6f3c3dfe3bb777d2a7ffd2065699e3f86fef27f9ddf079b90acc7d7a5be244301d45ba46d9c713b950bbaa7a113843631287fb1e9653f
+  data.tar.gz: 2246f04654d036e8df50440cf2c3d9ebe50933921f5720bf5f69308648ab34849d869b3969f581579dba8930ae1fbd0e5a1d6e27246900129cef39212e2876bf

data/README.md

@@ -17,9 +17,9 @@ 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.
 
-This repo has two main targets:
+This repository has two main goals:
 
-1. To communiate with memory easily.
+1. To communicate with memory easily.
 2. To collect all common structures for debugging/learning.
 
 ## Why
@@ -51,7 +51,7 @@ process.read(0x601000, 1, as: 'basic/u64')
 process.read(0x601000, 1, as: :u64)
 ```
 
-Goto [the online document](http://www.rubydoc.info/github/david942j/memory_io/master/MemoryIO/Types) for more details
+Go to [the online document](http://www.rubydoc.info/github/david942j/memory_io/master/MemoryIO/Types) for more details
 of each type.
 
 ### BASIC

data/lib/memory_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # MemoryIO - Read/Write structures in memory.
 #
 # @author david942j

data/lib/memory_io/io.rb

@@ -1,4 +1,5 @@
 # encoding: ascii-8bit
+# frozen_string_literal: true
 
 require 'memory_io/types/types'
 
@@ -11,14 +12,14 @@ module MemoryIO
     #
     # @param [#pos, #pos=, #read, #write] stream
     #   The file-like object to be read/written.
-    #   +file+ can be unwritable if you will not invoke any write-related method.
+    #   +file+ can be un-writable if you will not invoke any write-related method.
     #
     #   If +stream.read(*)+ returns empty string or +nil+, it would be seen as reaching EOF.
     def initialize(stream)
       @stream = stream
     end
 
-    # Read and convert result into custom type/stucture.
+    # Read and convert result into custom type/structure.
     #
     # @param [Integer] num_elements
     #   Number of elements to be read.
@@ -43,7 +44,7 @@ module MemoryIO
     #
     # @return [String, Object, Array<Object>]
     #   There're multiple possible return types,
-    #   which dependes on the value of parameter +num_elements+, +as+, and +force_array+.
+    #   which depends on the value of parameter +num_elements+, +as+, and +force_array+.
     #
     #   See examples for clear usage. The rule of return type is listed as following:
     #
@@ -102,6 +103,7 @@ module MemoryIO
     def read(num_elements, from: nil, as: nil, force_array: false)
       stream.pos = from if from
       return stream.read(num_elements) if as.nil?
+
       conv = to_proc(as, :read)
       # TODO: handle eof
       ret = Array.new(num_elements) { conv.call(stream) }
@@ -123,7 +125,7 @@ module MemoryIO
     #
     #   A +Proc+ is allowed, which should accept +stream+ and one object as arguments.
     #
-    #   If +objects+ is a descendent instance of {Types::Type} and +as+ is +nil,
+    #   If +objects+ is a descendant instance of {Types::Type} and +as+ is +nil,
     #   +objects.class+ will be used for +as+.
     #   Otherwise, when +as = nil+, this method will simply call +stream.write(objects)+.
     #
@@ -163,6 +165,7 @@ module MemoryIO
       stream.pos = from if from
       as ||= objects.class if objects.class.ancestors.include?(MemoryIO::Types::Type)
       return stream.write(objects) if as.nil?
+
       conv = to_proc(as, :write)
       Array(objects).map { |o| conv.call(stream, o) }
     end
@@ -182,8 +185,10 @@ module MemoryIO
       ret = as.respond_to?(rw) ? as.method(rw) : as
       ret = ret.respond_to?(:call) ? ret : MemoryIO::Types.get_proc(ret, rw)
       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.
       EOERR
+
       ret
     end
   end

data/lib/memory_io/process.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryIO
   # Records information of a process.
   class Process
@@ -26,6 +28,7 @@ module MemoryIO
       @perm = MemoryIO::Util.file_permission(@mem)
       # TODO: raise custom exception
       raise Errno::ENOENT, @mem if perm.nil?
+
       # FIXME: use logger
       warn(<<-EOS.strip) unless perm.readable? || perm.writable?
 You have no permission to read/write this process.
@@ -59,11 +62,13 @@ $ echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
     def bases
       file = "/proc/#{@pid}/maps"
       stat = MemoryIO::Util.file_permission(file)
-      return {} unless stat && stat.readable?
+      return {} unless stat&.readable?
+
       maps = ::IO.binread(file).split("\n").map do |line|
         # 7f76515cf000-7f76515da000 r-xp 00000000 fd:01 29360257  /lib/x86_64-linux-gnu/libnss_files-2.24.so
         addr, _perm, _offset, _dev, _inode, pathname = line.strip.split(' ', 6)
         next nil if pathname.nil?
+
         addr = addr.to_i(16)
         pathname = pathname[1..-2] if pathname =~ /^\[.+\]$/
         pathname = ::File.basename(pathname)
@@ -104,7 +109,7 @@ $ echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
     #   #=> "\x7fELF"
     # @see IO#read
     def read(addr, num_elements, **options)
-      mem_io(:read) { |io| io.read(num_elements, from: MemoryIO::Util.safe_eval(addr, bases), **options) }
+      mem_io(:read) { |io| io.read(num_elements, from: MemoryIO::Util.safe_eval(addr, **bases), **options) }
     end
 
     # Write objects at +addr+.
@@ -128,7 +133,7 @@ $ echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
     #   #=> 'BBBBCCCCAAAAAAAA'
     # @see IO#write
     def write(addr, objects, **options)
-      mem_io(:write) { |io| io.write(objects, from: MemoryIO::Util.safe_eval(addr, bases), **options) }
+      mem_io(:write) { |io| io.write(objects, from: MemoryIO::Util.safe_eval(addr, **bases), **options) }
     end
 
     private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'memory_io/types/type'
 
 module MemoryIO
@@ -6,7 +8,7 @@ module MemoryIO
     module Basic
       # Register numbers to {Types}.
       #
-      # All types registerd by this class are assumed as *little endian*.
+      # All types registered by this class are assumed as *little endian*.
       #
       # This class registered (un)signed {8, 16, 32, 64)-bit integers and IEEE-754 floating numbers.
       class Number

data/lib/memory_io/types/clang/c_str.rb

@@ -1,4 +1,5 @@
 # encoding: ascii-8bit
+# frozen_string_literal: true
 
 require 'memory_io/types/type'
 
@@ -10,15 +11,17 @@ module MemoryIO
     module Clang
       # A null-terminated string.
       class CStr < Types::Type
+
         # @api private
         #
         # @return [String]
         #   String without null byte.
         def self.read(stream)
-          ret = ''
+          ret = +''
           loop do
             c = stream.read(1)
             break if c.nil? || c == '' || c == "\x00"
+
             ret << c
           end
           ret
@@ -30,7 +33,7 @@ module MemoryIO
         #   A null byte would be appended if +val+ not ends with null byte.
         def self.write(stream, val)
           val = val.to_s
-          val << "\x00" unless val.end_with?("\x00")
+          val += "\x00" unless val.end_with?("\x00")
           stream.write(val)
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'memory_io/types/type'
 
 module MemoryIO
@@ -16,6 +18,7 @@ module MemoryIO
       #     }
       #   };
       class String < MemoryIO::Types::Type
+
         # std::string uses inlined-buffer if string length isn't larger than {LOCAL_CAPACITY}.
         LOCAL_CAPACITY = 15
 

data/lib/memory_io/types/record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryIO
   module Types
     # @api private
@@ -39,6 +41,7 @@ module MemoryIO
       def doc
         return @force_doc if @force_doc
         return '' unless @caller
+
         parse_file_doc(@caller.absolute_path, @caller.lineno)
       end
 
@@ -47,13 +50,16 @@ module MemoryIO
       # @return [String]
       def parse_file_doc(file, lineno)
         return '' unless ::File.file?(file)
+
         strings = []
         lines = ::IO.binread(file).split("\n")
         (lineno - 1).downto(1) do |no|
           str = lines[no - 1]
           break if str.nil?
+
           str.strip!
           break unless str.start_with?('#')
+
           strings.unshift(str[2..-1] || '')
         end
         trim_docstring(strings)

data/lib/memory_io/types/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 require 'memory_io/types/record'
@@ -5,7 +7,7 @@ require 'memory_io/util'
 
 module MemoryIO
   module Types
-    # The base class, all descendents of this class would be consider as a valid 'type'.
+    # The base class, all descendants of this class would be consider as a valid 'type'.
     class Type
       # The size of +size_t+. i.e. +sizeof(size_t)+.
       SIZE_T = 8
@@ -92,7 +94,7 @@ module MemoryIO
         # Register a new type.
         #
         # @param [#read, #write] object
-        #   Normally, +object+ is a descendent class of {Type}.
+        #   Normally, +object+ is a descendant class of {Type}.
         #
         # @option [Symbol, Array<Symbol>] alias
         #   Custom symbol name(s) that can be used in {.find}.
@@ -128,8 +130,10 @@ Register '#{object.inspect}' fails because another object with same name has bee
 Specify an alias such as `register(MyClass, alias: :custom_alias_name)`.
           EOS
           raise reg_fail if aliases.any? && aliases.all? { |ali| @map[ali] }
+
           keys = get_keys(object).concat(aliases).uniq.reject { |k| @map[k] }
           raise reg_fail if keys.empty?
+
           rec = MemoryIO::Types::Record.new(object, keys, option)
           keys.each { |k| @map[k] = rec }
         end
@@ -156,6 +160,7 @@ Specify an alias such as `register(MyClass, alias: :custom_alias_name)`.
         # @return [Array<Symbol>]
         def get_keys(klass)
           return [] unless klass.instance_of?(Class)
+
           snake = MemoryIO::Util.underscore(klass.name)
           snake.gsub!(%r[^memory_io/types/], '')
           ret = [snake]

data/lib/memory_io/types/types.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'memory_io/types/type'
 require 'memory_io/util'
 
-Dir[File.join(__dir__, '**', '*.rb')].each { |f| require f }
+Dir.glob(File.join(__dir__, '**', '*.rb')).sort.each { |f| require f unless f == __FILE__ }
 
 module MemoryIO
   # Module that includes multiple types.
@@ -53,7 +55,7 @@ module MemoryIO
     #   #=> #<Method: MemoryIO::Types::Number#read>
     def get_proc(name, rw)
       klass = find(name)
-      klass && klass.method(rw)
+      klass&.method(rw)
     end
   end
 end

data/lib/memory_io/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 require 'dentaku'
 
@@ -24,6 +26,7 @@ module MemoryIO
     #   #=> 'my_module/my_class'
     def underscore(str)
       return '' if str.empty?
+
       str = str.gsub('::', '/')
       str.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
       str.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
@@ -41,6 +44,7 @@ module MemoryIO
     #   +nil+ for file not exists 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?)
@@ -72,6 +76,7 @@ module MemoryIO
     #   #=> 56960 # 0xde80
     def safe_eval(str, **vars)
       return str if str.is_a?(Integer)
+
       # dentaku 2 doesn't support hex
       str = str.gsub(/0x[0-9a-zA-Z]+/) { |c| c.to_i(16) }
       Dentaku::Calculator.new.store(vars).evaluate(str)

data/lib/memory_io/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module MemoryIO
   # Current gem version.
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_io
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - david942j
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2020-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dentaku
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.59'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: ''
+description: 'Read/Write complicated structures in memory easily.
+
+'
 email:
 - david942j@gmail.com
 executables: []
@@ -125,15 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: memory_io