kantox-chronoscope 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4d53501fb7342dcf28242a948af1251633b0383
-  data.tar.gz: a2da48b18c3ad4ca31c7e82d2672bb1d93d631c8
+  metadata.gz: dff7a5c13087692f056fa3a698fdad64e0fdef46
+  data.tar.gz: 40805caadefc8ba3a6efc38757e57d5b26c1217c
 SHA512:
-  metadata.gz: 09cec413684352711afc0f92055bc45a56c97d8224e2649d4235c538e0964e1eff9828d3fc55cafec069288072060c4e00c7c3e15747f1e614f31fee0121b27a
-  data.tar.gz: 4b5dc5de71c87957b684954e58dc5c0bcab5826034c2692c597317417fa20b074a536a2b0bfbbe741af6e3b49faf900cc6f36cffc62f2449824de20bb37417aa
+  metadata.gz: 58fc0f60e486c203d7a4d36b17353e3273488d1be0e662f263fc13bada67b42941d21bf8e817c19bfb1a571812635f151f9249ae0cf7437ffaedf510445695ac
+  data.tar.gz: 27f91cdf5ffae2b81f6699b0f5c560c85f414f98b11f4fed1c23938d2a74bec5db242106d7cba6ad56433631f2ec0a4658b07147a62e2a3c34b0e3d4c3de5f02

data/README.md

@@ -2,6 +2,16 @@
 
 [![Build Status](https://travis-ci.org/am-kantox/kantox-chronoscope.svg?branch=master)](https://travis-ci.org/am-kantox/kantox-chronoscope)
 
+`Chronoscope` is designed for those, who has not enough foresight and starts
+benchmarking/profiling their applications when everything already is terrible.
+
+On the other hand, `Chronoscope` is a lightweight solution, that permits
+to plug in benchmarks for virtually everything in a matter of seconds.
+
+It just works out of the box: no modifications of application code is required.
+It permits benchmarking in production as well, though it is not recommended. The
+total impact on productivity is proven to be less that 1%.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +30,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Create the configuration file in `config/chronoscope.yml`:
+
+```yaml
+general:
+  handler: 'Kantox::Chronoscope::Generic'
+  enable: true
+
+options:
+  silent: true
+
+i18n:
+  name: метод
+  times: раз
+  average: среднее
+  total: всего
+```
+
+2. Attach `Chronoscope` to one or more targets:
+
+```ruby
+Kantox::Chronoscope.attach(Order) # all methods of Order
+Kantox::Chronoscope.attach(User, :login) #    User#login
+```
+
+And somewhere in the execution end (e. g. when used with `Rails`, this goes into
+`spec/spec_helper.rb`):
+
+```ruby
+config.after(:suite) do
+  benchmarks = ⌛(cleanup: true)
+end
+```
+
+3. Get the following output:
+
+![Chronoscope log](screenshot.jpg)
+
+Here `silent` options is set to `false`, that’s why we see logs from each subsequent
+call to monitored function.
+
+4. After execution, the result tree (with call hierarchy) is returned as:
+
+```ruby
+puts '—'*($stdin.winsize.last rescue 80)
+puts benchmarks[:data].inspect
+puts '—'*($stdin.winsize.last rescue 80)
+#⇒ {"Hedge#send_email_on_create"=>{:count=>26, :total=>0.00013026800000000003, :stack=>[]},
+#   "Hedge#send_email_on_create="=>{:count=>11, :total=>4.066e-05, :stack=>[]},
+#   "Hedge#hedge_type"=>{:count=>188, :total=>0.0024204860000000003, :stack=>[]} ...
+```
 
 ## Development
 

data/config/chronoscope.yml

@@ -2,6 +2,9 @@ general:
   handler: 'Kantox::Chronoscope::Generic'
   enable: true
 
+options:
+  silent: true
+
 i18n:
   name: метод
   times: раз

data/lib/kantox/chronoscope.rb

@@ -56,11 +56,12 @@ module Kantox
           next if (klazz.instance_method(m).parameters.to_h[:block] rescue false) # FIXME: report
 
           receiver, arg_string = m.to_s.end_with?('=') ? ['self.', 'arg'] : [nil, '*args'] # to satisfy setter
+          do_log = !option(ENV, 'options.silent')
 
           klazz.class_eval %Q|
             alias_method :'#{CHAIN_PREFIX}#{m}', :'#{m}'
             def #{m}(#{arg_string})
-              ⌚('#{klazz}##{m}', #{Kantox::Chronoscope.config.options!.silent && false || true}) { #{receiver}#{CHAIN_PREFIX}#{m} #{arg_string} }
+              ⌚('#{klazz}##{m}', #{do_log}) { #{receiver}#{CHAIN_PREFIX}#{m} #{arg_string} }
             end
           |
         end

data/lib/kantox/chronoscope/version.rb

@@ -1,5 +1,5 @@
 module Kantox
   module Chronoscope
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kantox-chronoscope
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kantox
@@ -121,6 +121,7 @@ files:
 - lib/kantox/chronoscope/dummy.rb
 - lib/kantox/chronoscope/generic.rb
 - lib/kantox/chronoscope/version.rb
+- screenshot.jpg
 homepage: https://github.com/am-kantox/kantox-chronoscope
 licenses:
 - MIT