ruby-macho 1.0.0 → 1.1.0

data/lib/macho/sections.rb

@@ -72,7 +72,8 @@ module MachO
       # @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
+      # @return [String] the name of the segment's section, including null
+      #  pad bytes
       attr_reader :segname
 
       # @return [Fixnum] the memory address of the section
@@ -124,17 +125,19 @@ module MachO
         @reserved2 = reserved2
       end
 
-      # @return [String] the section's name, with any trailing NULL characters removed
+      # @return [String] the section's name, with any trailing NULL characters
+      #  removed
       def section_name
         sectname.delete("\x00")
       end
 
-      # @return [String] the parent segment's name, with any trailing NULL characters removed
+      # @return [String] the parent segment's name, with any trailing NULL
+      #  characters removed
       def segment_name
         segname.delete("\x00")
       end
 
-      # @return [Boolean] true if the section has no contents (i.e, `size` is 0)
+      # @return [Boolean] whether the section is empty (i.e, {size} is 0)
       def empty?
         size.zero?
       end
@@ -142,7 +145,7 @@ module MachO
       # @example
       #  puts "this section is regular" if sect.flag?(:S_REGULAR)
       # @param flag [Symbol] a section flag symbol
-      # @return [Boolean] true if `flag` is present in the section's flag field
+      # @return [Boolean] whether the flag is present in the section's {flags}
       def flag?(flag)
         flag = SECTION_FLAGS[flag]
         return false if flag.nil?

data/lib/macho/structure.rb

@@ -19,7 +19,7 @@ module MachO
 
     # @param endianness [Symbol] either `:big` or `:little`
     # @param bin [String] the string to be unpacked into the new structure
-    # @return [MachO::MachOStructure] a new MachOStructure initialized with `bin`
+    # @return [MachO::MachOStructure] the resulting structure
     # @api private
     def self.new_from_bin(endianness, bin)
       format = Utils.specialize_format(self::FORMAT, endianness)

data/lib/macho/tools.rb

@@ -1,5 +1,6 @@
 module MachO
-  # A collection of convenient methods for common operations on Mach-O and Fat binaries.
+  # A collection of convenient methods for common operations on Mach-O and Fat
+  # binaries.
   module Tools
     # @param filename [String] the Mach-O or Fat binary being read
     # @return [Array<String>] an array of all dylibs linked to the binary
@@ -9,7 +10,8 @@ module MachO
       file.linked_dylibs
     end
 
-    # Changes the dylib ID of a Mach-O or Fat binary, overwriting the source file.
+    # Changes the dylib ID of a Mach-O or Fat binary, overwriting the source
+    #  file.
     # @param filename [String] the Mach-O or Fat binary being modified
     # @param new_id [String] the new dylib ID for the binary
     # @param options [Hash]
@@ -23,7 +25,8 @@ module MachO
       file.write!
     end
 
-    # Changes a shared library install name in a Mach-O or Fat binary, overwriting the source file.
+    # Changes a shared library install name in a Mach-O or Fat binary,
+    #  overwriting the source file.
     # @param filename [String] the Mach-O or Fat binary being modified
     # @param old_name [String] the old shared library name
     # @param new_name [String] the new shared library name
@@ -38,7 +41,8 @@ module MachO
       file.write!
     end
 
-    # Changes a runtime path in a Mach-O or Fat binary, overwriting the source file.
+    # Changes a runtime path in a Mach-O or Fat binary, overwriting the source
+    #  file.
     # @param filename [String] the Mach-O or Fat binary being modified
     # @param old_path [String] the old runtime path
     # @param new_path [String] the new runtime path
@@ -67,7 +71,8 @@ module MachO
       file.write!
     end
 
-    # Delete a runtime path from a Mach-O or Fat binary, overwriting the source file.
+    # Delete a runtime path from a Mach-O or Fat binary, overwriting the source
+    #  file.
     # @param filename [String] the Mach-O or Fat binary being modified
     # @param old_path [String] the old runtime path
     # @param options [Hash]
@@ -80,5 +85,24 @@ module MachO
       file.delete_rpath(old_path, options)
       file.write!
     end
+
+    # Merge multiple Mach-Os into one universal (Fat) binary.
+    # @param filename [String] the fat binary to create
+    # @param files [Array<MachO::MachOFile, MachO::FatFile>] the files to merge
+    # @return [void]
+    def self.merge_machos(filename, *files)
+      machos = files.map do |file|
+        macho = MachO.open(file)
+        case macho
+        when MachO::MachOFile
+          macho
+        else
+          macho.machos
+        end
+      end.flatten
+
+      fat_macho = MachO::FatFile.new_from_machos(*machos)
+      fat_macho.write(filename)
+    end
   end
 end

data/lib/macho/utils.rb

@@ -13,7 +13,8 @@ module MachO
       value
     end
 
-    # Returns the number of bytes needed to pad the given size to the given alignment.
+    # Returns the number of bytes needed to pad the given size to the given
+    #  alignment.
     # @param size [Fixnum] the unpadded size
     # @param alignment [Fixnum] the number to alignment the size with
     # @return [Fixnum] the number of pad bytes required
@@ -21,7 +22,8 @@ module MachO
       round(size, alignment) - size
     end
 
-    # Converts an abstract (native-endian) String#unpack format to big or little.
+    # Converts an abstract (native-endian) String#unpack format to big or
+    #  little.
     # @param format [String] the format string being converted
     # @param endianness [Symbol] either `:big` or `:little`
     # @return [String] the converted string
@@ -31,7 +33,8 @@ module MachO
     end
 
     # Packs tagged strings into an aligned payload.
-    # @param fixed_offset [Fixnum] the baseline offset for the first packed string
+    # @param fixed_offset [Fixnum] the baseline offset for the first packed
+    #  string
     # @param alignment [Fixnum] the alignment value to use for packing
     # @param strings [Hash] the labeled strings to pack
     # @return [Array<String, Hash>] the packed string and labeled offsets
@@ -53,42 +56,42 @@ module MachO
 
     # Compares the given number to valid Mach-O magic numbers.
     # @param num [Fixnum] the number being checked
-    # @return [Boolean] true if `num` is a valid Mach-O magic number, false otherwise
+    # @return [Boolean] whether `num` is a valid Mach-O magic number
     def self.magic?(num)
       Headers::MH_MAGICS.key?(num)
     end
 
     # Compares the given number to valid Fat magic numbers.
     # @param num [Fixnum] the number being checked
-    # @return [Boolean] true if `num` is a valid Fat magic number, false otherwise
+    # @return [Boolean] whether `num` is a valid Fat magic number
     def self.fat_magic?(num)
       num == Headers::FAT_MAGIC
     end
 
     # Compares the given number to valid 32-bit Mach-O magic numbers.
     # @param num [Fixnum] the number being checked
-    # @return [Boolean] true if `num` is a valid 32-bit magic number, false otherwise
+    # @return [Boolean] whether `num` is a valid 32-bit magic number
     def self.magic32?(num)
       num == Headers::MH_MAGIC || num == Headers::MH_CIGAM
     end
 
     # Compares the given number to valid 64-bit Mach-O magic numbers.
     # @param num [Fixnum] the number being checked
-    # @return [Boolean] true if `num` is a valid 64-bit magic number, false otherwise
+    # @return [Boolean] whether `num` is a valid 64-bit magic number
     def self.magic64?(num)
       num == Headers::MH_MAGIC_64 || num == Headers::MH_CIGAM_64
     end
 
     # Compares the given number to valid little-endian magic numbers.
     # @param num [Fixnum] the number being checked
-    # @return [Boolean] true if `num` is a valid little-endian magic number, false otherwise
+    # @return [Boolean] whether `num` is a valid little-endian magic number
     def self.little_magic?(num)
       num == Headers::MH_CIGAM || num == Headers::MH_CIGAM_64
     end
 
     # Compares the given number to valid big-endian magic numbers.
     # @param num [Fixnum] the number being checked
-    # @return [Boolean] true if `num` is a valid big-endian magic number, false otherwise
+    # @return [Boolean] whether `num` is a valid big-endian magic number
     def self.big_magic?(num)
       num == Headers::MH_CIGAM || num == Headers::MH_CIGAM_64
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies: []
 description: A library for viewing and manipulating Mach-O files in Ruby.
 email: william@tuffbizz.com
@@ -50,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: ruby-macho - Mach-O file analyzer.