wtf-tools 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd814bb3d6c501937b14cc58895910ecc022e500
-  data.tar.gz: 8035edd40c08bf9b4c5c6ee3f99f5cb381a9c3ed
+  metadata.gz: f83d668d36c0ec083d81479f7a16b4e9c1419ace
+  data.tar.gz: 7dc918cbf1e1c67006836b7a84a04943219fac23
 SHA512:
-  metadata.gz: ae70406ac25e7093a5953bce47b92a582270d6e74e26d27154287b7c23a2aafe8f2512a75ec350c452d1e17b500f50a6f20e9e86c90d583df3dc83c5daeefb5c
-  data.tar.gz: e737a3e0126265eac0cd0cba6640556b0374c19a3e67b7c0adcd1ac89086a4fb3ab5f15d44e1303d0fd31fbf1fd949f1dd5635744399b883c8f4a440055fb52d
+  metadata.gz: 78c9d15e95e10128fbfa4e9509dcc0333989499b007bfb0ad8e89247c3a0727bdbd1ffe0a638b23ec8f7be3583c6b10f5f86b32f20b101a2863e44919f9e225d
+  data.tar.gz: a1f03bdc671b5bdd7290b37cec42bfbba05cc79de7c70686bb7f133c7e93cf77b87362931a9c8215bf19f3d5787ee2b5b1f8c4589da277e99dd2fe1b25b124ab

data/LICENSE

@@ -1,22 +1,22 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Remigijus Jodelis
-
-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.
-
+The MIT License (MIT)
+
+Copyright (c) 2014 Remigijus Jodelis
+
+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

@@ -1,164 +1,165 @@
-wtf-tools
-=========
-
-Some tools for debugging and profiling Ruby on Rails projects. Included:
-
-* data dumper 
-* code timing tool
-* method tracker - a kind of middle ground between simple timing and full profiling
-* SQL tracker - detect where exactly given SQL query originated from
-
-User is responsible for requiring gems necessary for rendering output. 
-For example, when `:yaml` option is used with `WTF?`, we expect that `YAML` is already loaded.
-Library requirements for specific options are documented below.
-
-Usage examples
---------------
-
-### Data dumping
-
-```ruby
-WTF? my_var                                   # basic
-WTF? my_var, other_var, { some: data }, :pp   # more data, option: pretty-print
-WTF? :label, records, :bare, :time            # multiple options given
-data.wtf(:time).some_method                   # inline call
-```
-
-Supported options
-
-```
-Prefix
-  (default)  WTF (my_file_name/method_name:227): 
-  :np        no default prefix
-  :nl        new line before the record
-  :time      with timestamp: [2014-10-28 12:33:11 +0200]
-
-Formatting
-  (default)  simple Ruby inspect
-  :pp        pretty-print, require 'pp'
-  :yaml      YAML format,  require 'yaml'
-  :json      JSON format,  require 'json'
-  :csv       CSV format,   require 'csv'
-  :text      simple Ruby to_s
-  :line      modifier, each object in separate line
-  :bare      modifier, ActiveRecord with just id attributs: #<MyClass id: 1234>
-
-Output control
-  :puts      to STDOUT (default)
-  :file      to a separate file in configured location
-  :error     raise the string containing data as exception
-```
-
----
-
-### Code timing
-
-```ruby
-class MyClass
-  def run_something
-    WTF.time {
-      # your code
-    }
-  end
-end
-```
-
-Output:
-
-```
-WTF (my_class/run_something:3): 0.001
-```
-
----
-
-### Method tracking
-
-```ruby
-class MyClass
-  def run_something
-    WTF.track(self)
-    # lots of code
-    WTF.track_finish
-  end
-end
-```
-
-Additionally, extra classes/modules can be given:
-
-```
-WTF.track(self, OtherClass, Helpers)
-```
-
-This will create a CSV file in configured location, containing profiling info.
-Profiling happens only in the methods of the calling class, and any other given class.
-
-How it works: every method in `MyClass` and `OtherClass` is overridden, adding resource measuring code.
-All calls to those methods from the code between `track` and `track_finish` are measured (time and memory).
-Sum amounts are written as CSV file, sorted by total time used.
-
-Example output:
-
-```csv
-class,method,count,time,heap_mb
-,top,0,0.948,0.0
-Overview,some_helper,16408,0.351,0.0
-Overview,my_records,28,0.172,0.0
-Overview,load_data,1,0.166,0.0 
-...
-```
-
-*Warning:* tracking method calls adds time overhead (somewhere from 10% to 3x, depending on number of times the methods were called).
-
----
-
-### SQL tracking
-
-```ruby
-class MyClass
-  def run_something
-    WTF.sql %q{SELECT * FROM `my_records` WHERE `attribute`='value' AND `etc`}
-    WTF.sql /^UPDATE `my_records` SET .*?`some_values`=/, size: 10
-    # lots of code
-  end
-end
-```
-
-This will add a `WTF?`-style dump in the default location, containing stacktrace where given SQL statement was generated. SQL must match exactly as strings.
-
----
-
-
-Configuration
--------------
-
-Configure WTF before using the above-mentioned facilities.
-Rails initializers directory is a good place to put it.
-Subkeys of `output` must be lambdas taking one string argument. They are merged into default output options.
-
-```ruby
-WTF.options = {
-  files:   "#{Rails.root}/log/wtf",
-  output: {
-    default: ->(data) { Rails.logger.info(data) },
-    redis:   ->(data) { Redis.new.rpush(:wtf, data) },
-  }
-}
-
-require 'yaml' # to use :yaml option, etc
-```
-
-*Requirement:* Ruby 2.0, because the technique used involves module `prepend`-ing, which is not available in Ruby 1.9.
-
----
-
-License
--------
-
-This is released under the [MIT License](http://www.opensource.org/licenses/MIT).
-
-Sponsors
--------
-
-This gem is sponsored and used by [SameSystem](http://www.samesystem.com)
-
-![SameSystem](http://www.samesystem.com/assets/logo_small.png)
+wtf-tools
+=========
+
+Some tools for debugging and profiling Ruby on Rails projects. Included:
+
+* data dumper 
+* code timing tool
+* method tracker - a kind of middle ground between simple timing and full profiling
+* SQL tracker - detect where exactly given SQL query originated from
+
+User is responsible for requiring gems necessary for rendering output. 
+For example, when `:yaml` option is used with `WTF?`, we expect that `YAML` is already loaded.
+Library requirements for specific options are documented below.
+
+Usage examples
+--------------
+
+### Data dumping
+
+```ruby
+WTF? my_var                                   # basic
+WTF? my_var, other_var, { some: data }, :pp   # more data, option: pretty-print
+WTF? :label, records, :bare, :time            # multiple options given
+data.wtf(:time).some_method                   # inline call
+```
+
+Supported options
+
+```
+Prefix
+  (default)  WTF (my_file_name/method_name:227): 
+  :np        no default prefix
+  :nl        new line before the record
+  :time      with timestamp: [2014-10-28 12:33:11 +0200]
+
+Formatting
+  (default)  simple Ruby inspect
+  :pp        pretty-print, require 'pp'
+  :yaml      YAML format,  require 'yaml'
+  :json      JSON format,  require 'json'
+  :csv       CSV format,   require 'csv'
+  :text      simple Ruby to_s
+  :line      modifier, each object in separate line
+  :bare      modifier, ActiveRecord with just id attributes: #<MyClass id: 1234>
+  :name      like :line, but with names taken from source file
+
+Output control
+  :puts      to STDOUT (default)
+  :file      to a separate file in configured location
+  :error     raise the string containing data as exception
+```
+
+---
+
+### Code timing
+
+```ruby
+class MyClass
+  def run_something
+    WTF.time {
+      # your code
+    }
+  end
+end
+```
+
+Output:
+
+```
+WTF (my_class/run_something:3): 0.001
+```
+
+---
+
+### Method tracking
+
+```ruby
+class MyClass
+  def run_something
+    WTF.track(self)
+    # lots of code
+    WTF.track_finish
+  end
+end
+```
+
+Additionally, extra classes/modules can be given:
+
+```
+WTF.track(self, OtherClass, Helpers)
+```
+
+This will create a CSV file in configured location, containing profiling info.
+Profiling happens only in the methods of the calling class, and any other given class.
+
+How it works: every method in `MyClass` and `OtherClass` is overridden, adding resource measuring code.
+All calls to those methods from the code between `track` and `track_finish` are measured (time and memory).
+Sum amounts are written as CSV file, sorted by total time used.
+
+Example output:
+
+```csv
+class,method,count,time,heap_mb
+,top,0,0.948,0.0
+Overview,some_helper,16408,0.351,0.0
+Overview,my_records,28,0.172,0.0
+Overview,load_data,1,0.166,0.0 
+...
+```
+
+*Warning:* tracking method calls adds time overhead (somewhere from 10% to 3x, depending on number of times the methods were called).
+
+---
+
+### SQL tracking
+
+```ruby
+class MyClass
+  def run_something
+    WTF.sql %q{SELECT * FROM `my_records` WHERE `attribute`='value' AND `etc`}
+    WTF.sql /^UPDATE `my_records` SET .*?`some_values`=/, size: 10
+    # lots of code
+  end
+end
+```
+
+This will add a `WTF?`-style dump in the default location, containing stacktrace where given SQL statement was generated. SQL must match exactly as strings.
+
+---
+
+
+Configuration
+-------------
+
+Configure WTF before using the above-mentioned facilities.
+Rails initializers directory is a good place to put it.
+Subkeys of `output` must be lambdas taking one string argument. They are merged into default output options.
+
+```ruby
+WTF.options = {
+  files:   "#{Rails.root}/log/wtf",
+  output: {
+    default: ->(data) { Rails.logger.info(data) },
+    redis:   ->(data) { Redis.new.rpush(:wtf, data) },
+  }
+}
+
+require 'yaml' # to use :yaml option, etc
+```
+
+*Requirement:* Ruby 2.0, because the technique used involves module `prepend`-ing, which is not available in Ruby 1.9.
+
+---
+
+License
+-------
+
+This is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+Sponsors
+-------
+
+This gem is sponsored and used by [SameSystem](http://www.samesystem.com)
+
+![SameSystem](http://www.samesystem.com/assets/logo_small.png)

data/Rakefile

@@ -1,8 +1,8 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/example/dump.rb

@@ -1,30 +1,30 @@
-require 'rubygems'
-require 'wtf-tools'
-require 'pp'
-require 'json'
-require 'yaml'
-require 'active_support/logger'
-require 'fileutils'
-
-WTF.options = {
-  files: './wtf',
-  output: {
-    default: ActiveSupport::Logger.new('./example.log'),
-  }
-}
-
-data = { 'some' => { 'nested' => { 'data' => 17 } }, :question => %w(life universe and everything), :answer => 42 }
-
-WTF? Time.now
-
-WTF? :label, "string", 17, 2.0001, :time, :nl
-
-WTF? 'label', "string", 17, 2.0001, :time, :line, :nl
-
-WTF? data, :pp, :nl
-
-WTF? data, :json, :nl
-
-WTF? data, :yaml, :np, :file
-
-data.wtf(:file).size
+require 'rubygems'
+require 'wtf-tools'
+require 'pp'
+require 'json'
+require 'yaml'
+require 'active_support/logger'
+require 'fileutils'
+
+WTF.options = {
+  files: './wtf',
+  output: {
+    default: ActiveSupport::Logger.new('./example.log'),
+  }
+}
+
+data = { 'some' => { 'nested' => { 'data' => 17 } }, :question => %w(life universe and everything), :answer => 42 }
+
+WTF? Time.now
+
+WTF? :label, "string", 17, 2.0001, :time, :nl
+
+WTF? 'label', "string", 17, 2.0001, :time, :line, :nl
+
+WTF? data, :pp, :nl
+
+WTF? data, :json, :nl
+
+WTF? data, :yaml, :np, :file
+
+data.wtf(:file).size