micro_profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b34ad848510743470428cf46f8b887824a7ebab819e15a12826882ee2d8ea99
+  data.tar.gz: 91a3c0b348c2606eb4dd773435583c5556ccdd2054d0116f7e4a56e9649d1ef6
+SHA512:
+  metadata.gz: 41fb54cd074609d20048951bfeed9e1df750f999c25e7e03062dbc3a692b6833ab18e83cd9f6729373bfe05453145f75c2faf875e2287db6eb680643e10a964e
+  data.tar.gz: 6a5b58e6bb8affd25fc5f3ae9e354287d7e614b9d97e8f69468633e19ed8b1d9d5516ac9fba12a47aa6c4887f64a302c537b5458913ba9947c01d7cbbe713744

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.rspec_status

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in micro_profiler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    micro_profiler (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  micro_profiler!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jayson Virissimo
+
+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,62 @@
+# MicroProfiler
+
+Did you ever wish you had a Ruby performance profiler with almost no features?
+
+No? Well, if you did, then this is the gem for you!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'micro_profiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install micro_profiler
+
+## Usage
+Just wrap the code you want to profile in a block like this:
+```ruby
+def expensive_method
+  MicroProfiler.measure do
+    array = []
+    10000.times do
+      string = 'ABC' * 1000
+      array.unshift(string)
+    end
+    array
+  end
+end
+```
+
+And the measurements will print to STDOUT like this:
+```
+--- Performance Measurements ---
+Calling Method: #expensive_method:26
+Garbage Collection: Disabled
+Memory Usage: 89 MB
+Number of Garbage Collection Runs: 4
+Time Elapsed: 0.06 seconds
+```
+
+By default, garbage collection is disabled. Re-enable it by passing `garbage_collection: true` to `MicroProfiler.measure`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/jaysonvirissimo/micro-profiler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "micro_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(__FILE__)

data/bin/setup

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

data/lib/micro_profiler.rb

@@ -0,0 +1,92 @@
+require 'micro_profiler/version'
+require 'benchmark'
+
+class MicroProfiler
+  TIME_PRECISION = 2
+
+  def self.measure(garbage_collection: false, block: Proc.new)
+    new(garbage_collection: garbage_collection).measure(block: block)
+  end
+
+  def initialize(garbage_collection: false)
+    @garbage_collection = garbage_collection
+  end
+
+  def measure(result: nil, block: Proc.new)
+    calling_method
+    before
+    self.time = Benchmark.realtime { result = block.call }
+    after
+
+    print_measurements
+    result
+  end
+
+  private
+
+  attr_accessor :time
+  attr_reader :garbage_collection
+
+  def after
+    ending_memory_usage
+    ending_garbage_collection_count
+  end
+
+  def before
+    starting_garbage_collection_count
+    starting_memory_usage
+  end
+
+  def calling_method
+    @calling_method ||= "##{caller_locations[2].label}:#{caller_locations[2].lineno}"
+  end
+
+  def current_garbage_collection_count
+    GC.stat[:count].to_i
+  end
+
+  def current_memory_usage
+    `ps -o rss= -p #{Process.pid}`.to_i / 1024
+  end
+
+  def ending_garbage_collection_count
+    @ending_garbage_collection_count ||= current_garbage_collection_count
+  end
+
+  def ending_memory_usage
+    @ending_memory_usage ||= current_memory_usage
+  end
+
+  def formatted_memory_usage
+    format('%d MB', (ending_memory_usage - starting_memory_usage))
+  end
+
+  def garbage_collection_runs
+    ending_garbage_collection_count - starting_garbage_collection_count
+  end
+
+  def handle_garbage_collection
+    if garbage_collection
+      GC.start
+    else
+      GC.disable
+    end
+  end
+
+  def print_measurements
+    puts '--- Performance Measurements ---'
+    puts "Calling Method: #{calling_method}"
+    puts "Garbage Collection: #{garbage_collection ? 'Enabled' : 'Disabled'}"
+    puts "Memory Usage: #{formatted_memory_usage}"
+    puts "Number of Garbage Collection Runs: #{garbage_collection_runs}"
+    puts "Time Elapsed: #{time.round(TIME_PRECISION)} seconds"
+  end
+
+  def starting_garbage_collection_count
+    @starting_garbage_collection_count ||= current_garbage_collection_count
+  end
+
+  def starting_memory_usage
+    @starting_memory_usage ||= current_memory_usage
+  end
+end

data/lib/micro_profiler/version.rb

@@ -0,0 +1,3 @@
+class MicroProfiler
+  VERSION = "0.1.0"
+end

data/micro_profiler.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "micro_profiler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "micro_profiler"
+  spec.version       = MicroProfiler::VERSION
+  spec.authors       = ["Jayson Virissimo"]
+  spec.email         = ["jayson.virissimo@asu.edu"]
+
+  spec.summary       = %q{A minimalistic performance profiler}
+  spec.description   = %q{Measure time, memory usage, and GC runs of Ruby code}
+  spec.homepage      = "https://github.com/jaysonvirissimo/micro-profiler"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org/'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: micro_profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jayson Virissimo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Measure time, memory usage, and GC runs of Ruby code
+email:
+- jayson.virissimo@asu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/micro_profiler.rb
+- lib/micro_profiler/version.rb
+- micro_profiler.gemspec
+homepage: https://github.com/jaysonvirissimo/micro-profiler
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A minimalistic performance profiler
+test_files: []