perforator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3622ce3f88d863ac6b0aedf38c796d8d593d611
-  data.tar.gz: 29086ae16a88db6dc61754cdcd23aebc470df3e3
+  metadata.gz: 765608fcc481e88b7621130998a320433e424f61
+  data.tar.gz: b4d0060e1a221516f3e4eec1263c5ea1da90d614
 SHA512:
-  metadata.gz: 73193d58bb3eb2f024065848063b4ba79251620ea6ca87b5f6c3a9fd8e3e0f565da6586ec2400644d88edb2ac5d5df5c2c0decd9d0eea217ce3fe340f6424819
-  data.tar.gz: e39fbafccb6373c68c109c0056a065ec6cefdf3abf9429f2902fa780b107010f7937c4b6ed15c98a87ca7abf4eaf286bdd1bd51c5bbc5f4f5e628455a054cb90
+  metadata.gz: 52bbcde22a49ac34237cf3cfc401130f15cd1f6b94fda34ce21ece48c1cfde06c34030db01ce40fe5b52289cc5168fde415c632043cde79ddcdc36f7c0c1d4d1
+  data.tar.gz: 19460fd73bf0913ef060651f30afe8e32185a5e06432ecabd683baa0b693c96f48a6fff6f384cc820585075d8936fd1fc95c3e8e46cb9a81ea865b285cd4a609

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/sveredyuk/perforator.svg?branch=master)](https://travis-ci.org/sveredyuk/perforator)
+
 # Perforator
 
 ### Simple and pretty stupid way to measure execution time of your code
@@ -50,6 +52,49 @@ my_meter = Perforator::Meter.new(
 )
 ```
 
+
+You can skip any option if you don't need it.
+
+But for callbacks :expected_time is necessary:
+```ruby
+Perforator::Meter.new(positive_callback: -> { puts ':)' }) #=> NoExpectedTimeError
+```
+
+Callbacks must be callable:
+```ruby
+Perforator::Meter.new(positive_callback: Hash.new) #=> NotCallableCallbackError
+
+```
+
+Expeted time must be fixnum:
+```ruby
+Perforator::Meter.new(expected_time: '10') #=> NotFixnumExpectedTimeError
+
+```
+
+Just wrap your code with meter:
+```ruby
+my_meter.call do
+  # put your code here
+end
+```
+
+Any of undefined method for meter will be added to output and log. It helps to add some custom breakpoints:
+```ruby
+my_meter.call do |meter|
+  meter.some_start 'Value'
+  # put your code here
+  meter.some_finish 'Valud'
+end
+
+# =======> your label
+# some_start: Value
+# Start: 2017-06-02 14:24:53 +0300
+# Finish: 2017-06-02 14:24:54 +0300
+# Spent: 1.000919
+# some_finish Value
+```
+
 ## 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.

data/lib/perforator/version.rb

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

data/lib/perforator.rb

@@ -88,8 +88,8 @@ module Perforator
     end
 
     # TODO Add possibility to log method_missing keys
-    # def method_missing(meth, *args, &blk)
-    #   log!("#{meth}: #{args[0]}")
-    # end
+    def method_missing(meth, *args, &blk)
+      log!("#{meth}: #{args[0]}")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perforator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Volodya Sveredyuk