class_profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79286d695e8c01ec9433d4908005f7d6f232acd9
+  data.tar.gz: e3a38bcbf80398cabfd79ccde4b96ef7cdde7413
+SHA512:
+  metadata.gz: bde33ef191d9ee417feff45649ddf64daba6c5c61769b71b0bf0dea9bc551de74c14827fb6af00c326142cf981281cad7c7878bc3ee8d0753c76fc6dd85e97e8
+  data.tar.gz: 1373a8272789a554b327f67bf08ad735ca22f5ebda05b23f16a3c681f76aec1001165ce03f5cacb9f50952dee068ddffc8e6f1526ec3384c3c0ba96c314b2306

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vasilakisfil@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in class_profiler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Filippos Vasilakis
+
+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,80 @@
+# ClassProfiler
+Simple performance analyzer for Ruby classes. Just include it in the bottom of
+your class and let it analyze your Ruby class performance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'class_profiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install class_profiler
+
+## Usage
+It can be used only for classes. You need to include it in the **bottom** of your class:
+
+```ruby
+class Foobar
+  #includes/extend definitions
+
+  #methods
+  def hard_working_method
+  end
+  #more methods
+
+  include ClassProfiler #include it just before closing the class
+end
+```
+
+Or if you want something more configurable, to measure only specific methods and/or
+modules you can use this little API:
+```ruby
+include ClassProfiler.for(instance_methods: [
+  :on_correct_scale, :on_correct_currency, :as_financial_value
+], modules: [Financial, Company])
+```
+
+It comes with a built-in rack middleware to report you the whole request-response cycle
+(but you still have to `include ClassProfiler` in the classes of your interest)
+
+```ruby
+config.middleware.use ClassProfiler::Rack
+```
+
+If you want something more specific, then you only need to wrap the code of your
+interest under `start` block:
+
+```ruby
+ClassProfiler::Benchmark.instance.start 'MY LABEL' do
+  #code I want to benchmark
+end
+```
+
+Note that `ClassProfiler::Benchmark` class is a singleton.
+
+## How does it work?
+You can find details on the motivation and implementation in [this blog post](https://blog.kollegorna.se/ruby-performance-profiling-an-unorthodox-approach-69c549e3293b).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/vasilakisfil/class_profiler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "class_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,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/class_profiler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'class_profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "class_profiler"
+  spec.version       = ClassProfiler::VERSION
+  spec.authors       = ["Filippos Vasilakis"]
+  spec.email         = ["vasilakisfil@gmail.com"]
+
+  spec.summary       = %q{Simple class performance profiler with some metaprogramming alcohol}
+  spec.description   = %q{Simple class performance profiler with some metaprogramming alcohol}
+  spec.homepage      = "https://github.com/vasilakisfil/class_profiler"
+  spec.license       = "MIT"
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/class_profiler.rb

@@ -0,0 +1,87 @@
+require "class_profiler/version"
+require "class_profiler/benchmark"
+require "class_profiler/object_label"
+require "class_profiler/rack"
+
+#tons of metaprogramming and hacks, don't ask..
+module ClassProfiler
+  CONSTANTIZE = ->(string) {
+    string.split(':').select{|i|
+      !i.blank? && i.downcase != '<class' && !i.start_with?('0x')
+    }.map{|i|
+      i.gsub("#","").gsub("<","").gsub(">","")
+    }.join("::").constantize #use const_get
+  }
+
+  #add some metaprogramming here
+  IGNORED_METHODS = [Object, BasicObject, Class, Class.new, Module].map{|o|
+    array = []
+    [:private_instance_methods, :protected_instance_methods, :instance_methods].each do |m|
+      array.concat(o.send(m, true))
+    end
+
+    [:private_methods, :protected_methods, :methods].each do |m|
+      array.concat(o.send(m, true))
+    end
+    array
+  }.flatten.uniq - [:initialize]
+
+  def self.for(options = {})
+    methods = options[:instance_methods] || []
+    _caller = CONSTANTIZE.call(caller_locations(1,1)[0].label)
+
+    if options[:modules]
+      methods.concat(
+        options[:modules].map{|m|
+          _get_methods_for(m)
+        }
+      )
+    end
+
+    @__cp_instance_methods = methods.flatten.uniq
+
+    return self
+  end
+
+  def self.included(base)
+    @__cp_instance_methods = _get_methods_for(base, true) if @__cp_instance_methods.nil?
+
+    default_protected_methods = self.protected_instance_methods
+    default_private_methods = self.private_instance_methods
+
+    (@__cp_instance_methods).each do |method_name|
+      base.send(:alias_method, "__#{method_name}", method_name)
+
+      base.send(:define_method, method_name) do |*args, &block|
+        Benchmark.instance.start(label(__method__)){
+          if block
+            self.send("__#{method_name}", *args, &block)
+          else
+            self.send("__#{method_name}", *args)
+          end
+        }
+      end
+
+      protected(method_name) if default_protected_methods.include?(method_name)
+      private(method_name) if default_private_methods.include?(method_name)
+    end
+
+    @__cp_instance_methods = nil
+  end
+
+  def self._get_methods_for(_caller, inherited = false)
+    _caller.constantize if _caller.is_a? String #use const_get
+
+    array = []
+    array.concat(
+      _caller.instance_methods(inherited)
+    ).concat(
+      _caller.protected_instance_methods(inherited)
+    ).concat(
+      _caller.private_instance_methods(inherited)
+    )
+
+    return array unless inherited
+    return (array - IGNORED_METHODS).flatten.uniq
+  end
+end

data/lib/class_profiler/benchmark.rb

@@ -0,0 +1,67 @@
+require "class_profiler"
+
+class ClassProfiler::Benchmark
+  include Singleton
+
+  def initialize(options = {})
+    @options = options
+    @sum_hash = {}
+    @active_labels = []
+  end
+
+  def start(label, &block)
+    append_active_label(label)
+
+    value = nil
+    time = ::Benchmark.measure {
+      value = block.call
+    }.real
+
+    sum_hash[label] = {num: 0, sum: 0} if sum_hash[label].nil?
+    sum_hash[label][:num] += 1
+    sum_hash[label][:sum] += time.round(5)
+
+    remove_active_label(label)
+    return value
+  end
+
+  def start_and_report(label = 'Total Time', &block)
+    bench!(label, &block)
+
+    report!(label)
+  end
+
+  def report(total_label = nil)
+    printf "######### Performance Report #########\n"
+    if sum_hash[total_label]
+      total_time = sum_hash[total_label][:sum].round(5)
+      puts total_time
+      sum_hash.sort_by{|label, values| values[:sum]}.to_h.each{|label, values|
+        printf "%-150s %s (%s)\n", "#{label} (total time):", values[:sum].round(5), "#{((values[:sum]/ total_time) * 100).round(1)}%"
+        printf "%-150s %s\n", "#{label} (number of calls):", values[:num]
+        printf "%-150s %s\n\n", "#{label} (average time):", (values[:sum]/values[:num]).round(5)
+      }
+    end
+    printf "\n######### (most time consuming method is at the bottom) #########"
+
+    reset!
+  end
+
+  def reset!
+    self.sum_hash = {}
+  end
+
+  def active?
+    active_labels.any?
+  end
+
+  private
+    attr_accessor :sum_hash, :options, :active_labels
+    def append_active_label(label)
+      active_labels << label
+    end
+
+    def remove_active_label(label)
+      self.active_labels = active_labels.select{|i| i != label}
+    end
+end

data/lib/class_profiler/object_label.rb

@@ -0,0 +1,13 @@
+module ObjectLabel
+  def label(method_name, notes = nil)
+    if notes
+    "#{self.class.name}##{method_name} (#{notes})"
+    else
+    "#{self.class.name}##{method_name}"
+    end
+  end
+end
+
+class Object
+  include ObjectLabel
+end

data/lib/class_profiler/rack.rb

@@ -0,0 +1,16 @@
+module ClassProfiler
+  class Rack
+    def initialize(app)
+      @app  = app
+    end
+
+    def call(env)
+      response = ::ClassProfiler::Benchmark.instance.start 'rack time' do
+        @status, @headers, @response = @app.call(env)
+      end
+
+      ::ClassProfiler::Benchmark.instance.report('rack time')
+      return response
+    end
+  end
+end

data/lib/class_profiler/version.rb

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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: class_profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Filippos Vasilakis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Simple class performance profiler with some metaprogramming alcohol
+email:
+- vasilakisfil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- class_profiler.gemspec
+- lib/class_profiler.rb
+- lib/class_profiler/benchmark.rb
+- lib/class_profiler/object_label.rb
+- lib/class_profiler/rack.rb
+- lib/class_profiler/version.rb
+homepage: https://github.com/vasilakisfil/class_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.6.12
+signing_key: 
+specification_version: 4
+summary: Simple class performance profiler with some metaprogramming alcohol
+test_files: []