Merge pull request #56 from Homebrew/general-refactoring

General refactoring.

Author: UniqMartin

.rubocop.yml

@@ -0,0 +1,53 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+# we prefer compact if-else-end/case-when-end alignment
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+# Ruby 1.8 compatibility
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+# TODO: re-enable in the future
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

lib/macho/exceptions.rb

@@ -146,9 +146,9 @@ def initialize(offset)
   class HeaderPadError < ModificationError
     # @param filename [String] the filename
     def initialize(filename)
-      super "Updated load commands do not fit in the header of " +
-      "#{filename}. #{filename} needs to be relinked, possibly with " +
-      "-headerpad or -headerpad_max_install_names"
+      super "Updated load commands do not fit in the header of " \
+        "#{filename}. #{filename} needs to be relinked, possibly with " \
+        "-headerpad or -headerpad_max_install_names"
     end
   end
 

lib/macho/fat_file.rb

@@ -30,13 +30,13 @@ def self.new_from_bin(bin)
     # @param filename [String] the fat file to load from
     # @raise [ArgumentError] if the given file does not exist
     def initialize(filename)
-      raise ArgumentError.new("#{filename}: no such file") unless File.file?(filename)
+      raise ArgumentError, "#{filename}: no such file" unless File.file?(filename)
 
       @filename = filename
-      @raw_data = File.open(@filename, "rb") { |f| f.read }
-      @header = get_fat_header
-      @fat_archs = get_fat_archs
-      @machos = get_machos
+      @raw_data = File.open(@filename, "rb", &:read)
+      @header = populate_fat_header
+      @fat_archs = populate_fat_archs
+      @machos = populate_machos
     end
 
     # Initializes a new FatFile instance from a binary string.
@@ -45,9 +45,9 @@ def initialize(filename)
     def initialize_from_bin(bin)
       @filename = nil
       @raw_data = bin
-      @header = get_fat_header
-      @fat_archs = get_fat_archs
-      @machos = get_machos
+      @header = populate_fat_header
+      @fat_archs = populate_fat_archs
+      @machos = populate_machos
     end
 
     # The file's raw fat data.
@@ -142,13 +142,8 @@ def dylib_id
     # @raise [ArgumentError] if `new_id` is not a String
     # @see MachO::MachOFile#linked_dylibs
     def change_dylib_id(new_id, options = {})
-      if !new_id.is_a?(String)
-        raise ArgumentError.new("argument must be a String")
-      end
-
-      if !machos.all?(&:dylib?)
-        return nil
-      end
+      raise ArgumentError, "argument must be a String" unless new_id.is_a?(String)
+      return unless machos.all?(&:dylib?)
 
       each_macho(options) do |macho|
         macho.change_dylib_id(new_id, options)
@@ -157,7 +152,7 @@ def change_dylib_id(new_id, options = {})
       synchronize_raw_data
     end
 
-    alias :dylib_id= :change_dylib_id
+    alias dylib_id= change_dylib_id
 
     # All shared libraries linked to the file's Mach-Os.
     # @return [Array<String>] an array of all shared libraries
@@ -188,7 +183,7 @@ def change_install_name(old_name, new_name, options = {})
       synchronize_raw_data
     end
 
-    alias :change_dylib :change_install_name
+    alias change_dylib change_install_name
 
     # All runtime paths associated with the file's Mach-Os.
     # @return [Array<String>] an array of all runtime paths
@@ -265,7 +260,7 @@ def write(filename)
     # @note Overwrites all data in the file!
     def write!
       if filename.nil?
-        raise MachOError.new("cannot write to a default file when initialized from a binary string")
+        raise MachOError, "cannot write to a default file when initialized from a binary string"
       else
         File.open(@filename, "wb") { |f| f.write(@raw_data) }
       end
@@ -280,14 +275,14 @@ def write!
     # @raise [MachO::MachOBinaryError] if the magic is for a non-fat Mach-O file
     # @raise [MachO::JavaClassFileError] if the file is a Java classfile
     # @api private
-    def get_fat_header
+    def populate_fat_header
       # the smallest fat Mach-O header is 8 bytes
-      raise TruncatedFileError.new if @raw_data.size < 8
+      raise TruncatedFileError if @raw_data.size < 8
 
       fh = FatHeader.new_from_bin(:big, @raw_data[0, FatHeader.bytesize])
 
-      raise MagicError.new(fh.magic) unless Utils.magic?(fh.magic)
-      raise MachOBinaryError.new unless Utils.fat_magic?(fh.magic)
+      raise MagicError, fh.magic unless Utils.magic?(fh.magic)
+      raise MachOBinaryError unless Utils.fat_magic?(fh.magic)
 
       # Rationale: Java classfiles have the same magic as big-endian fat
       # Mach-Os. Classfiles encode their version at the same offset as
@@ -296,15 +291,15 @@ def get_fat_header
       # technically possible for a fat Mach-O to have over 30 architectures,
       # but this is extremely unlikely and in practice distinguishes the two
       # formats.
-      raise JavaClassFileError.new if fh.nfat_arch > 30
+      raise JavaClassFileError if fh.nfat_arch > 30
 
       fh
     end
 
     # Obtain an array of fat architectures from raw file data.
     # @return [Array<MachO::FatArch>] an array of fat architectures
     # @api private
-    def get_fat_archs
+    def populate_fat_archs
       archs = []
 
       fa_off = FatHeader.bytesize
@@ -319,7 +314,7 @@ def get_fat_archs
     # Obtain an array of Mach-O blobs from raw file data.
     # @return [Array<MachO::MachOFile>] an array of Mach-Os
     # @api private
-    def get_machos
+    def populate_machos
       machos = []
 
       fat_archs.each do |arch|

lib/macho/headers.rb

@@ -32,8 +32,8 @@ module MachO
     MH_MAGIC => "MH_MAGIC",
     MH_CIGAM => "MH_CIGAM",
     MH_MAGIC_64 => "MH_MAGIC_64",
-    MH_CIGAM_64 => "MH_CIGAM_64"
-  }
+    MH_CIGAM_64 => "MH_CIGAM_64",
+  }.freeze
 
   # mask for CPUs with 64-bit architectures (when running a 64-bit ABI?)
   # @api private
@@ -85,7 +85,7 @@ module MachO
     CPU_TYPE_ARM64 => :arm64,
     CPU_TYPE_POWERPC => :ppc,
     CPU_TYPE_POWERPC64 => :ppc64,
-  }
+  }.freeze
 
   # mask for CPU subtype capabilities
   # @api private
@@ -114,7 +114,7 @@ module MachO
 
   # @see CPU_SUBTYPE_586
   # @api private
-  CPU_SUBTYPE_PENT  = CPU_SUBTYPE_586
+  CPU_SUBTYPE_PENT = CPU_SUBTYPE_586
 
   # the Pentium Pro (P6) sub-type for `CPU_TYPE_I386`
   # @api private
@@ -412,7 +412,7 @@ module MachO
     MH_DYLIB_STUB => :dylib_stub,
     MH_DSYM => :dsym,
     MH_KEXT_BUNDLE => :kext_bundle,
-  }
+  }.freeze
 
   # association of mach header flag symbols to values
   # @api private
@@ -442,8 +442,8 @@ module MachO
     :MH_DEAD_STRIPPABLE_DYLIB => 0x400000,
     :MH_HAS_TLV_DESCRIPTORS => 0x800000,
     :MH_NO_HEAP_EXECUTION => 0x1000000,
-    :MH_APP_EXTENSION_SAFE => 0x02000000
-  }
+    :MH_APP_EXTENSION_SAFE => 0x02000000,
+  }.freeze
 
   # Fat binary header structure
   # @see MachO::FatArch
@@ -457,7 +457,7 @@ class FatHeader < MachOStructure
     # always big-endian
     # @see MachOStructure::FORMAT
     # @api private
-    FORMAT = "N2"
+    FORMAT = "N2".freeze
 
     # @see MachOStructure::SIZEOF
     # @api private
@@ -492,7 +492,7 @@ class FatArch < MachOStructure
     # always big-endian
     # @see MachOStructure::FORMAT
     # @api private
-    FORMAT = "N5"
+    FORMAT = "N5".freeze
 
     # @see MachOStructure::SIZEOF
     # @api private
@@ -533,15 +533,15 @@ class MachHeader < MachOStructure
 
     # @see MachOStructure::FORMAT
     # @api private
-    FORMAT = "L=7"
+    FORMAT = "L=7".freeze
 
     # @see MachOStructure::SIZEOF
     # @api private
     SIZEOF = 28
 
     # @api private
     def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
-        flags)
+                   flags)
       @magic = magic
       @cputype = cputype
       # For now we're not interested in additional capability bits also to be
@@ -571,15 +571,15 @@ class MachHeader64 < MachHeader
 
     # @see MachOStructure::FORMAT
     # @api private
-    FORMAT = "L=8"
+    FORMAT = "L=8".freeze
 
     # @see MachOStructure::SIZEOF
     # @api private
     SIZEOF = 32
 
     # @api private
     def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
-        flags, reserved)
+                   flags, reserved)
       super(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds, flags)
       @reserved = reserved
     end