ruby-macho 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 634d3249001bb3d3bf5782055392c8feea3d15c8
-  data.tar.gz: bd854ada089451f23d4b253642bbb3eebcbba25f
+  metadata.gz: 18e0719447412b4c6fea5f4ca08f5f0e316e34c1
+  data.tar.gz: e42a6a11cc91a374693cd13d6d5ff8b07d5dec9c
 SHA512:
-  metadata.gz: 06436af8d8c711a2eaa40f396020a80e15ff8f8de474e162f7f3e41d7b1a984d1218bec862d54f18bb9fe20675908ea8dfe1bcdd08b3d4bd50c8d0405daf06a5
-  data.tar.gz: cc4846d66dc58873417d1baae77c95c7ee4678f5861e98211cb52c4a6363280490473261de8b0143080a7aae71b97e20c0d85b6e0dac5647f106918a3de68c85
+  metadata.gz: 6a77b43c73461ed816155a184230f27cb4a8130117f41c9f209033eb89cc09c1581849eb58b5fec55a58a7e8d444e1c0da16576fda19463b9d7c7843b0f21082
+  data.tar.gz: 80ac6b3e2c76001e7a61076b7a6cfc72be034f418636d1ac195ee7f24144749ad4453ec67b3d0382e325a9f99fe88e0618db92696d7881051d93f01a2ef1b8d6

data/lib/macho/fat_file.rb

@@ -15,10 +15,9 @@ module MachO
 
 		# Creates a new FatFile from the given filename.
 		# @param filename [String] the fat file to load from
-		# @raise [MachO::MagicError] if the file does not have a Mach-O magic number.
-		# @raise [MachO::MachOBinaryError] if the file is not a fat binary.
+		# @raise [ArgumentError] if the given filename does not exist
 		def initialize(filename)
-			raise ArgumentError.new("filename must be a String") unless filename.is_a? String
+			raise ArgumentError.new("#{filetype}: no such file") unless File.exist?(filename)
 
 			@filename = filename
 			@raw_data = open(@filename, "rb") { |f| f.read }
@@ -33,29 +32,26 @@ module MachO
 			@raw_data
 		end
 
+		# The file's type. Assumed to be the same for every Mach-O within.
+		# @return [String] the filetype
+		def filetype
+			machos.first.filetype
+		end
+
 		# The file's dylib ID. If the file is not a dylib, returns `nil`.
 		# @example
 		#  file.dylib_id # => 'libBar.dylib'
-		# @return [String] the file's dylib ID
+		# @return [String, nil] the file's dylib ID
 		def dylib_id
-			if !machos.all?(&:dylib?)
-				return nil
-			end
-
-			ids = machos.map(&:dylib_id)
-
-			# this should never be the case, but let's be defensive
-			if !ids.uniq!.size == 1
-				return nil
-			end
-
-			ids.first
+			machos.first.dylib_id
 		end
 
 		# Changes the file's dylib ID to `new_id`. If the file is not a dylib, does nothing.
 		# @example
 		#  file.dylib_id = 'libFoo.dylib'
 		# @param new_id [String] the new dylib ID
+		# @return [void]
+		# @raise [ArgumentError] if `new_id` is not a String
 		def dylib_id=(new_id)
 			if !new_id.is_a?(String)
 				raise ArgumentError.new("argument must be a String")

data/lib/macho/load_commands.rb

@@ -303,16 +303,17 @@ module MachO
 		# @param offset [Fixnum] the offset to initialize with
 		# @param bin [String] the binary string to initialize with
 		# @return [MachO::LoadCommand] the new load command
-		# @private
-		def self.new_from_bin(offset, bin)
-			self.new(offset, *bin.unpack(@format))
+		# @api private
+		def self.new_from_bin(raw_data, offset, bin)
+			self.new(raw_data, offset, *bin.unpack(@format))
 		end
 
-		# @param offset [Fixnum] the offset to initialize iwth
+		# @param offset [Fixnum] the offset to initialize with
 		# @param cmd [Fixnum] the load command's identifying number
 		# @param cmdsize [Fixnum] the size of the load command in bytes
-		# @private
-		def initialize(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize)
+			@raw_data = raw_data
 			@offset = offset
 			@cmd = cmd
 			@cmdsize = cmdsize
@@ -322,6 +323,33 @@ module MachO
 		def to_s
 			LOAD_COMMANDS[cmd]
 		end
+
+		# Represents a Load Command string. A rough analogue to the lc_str
+		# struct used internally by OS X. This class allows ruby-macho to
+		# pretend that strings stored in LCs are immediately available without
+		# explicit operations on the raw Mach-O data.
+		class LCStr
+			# @param raw_data [String] the raw Mach-O data.
+			# @param lc [MachO::LoadCommand] the load command
+			# @param lc_str [Fixnum] the offset to the beginning of the string
+			# @api private
+			def initialize(raw_data, lc, lc_str)
+				@raw_data = raw_data
+				@lc = lc
+				@lc_str = lc_str
+				@str = @raw_data.slice(@lc.offset + @lc_str...@lc.offset + @lc.cmdsize).delete("\x00")
+			end
+
+			# @return [String] a string representation of the LCStr
+			def to_s
+				@str
+			end
+
+			# @return [Fixnum] the offset to the beginning of the string in the load command
+			def to_i
+				@lc_str
+			end
+		end
 	end
 
 	# A load command containing a single 128-bit unique random number identifying
@@ -333,9 +361,9 @@ module MachO
 		@format = "VVa16"
 		@sizeof = 24
 
-		# @private
-		def initialize(offset, cmd, cmdsize, uuid)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, uuid)
+			super(raw_data, offset, cmd, cmdsize)
 			@uuid = uuid.unpack("C16") # re-unpack for the actual UUID array
 		end
 
@@ -384,10 +412,10 @@ module MachO
 		@format = "VVa16VVVVVVVV"
 		@sizeof = 56
 
-		# @private
-		def initialize(offset, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
 				filesize, maxprot, initprot, nsects, flags)
-			super(offset, cmd, cmdsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@segname = segname
 			@vmaddr = vmaddr
 			@vmsize = vmsize
@@ -438,10 +466,10 @@ module MachO
 		@format = "VVa16QQQQVVVV"
 		@sizeof = 72
 
-		# @private
-		def initialize(offset, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
 				filesize, maxprot, initprot, nsects, flags)
-			super(offset, cmd, cmdsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@segname = segname
 			@vmaddr = vmaddr
 			@vmsize = vmsize
@@ -463,7 +491,7 @@ module MachO
 	# on filetype. Corresponds to LC_ID_DYLIB, LC_LOAD_DYLIB, LC_LOAD_WEAK_DYLIB,
 	# and LC_REEXPORT_DYLIB.
 	class DylibCommand < LoadCommand
-		# @return [Fixnum] the library's path name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the library's path name as an LCStr
 		attr_reader :name
 
 		# @return [Fixnum] the library's build time stamp
@@ -478,11 +506,11 @@ module MachO
 		@format = "VVVVVV"
 		@sizeof = 24
 
-		# @private
-		def initialize(offset, cmd, cmdsize, name, timestamp, current_version,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, name, timestamp, current_version,
 				compatibility_version)
-			super(offset, cmd, cmdsize)
-			@name = name
+			super(raw_data, offset, cmd, cmdsize)
+			@name = LCStr.new(raw_data, self, name)
 			@timestamp = timestamp
 			@current_version = current_version
 			@compatibility_version = compatibility_version
@@ -493,23 +521,23 @@ module MachO
 	# on filetype. Corresponds to LC_ID_DYLINKER, LC_LOAD_DYLINKER, and
 	# LC_DYLD_ENVIRONMENT.
 	class DylinkerCommand < LoadCommand
-		# @return [Fixnum] the dynamic linker's path name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the dynamic linker's path name as an LCStr
 		attr_reader :name
 
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, name)
-			super(offset, cmd, cmdsize)
-			@name = name
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, name)
+			super(raw_data, offset, cmd, cmdsize)
+			@name = LCStr.new(raw_data, self, name)
 		end
 	end
 
 	# A load command used to indicate dynamic libraries used in prebinding.
 	# Corresponds to LC_PREBOUND_DYLIB.
 	class PreboundDylibCommand < LoadCommand
-		# @return [Fixnum] the library's path name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the library's path name as an LCStr
 		attr_reader :name
 
 		# @return [Fixnum] the number of modules in the library
@@ -521,10 +549,10 @@ module MachO
 		@format = "VVVVV"
 		@sizeof = 20
 
-		# @private
-		def initialize(offset, cmd, cmdsize, name, nmodules, linked_modules)
-			super(offset, cmd, cmdsize)
-			@name = name
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, name, nmodules, linked_modules)
+			super(raw_data, offset, cmd, cmdsize)
+			@name = LCStr.new(raw_data, self, name)
 			@nmodules = nmodules
 			@linked_modules = linked_modules
 		end
@@ -567,11 +595,11 @@ module MachO
 		@format = "VVVVVVVVVV"
 		@sizeof = 40
 
-		# @private
-		def initialize(offset, cmd, cmdsize, init_address, init_module,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, init_address, init_module,
 				reserved1, reserved2, reserved3, reserved4, reserved5,
 				reserved6)
-			super(offset, cmd, cmdsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@init_address = init_address
 			@init_module = init_module
 			@reserved1 = reserved1
@@ -614,11 +642,11 @@ module MachO
 		@format = "VVQQQQQQQQ"
 		@sizeof = 72
 
-		# @private
-		def initialize(offset, cmd, cmdsize, init_address, init_module,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, init_address, init_module,
 				reserved1, reserved2, reserved3, reserved4, reserved5,
 				reserved6)
-			super(offset, cmd, cmdsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@init_address = init_address
 			@init_module = init_module
 			@reserved1 = reserved1
@@ -633,64 +661,64 @@ module MachO
 	# A load command signifying membership of a subframework containing the name
 	# of an umbrella framework. Corresponds to LC_SUB_FRAMEWORK.
 	class SubFrameworkCommand < LoadCommand
-		# @return [Fixnum] the umbrella framework name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the umbrella framework name as an LCStr
 		attr_reader :umbrella
 
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, umbrella)
-			super(offset, cmd, cmdsize)
-			@umbrella = umbrella
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, umbrella)
+			super(raw_data, offset, cmd, cmdsize)
+			@umbrella = LCStr.new(raw_data, self, umbrella)
 		end
 	end
 
 	# A load command signifying membership of a subumbrella containing the name
 	# of an umbrella framework. Corresponds to LC_SUB_UMBRELLA.
 	class SubUmbrellaCommand < LoadCommand
-		# @return [Fixnum] the subumbrella framework name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the subumbrella framework name as an LCStr
 		attr_reader :sub_umbrella
 
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, sub_umbrella)
-			super(offset, cmd, cmdsize)
-			@sub_umbrella = sub_umbrella
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, sub_umbrella)
+			super(raw_data, offset, cmd, cmdsize)
+			@sub_umbrella = LCStr.new(raw_data, self, sub_umbrella)
 		end
 	end
 
 	# A load command signifying a sublibrary of a shared library. Corresponds
 	# to LC_SUB_LIBRARY.
 	class SubLibraryCommand < LoadCommand
-		# @return [Fixnum] the sublibrary name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the sublibrary name as an LCStr
 		attr_reader :sub_library
 
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, sub_library)
-			super(offset, cmd, cmdsize)
-			@sub_library = sub_library
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, sub_library)
+			super(raw_data, offset, cmd, cmdsize)
+			@sub_library = LCStr.new(raw_data, self, sub_library)
 		end
 	end
 
 	# A load command signifying a shared library that is a subframework of
 	# an umbrella framework. Corresponds to LC_SUB_CLIENT.
 	class SubClientCommand < LoadCommand
-		# @return [Fixnum] the subclient name (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the subclient name as an LCStr
 		attr_reader :sub_client
 
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, sub_client)
-			super(offset, cmd, cmdsize)
-			@sub_client = sub_client
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, sub_client)
+			super(raw_data, offset, cmd, cmdsize)
+			@sub_client = LCStr.new(raw_data, self, sub_client)
 		end
 	end
 
@@ -712,9 +740,9 @@ module MachO
 		@format = "VVVVVV"
 		@sizeof = 24
 
-		# @private
-		def initialize(offset, cmd, cmdsize, symoff, nsyms, stroff, strsize)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, symoff, nsyms, stroff, strsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@symoff = symoff
 			@nsyms = nsyms
 			@stroff = stroff
@@ -784,12 +812,12 @@ module MachO
 		@sizeof = 80
 
 		# ugh
-		# @private
-		def initialize(offset, cmd, cmdsize, ilocalsym, nlocalsym, iextdefsym,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, ilocalsym, nlocalsym, iextdefsym,
 				nextdefsym, iundefsym, nundefsym, tocoff, ntoc, modtaboff,
 				nmodtab, extrefsymoff, nextrefsyms, indirectsymoff,
 				nindirectsyms, extreloff, nextrel, locreloff, nlocrel)
-			super(offset, cmd, cmdsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@ilocalsym = ilocalsym
 			@nlocalsym = nlocalsym
 			@iextdefsym = iextdefsym
@@ -823,9 +851,9 @@ module MachO
 		@format = "VVVV"
 		@sizeof = 16
 
-		# @private
-		def initialize(offset, cmd, cmdsize, htoffset, nhints)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, htoffset, nhints)
+			super(raw_data, offset, cmd, cmdsize)
 			@htoffset = htoffset
 			@nhints = nhints
 		end
@@ -840,9 +868,9 @@ module MachO
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, cksum)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, cksum)
+			super(raw_data, offset, cmd, cmdsize)
 			@cksum = cksum
 		end
 	end
@@ -851,16 +879,16 @@ module MachO
 	# be added to the current run path used to find @rpath prefixed dylibs.
 	# Corresponds to LC_RPATH.
 	class RpathCommand < LoadCommand
-		# @return [Fixnum] the oath to add to the run path (lc_str)
+		# @return [MachO::LoadCommand::LCStr] the path to add to the run path as an LCStr
 		attr_reader :path
 
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, path)
-			super(offset, cmd, cmdsize)
-			@path = path
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, path)
+			super(raw_data, offset, cmd, cmdsize)
+			@path = LCStr.new(raw_data, self, path)
 		end
 	end
 
@@ -877,9 +905,9 @@ module MachO
 		@format = "VVVV"
 		@sizeof = 16
 
-		# @private
-		def initialize(offset, cmd, cmdsize, dataoff, datasize)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, dataoff, datasize)
+			super(raw_data, offset, cmd, cmdsize)
 			@dataoff = dataoff
 			@datasize = datasize
 		end
@@ -900,9 +928,9 @@ module MachO
 		@format = "VVVVV"
 		@sizeof = 20
 
-		# @private
-		def initialize(offset, cmd, cmdsize, cryptoff, cryptsize, cryptid)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, cryptoff, cryptsize, cryptid)
+			super(raw_data, offset, cmd, cmdsize)
 			@cryptoff = cryptoff
 			@cryptsize = cryptsize
 			@cryptid = cryptid
@@ -927,9 +955,9 @@ module MachO
 		@format = "VVVVVV"
 		@sizeof = 24
 
-		# @private
-		def initialize(offset, cmd, cmdsize, cryptoff, cryptsize, cryptid)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, cryptoff, cryptsize, cryptid)
+			super(raw_data, offset, cmd, cmdsize)
 			@cryptoff = cryptoff
 			@cryptsize = cryptsize
 			@cryptid = cryptid
@@ -949,9 +977,9 @@ module MachO
 		@format = "VVVV"
 		@sizeof = 16
 
-		# @private
-		def initialize(offset, cmd, cmdsize, version, sdk)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, version, sdk)
+			super(raw_data, offset, cmd, cmdsize)
 			@version = version
 			@sdk = sdk
 		end
@@ -1016,11 +1044,11 @@ module MachO
 		@format = "VVVVVVVVVVVV"
 		@sizeof = 48
 
-		# @private
-		def initialize(offset, cmd, cmdsize, rebase_off, rebase_size, bind_off,
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, rebase_off, rebase_size, bind_off,
 				bind_size, weak_bind_off, weak_bind_size, lazy_bind_off,
 				lazy_bind_size, export_off, export_size)
-			super(offset, cmd, cmdsize)
+			super(raw_data, offset, cmd, cmdsize)
 			@rebase_off = rebase_off
 			@rebase_size = rebase_size
 			@bind_off = bind_off
@@ -1043,9 +1071,9 @@ module MachO
 		@format = "VVV"
 		@sizeof = 12
 
-		# @private
-		def initialize(offset, cmd, cmdsize, count)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, count)
+			super(raw_data, offset, cmd, cmdsize)
 			@count = count
 		end
 	end
@@ -1061,9 +1089,9 @@ module MachO
 		@format = "VVQQ"
 		@sizeof = 24
 
-		# @private
-		def initialize(offset, cmd, cmdsize, entryoff, stacksize)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, entryoff, stacksize)
+			super(raw_data, offset, cmd, cmdsize)
 			@entryoff = entryoff
 			@stacksize = stacksize
 		end
@@ -1078,9 +1106,9 @@ module MachO
 		@format = "VVQ"
 		@sizeof = 16
 
-		# @private
-		def initialize(offset, cmd, cmdsize, version)
-			super(offset, cmd, cmdsize)
+		# @api private
+		def initialize(raw_data, offset, cmd, cmdsize, version)
+			super(raw_data, offset, cmd, cmdsize)
 			@version = version
 		end
 

data/lib/macho/macho_file.rb

@@ -24,9 +24,9 @@ module MachO
 
 		# Creates a new FatFile from the given filename.
 		# @param filename [String] the Mach-O file to load from
-		# @todo document all the exceptions propagated here
+		# @raise [ArgumentError] if the given filename does not exist
 		def initialize(filename)
-			raise ArgumentError.new("filename must be a String") unless filename.is_a? String
+			raise ArgumentError.new("#{filetype}: no such file") unless File.exist?(filename)
 
 			@filename = filename
 			@raw_data = open(@filename, "rb") { |f| f.read }
@@ -34,7 +34,7 @@ module MachO
 			@load_commands = get_load_commands
 		end
 
-		# @private
+		# @api private
 		def initialize_from_bin(bin)
 			@filename = nil
 			@raw_data = bin
@@ -138,21 +138,15 @@ module MachO
 		# The Mach-O's dylib ID, or `nil` if not a dylib.
 		# @example
 		#  file.dylib_id # => 'libBar.dylib'
-		# @return [String] the Mach-O's dylib ID
+		# @return [String, nil] the Mach-O's dylib ID
 		def dylib_id
 			if !dylib?
 				return nil
 			end
 
-			dylib_id_cmd = command('LC_ID_DYLIB').first
-
-			cmdsize = dylib_id_cmd.cmdsize
-			offset = dylib_id_cmd.offset
-			stroffset = dylib_id_cmd.name
+			dylib_id_cmd = command("LC_ID_DYLIB").first
 
-			dylib_id = @raw_data.slice(offset + stroffset...offset + cmdsize).unpack("Z*").first
-
-			dylib_id.delete("\x00")
+			dylib_id_cmd.name.to_s
 		end
 
 		# Changes the Mach-O's dylib ID to `new_id`. Does nothing if not a dylib.
@@ -160,6 +154,7 @@ module MachO
 		#  file.dylib_id = "libFoo.dylib"
 		# @param new_id [String] the dylib's new ID
 		# @return [void]
+		# @raise [ArgumentError] if `new_id` is not a String
 		def dylib_id=(new_id)
 			if !new_id.is_a?(String)
 				raise ArgumentError.new("argument must be a String")
@@ -169,7 +164,7 @@ module MachO
 				return nil
 			end
 
-			dylib_cmd = command('LC_ID_DYLIB').first
+			dylib_cmd = command("LC_ID_DYLIB").first
 			old_id = dylib_id
 
 			set_name_in_dylib(dylib_cmd, old_id, new_id)
@@ -179,14 +174,10 @@ module MachO
 		# @return [Array<String>] an array of all shared libraries
 		def linked_dylibs
 			dylibs = []
-			dylib_cmds = command('LC_LOAD_DYLIB')
+			dylib_cmds = command("LC_LOAD_DYLIB")
 
 			dylib_cmds.each do |dylib_cmd|
-				cmdsize = dylib_cmd.cmdsize
-				offset = dylib_cmd.offset
-				stroffset = dylib_cmd.name
-
-				dylib = @raw_data.slice(offset + stroffset...offset + cmdsize).unpack("Z*").first
+				dylib = dylib_cmd.name.to_s
 
 				dylibs << dylib
 			end
@@ -200,6 +191,7 @@ module MachO
 		# @param old_name [String] the shared library's old name
 		# @param new_name [String] the shared library's new name
 		# @return [void]
+		# @raise [MachO::DylibUnknownError] if no shared library has the old name
 		def change_install_name(old_name, new_name)
 			idx = linked_dylibs.index(old_name)
 			raise DylibUnknownError.new(old_name) if idx.nil?
@@ -207,7 +199,7 @@ module MachO
 			# this is a bit of a hack - since there is a 1-1 ordered association
 			# between linked_dylibs and command('LC_LOAD_DYLIB'), we can use
 			# their indices interchangeably to avoid having to loop.
-			dylib_cmd = command('LC_LOAD_DYLIB')[idx]
+			dylib_cmd = command("LC_LOAD_DYLIB")[idx]
 
 			set_name_in_dylib(dylib_cmd, old_name, new_name)
 		end
@@ -215,6 +207,7 @@ module MachO
 		alias :change_dylib :change_install_name
 
 		# All sections of the segment `segment`.
+		# @param segment [MachO::SegmentCommand, MachO::SegmentCommand64] the segment being inspected
 		# @return [Array<MachO::Section>] if the Mach-O is 32-bit
 		# @return [Array<MachO::Section64>] if the Mach-O is 64-bit
 		def sections(segment)
@@ -253,6 +246,7 @@ module MachO
 		# Write all Mach-O data to the file used to initialize the instance.
 		# @raise [MachOError] if the instance was created from a binary string
 		# @return [void]
+		# @raise [MachO::MachOError] if the instance was initialized without a file
 		# @note Overwrites all data in the file!
 		def write!
 			if @filename.nil?
@@ -394,7 +388,7 @@ module MachO
 				# why do I do this? i don't like declaring constants below
 				# classes, and i need them to resolve...
 				klass = MachO.const_get "#{LC_STRUCTURES[cmd]}"
-				command = klass.new_from_bin(offset, @raw_data.slice(offset, klass.bytesize))
+				command = klass.new_from_bin(@raw_data, offset, @raw_data.slice(offset, klass.bytesize))
 
 				load_commands << command
 				offset += command.cmdsize
@@ -417,6 +411,7 @@ module MachO
 		# @param old_name [String] the old dylib name
 		# @param new_name [String] the new dylib name
 		# @return [void]
+		# @raise [MachO::HeaderPadError] if the new name exceeds the header pad buffer
 		# @private
 		def set_name_in_dylib(dylib_cmd, old_name, new_name)
 			if magic32?
@@ -465,10 +460,10 @@ module MachO
 			@raw_data[dylib_cmd.offset + 4, 4] = [new_size].pack("V")
 
 			# delete the old name
-			@raw_data.slice!(dylib_cmd.offset + dylib_cmd.name...dylib_cmd.offset + dylib_cmd.class.bytesize + old_name.size)
+			@raw_data.slice!(dylib_cmd.offset + dylib_cmd.name.to_i...dylib_cmd.offset + dylib_cmd.class.bytesize + old_name.size)
 
 			# insert the new id
-			@raw_data.insert(dylib_cmd.offset + dylib_cmd.name, new_name)
+			@raw_data.insert(dylib_cmd.offset + dylib_cmd.name.to_i, new_name)
 
 			# pad/unpad after new_sizeofcmds until offsets are corrected
 			null_pad = old_name.size - new_name.size

data/lib/macho/sections.rb

@@ -58,13 +58,43 @@ module MachO
 
 	# Represents a section of a segment for 32-bit architectures.
 	class Section < MachOStructure
-		attr_reader :sectname, :segname, :addr, :size, :offset, :align, :reloff
-		attr_reader :nreloc, :flags, :reserved1, :reserved2
+		# @return [String] the name of the section, including null pad bytes
+		attr_reader :sectname
+
+		# @return [String] the name of the segment's section, including null pad bytes
+		attr_reader :segname
+
+		# @return [Fixnum] the memory address of the section
+		attr_reader :addr
+
+		# @return [Fixnum] the size, in bytes, of the section
+		attr_reader :size
+
+		# @return [Fixnum] the file offset of the section
+		attr_reader :offset
+
+		# @return [Fixnum] the section alignment (power of 2) of the section
+		attr_reader :align
+
+		# @return [Fixnum] the file offset of the section's relocation entries
+		attr_reader :reloff
+
+		# @return [Fixnum] the number of relocation entries
+		attr_reader :nreloc
+
+		# @return [Fixnum] flags for type and addrributes of the section
+		attr_reader :flags
+
+		# @return [void] reserved (for offset or index)
+		attr_reader :reserved1
+
+		# @return [void] reserved (for count or sizeof)
+		attr_reader :reserved2
 
 		@format = "a16a16VVVVVVVVV"
 		@sizeof = 68
 
-		# @private
+		# @api private
 		def initialize(sectname, segname, addr, size, offset, align, reloff,
 				nreloc, flags, reserved1, reserved2)
 			@sectname = sectname
@@ -101,13 +131,46 @@ module MachO
 
 	# Represents a section of a segment for 64-bit architectures.
 	class Section64 < MachOStructure
-		attr_reader :sectname, :segname, :addr, :size, :offset, :align, :reloff
-		attr_reader :nreloc, :flags, :reserved1, :reserved2, :reserved3
+		# @return [String] the name of the section, including null pad bytes
+		attr_reader :sectname
+
+		# @return [String] the name of the segment's section, including null pad bytes
+		attr_reader :segname
+
+		# @return [Fixnum] the memory address of the section
+		attr_reader :addr
+
+		# @return [Fixnum] the size, in bytes, of the section
+		attr_reader :size
+
+		# @return [Fixnum] the file offset of the section
+		attr_reader :offset
+
+		# @return [Fixnum] the section alignment (power of 2) of the section
+		attr_reader :align
+
+		# @return [Fixnum] the file offset of the section's relocation entries
+		attr_reader :reloff
+
+		# @return [Fixnum] the number of relocation entries
+		attr_reader :nreloc
+
+		# @return [Fixnum] flags for type and addrributes of the section
+		attr_reader :flags
+
+		# @return [void] reserved (for offset or index)
+		attr_reader :reserved1
+
+		# @return [void] reserved (for count or sizeof)
+		attr_reader :reserved2
+
+		# @return [void] reserved
+		attr_reader :reserved3
 
 		@format = "a16a16QQVVVVVVVV"
 		@sizeof = 80
 
-		# @private
+		# @api private
 		def initialize(sectname, segname, addr, size, offset, align, reloff,
 				nreloc, flags, reserved1, reserved2, reserved3)
 			@sectname = sectname

data/lib/macho/structure.rb

@@ -12,6 +12,7 @@ module MachO
 		end
 
 		# @return [MachO::MachOStructure] a new MachOStructure initialized with `bin`
+		# @api private
 		def self.new_from_bin(bin)
 			self.new(*bin.unpack(@format))
 		end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies: []
 description: A library for viewing and manipulating Mach-O files in Ruby.
 email: william@tuffbizz.com