squash_ios_symbolicator 1.0.0

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,106 @@
+Squash iOS Symbolicator
+=======================
+
+This gem serves two purposes: to upload symbolication data to Squash, and to
+notify Squash of new releases of the software (internally or externally).
+
+This gem installs a `symbolicate` binary that converts a dSYM file into a format
+usable for Squash, and then uploads the data to the Squash host. It also
+installs a `squash_release` binary that notifies Squash of the release.
+
+Documentation
+-------------
+
+Comprehensive documentation is written in YARD- and Markdown-formatted comments
+throughout the source. To view this documentation as an HTML site, run
+`rake doc`.
+
+For an overview of the various components of Squash, see the website
+documentation at https://github.com/SquareSquash/web.
+
+Compatibility
+-------------
+
+This library is compatible with Ruby 1.8.6 and later, including Ruby Enterprise
+Edition.
+
+Requirements
+------------
+
+This gem requires the `json` gem (http://rubygems.org/gems/json). You can use
+any JSON gem that conforms to the typical standard
+(`require 'json'; object.to_json`).
+
+This gem uses the `plist` gem to parse your Info.plist file. The property list
+must be in XML, not binary, format.
+
+This gem uses `dwarfdump` to perform its symbolication. You'll therefore need
+the Xcode Command Line tools installed on the machine that will be performing
+the symbolication upload.
+
+Usage
+-----
+
+### Uploading Symbolication Data
+
+This gem installs a command-line binary named `symbolicate`. It is called in the
+following format:
+
+````
+symbolicate [options]
+````
+
+Example: `symbolicate --host https://squash.mycompany.com`
+
+This binary is intended to be used as part of your release process. In Xcode,
+you can add a build script that invokes this binary. Little configuration is
+needed: Xcode sets a number of environment variables related to the build, and
+`symbolicate` uses these by default to find the data it needs. You can customize
+the script's options as needed to suit your specific toolchain, though.
+
+An example "Run Script" phase for a build might look like this, assuming you had
+the gem installed in a gemset using RVM:
+
+```` sh
+/Users/someone/.rvm/bin/rvm 1.8.7@squash do /Users/someone/.rvm/gems/ruby-1.8.7-p370@squash/bin/symbolicate
+````
+
+For documentation on `symbolicate`'s command-line options, run
+`symbolicate --help.`
+
+### Release Notification
+
+This gem installs a command-line binary named `squash_release`. It is called in
+the following format:
+
+````
+squash_release [options] <API key> <environment>
+````
+
+Example: `squash_release --build 1138 a9232f94-6c2d-45ae-8f9e-9add5bd7ff35 internal_beta`
+
+This binary is intended to be used as part of your release process, similar to
+`symbolicate` (see above). Like `symbolicate`, sensible defaults are provided
+for all command line switches.
+
+For documentation on `squash_release`'s command-line options, run
+`squash_release --help`.
+
+Data Transmission
+-----------------
+
+Symbolication and release data is transmitted to Squash using JSON-over-HTTPS. A
+default API endpoint is pre-configured, though you can always set your own (see
+`symbolicate --help` or `squash_release --help`).
+
+By default, `Net::HTTP` is used to transmit errors to the API server. If you
+would prefer to use your own HTTP library, you can override the
+{SquashUploader#http_post} method.
+
+Use as a Library
+----------------
+
+In addition to using the symbolication with Squash, you can also use the gem as
+a library, to perform symbolication for your own purposes (even unrelated to
+Squash). See the {Symbolicator} class documentation for more information. To
+use the gem, include `require 'squash/symbolicator'` in your code.

data/bin/squash_release

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'optparse'
+require 'rubygems'
+require 'squash/uploader'
+
+def git_revision(dir)
+  head = File.read(File.join(dir, '.git', 'HEAD')).chomp
+  if head =~ /^ref: (.+)$/
+    File.read(File.join(dir, '.git', $1)).chomp
+  else
+    raise "Couldn't determine current revision from #{head.inspect}"
+  end
+end
+
+project_dir = Dir.getwd
+revision    = nil
+options     = {}
+
+parser = OptionParser.new do |parser|
+  parser.banner = "Usage: squash_release [options] YOUR_SQUASH_HOST YOUR_API_KEY ENVIRONMENT BUILD_NUMBER"
+  parser.on('-o', '--open-timeout N', Integer, "HTTP connection open timeout") { |ot| options[:open_timeout] = ot }
+  parser.on('-r', '--read-timeout N', Integer, "HTTP connection data received timeout") { |rt| options[:read_timeout] = rt }
+  parser.on('-k', '--[no-]skip-verification', "Do not perform SSL peer verification") { |sv| options[:skip_verification] = sv }
+
+  parser.on('-p', '--project-dir F', "Specify a custom project directory (default current directory)") { |pd| project_dir = pd }
+  parser.on('-r', '--revision R', "Specify a code revision that was deployed (default current revision)") { |r| revision = r }
+
+  parser.on('-h', '--help', "Show this message") { puts parser; exit }
+  parser.on('--version', "Display version number of this program") { puts "1.0.0"; exit }
+end
+parser.parse!(ARGV)
+
+if ARGV.size != 4
+  puts parser
+  exit 1
+end
+
+host        = ARGV.shift
+api_key     = ARGV.shift
+environment = ARGV.shift
+build       = ARGV.shift
+revision    = revision || git_revision(project_dir)
+
+Squash::Uploader.new(host, options).transmit '/api/1.0/deploy.json',
+                                             {
+                                                 'project'     => {'api_key' => api_key},
+                                                 'environment' => {'name' => environment},
+                                                 'deploy'      => {
+                                                     'deployed_at' => Time.now,
+                                                     'revision'    => revision,
+                                                     'build'       => build
+                                                 }
+                                             }

data/bin/symbolicate

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'optparse'
+require 'base64'
+require 'zlib'
+require 'yaml'
+
+require 'rubygems'
+require 'squash/uploader'
+require 'squash_ios_symbolicator'
+
+def git_revision(dir)
+  head = File.read(File.join(dir, '.git', 'HEAD')).chomp
+  if head =~ /^ref: (.+)$/
+    File.read(File.join(dir, '.git', $1)).chomp
+  else
+    raise "Couldn't determine current revision from #{head.inspect}"
+  end
+end
+
+project_dir = ENV['PROJECT_DIR']
+dsym_file   = nil
+options     = {}
+
+parser = OptionParser.new do |parser|
+  parser.banner = "Usage: symbolicate YOUR_API_HOST [options]"
+  parser.on('-o', '--open-timeout N', Integer, "HTTP connection open timeout") { |ot| options[:open_timeout] = ot }
+  parser.on('-r', '--read-timeout N', Integer, "HTTP connection data received timeout") { |rt| options[:read_timeout] = rt }
+  parser.on('-k', '--[no-]skip-verification', "Do not perform SSL peer verification") { |sv| options[:skip_verification] = sv }
+
+  parser.on('-d', '--dsym-file F', "Specify a custom dSYM file (default $DWARF_DSYM_FILE_NAME)") { |df| dsym_file = df }
+  parser.on('-p', '--project-dir F', "Specify a custom project directory (default $PROJECT_DIR)") { |pd| project_dir = pd }
+
+  parser.on('-h', '--help', "Show this message") { puts parser; exit }
+  parser.on('--version', "Display version number of this program") { puts "1.0.0"; exit }
+end
+parser.parse!(ARGV)
+
+if ARGV.size != 1
+  puts parser
+  exit 1
+end
+
+host = ARGV.shift
+
+if ENV['DWARF_DSYM_FOLDER_PATH'] && ENV['DWARF_DSYM_FILE_NAME']
+  dsym_file ||= File.join(ENV['DWARF_DSYM_FOLDER_PATH'], ENV['DWARF_DSYM_FILE_NAME'])
+else
+  unless dsym_file
+    puts parser
+    exit 1
+  end
+end
+
+sym   = Symbolicator.new(dsym_file, project_dir)
+archs = sym.architectures
+uuids = Hash.new
+archs.each do |arch, uuid|
+  uuids[uuid] = [sym.symbols(arch), sym.lines(arch)]
+end
+
+Squash::Uploader.new(host, options).transmit '/api/1.0/symbolication.json',
+                                             'symbolications' =>
+                                                 uuids.map do |uuid, (symbols, lines)|
+                                                   {
+                                                       'uuid'    => uuid,
+                                                       'symbols' => Base64.encode64(Zlib::Deflate.deflate(symbols.to_yaml)),
+                                                       'lines'   => Base64.encode64(Zlib::Deflate.deflate(lines.to_yaml))
+                                                   }
+                                                 end

data/lib/squash/symbolicator/lines.rb

@@ -0,0 +1,80 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# An address ranged mapped to a specific line of code, as part of a {Lines}
+# aggregation. No symbol data is included.
+
+Squash::Symbolicator::Line = Struct.new(:start_address, :file, :line, :column)
+
+Squash::Symbolicator::Line.send(:define_method, :<=>) do |other|
+  raise ArgumentError unless other.kind_of?(Squash::Symbolicator::Line)
+  start_address <=> other.start_address
+end
+
+# An aggregation of the `Symbolicator::Line`s of a binary class. This class
+# is enumerable.
+
+class Squash::Symbolicator::Lines
+  include Enumerable
+
+  # Creates a new empty aggregation.
+
+  def initialize
+    @lines = Array.new
+  end
+
+  # Adds a line definition to the aggregation.
+  #
+  # @param [Fixnum] start_address The lowest program counter address
+  #   corresponding to this method or function.
+  # @param [String] file The path to the file where this line is found.
+  # @param [Fixnum] lineno The line number in `file`.
+  # @param [Fixnum] col The column number in `file`.
+
+  def add(start_address, file, lineno, col)
+    index   = @lines.find_index { |line| line.start_address > start_address }
+    new_line = Squash::Symbolicator::Line.new(start_address, file, lineno, col)
+
+    if index
+      @lines.insert index, new_line
+    else
+      @lines << new_line
+    end
+  end
+
+  # Returns the nearest `Symbolicator::Line` to a given program counter address.
+  #
+  # @param [Fixnum] address A program counter address.
+  # @return [Symbol, nil] The line corresponding to that address, or `nil` if
+  #   the address is not symbolicated.
+
+  def for(address)
+    return @lines.last if @lines.last && @lines.last.start_address == address
+    idx = @lines.find_index { |line| address < line.start_address }
+    return nil unless idx
+    return @lines[idx - 1]
+  end
+
+  # Delegated to `Array`.
+  def each(*args) @lines.each(*args) end
+  # Delegated to `Array`.
+  def [](*args) @lines[*args] end
+  # Delegated to `Array`.
+  def clear(*args) @lines.clear(*args) end
+  # Delegated to `Array`.
+  def size(*args) @lines.size(*args) end
+
+  # @private
+  def inspect() "#<#{self.class} [#{size} lines]>" end
+end

data/lib/squash/symbolicator/symbols.rb

@@ -0,0 +1,87 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# An address ranged mapped to a symbol (method or function name), as part of a
+# {Symbols} aggregation. The file and line where the symbol is declared is also
+# included.
+
+Squash::Symbolicator::Symbol = Struct.new(:start_address, :end_address, :file, :line, :method)
+
+Squash::Symbolicator::Symbol.send(:define_method, :<=>) do |other|
+  raise ArgumentError unless other.kind_of?(Squash::Symbolicator::Symbol)
+  if start_address == other.start_address
+    end_address <=> other.end_address
+  else
+    start_address <=> other.start_address
+  end
+end
+
+# An aggregation of the `Symbolicator::Symbol`s of a binary. This class is
+# enumerable.
+
+class Squash::Symbolicator::Symbols
+  include Enumerable
+
+  # Creates a new empty aggregation.
+
+  def initialize
+    @symbols = Array.new
+  end
+
+  # Adds a symbol definition to the aggregation.
+  #
+  # @param [Fixnum] start_address The lowest program counter address
+  #   corresponding to this method or function.
+  # @param [Fixnum] end_address The highest program counter address
+  #   corresponding to this method or function.
+  # @param [String] file The path to the file where this symbol is declared.
+  # @param [Fixnum] line The line number in `file` where this symbol is
+  #   declared.
+  # @param [String] symbol The method or function name.
+
+  def add(start_address, end_address, file, line, symbol)
+    index   = @symbols.find_index { |sym| sym.start_address > start_address || (sym.start_address == start_address && sym.end_address >= end_address) }
+    new_sym = Squash::Symbolicator::Symbol.new(start_address, end_address, file, line, symbol)
+
+    if index
+      @symbols.insert index, new_sym
+    else
+      @symbols << new_sym
+    end
+  end
+
+  # Returns the `Symbolicator::Symbol` containing a given program counter
+  # address. If there are symbols with overlapping address ranges, the one with
+  # the smallest range is returned.
+  #
+  # @param [Fixnum] address A program counter address.
+  # @return [Symbol, nil] The symbol corresponding to that address, or `nil` if
+  #   the address is not symbolicated.
+
+  def for(address)
+    @symbols.detect { |sym| sym.start_address <= address && sym.end_address >= address }
+  end
+
+  # Delegated to `Array`.
+  def each(*args) @symbols.each(*args) end
+  # Delegated to `Array`.
+  def [](*args) @symbols[*args] end
+  # Delegated to `Array`.
+  def clear(*args) @symbols.clear(*args) end
+  # Delegated to `Array`.
+  def size(*args) @symbols.size(*args) end
+
+  # @private
+  def inspect() "#<#{self.class} [#{size} symbols]>" end
+end

data/lib/squash/symbolicator.rb

@@ -0,0 +1,141 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'open3'
+
+module Squash
+
+  # Uses `dwarfdump` to generate symbolication information for a given dSYM
+  # file. Uses `POpen3` to shell out to `dwarfdump`.
+
+  class Symbolicator
+
+    # Creates a new symbolicator for a given dSYM file.
+    #
+    # @param [String] dsym The path to a dSYM file (or DWARF file within).
+    # @param [String] project_dir The path to a project root that will be removed
+    #   from file paths underneath that root.
+
+    def initialize(dsym, project_dir=nil)
+      @dsym        = dsym
+      @project_dir = project_dir
+    end
+
+    # @return [Hash<String, String>] A hash mapping architectures (such as "i386")
+    #   to the UUID for the symbolication of that architecture.
+
+    def architectures
+      architectures = Hash.new
+
+      stdin, stdout, stderr = Open3.popen3('dwarfdump', '-u', @dsym)
+      stdout.each_line do |line|
+        if line =~ /^UUID: ([0-9A-F\-]+) \((.+?)\) [^\s]+$/
+          architectures[$2] = $1
+        end
+      end
+
+      return architectures
+    end
+
+    # Extracts symbol information from the dSYM.
+    #
+    # @param [String] arch The architecture to extract symbols for.
+    # @return [Symbols] The symbols defined in the dSYM.
+    # @see #architectures
+
+    def symbols(arch)
+      symbolications     = Symbols.new
+      current_subprogram = nil
+
+      stdin, stdout, stderr = Open3.popen3('dwarfdump', '--debug-info', "--arch=#{arch}", @dsym)
+      stdout.each_line do |line|
+        if current_subprogram
+          if line =~ /^\s*AT_(\w+)\(\s*(.+?)\s*\)$/
+            tag   = $1
+            value = $2
+
+            case tag
+              when 'name', 'decl_file' # quoted strings
+                value = value[1..-2]
+              when 'decl_line' # decimal integers
+                value = value.to_i
+              when 'prototyped', 'external' # booleans
+                value = (value == '0x01')
+              when 'low_pc', 'high_pc' # hex integers
+                value = value.hex
+            end
+
+            current_subprogram[tag] = value
+          elsif line =~ /^0x[0-9a-f]+:\s+TAG_(\w+)/
+            current_subprogram['decl_file'].sub!(/^#{Regexp.escape @project_dir}\//, '') if @project_dir
+            symbolications.add current_subprogram['low_pc'],
+                               current_subprogram['high_pc'],
+                               current_subprogram['decl_file'],
+                               current_subprogram['decl_line'],
+                               current_subprogram['name']
+
+            current_subprogram = ($1 == 'subprogram') ? Hash.new : nil
+          end
+        else
+          if line =~ /^0x[0-9a-f]+:\s+TAG_subprogram\s+\[\d+\]\s+\*$/
+            current_subprogram = Hash.new
+          end
+        end
+      end
+
+      return symbolications
+    end
+
+    # Extracts line number information from the dSYM.
+    #
+    # @param [String] arch The architecture to extract symbols for.
+    # @return [Symbols] The line info defined in the dSYM.
+    # @see #architectures
+
+    def lines(arch)
+      lines        = Lines.new
+      current_line = nil
+
+      stdin, stdout, stderr = Open3.popen3('dwarfdump', '--debug-line', "--arch=#{arch}", @dsym)
+      stdout.each_line do |line|
+        if current_line
+          if line =~ /^include_directories\[\s+(\d+)\] = '(.+)'$/
+            current_line[:include_directories][$1] = $2
+          elsif line =~ /^file_names\[\s*(\d+)\]\s+(\d+)\s+0x[0-9a-f]+\s+0x[0-9a-f]+\s+(.+)$/
+            current_line[:file_names][$1] = current_line[:include_directories][$2] + '/' + $3
+          elsif line =~ /^            (0x[0-9a-f]+)\s+(\d+)\s+(\d+)\s+(\d+)\s+/
+            path          = current_line[:file_names][$2]
+            line          = $3.to_i
+            col           = $4.to_i
+            start_address = $1.hex
+            path.sub!(/^#{Regexp.escape @project_dir}\//, '') if @project_dir
+            lines.add start_address, path, line, col
+          end
+        else
+          if line =~ /^debug_line\[0x[0-9a-f]+\]$/
+            current_line = {
+                :include_directories => {},
+                :file_names          => {}
+            }
+          end
+        end
+      end
+
+      return lines
+    end
+  end
+end
+
+require 'squash/symbolicator/lines'
+require 'squash/symbolicator/symbols'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: squash_ios_symbolicator
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: plist
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: squash_uploader
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: yard
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: redcarpet
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: jeweler
+  version_requirements: *id006
+description: This gem includes a library that imports dwarfdump symbolications, and a binary that uploads the data to Squash.
+email: tim@squareup.com
+executables: 
+- symbolicate
+- squash_release
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- LICENSE.txt
+- README.md
+- bin/squash_release
+- bin/symbolicate
+- lib/squash/symbolicator.rb
+- lib/squash/symbolicator/lines.rb
+- lib/squash/symbolicator/symbols.rb
+homepage: http://github.com/SquareSquash/ios_symbolicator
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Binary and library for symbolicating your iOS project and uploading the symbolication to Squash.
+test_files: []
+