style: More aggressive style conformity.

Shorten documented hierarchies where YARD allows, break lines
apart to fit in 80 columns.

Author: woodruffw

lib/macho.rb

@@ -16,11 +16,11 @@ module MachO
 
   # Opens the given filename as a MachOFile or FatFile, depending on its magic.
   # @param filename [String] the file being opened
-  # @return [MachO::MachOFile] if the file is a Mach-O
-  # @return [MachO::FatFile] if the file is a Fat file
+  # @return [MachOFile] if the file is a Mach-O
+  # @return [FatFile] if the file is a Fat file
   # @raise [ArgumentError] if the given file does not exist
-  # @raise [MachO::TruncatedFileError] if the file is too small to have a valid header
-  # @raise [MachO::MagicError] if the file's magic is not valid Mach-O magic
+  # @raise [TruncatedFileError] if the file is too small to have a valid header
+  # @raise [MagicError] if the file's magic is not valid Mach-O magic
   def self.open(filename)
     raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
     raise TruncatedFileError unless File.stat(filename).size >= 4

lib/macho/exceptions.rb

@@ -80,7 +80,8 @@ class CPUSubtypeError < MachOError
     # @param cputype [Fixnum] the CPU type of the unknown pair
     # @param cpusubtype [Fixnum] the CPU sub-type of the unknown pair
     def initialize(cputype, cpusubtype)
-      super "Unrecognized CPU sub-type: 0x#{"%08x" % cpusubtype} (for CPU type: 0x#{"%08x" % cputype})"
+      super "Unrecognized CPU sub-type: 0x#{"%08x" % cpusubtype}" \
+        " (for CPU type: 0x#{"%08x" % cputype})"
     end
   end
 
@@ -108,13 +109,15 @@ def initialize(cmd_sym)
     end
   end
 
-  # Raised when the number of arguments used to create a load command manually is wrong.
+  # Raised when the number of arguments used to create a load command manually
+  # is wrong.
   class LoadCommandCreationArityError < MachOError
     # @param cmd_sym [Symbol] the load command's symbol
     # @param expected_arity [Fixnum] the number of arguments expected
     # @param actual_arity [Fixnum] the number of arguments received
     def initialize(cmd_sym, expected_arity, actual_arity)
-      super "Expected #{expected_arity} arguments for #{cmd_sym} creation, got #{actual_arity}"
+      super "Expected #{expected_arity} arguments for #{cmd_sym} creation," \
+        " got #{actual_arity}"
     end
   end
 
@@ -130,7 +133,8 @@ def initialize(cmd_sym)
   class LCStrMalformedError < MachOError
     # @param lc [MachO::LoadCommand] the load command containing the string
     def initialize(lc)
-      super "Load command #{lc.type} at offset #{lc.view.offset} contains a malformed string"
+      super "Load command #{lc.type} at offset #{lc.view.offset} contains a" \
+        " malformed string"
     end
   end
 

lib/macho/fat_file.rb

@@ -4,25 +4,25 @@ module MachO
   # Represents a "Fat" file, which contains a header, a listing of available
   # architectures, and one or more Mach-O binaries.
   # @see https://en.wikipedia.org/wiki/Mach-O#Multi-architecture_binaries
-  # @see MachO::MachOFile
+  # @see MachOFile
   class FatFile
     extend Forwardable
 
     # @return [String] the filename loaded from, or nil if loaded from a binary string
     attr_accessor :filename
 
-    # @return [MachO::Headers::FatHeader] the file's header
+    # @return [Headers::FatHeader] the file's header
     attr_reader :header
 
-    # @return [Array<MachO::Headers::FatArch>] an array of fat architectures
+    # @return [Array<Headers::FatArch>] an array of fat architectures
     attr_reader :fat_archs
 
-    # @return [Array<MachO::MachOFile>] an array of Mach-O binaries
+    # @return [Array<MachOFile>] an array of Mach-O binaries
     attr_reader :machos
 
     # Creates a new FatFile from the given (single-arch) Mach-Os
-    # @param machos [Array<MachO::MachOFile>] the machos to combine
-    # @return [MachO::FatFile] a new FatFile containing the give machos
+    # @param machos [Array<MachOFile>] the machos to combine
+    # @return [FatFile] a new FatFile containing the give machos
     def self.new_from_machos(*machos)
       header = Headers::FatHeader.new(Headers::FAT_MAGIC, machos.size)
       offset = Headers::FatHeader.bytesize + (machos.size * Headers::FatArch.bytesize)
@@ -44,7 +44,7 @@ def self.new_from_machos(*machos)
 
     # Creates a new FatFile instance from a binary string.
     # @param bin [String] a binary string containing raw Mach-O data
-    # @return [MachO::FatFile] a new FatFile
+    # @return [FatFile] a new FatFile
     def self.new_from_bin(bin)
       instance = allocate
       instance.initialize_from_bin(bin)
@@ -64,7 +64,7 @@ def initialize(filename)
     end
 
     # Initializes a new FatFile instance from a binary string.
-    # @see MachO::FatFile.new_from_bin
+    # @see new_from_bin
     # @api private
     def initialize_from_bin(bin)
       @filename = nil
@@ -125,12 +125,13 @@ def populate_fields
     end
 
     # All load commands responsible for loading dylibs in the file's Mach-O's.
-    # @return [Array<MachO::LoadCommands::DylibCommand>] an array of DylibCommands
+    # @return [Array<LoadCommands::DylibCommand>] an array of DylibCommands
     def dylib_load_commands
       machos.map(&:dylib_load_commands).flatten
     end
 
-    # Changes the file's dylib ID to `new_id`. If the file is not a dylib, does nothing.
+    # Changes the file's dylib ID to `new_id`. If the file is not a dylib,
+    #  does nothing.
     # @example
     #  file.change_dylib_id('libFoo.dylib')
     # @param new_id [String] the new dylib ID
@@ -139,7 +140,7 @@ def dylib_load_commands
     #  if false, fail only if all slices fail.
     # @return [void]
     # @raise [ArgumentError] if `new_id` is not a String
-    # @see MachO::MachOFile#linked_dylibs
+    # @see MachOFile#linked_dylibs
     def change_dylib_id(new_id, options = {})
       raise ArgumentError, "argument must be a String" unless new_id.is_a?(String)
       return unless machos.all?(&:dylib?)
@@ -155,16 +156,17 @@ def change_dylib_id(new_id, options = {})
 
     # All shared libraries linked to the file's Mach-Os.
     # @return [Array<String>] an array of all shared libraries
-    # @see MachO::MachOFile#linked_dylibs
+    # @see MachOFile#linked_dylibs
     def linked_dylibs
       # Individual architectures in a fat binary can link to different subsets
       # of libraries, but at this point we want to have the full picture, i.e.
       # the union of all libraries used by all architectures.
       machos.map(&:linked_dylibs).flatten.uniq
     end
 
-    # Changes all dependent shared library install names from `old_name` to `new_name`.
-    # In a fat file, this changes install names in all internal Mach-Os.
+    # Changes all dependent shared library install names from `old_name` to
+    # `new_name`. In a fat file, this changes install names in all internal
+    # Mach-Os.
     # @example
     #  file.change_install_name('/usr/lib/libFoo.dylib', '/usr/lib/libBar.dylib')
     # @param old_name [String] the shared library name being changed
@@ -173,7 +175,7 @@ def linked_dylibs
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return [void]
-    # @see MachO::MachOFile#change_install_name
+    # @see MachOFile#change_install_name
     def change_install_name(old_name, new_name, options = {})
       each_macho(options) do |macho|
         macho.change_install_name(old_name, new_name, options)
@@ -186,7 +188,7 @@ def change_install_name(old_name, new_name, options = {})
 
     # All runtime paths associated with the file's Mach-Os.
     # @return [Array<String>] an array of all runtime paths
-    # @see MachO::MachOFile#rpaths
+    # @see MachOFile#rpaths
     def rpaths
       # Can individual architectures have different runtime paths?
       machos.map(&:rpaths).flatten.uniq
@@ -199,7 +201,7 @@ def rpaths
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return [void]
-    # @see MachO::MachOFile#change_rpath
+    # @see MachOFile#change_rpath
     def change_rpath(old_path, new_path, options = {})
       each_macho(options) do |macho|
         macho.change_rpath(old_path, new_path, options)
@@ -214,7 +216,7 @@ def change_rpath(old_path, new_path, options = {})
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return [void]
-    # @see MachO::MachOFile#add_rpath
+    # @see MachOFile#add_rpath
     def add_rpath(path, options = {})
       each_macho(options) do |macho|
         macho.add_rpath(path, options)
@@ -229,7 +231,7 @@ def add_rpath(path, options = {})
     # @option options [Boolean] :strict (true) if true, fail if one slice fails.
     #  if false, fail only if all slices fail.
     # @return void
-    # @see MachO::MachOFile#delete_rpath
+    # @see MachOFile#delete_rpath
     def delete_rpath(path, options = {})
       each_macho(options) do |macho|
         macho.delete_rpath(path, options)
@@ -242,20 +244,21 @@ def delete_rpath(path, options = {})
     # @example
     #  file.extract(:i386) # => MachO::MachOFile
     # @param cputype [Symbol] the CPU type of the Mach-O being extracted
-    # @return [MachO::MachOFile, nil] the extracted Mach-O or nil if no Mach-O has the given CPU type
+    # @return [MachOFile, nil] the extracted Mach-O or nil if no Mach-O has the given CPU type
     def extract(cputype)
       machos.select { |macho| macho.cputype == cputype }.first
     end
 
     # Write all (fat) data to the given filename.
     # @param filename [String] the file to write to
+    # @return [void]
     def write(filename)
       File.open(filename, "wb") { |f| f.write(@raw_data) }
     end
 
     # Write all (fat) data to the file used to initialize the instance.
     # @return [void]
-    # @raise [MachO::MachOError] if the instance was initialized without a file
+    # @raise [MachOError] if the instance was initialized without a file
     # @note Overwrites all data in the file!
     def write!
       if filename.nil?
@@ -268,11 +271,12 @@ def write!
     private
 
     # Obtain the fat header from raw file data.
-    # @return [MachO::Headers::FatHeader] the fat header
-    # @raise [MachO::TruncatedFileError] if the file is too small to have a valid header
-    # @raise [MachO::MagicError] if the magic is not valid Mach-O magic
-    # @raise [MachO::MachOBinaryError] if the magic is for a non-fat Mach-O file
-    # @raise [MachO::JavaClassFileError] if the file is a Java classfile
+    # @return [Headers::FatHeader] the fat header
+    # @raise [TruncatedFileError] if the file is too small to have a
+    #  valid header
+    # @raise [MagicError] if the magic is not valid Mach-O magic
+    # @raise [MachOBinaryError] if the magic is for a non-fat Mach-O file
+    # @raise [JavaClassFileError] if the file is a Java classfile
     # @api private
     def populate_fat_header
       # the smallest fat Mach-O header is 8 bytes
@@ -296,7 +300,7 @@ def populate_fat_header
     end
 
     # Obtain an array of fat architectures from raw file data.
-    # @return [Array<MachO::Headers::FatArch>] an array of fat architectures
+    # @return [Array<Headers::FatArch>] an array of fat architectures
     # @api private
     def populate_fat_archs
       archs = []
@@ -311,7 +315,7 @@ def populate_fat_archs
     end
 
     # Obtain an array of Mach-O blobs from raw file data.
-    # @return [Array<MachO::MachOFile>] an array of Mach-Os
+    # @return [Array<MachOFile>] an array of Mach-Os
     # @api private
     def populate_machos
       machos = []
@@ -339,7 +343,7 @@ def repopulate_raw_machos
     # @option options [Boolean] :strict (true) whether or not to fail loudly
     #  with an exception if at least one Mach-O raises an exception. If false,
     #  only raises an exception if *all* Mach-Os raise exceptions.
-    # @raise [MachO::RecoverableModificationError] under the conditions of
+    # @raise [RecoverableModificationError] under the conditions of
     #  the `:strict` option above.
     # @api private
     def each_macho(options = {})
@@ -364,7 +368,7 @@ def each_macho(options = {})
 
     # Return a single-arch Mach-O that represents this fat Mach-O for purposes
     #  of delegation.
-    # @return [MachO::MachOFile] the Mach-O file
+    # @return [MachOFile] the Mach-O file
     # @api private
     def canonical_macho
       machos.first