perforat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7ca44e3dad104ec39a6f02dd5c01f95bc4ed59e
+  data.tar.gz: c88ca6a54437a9f3c5b3e4b034bf77bdfcc38d2d
+SHA512:
+  metadata.gz: 388aea2f62f7e8dc1f08b29d2841eb18876dd2d201c43981a7824e5420bd4c8ca14fec8e04d4ff6d04e6ee4ed589e64e7d2f243114f7feecfcf33b5c7e3daf2f
+  data.tar.gz: da02e8d5c12a38496b869fca4310ba19d92a2f47ce5c02fb172e9ab7f2247ba55fbb8a4ee2ff011d7c6a058a254dd0a52a6454af44a07245c212eac48004a168

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ignat Zakrevsky
+
+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,56 @@
+# Perforat
+
+**Perforat** monitors your tests and notice in case some of them significant slowed down.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'perforat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install perforat
+
+Then you need to require it on your `rails_helper` or `spec_helper`
+
+```ruby
+require 'perforat'
+```
+As each test running takes different time to run there are some settings to tune it:
+
+```ruby
+:results_count,    default: 20   # how much notification can be displayed
+:minimal_duration, default: 0.1  # in case of your tests are really fast they produce really huge coefficients event without any changes, minimal_duration` uses to minimal false positive activation.
+:minimal_epsilon,  default: 0.1  # in case of test takes acceptable time it can be not so slowed down to notify about it
+:keep_files,       default: 2    # **Perforat** need only last two files to see difference between tests duration, so if you need more -- you always can change this setting
+```
+
+To configure it add you need to pass params to RSpec settings
+
+```ruby
+RSpec.configure do |config|
+  config.perforat = { keep_files: 5 }
+end
+```
+
+## 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/ignat-zakrevsky/perforat.
+
+
+## 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 'perforat'
+
+# 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/lib/perforat.rb

@@ -0,0 +1,22 @@
+require 'perforat/version'
+require 'perforat/listener'
+
+module Perforat
+  PERFORAT_DIR = 'tmp/perforat'.freeze
+  DEFAULT_SETTINGS = {
+    results_count:    20,
+    minimal_duration: 0.1,
+    minimal_epsilon:  0.1,
+    keep_files:       2
+  }.freeze
+
+  def self.settings
+    DEFAULT_SETTINGS.merge(RSpec.configuration.perforat)
+  end
+end
+
+RSpec.configure do |config|
+  config.reporter.register_listener Perforat::Listener.new,
+    :start, :example_passed, :example_failed, :stop
+  config.add_setting :perforat, default: Perforat::DEFAULT_SETTINGS
+end

data/lib/perforat/listener.rb

@@ -0,0 +1,42 @@
+require 'fileutils'
+require 'csv'
+require 'date'
+
+require 'perforat/results_processor'
+
+module Perforat
+  class Listener
+    def start(_)
+      current_time = Time.now.to_i
+      FileUtils.mkdir_p(PERFORAT_DIR)
+      @output = CSV.open("#{PERFORAT_DIR}/#{current_time}.csv", 'w')
+      @output << [current_time]
+    end
+
+    def example_finished(notification)
+      @output << [
+        notification.example.full_description,
+        notification.example.execution_result.run_time
+      ]
+    end
+
+    def stop(_)
+      @output.close
+      puts
+      files = Dir["#{PERFORAT_DIR}/*.csv"].sort_by(&File.method(:mtime))
+      remove_old_files(files)
+      contents = files.last(2).map { |file| CSV.read(file) }
+      ResultsProcessor.new(contents: contents).call
+    end
+
+    alias :example_passed :example_finished
+    alias :example_failed :example_finished
+
+    private
+
+    def remove_old_files(files)
+      keep_files = Perforat.settings.fetch(:keep_files)
+      (files - files.last(keep_files)).each(&File.method(:delete))
+    end
+  end
+end

data/lib/perforat/results_processor.rb

@@ -0,0 +1,61 @@
+module Perforat
+  class ResultsProcessor
+    def initialize(contents:, formatter: default_formatter, settings: Perforat.settings)
+      @formatter = formatter
+      @contents = contents
+      @settings = settings
+    end
+
+    def call
+      results = @contents.map(&parse_info).inject(&:merge)
+
+      results.values.map(&:keys).inject(&:&).map do |test_name|
+        durations = results.map(&tests_by(test_name)).reverse
+        [test_name, durations, durations.inject(&:/)]
+      end
+      .sort_by(&by_coefficient_increasing)
+      .last(settings.fetch(:results_count))
+      .reject(&by_low_results)
+      .each(&formatter)
+    end
+
+    private
+
+    def parse_info
+      lambda do |info|
+        { parse_timestamp(info.shift.first) => info.map(&present_test_info).inject(&:merge) }
+      end
+    end
+
+    def present_test_info
+      -> (test, time) { { test => time.to_f } }
+    end
+
+    def tests_by(test_name)
+      -> (_, tests) { tests.fetch(test_name) }
+    end
+
+    def by_coefficient_increasing
+      -> (_, _, coefficient) { coefficient }
+    end
+
+    def by_low_results
+      lambda do |_, durations, coefficient|
+        durations.all? { |duration| duration < settings.fetch(:minimal_duration) } ||
+          coefficient - 1 < settings.fetch(:minimal_epsilon)
+      end
+    end
+
+    def parse_timestamp(timestamp)
+      Time.at(timestamp.to_i).to_datetime
+    end
+
+    def default_formatter
+      lambda do |(test_name, durations, coefficient)|
+        puts "#{test_name}: #{durations[1]} -> #{durations[0]} coefficient: #{coefficient}"
+      end
+    end
+
+    attr_reader :formatter, :settings
+  end
+end

data/lib/perforat/version.rb

@@ -0,0 +1,3 @@
+module Perforat
+  VERSION = '0.1.0'.freeze
+end

data/perforat.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perforat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'perforat'
+  spec.version       = Perforat::VERSION
+  spec.authors       = ['Ignat Zakrevsky']
+  spec.email         = ['iezakrevsky@gmail.com']
+
+  spec.summary       = 'Check your tests for performance decrease.'
+  spec.description   = 'Check your tests for performance decrease and notify about it.'
+  spec.homepage      = 'https://github.com/ignat-zakrevsky/perforat'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: perforat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ignat Zakrevsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  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'
+description: Check your tests for performance decrease and notify about it.
+email:
+- iezakrevsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/perforat.rb
+- lib/perforat/listener.rb
+- lib/perforat/results_processor.rb
+- lib/perforat/version.rb
+- perforat.gemspec
+homepage: https://github.com/ignat-zakrevsky/perforat
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Check your tests for performance decrease.
+test_files: []