koine-profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cf14a8e986ee18a7bf62d8789fb178c6c79b506
+  data.tar.gz: 63326ff4d1822874a9c5ebd7053016fc5e3d6977
+SHA512:
+  metadata.gz: 922a971e1f4457345eefdec93df54a38a7ba1e1b5c1cbd6cf84a53f06db5da73254886f0499104f13846099d15f93ffcfa482ac9edab23e481dd147ae0a6074c
+  data.tar.gz: 43842ed68421c9196aef2def2426f7ef77e3ddd2a1e66b19bb4e06074f674ced540564483230c0bbb2f04e7c2f5fe8d2773d8e109b20d24c8829756869f519a0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+cache: bundle
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler

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 marcelo.jacobus@xing.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 koine-profiler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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
+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,69 @@
+# Koine::Profiler
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koine-profiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koine-profiler
+
+## Usage
+
+```ruby
+profiler.profile('some potentially slow task') do
+  potentially_slow()
+end
+
+profiler.profile('require rails/all') do
+  require 'rails/all'
+end
+```
+
+### Reporting
+
+```ruby
+require 'koine/profiler/reporters/cli'
+
+reporter = Koine::Profiler::Reporters::Cli.new
+
+# all
+reporter.report(entries)
+
+# 5 slowest
+five_slowest = profile.entries.slowest.limit(5)
+reporter.report(five_slowest)
+```
+
+## 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/mjacobus/koine-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,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 "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.
+
+# (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/koine-profiler.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koine/profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "koine-profiler"
+  spec.version       = Koine::Profiler::VERSION
+  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"
+
+  # 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_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"
+end

data/lib/koine/profiler.rb

@@ -0,0 +1,24 @@
+require "koine/profiler/version"
+require "koine/profiler/entries"
+require "koine/profiler/entry_group"
+require "koine/profiler/entry"
+
+module Koine
+  class Profiler
+    attr_reader :entries
+
+    def initialize
+      @entries = Entries.new
+    end
+
+    def profile(name)
+      value = nil
+      start_time = Time.now.utc
+      value = yield if block_given?
+      finish_time = Time.now.utc
+
+      entries.append(name, finish_time - start_time)
+      value
+    end
+  end
+end

data/lib/koine/profiler/entries.rb

@@ -0,0 +1,79 @@
+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.rb

@@ -0,0 +1,19 @@
+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
+
+      def ==(other)
+        other.name == name && other.elapsed_time == elapsed_time
+      end
+
+      def <=>(other)
+         elapsed_time <=> other.elapsed_time
+      end
+    end
+  end
+end

data/lib/koine/profiler/entry_group.rb

@@ -0,0 +1,32 @@
+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

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

@@ -0,0 +1,24 @@
+require 'terminal-table'
+
+module Koine
+  class Profiler
+    module Reporters
+      class Cli
+        def initialize(output = STDOUT, table = Terminal::Table.new)
+          @output = output
+          @table = table
+        end
+
+        def report(entries)
+          @table << ['Entry', 'Elapsed Time', '# of calls']
+
+          entries.each do |entry|
+            @table << [entry.name, entry.elapsed_time, entry.entries.size]
+          end
+
+          @output << @table
+        end
+      end
+    end
+  end
+end

data/lib/koine/profiler/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: koine-profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  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
+    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
+    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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: A simple profiler for profiling tests, for instance
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple profiler
+test_files: []