motion-profiler 0.0.1

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/*
+.yardoc/*
+doc/*
+.repl_history
+build
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2013 by Marcus Gartner
+
+Copyright (C) 2012 by Jimmy Cuadra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+[![Build Status](https://secure.travis-ci.org/change/method_profiler.png)](http://travis-ci.org/change/method_profiler) [![Code Climate](https://codeclimate.com/github/change/method_profiler.png)](https://codeclimate.com/github/change/method_profiler) [![endorse](http://api.coderwall.com/jimmycuadra/endorsecount.png)](http://coderwall.com/jimmycuadra)
+
+# MethodProfiler
+
+**MethodProfiler** collects performance information about the methods in your objects and creates reports to help you identify slow methods. The collected data can be sorted in various ways, converted into an array, or pretty printed as a table.
+
+## Basic usage
+
+Create a new profiler by passing the object you want to profile to `MethodProfiler.observe`. All future class and instance methods called on your object will be recorded by the profiler. To see the results of the profiling as a table, simply print out the report returned by `#report` on the profiler object.
+
+```ruby
+profiler = MethodProfiler.observe(MyClass)
+
+MyClass.labore_voluptatum
+MyClass.labore_voluptatum
+
+my_obj = MyClass.new
+
+my_obj.accusamus_est
+my_obj.accusamus_est
+my_obj.accusamus_est
+
+puts profiler.report
+```
+
+The resulting chart includes each method, the minimum time it took to run, the maximum time, the average across all calls, and the total number of times it was called. Class methods are prefixed by a `.` and instance methods are prefixed with a `#`.
+
+```
+MethodProfiler results for: MyClass
++-----------------------+-----------+------------+--------------+------------+-------------+
+| Method                | Min Time  | Max Time   | Average Time | Total Time | Total Calls |
++-----------------------+-----------+------------+--------------+------------+-------------+
+| #accusamus_est        | 28.722 ms | 393.649 ms | 150.543 ms   | 451.628 ms | 3           |
+| #autem_iste!          | 26.220 ms | 387.026 ms | 146.644 ms   | 439.933 ms | 3           |
+| #distinctio_eos       | 26.095 ms | 386.903 ms | 146.520 ms   | 439.559 ms | 3           |
+| #laborum_fugit        | 14.887 ms | 351.369 ms | 127.564 ms   | 382.692 ms | 3           |
+| #suscipit_architecto  | 9.876 ms  | 269.339 ms | 96.440 ms    | 289.319 ms | 3           |
+| #et_fugit             | 0.005 ms  | 63.101 ms  | 10.704 ms    | 64.225 ms  | 6           |
+| #porro_rerum          | 2.970 ms  | 15.137 ms  | 7.126 ms     | 21.378 ms  | 3           |
+| #provident_molestiae  | 0.097 ms  | 17.860 ms  | 1.134 ms     | 27.225 ms  | 24          |
+| #nisi_inventore       | 0.098 ms  | 15.076 ms  | 1.044 ms     | 54.272 ms  | 52          |
+| #quis_temporibus      | 0.004 ms  | 11.908 ms  | 0.643 ms     | 15.430 ms  | 24          |
+| .labore_voluptatum    | 0.440 ms  | 0.470 ms   | 0.455 ms     | 0.910 ms   | 2           |
+| #quia_est             | 0.004 ms  | 11.133 ms  | 0.453 ms     | 47.092 ms  | 104         |
+| #ut_reiciendis        | 0.004 ms  | 5.626 ms   | 0.346 ms     | 8.302 ms   | 24          |
+| #sint_quasi           | 0.062 ms  | 2.152 ms   | 0.188 ms     | 4.504 ms   | 24          |
+| #sed_at               | 0.065 ms  | 0.150 ms   | 0.085 ms     | 2.034 ms   | 24          |
+| #repellendus_suscipit | 0.051 ms  | 0.122 ms   | 0.070 ms     | 1.684 ms   | 24          |
+| .quas_nesciunt        | 0.058 ms  | 0.124 ms   | 0.062 ms     | 4.303 ms   | 69          |
+| #iure_quis            | 0.021 ms  | 0.025 ms   | 0.023 ms     | 0.069 ms   | 3           |
+| #dicta_ipsam          | 0.006 ms  | 0.266 ms   | 0.017 ms     | 0.798 ms   | 48          |
+| #perspiciatis_aut     | 0.004 ms  | 0.068 ms   | 0.013 ms     | 0.314 ms   | 24          |
+| .aperiam_laborum      | 0.005 ms  | 0.015 ms   | 0.006 ms     | 0.438 ms   | 69          |
+| #voluptas_ratione     | 0.005 ms  | 0.007 ms   | 0.006 ms     | 0.018 ms   | 3           |
+| #ex_voluptas          | 0.004 ms  | 0.010 ms   | 0.005 ms     | 0.212 ms   | 41          |
++-----------------------+-----------+------------+--------------+------------+-------------+
+```
+
+## Reporting
+
+`MethodProfiler::Profiler#report` actually returns a report object which can be used to sort and display the data in various ways. A report has chainable `#sort_by` and `#order` methods to control the sorting of the report when it is ultimately displayed. The report can be turned into an array by calling `#to_a` and the table shown above by calling `#to_s`.
+
+*Example of sorting by the number of total calls, ascending:*
+
+```ruby
+puts profiler.report.sort_by(:total_calls).order(:ascending)
+```
+
+`#sort_by` accepts a symbol or string with the name of any of the columns in the table: `:method`, `:min`, `:max`, `:average`, `:total_time`, or `:total_calls`.
+
+`#order` accepts a symbol or string of `:ascending` or `:descending`. These can also be abbreviated with `:asc` and `:desc`.
+
+## Documentation
+
+The public API is fully documented using [YARD](http://yardoc.org/) and can be viewed on [RubyDoc.info](http://rubydoc.info/).
+
+## Tests
+
+All code is tested with [RSpec](https://github.com/rspec/rspec). To run the specs, clone the repository, install the dependencies with `bundle install`, and then run `rake`.
+
+## Issues
+
+If you have any problems or suggestions for the project, please open a GitHub issue.
+
+## License
+
+MethodProfiler is available under the included MIT license.
+
+## Acknowledgements
+
+Thank you to [Change.org](http://www.change.org/) for sponsoring the project and to my coworker [Alain Bloch](https://github.com/alainbloch) for the inspiration.

data/Rakefile

@@ -0,0 +1,13 @@
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+$:.unshift("./lib/")
+require './lib/motion-profiler.rb'
+
+require 'motion-colorize'
+
+Motion::Project::App.setup do |app|
+  app.name = 'velocity'
+end

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    true
+  end
+end

data/lib/motion-profiler.rb

@@ -0,0 +1,9 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.dirname(__FILE__), 'motion-profiler/*.rb')).each do |file|
+    app.files.unshift(file)
+  end
+end

data/lib/motion-profiler/helper.rb

@@ -0,0 +1,14 @@
+module MotionProfiler
+
+  # Contains convenience methods.
+  module Helper
+
+    # A convenience method for observing a class with a profiler.
+    # The same as calling `MotionProfiler::Profiler.new(obj)`.
+    def observe(obj)
+      Profiler.new(obj)
+    end
+  end
+
+  extend Helper
+end

data/lib/motion-profiler/profiler.rb

@@ -0,0 +1,81 @@
+module MotionProfiler
+
+  # Velocity::Profiler collects execution time of method calls of an object.
+  class Profiler
+
+    # Initializes a new Profiler to observe the given object.
+    def initialize(obj)
+      @obj = obj
+      @data = Hash.new { |h, k| h[k] = [] }
+
+      wrap_methods_with_profiling(self)
+    end
+
+    # Returns a report of the profile data collected on the object.
+    def report
+      Report.new(final_data, @obj.name)
+    end
+
+    private
+
+    # Wraps all the methods of @obj to calculate exectuion time.
+    def wrap_methods_with_profiling(profiler)
+      [
+        { object: @obj.singleton_class, methods: @obj.methods(false), private: false, singleton: true },
+        { object: @obj, methods: @obj.instance_methods(false), private: false },
+        { object: @obj, methods: @obj.private_instance_methods(false), private: true }
+      ].each do |group|
+        group[:object].module_eval do
+          group[:methods].each do |method|
+            define_method("#{method}_with_profiling") do |*args, &block|
+              profiler.send(:profile, method, singleton: group[:singleton]) do
+                send("#{method}_without_profiling", *args, &block)
+              end
+            end
+
+            alias_method "#{method}_without_profiling", method
+            alias_method method, "#{method}_with_profiling"
+          end
+        end
+      end
+    end
+
+    # Profiles the block and records the elapsed time.
+    def profile(method, options = {}, &block)
+      method_name = options[:singleton] ? ".#{method}" : "##{method}"
+      elapsed_time, result = benchmark(block)
+      @data[method_name] << elapsed_time
+      result
+    end
+
+    # Returns the elapsed time taken for block_to_benchmark.
+    def benchmark(block_to_benchmark)
+      result = nil
+      t0 = Time.now
+      result = block_to_benchmark.call
+      return Time.now - t0, result
+    end
+
+    # Compiles the collected data into several useful catagories.
+    def final_data
+      results = []
+
+      @data.each do |method, records|
+        total_calls = records.size
+        total_time = records.reduce(:+)
+        average = total_time / total_calls
+        results << {
+          method: method,
+          min: records.min,
+          max: records.max,
+          average: average,
+          total_time: total_time,
+          total_calls: total_calls,
+        }
+      end
+
+      results
+    end
+
+  end
+end

data/lib/motion-profiler/report.rb

@@ -0,0 +1,71 @@
+# Add a convenience method to float for coverting from seconds to
+# milliseconds.
+class Float
+  def to_ms
+    "%.3f ms" % (self * 1000)
+  end
+end
+
+module MotionProfiler
+
+  # Sorts and displays data collected by a Profiler.
+  class Report
+
+    # Fields that can be passed to #sort_by.
+    FIELDS = [:method, :min, :max, :average, :total_time, :total_calls]
+
+    # Directions that can be passed to #order.
+    DIRECTIONS = [:asc, :desc,]
+
+    # Initializes a new Report.
+    def initialize(data, name)
+      @data = data
+      @name = name
+      @sort_by = :average
+      @order = :descending
+    end
+
+    # Sorts the report by the given field. Defaults to `:average`.
+    # Chainable with #order.
+    def sort_by(field)
+      field = field.to_sym
+      field = :average unless FIELDS.include?(field)
+      @sort_by = field
+      self
+    end
+
+    # Changes the direction of the sort. Defaults to `:desc`.
+    # Chainable with #sort_by.
+    def order(direction)
+      direction = direction.to_sym
+      direction = :desc unless DIRECTIONS.include?(direction)
+      @order = direction
+      self
+    end
+
+    # Sorts the data by order and sort_by and returns an array.
+    def to_a
+      if @order == :asc
+        @data.sort { |a, b| a[@sort_by] <=> b[@sort_by] }
+      else
+        @data.sort { |a, b| b[@sort_by] <=> a[@sort_by] }
+      end
+    end
+
+    # Returns a printable string of the sorted data.
+    def to_s
+      string = "\nVelocity results for: #{@name}\n".light_blue
+      self.to_a.each do |method_data|
+        string += "-- #{method_data.shift[1]}\n".red
+        method_data.each_pair do |metric, time|
+          if time.is_a?(Float)
+            time = time.to_ms
+          end
+          string += "  #{metric}: #{time}\n"
+        end
+      end
+      return string
+    end
+
+  end
+end

data/motion-profiler.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = "motion-profiler"
+  s.version     = "0.0.1"
+  s.authors     = ["Marcus Garter"]
+  s.email       = ["magartner@gmail.com"]
+  s.homepage    = "https://github.com/mgarter/motion-profiler"
+  s.summary     = %q{A profiler for RubyMotion.}
+  s.description = %q{A profiler for RubyMotion based on method_profiler.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'motion-colorize'
+end

data/spec/helpers/lion.rb

@@ -0,0 +1,32 @@
+# Helper class used for testing.
+class Lion
+
+  # TODO: Figure out why this breaks the profiler.
+  # def initialize(name)
+  #   @name = name
+  # end
+
+  def zzz(sec = 1)
+    sleep(sec)
+  end
+
+  def eat(n = 100)
+    privately do
+      100.times do
+        rand + rand
+      end
+    end
+  end
+
+  def hunt(n = 100)
+    n.times do
+      rand ** rand ** rand
+    end
+  end
+
+  private
+
+  def privately(&block)
+    block.call
+  end
+end

data/spec/main_spec.rb

@@ -0,0 +1,16 @@
+describe "Velocity" do
+  before do
+    @app = UIApplication.sharedApplication
+  end
+  it "should profile the class" do
+    profiler = MotionProfiler.observe(Lion)
+
+    lion = Lion.new
+    lion.hunt
+    lion.eat
+    lion.zzz
+
+    puts profiler.report
+    true.should.be ==  true
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: motion-profiler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marcus Garter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: motion-colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A profiler for RubyMotion based on method_profiler.
+email:
+- magartner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion-profiler.rb
+- lib/motion-profiler/helper.rb
+- lib/motion-profiler/profiler.rb
+- lib/motion-profiler/report.rb
+- motion-profiler.gemspec
+- spec/helpers/lion.rb
+- spec/main_spec.rb
+homepage: https://github.com/mgarter/motion-profiler
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A profiler for RubyMotion.
+test_files:
+- spec/helpers/lion.rb
+- spec/main_spec.rb