simple_profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1685cfb1b589526acc923cfbc8c9806d368b32d1
+  data.tar.gz: 6959fcfd29813c058f5a5fc612c3874b2f5c51a2
+SHA512:
+  metadata.gz: 03ed4d5171e8f7403d879b548274c397603105cb4bd7cdbbe81bbd0f096f46053ed9fef4ecb12a060f782915f07daacd3b6befdf70bdd3709feb582db370d20c
+  data.tar.gz: 840a8fb61993ae559cb1d9a9be115bb57c36e7d990f015503f06904601c36fd075093d7620ee79cce8fcc457855272f408476ce7dd4829093d79466088676d69

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: MvID3lGDWmo8LqUQbdx0tL3ggoNqvMYD0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+simple_profiler

data/.ruby-version

@@ -0,0 +1 @@
+ruby 2.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - jruby
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_profiler.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -0,0 +1,78 @@
+# SimpleProfiler
+
+[![Gem Version](https://badge.fury.io/rb/simple_profiler.png)](https://rubygems.org/gems/simple_profiler)
+[![Build Status](https://travis-ci.org/gabynaiman/simple_profiler.png?branch=master)](https://travis-ci.org/gabynaiman/simple_profiler)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/simple_profiler/badge.png?branch=master)](https://coveralls.io/r/gabynaiman/simple_profiler?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/simple_profiler.png)](https://codeclimate.com/github/gabynaiman/simple_profiler)
+[![Dependency Status](https://gemnasium.com/gabynaiman/simple_profiler.png)](https://gemnasium.com/gabynaiman/simple_profiler)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_profiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_profiler
+
+## Usage
+
+```ruby
+class MyClass
+  def execute
+    ...
+  end
+
+  def self.execute!
+    ...
+  end
+end
+```
+
+**Configuration**
+```ruby
+SimpleProfiler.profile_class_methods MyClass, :execute!
+SimpleProfiler.profile_instance_methods MyClass, :execute
+
+summary_reporter = SimpleProfiler::Reporters::Summary.new
+logger_reporter = SimpleProfiler::Reporters::Logger.new Logger.new('profile.log')
+
+SimpleProfiler.configure do |config|
+  config.reporters = [summary_reporter, logger_reporter]
+end
+```
+
+**Summary**
+```ruby
+ranking = summary_reporter.summary.ranking
+    
+ranking[0][:klass] # => 'MyClass'
+ranking[0][:method] # => :execute
+ranking[0][:hits] # => hits count
+```
+
+**Logger**
+```
+# Logfile created on 2016-05-31 15:12:30 -0300 by profile.rb/41954
+D, [2016-05-31T15:12:30.302556 #7582] DEBUG -- : MyClass.execute! -> 0.0 sec. - 0.0MB - (Total Memory: 36.80078125MB)
+D, [2016-05-31T15:12:30.302642 #7582] DEBUG -- : MyClass.execute! -> 0.0 sec. - 0.0MB - (Total Memory: 36.80078125MB)
+D, [2016-05-31T15:12:30.302694 #7582] DEBUG -- : MyClass.execute! -> 0.0 sec. - 0.0MB - (Total Memory: 36.80078125MB)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/simple_profiler.
+

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+desc 'Console'
+task :console do
+  require 'pry'
+  require 'simple_profiler'
+  ARGV.clear
+  Pry.start
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_profiler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_profiler/event.rb

@@ -0,0 +1,17 @@
+module SimpleProfiler
+  class Event < Struct.new(:klass, :target, :method, :args, :started_at, :finalized_at, :memory_at_beginning, :memory_at_end)
+    
+    def total_time
+      finalized_at - started_at
+    end
+
+    def used_memory
+      memory_at_end - memory_at_beginning
+    end
+
+    def to_s
+      separator = target == :class ? '.' : '#'
+      "#{klass}#{separator}#{method} -> #{total_time.round(4)} sec. - #{used_memory}MB - (Total Memory: #{memory_at_end}MB)"
+    end
+  end
+end

data/lib/simple_profiler/reporters/logger.rb

@@ -0,0 +1,26 @@
+module SimpleProfiler
+  module Reporters
+    class Logger
+
+      def initialize(logger, options={})
+        @options = options
+        @logger = logger
+      end
+
+      def notify(event)
+        logger.debug event.to_s if login?(event)
+      end
+
+      private
+
+      attr_reader :logger
+      attr_reader :options    
+
+      def login?(event)
+        event.total_time >= options.fetch(:min_time, 0) || 
+        event.used_memory >= options.fetch(:min_memory, 0)
+      end
+
+    end
+  end
+end

data/lib/simple_profiler/reporters/summary.rb

@@ -0,0 +1,50 @@
+module SimpleProfiler
+  module Reporters
+    class Summary
+
+      attr_reader :events
+      
+      def initialize
+        @events = []
+      end
+
+      def notify(event)
+        @events << event
+      end
+
+      def ranking(options={})
+        order = options.fetch(:sort_by, :total_time)
+
+        events_by_method = events.group_by {|e| {klass: e.klass.to_s, method: e.method, target: e.target}}
+        ranking = events_by_method.map do |key, values|
+          key.merge statistics_for(values)
+        end
+        
+        ranking.sort_by {|e| e[order]}.reverse
+      end
+
+      private
+
+      def statistics_for(events)
+        count = 0
+        total_time = 0
+        total_memory = 0
+
+        events.each do |e|
+          count += 1
+          total_time += e.total_time
+          total_memory += e.used_memory
+        end
+
+        {
+          hits: count, 
+          total_time: total_time, 
+          avg_time: count == 0 ? 0 : total_time / count, 
+          total_memory: total_memory, 
+          avg_memory: count == 0 ? 0 : total_memory / count
+        }
+      end
+
+    end
+  end
+end

data/lib/simple_profiler/version.rb

@@ -0,0 +1,3 @@
+module SimpleProfiler
+  VERSION = "0.1.0"
+end

data/lib/simple_profiler.rb

@@ -0,0 +1,65 @@
+require 'datacenter'
+require 'class_config'
+
+require_relative 'simple_profiler/version'
+require_relative 'simple_profiler/event'
+require_relative 'simple_profiler/reporters/logger'
+require_relative 'simple_profiler/reporters/summary'
+
+Datacenter.logger.level = Logger::ERROR
+
+module SimpleProfiler
+
+  extend ClassConfig
+  attr_config :reporters, [SimpleProfiler::Reporters::Logger.new(Logger.new(STDOUT))]
+
+  class << self
+    
+    def profile_instance_methods(klass, *methods)
+      methods.each do |method|
+        new_method = "__#{method}_profiled__"
+        klass.send :alias_method, new_method, method
+        klass.send(:define_method, method) do |*args, &block|
+          SimpleProfiler.track klass, :instance, method, args do
+            send new_method, *args, &block
+          end
+        end
+      end
+    end
+
+    def profile_class_methods(klass, *methods)
+      methods.each do |method|
+        new_method = "__#{method}_profiled__"
+        klass.singleton_class.send :alias_method, new_method, method
+        klass.send(:define_singleton_method, method) do |*args, &block|
+          SimpleProfiler.track klass, :class, method, args do
+            send new_method, *args, &block
+          end
+        end
+      end
+    end
+
+    def track(klass, target, method, args)
+      started_at = Time.now
+      memory = process.memory
+      
+      result = yield
+      
+      notify Event.new(klass, target, method, args, started_at, Time.now, memory, process.memory)
+      result
+    end
+
+    private
+
+    def notify(event)
+      reporters.each do |report|
+        report.notify event
+      end
+    end
+
+    def process
+      @process ||= Datacenter::Process.new Process.pid
+    end
+
+  end
+end

data/simple_profiler.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_profiler"
+  spec.version       = SimpleProfiler::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+  spec.summary       = 'Simple Profiler'
+  spec.description   = 'Simple Profiler'
+  spec.homepage      = 'https://github.com/gabynaiman/simple_profiler'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'datacenter', '~> 0.3'
+  spec.add_dependency 'class_config', '~> 0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", '~> 4.7'
+  spec.add_development_dependency 'turn', '~> 0.9'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/coverage_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start

data/spec/minitest_helper.rb

@@ -0,0 +1,24 @@
+require 'coverage_helper'
+require 'simple_profiler'
+require 'minitest/autorun'
+require 'turn'
+require 'pry-nav'
+
+Turn.config do |c|
+  c.format = :pretty
+  c.natural = true
+  c.ansi = true
+end
+
+class Minitest::Spec
+
+  let(:temp_path) {File.expand_path "./tmp", File.dirname(__FILE__)}
+
+  before do
+    FileUtils.mkpath temp_path
+  end
+
+  after do
+    FileUtils.rm_rf temp_path
+  end
+end

data/spec/simple_profiler_spec.rb

@@ -0,0 +1,85 @@
+require 'minitest_helper'
+
+describe SimpleProfiler do
+
+  class TestRunner
+    def self.run
+      'profile_class_methods OK'
+    end
+    def run
+      'profile_instance_methods OK'
+    end
+  end
+
+  class TestReporter
+    def initialize(filename)
+      @filename = filename
+    end
+    def notify(event)
+      File.write @filename, "#{event.klass}-#{event.method}"
+    end
+  end
+
+  SimpleProfiler.profile_class_methods    TestRunner, :run
+  SimpleProfiler.profile_instance_methods TestRunner, :run
+
+  it 'Profile class methods' do
+    filename = File.join temp_path, "file_#{(Time.now.to_f * 1000).to_i}.txt"
+
+    SimpleProfiler.configure do |config|
+      config.reporters = [TestReporter.new(filename)]
+    end
+
+    TestRunner.run.must_equal 'profile_class_methods OK'
+    File.exist?(filename).must_equal true
+    File.read(filename).must_equal "TestRunner-run"
+  end
+
+  it 'Profile instance methods' do
+    filename = File.join temp_path, "file_#{(Time.now.to_f * 1000).to_i}.txt"
+
+    SimpleProfiler.configure do |config|
+      config.reporters = [TestReporter.new(filename)]
+    end
+
+    TestRunner.new.run.must_equal 'profile_instance_methods OK'
+    File.exist?(filename).must_equal true
+    File.read(filename).must_equal "TestRunner-run"
+  end
+
+  it 'Profile with logger' do
+    filename = File.join temp_path, "file_#{(Time.now.to_f * 1000).to_i}.log"
+    logger = ::Logger.new filename
+
+    SimpleProfiler.configure do |config|
+      config.reporters = [SimpleProfiler::Reporters::Logger.new(logger)]
+    end
+
+    3.times do
+      TestRunner.run.must_equal 'profile_class_methods OK'
+    end
+
+    File.exist?(filename).must_equal true
+    file = File.read(filename)
+    file.lines.count.must_equal 4
+  end
+
+  it 'Profile with summary' do
+    SimpleProfiler.configure do |config|
+      config.reporters = [SimpleProfiler::Reporters::Summary.new]
+    end
+
+    3.times do
+      TestRunner.run.must_equal 'profile_class_methods OK'
+    end
+
+    summary = SimpleProfiler.reporters.first
+    ranking = summary.ranking
+    
+    ranking.count.must_equal 1
+    ranking[0][:klass].must_equal 'TestRunner'
+    ranking[0][:method].must_equal :run
+    ranking[0][:hits].must_equal 3
+  end
+
+end

data/spec/summary_spec.rb

@@ -0,0 +1,40 @@
+require 'minitest_helper'
+
+describe 'Summary' do
+
+  let(:events) do
+    [
+      SimpleProfiler::Event.new(Struct, :class, :run, [], Time.now, Time.now+1, 5, 10),
+      SimpleProfiler::Event.new(Struct, :class, :run, [], Time.now, Time.now+1, 10, 15),
+      SimpleProfiler::Event.new(Struct, :instance, :run, [], Time.now, Time.now+1, 15, 16)
+    ]
+  end
+  
+  it 'Accumulate events' do
+    summary = SimpleProfiler::Reporters::Summary.new
+    events.each do |event|
+      summary.notify event
+    end
+
+    summary.events.must_equal events
+  end
+
+  it 'Ranking' do
+    summary = SimpleProfiler::Reporters::Summary.new
+    events.each do |event|
+      summary.notify event
+    end
+    ranking = summary.ranking(sort_by: :hits)
+
+    ranking.count.must_equal 2
+    ranking[0][:klass].must_equal 'Struct'
+    ranking[0][:target].must_equal :class
+    ranking[0][:method].must_equal :run
+    ranking[0][:hits].must_equal 2
+    ranking[1][:klass].must_equal 'Struct'
+    ranking[1][:target].must_equal :instance
+    ranking[1][:method].must_equal :run
+    ranking[1][:hits].must_equal 1
+  end
+
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: simple_profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: datacenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: class_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Profiler
+email:
+- gabynaiman@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_profiler.rb
+- lib/simple_profiler/event.rb
+- lib/simple_profiler/reporters/logger.rb
+- lib/simple_profiler/reporters/summary.rb
+- lib/simple_profiler/version.rb
+- simple_profiler.gemspec
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/simple_profiler_spec.rb
+- spec/summary_spec.rb
+homepage: https://github.com/gabynaiman/simple_profiler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple Profiler
+test_files:
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/simple_profiler_spec.rb
+- spec/summary_spec.rb