perforator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3622ce3f88d863ac6b0aedf38c796d8d593d611
+  data.tar.gz: 29086ae16a88db6dc61754cdcd23aebc470df3e3
+SHA512:
+  metadata.gz: 73193d58bb3eb2f024065848063b4ba79251620ea6ca87b5f6c3a9fd8e3e0f565da6586ec2400644d88edb2ac5d5df5c2c0decd9d0eea217ce3fe340f6424819
+  data.tar.gz: e39fbafccb6373c68c109c0056a065ec6cefdf3abf9429f2902fa780b107010f7937c4b6ed15c98a87ca7abf4eaf286bdd1bd51c5bbc5f4f5e628455a054cb90

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

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 sveredyuk@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 perforator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Volodya Sveredyuk
+
+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,67 @@
+# Perforator
+
+### Simple and pretty stupid way to measure execution time of your code
+
+Quick example
+```ruby
+meter = Perforator::Meter.new(puts: true)
+
+meter.call do
+  sleep 1 # doing some serious job
+end
+
+# =======>
+# Start: 2017-06-02 14:24:53 +0300
+# Finish: 2017-06-02 14:24:54 +0300
+# Spent: 1.000919
+```
+
+More details below
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'perforator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install perforator
+
+## Usage
+
+### Options
+You can init new meter object with following arguments:
+
+```ruby
+my_meter = Perforator::Meter.new(
+  name: 'your label', # -> meter name, just label for passing in start line # =======> your label
+  logger: Logger.new('my_logger.log'), # -> logger object, will receive :info at each step
+  puts: true, # -> true/false output to STDOUT
+  expected_time: 10, # -> time in seconds (!) that expected for execution
+  positive_callback: proc { puts ':)' }, # -> executed if real execution less than expected
+  negative_callback: proc { puts ':(' } # -> executed if real execution more than expected
+)
+```
+
+## 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/sveredyuk/perforator. 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 "perforator"
+
+# 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/perforator/version.rb

@@ -0,0 +1,3 @@
+module Perforator
+  VERSION = '0.1.0'
+end

data/lib/perforator.rb

@@ -0,0 +1,95 @@
+require 'perforator/version'
+
+module Perforator
+  class Meter
+    NoExpectedTimeError        = Class.new(StandardError)
+    NotCallableCallbackError   = Class.new(StandardError)
+    NotFixnumExpectedTimeError = Class.new(StandardError)
+
+    attr_reader :name, :logger, :expected_time,:positive_callback,
+      :negative_callback, :start_time, :finish_time, :spent_time
+
+    def initialize(options = {})
+      @name              = options.fetch(:name,              nil)
+      @logger            = options.fetch(:logger,            nil)
+      @puts              = options.fetch(:puts,            false)
+      @expected_time     = options.fetch(:expected_time,     nil)
+      @positive_callback = options.fetch(:positive_callback, nil)
+      @negative_callback = options.fetch(:negative_callback, nil)
+
+      raise NoExpectedTimeError if callbacks_without_expected_time?
+      raise NotFixnumExpectedTimeError unless expected_time_valid?
+      raise NotCallableCallbackError unless callable_callbacks?
+    end
+
+    def call(&block)
+      start
+
+      yield(self)
+
+      finish
+    end
+
+    def puts?
+      @puts
+    end
+
+    private
+
+    def start
+      log! "=======> #{name}"
+
+      @start_time = Time.now
+
+      log! "Start: #{start_time}"
+    end
+
+    def finish
+      @finish_time = Time.now
+      @spent_time = finish_time - start_time
+
+      log! "Finish: #{finish_time}"
+      log! "Spent: #{spent_time}"
+
+      execute_callbacks!
+    end
+
+    def execute_callbacks!
+      return unless expected_time
+
+      if spent_time < expected_time
+        log! "Spent time less than exepcted. Executing: #{positive_callback.inspect}"
+        positive_callback.call
+      else
+        log! "Spent time more than exepcted. Executing: #{positive_callback.inspect}"
+        negative_callback.call
+      end
+    end
+
+    def log!(content)
+      puts(content)        if puts?
+      logger.info(content) if logger
+    end
+
+    def callbacks_without_expected_time?
+      (positive_callback || negative_callback) && !expected_time
+    end
+
+    def callable_callbacks?
+      callbacks = [positive_callback, negative_callback].compact
+
+      return true if callbacks.empty?
+
+      callbacks.map { |c| c.respond_to?(:call) }.uniq == [true]
+    end
+
+    def expected_time_valid?
+      expected_time.nil? || expected_time.is_a?(Fixnum)
+    end
+
+    # TODO Add possibility to log method_missing keys
+    # def method_missing(meth, *args, &blk)
+    #   log!("#{meth}: #{args[0]}")
+    # end
+  end
+end

data/perforator.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perforator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'perforator'
+  spec.version       = Perforator::VERSION
+  spec.authors       = ['Volodya Sveredyuk']
+  spec.email         = ['sveredyuk@gmail.com']
+
+  spec.summary       = %q{Easy way to measure performance time of anything}
+  spec.description   = %q{Easy way to measure performance time of anything}
+  spec.homepage      = 'https://github.com/sveredyuk/perforator'
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_development_dependency 'bundler',           '~> 1.14'
+  spec.add_development_dependency 'rake',              '~> 10.0'
+  spec.add_development_dependency 'rspec',              '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: perforator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodya Sveredyuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-02 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: Easy way to measure performance time of anything
+email:
+- sveredyuk@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
+- lib/perforator.rb
+- lib/perforator/version.rb
+- perforator.gemspec
+homepage: https://github.com/sveredyuk/perforator
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easy way to measure performance time of anything
+test_files: []