koine-profiler 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6cf14a8e986ee18a7bf62d8789fb178c6c79b506
-  data.tar.gz: 63326ff4d1822874a9c5ebd7053016fc5e3d6977
+SHA256:
+  metadata.gz: 2603470fb2462b192b7290f6930c6c3aa4a71b94a198eb01ea34a4d0e1bcd90e
+  data.tar.gz: e9d010acbfd05cfeb38dc721c87daf27517e7d049813a7a50ca210145c43810b
 SHA512:
-  metadata.gz: 922a971e1f4457345eefdec93df54a38a7ba1e1b5c1cbd6cf84a53f06db5da73254886f0499104f13846099d15f93ffcfa482ac9edab23e481dd147ae0a6074c
-  data.tar.gz: 43842ed68421c9196aef2def2426f7ef77e3ddd2a1e66b19bb4e06074f674ced540564483230c0bbb2f04e7c2f5fe8d2773d8e109b20d24c8829756869f519a0
+  metadata.gz: 30d0fc8cbb86571c2e7142a4af368c64ac715998f8522db06624548630cddb67d9f96cb7b0482e6f3e36cd9208054c39e578554ee6f48d9a25e1236107a2c8a2
+  data.tar.gz: 8e41780379d1db9d9c44ce5edc46c032ee00a9cabe43a189bdd1e04adf1d7e949260bbab2c2fc6601bff927b26fb0d469b97481e30720ee0045d38b1a0ad45c7

data/.rspec

@@ -1,2 +1 @@
---format documentation
 --color

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Marcelo Jacobus
+Copyright (c) 2017-2020 Marcelo Jacobus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,8 +5,6 @@ Simple profiler
 [![Build Status](https://travis-ci.org/mjacobus/koine-profiler.svg?branch=master)](https://travis-ci.org/mjacobus/koine-profiler)
 [![Code Coverage](https://scrutinizer-ci.com/g/mjacobus/koine-profiler/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mjacobus/koine-profiler/?branch=master)
 [![Code Climate](https://codeclimate.com/github/mjacobus/koine-profiler/badges/gpa.svg)](https://codeclimate.com/github/mjacobus/koine-profiler)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mjacobus/koine-profiler/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mjacobus/koine-profiler/?branch=master)
-[![Dependency Status](https://gemnasium.com/mjacobus/koine-profiler.svg)](https://gemnasium.com/mjacobus/koine-profiler)
 [![Gem Version](https://badge.fury.io/rb/koine-profiler.svg)](https://badge.fury.io/rb/koine-profiler)
 
 ## Installation
@@ -28,6 +26,8 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+profiler = Koine::Profiler.new
+
 profiler.profile('some potentially slow task') do
   potentially_slow()
 end
@@ -44,12 +44,16 @@ require 'koine/profiler/reporters/cli'
 
 reporter = Koine::Profiler::Reporters::Cli.new
 
-# all
-reporter.report(entries)
+reporter.report(reporter.entries)
+```
+
+Output example:
 
-# 5 slowest
-five_slowest = profile.entries.slowest.limit(5)
-reporter.report(five_slowest)
+```text
++----------------------------+-------------------+--------------+---------+
+| Entry                      | Elapsed Time      | Memory       | # hits  |
+| some potentially slow task | 48.59363997100241 | 7.5625       | 1000000 |
++----------------------------+-------------------+--------------+---------+
 ```
 
 ## Development

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "koine/profiler"
+require 'bundler/setup'
+require 'koine/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.
@@ -10,5 +10,5 @@ require "koine/profiler"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/examples/profiling_example.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'koine/profiler'
+require 'koine/profiler/reporters/cli'
+
+MAX = 1_000_000
+
+reporter = Koine::Profiler::Reporters::Cli.new
+profiler = Koine::Profiler.instance
+
+profiler.profile('arrays integers') do
+  data = []
+  1.upto(MAX).each do |num|
+    profiler.profile('arrays integers item') do
+      data << num
+    end
+  end
+  data.length
+end
+
+profiler.profile('arrays hashes') do
+  data = []
+  1.upto(MAX).each do |num|
+    profiler.profile('arrays hashes item') do
+      data << { num: num }
+    end
+  end
+  data.length
+end
+
+reporter.report(profiler.entries)
+
+# Output example:
+#
+# +----------------------+-------------------+--------------+---------+
+# | Entry                | Elapsed Time      | Memory       | # hits  |
+# | arrays integers item | 48.59363997100241 | 7.5625       | 1000000 |
+# | arrays integers      | 50.281231385      | 8.14453125   | 1       |
+# | arrays hashes item   | 64.81660490299825 | 152.8828125  | 1000000 |
+# | arrays hashes        | 66.691896445      | 264.04296875 | 1       |
+# +----------------------+-------------------+--------------+---------+

data/koine-profiler.gemspec

@@ -4,36 +4,38 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'koine/profiler/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "koine-profiler"
+  spec.name          = 'koine-profiler'
   spec.version       = Koine::Profiler::VERSION
-  spec.authors       = ["Marcelo Jacobus"]
-  spec.email         = ["marcelo.jacobus@gmail.com"]
+  spec.authors       = ['Marcelo Jacobus']
+  spec.email         = ['marcelo.jacobus@gmail.com']
 
-  spec.summary       = %q{A simple profiler}
-  spec.description   = %q{A simple profiler for profiling tests, for instance}
-  spec.homepage      = "https://github.com/mjacobus/koine-profiler"
-  spec.license       = "MIT"
+  spec.summary       = 'A simple profiler'
+  spec.description   = 'A simple profiler for profiling tests, for instance'
+  spec.homepage      = 'https://github.com/mjacobus/koine-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"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    fail '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|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'terminal-table'
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'get_process_mem'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'object_comparator'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/koine/profiler.rb

@@ -1,24 +1,41 @@
-require "koine/profiler/version"
-require "koine/profiler/entries"
-require "koine/profiler/entry_group"
-require "koine/profiler/entry"
+require 'koine/profiler/version'
+require 'koine/profiler/entry'
+require 'get_process_mem'
 
 module Koine
   class Profiler
-    attr_reader :entries
-
     def initialize
-      @entries = Entries.new
+      @entries = {}
     end
 
     def profile(name)
       value = nil
       start_time = Time.now.utc
+      start_memory = GetProcessMem.new.mb
       value = yield if block_given?
+      finish_memory = GetProcessMem.new.mb
       finish_time = Time.now.utc
-
-      entries.append(name, finish_time - start_time)
+      add_entry(
+        name,
+        time: finish_time - start_time,
+        memory: finish_memory - start_memory
+      )
       value
     end
+
+    def entries
+      @entries.values
+    end
+
+    def self.instance
+      @instance ||= new
+    end
+
+    private
+
+    def add_entry(name, time:, memory:)
+      entry = @entries[name] ||= Entry.new(name)
+      entry.increment(elapsed_time: time, memory_used: memory)
+    end
   end
 end

data/lib/koine/profiler/entry.rb

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
+
 module Koine
   class Profiler
     class Entry
-      attr_reader :name, :elapsed_time
-
-      def initialize(name, elapsed_time)
-        @name, @elapsed_time = name.to_s, elapsed_time
-      end
+      attr_reader :name
+      attr_reader :elapsed_time
+      attr_reader :memory_used
+      attr_reader :hits
 
-      def ==(other)
-        other.name == name && other.elapsed_time == elapsed_time
+      def initialize(name)
+        @name = name
+        @elapsed_time = 0
+        @memory_used = 0
+        @hits = 0
       end
 
-      def <=>(other)
-         elapsed_time <=> other.elapsed_time
+      def increment(elapsed_time:, memory_used:)
+        @hits += 1
+        @elapsed_time += elapsed_time
+        @memory_used += memory_used
       end
     end
   end

data/lib/koine/profiler/reporters/cli.rb

@@ -10,10 +10,10 @@ module Koine
         end
 
         def report(entries)
-          @table << ['Entry', 'Elapsed Time', '# of calls']
+          @table << ['Entry', 'Elapsed Time', 'Memory', '# hits']
 
           entries.each do |entry|
-            @table << [entry.name, entry.elapsed_time, entry.entries.size]
+            @table << [entry.name, entry.elapsed_time, entry.memory_used, entry.hits]
           end
 
           @output << @table

data/lib/koine/profiler/version.rb

@@ -1,5 +1,5 @@
 module Koine
   class Profiler
-    VERSION = "0.1.0"
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koine-profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marcelo Jacobus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terminal-table
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: object_comparator
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,11 +139,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/profiling_example.rb
 - koine-profiler.gemspec
 - lib/koine/profiler.rb
-- lib/koine/profiler/entries.rb
 - lib/koine/profiler/entry.rb
-- lib/koine/profiler/entry_group.rb
 - lib/koine/profiler/reporters/cli.rb
 - lib/koine/profiler/version.rb
 homepage: https://github.com/mjacobus/koine-profiler
@@ -138,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple profiler

data/lib/koine/profiler/entries.rb

@@ -1,79 +0,0 @@
-require 'forwardable'
-
-module Koine
-  class Profiler
-    class Entries
-      extend Forwardable
-
-      def_delegators :storage, :size
-      def_delegators :to_a, :each
-
-      def initialize(groups = [])
-        @storage = Hash.new
-        groups.each { |group| append_group(group) }
-      end
-
-      def append(name, time)
-        group = find_by_name(name) || create_group(name)
-        append_to_group(group, name, time)
-      end
-
-      def find_by_name(name)
-        storage[name.to_s]
-      end
-
-      def elapsed_time
-        storage.inject(0) do |total, (_key, group)|
-          total + group.elapsed_time
-        end
-      end
-
-      def sort_by(&_block)
-        sorted = storage.sort_by { |item| yield(item[1]) }.map {|_key, group| group }
-        create(sorted)
-      end
-
-      def reverse
-        create(storage.to_a.reverse.map { |_key, group| group })
-      end
-
-      def slowest
-        sort_by(&:elapsed_time).reverse
-      end
-
-      def to_a
-        storage.values
-      end
-
-      def limit(number)
-        create(to_a.slice(0, number.to_i))
-      end
-
-      def ==(other)
-        storage.to_a == other.storage.to_a
-      end
-
-      private
-
-      def create(groups = [])
-        self.class.new(groups)
-      end
-
-      def create_group(name)
-        append_group(EntryGroup.new(name))
-      end
-
-      def append_group(group)
-        storage[group.name] = group
-      end
-
-      def append_to_group(group, name, time)
-        group.append(Entry.new(name, time))
-      end
-
-      protected
-
-      attr_reader :storage
-    end
-  end
-end

data/lib/koine/profiler/entry_group.rb

@@ -1,32 +0,0 @@
-module Koine
-  class Profiler
-    class EntryGroup
-      InvalidEntryError = Class.new(StandardError)
-
-      attr_reader :name, :entries
-
-      def initialize(name)
-        @name = name.to_s
-        @entries = []
-      end
-
-      def append(entry)
-        raise InvalidEntryError.new(entry.name) unless entry.name == name
-
-        entries << entry
-      end
-
-      def ==(other)
-        entries == other.entries
-      end
-
-      def <=>(other)
-        elapsed_time <=> other.elapsed_time
-      end
-
-      def elapsed_time
-        entries.inject(0) { |total, entry| entry.elapsed_time + total }
-      end
-    end
-  end
-end