profilizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd6e4cb9fd428cdeb8fd286926b4755b2fe92963551f067dbeb39c4ea6039f34
+  data.tar.gz: 6cec08e96bc08e68ac506a8273abeb6a54dba4ebdbc13eb719b2cc992fa083ef
+SHA512:
+  metadata.gz: e6d8f8283746df3b427d5c8dc8ecb54fa53ae3f341a4f1ee61b3a47379d0bfec1e685e15384e1dd9554933167a7852f47cefed873536c3bd9e3c11eae4e9b5e1
+  data.tar.gz: 24ea81e36e5d27ed89efc988e7f8dff35b2cd1342d83c60ea4750338c620665454902018bb71cba452710c79ed027fb2f5192907def70ea510db1ddbd0c5d258

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+require: rubocop-rspec
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  MinNameLength: 2
+
+Metrics/BlockLength:
+  Exclude: 
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in profilizer.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+
+group :development, :test do
+  gem 'pry', '~> 0.12.2', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: false
+  gem 'simplecov-console', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    profilizer (0.1.0)
+      ruby2_keywords (~> 0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-console (0.7.2)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  profilizer!
+  pry (~> 0.12.2)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  simplecov
+  simplecov-console
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dzmitry Kremez
+
+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,125 @@
+# Profilizer
+
+Profilizer is a Ruby gem for easy profile of methods. It helps you to track how fast you methods are, how much memory the consume and how much objects were allocated. 
+
+The normal hand on profiling in Ruby doesn't require any gems and looks like this:
+
+```ruby
+def profile
+  start = Time.now
+  yield if block_given?
+  end = Time.now
+  puts "Duration: #{end - start}"
+end
+```
+
+However, it is not handy in case you want more options of you just need to repeat this code many time in different application.
+
+Here is what is gem propose instead:
+
+```ruby
+class A
+  include Profilizer
+
+  profilize def foo
+    a = 1
+    b = 2
+    c = a + b
+  end
+end
+
+A.new.foo 
+```
+
+It will output in STDOUT something like:
+
+```
+Objects Freed: 39
+Time: 0.02 seconds
+Memory usage: 2.05 MB
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'profilizer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install profilizer
+
+## Usage
+
+### Basic usage
+
+```ruby
+class A
+  include Profilizer
+
+  profilize def foo
+    a = 1
+    b = 2
+    c = a + b
+  end
+end
+
+A.new.foo 
+```
+
+It prints in STDOUT something like:
+
+```
+Objects Freed: 39
+Time: 0.02 seconds
+Memory usage: 2.05 MB
+```
+
+### Configuration
+
+What if you only want to profile time or just used memory or objects allocations only.
+Here is how you could config
+
+```ruby
+class A
+  include Profilizer
+
+  def foo
+    a = 1
+    b = 2
+    c = a + b
+  end
+
+  profilize :foo, time: true, memory: false, gc: false
+end
+
+A.new.foo 
+```
+
+It prints:
+
+```
+Time: 0.02 seconds
+```
+
+## 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/dkremez/profilizer.
+
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'profilizer'
+
+# 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/profilizer/profiler.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+
+module Profilizer
+  class Profiler
+    def profile_method(memory: true, time: true, gc: true)
+      profile_memory(!memory) do
+        profile_time(!time) do
+          profile_gc(!gc) do
+            yield
+          end
+        end
+      end
+    end
+
+    def profile_memory(skip, &block)
+      return block.call if skip
+
+      memory_usage_before = `ps -o rss= -p #{Process.pid}`.to_i
+      result = block.call
+      memory_usage_after = `ps -o rss= -p #{Process.pid}`.to_i
+
+      used_memory = ((memory_usage_after - memory_usage_before) / 1024.0).round(2)
+      puts "Memory usage: #{used_memory} MB"
+      result
+    end
+
+    def profile_time(skip, &block)
+      return block.call if skip
+
+      result = nil
+
+      time_elapsed = Benchmark.realtime do
+        result = block.call
+      end
+
+      puts "Time: #{time_elapsed.round(2)} seconds"
+      result
+    end
+
+    def profile_gc(skip, &block)
+      return block.call if skip
+
+      GC.start
+      before = GC.stat(:total_freed_objects)
+      result = block.call
+      GC.start
+      after = GC.stat(:total_freed_objects)
+
+      puts "Objects Freed: #{after - before}"
+      result
+    end
+  end
+end

data/lib/profilizer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Profilizer
+  VERSION = '0.1.0'
+end

data/lib/profilizer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'ruby2_keywords'
+
+require 'profilizer/profiler'
+require 'profilizer/version'
+
+module Profilizer
+  class ArgumentError < StandardError; end
+
+  OUR_BLOCK = lambda do
+    extend(ClassMethods)
+    extend ModuleMethods if instance_of?(Module)
+  end
+
+  private_constant :OUR_BLOCK
+
+  module ModuleMethods
+    def included(base = nil, &block)
+      if base.nil? && block
+        super do
+          instance_exec(&block)
+          instance_exec(&OUR_BLOCK)
+        end
+      else
+        base.instance_exec(&OUR_BLOCK)
+      end
+    end
+  end
+
+  extend ModuleMethods
+
+  module ClassMethods
+    def profilize(method_name, time: true, gc: true, memory: true)
+      prepend_profilizer_module!
+      define_profilized_method!(method_name, time: time, gc: gc, memory: memory)
+      method_name
+    end
+
+    private
+
+    def prepend_profilizer_module!
+      return if defined?(@_prifilizer_module)
+
+      @_prifilizer_module = Module.new { extend ProfilizerModule }
+      prepend @_prifilizer_module
+    end
+
+    def define_profilized_method!(*args, **kwargs)
+      @_prifilizer_module.public_send __method__, self, *args, **kwargs
+    end
+
+    module ProfilizerModule
+      def define_profilized_method!(klass, method_name, time: nil, gc: nil, memory: nil)
+        original_visibility = method_visibility(klass, method_name)
+
+        define_method method_name do |*args, &block|
+          result = nil
+          Profiler.new.profile_method(time: time, gc: gc, memory: memory) do
+            result = super(*args, &block)
+          end
+          result
+        end
+
+        ruby2_keywords method_name
+
+        send original_visibility, method_name
+      end
+
+      private
+
+      def method_visibility(klass, method_name)
+        if klass.private_method_defined?(method_name)
+          :private
+        elsif klass.protected_method_defined?(method_name)
+          :protected
+        elsif klass.public_method_defined?(method_name)
+          :public
+        else
+          raise ArgumentError, "Method #{method_name} is not defined on #{klass}"
+        end
+      end
+    end
+  end
+
+  # private_constant ProfilizerModule
+end

data/profilizer.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/profilizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'profilizer'
+  spec.version       = Profilizer::VERSION
+  spec.authors       = ['Dzmitry Kremez']
+  spec.email         = ['mr.dkremez@gmail.com']
+
+  spec.summary       = 'Profile you methods easier'
+  spec.description   = <<~DEC
+    Some times we need to test in development how long our methods execute,
+    how much memery code consumes, how many objects it allocates.
+    What if we don't want to touch the code a lot and just like kind of a decorator
+    that will log profile info into the console.
+    This gem helps to do it in one line of code.
+  DEC
+  spec.homepage      = 'https://github.com/dkremez/profilizer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency 'ruby2_keywords', '~> 0.0.2'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: profilizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dzmitry Kremez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: |
+  Some times we need to test in development how long our methods execute,
+  how much memery code consumes, how many objects it allocates.
+  What if we don't want to touch the code a lot and just like kind of a decorator
+  that will log profile info into the console.
+  This gem helps to do it in one line of code.
+email:
+- mr.dkremez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/profilizer.rb
+- lib/profilizer/profiler.rb
+- lib/profilizer/version.rb
+- profilizer.gemspec
+homepage: https://github.com/dkremez/profilizer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dkremez/profilizer
+  source_code_uri: https://github.com/dkremez/profilizer
+  changelog_uri: https://github.com/dkremez/profilizer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Profile you methods easier
+test_files: []