wtf-tools 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39cd4bdb18179b654c8c89627596eba83ef1bb93
-  data.tar.gz: b55d4b4ddb008660477c7c54a3124299b50f8380
+  metadata.gz: 8b03d032d5d09b5261862248f5cc65b8e4932d16
+  data.tar.gz: dcfd4c3e52e98bedbd466691a2d06bd4d5b70e51
 SHA512:
-  metadata.gz: 3fe5a3c452e36a089d9f54f94f2e082e3453bf9f2164ea91d28a58c3b725d24b7c18c8935e914890ab830374305cca3cb6d73add38cdbad12bc86191b6485b13
-  data.tar.gz: b3301c939c79f6dcf23ad3060908e0555255bd517e3f71a129bc26f57a26ec4c3cdde88643f2828bf607ff49c18038420667dcc8782937cfb61af39bbe5bdce2
+  metadata.gz: 00326e4785fcbb49bb840148ea29b82f6be03fe967b910f97aea15203a499251873b2603c0b99a62aeffe3fc4c9c69014fb73db3c24fbc778804cd9d61f648fe
+  data.tar.gz: 9ccf0185977fc76a51582adb8c78fac32db6fa149ca4ed35a65f047b1c3dc4def4a2af0314ca7f1b802d9c370e57fa072af790f6409e7d6662c95973febaa776

data/README.md

@@ -9,7 +9,7 @@ Some tools for debugging and profiling Ruby on Rails projects. Included:
 * 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.
+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
@@ -65,6 +65,12 @@ class MyClass
 end
 ```
 
+Output:
+
+```
+WTF (my_class/run_something:3): 0.001
+```
+
 ---
 
 ### Method tracking
@@ -72,19 +78,25 @@ end
 ```ruby
 class MyClass
   def run_something
-    WTF.track(self, OtherClass)
+    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 other given class.
+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 timing code.
-All calls to those methods from the code between `track` and `track_finish` are measured (time and memory),
-and sum amounts are output at the end, sorted by total time used.
+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:
 
@@ -97,8 +109,7 @@ Overview,load_data,1,0.166,0.0
 ...
 ```
 
-Requirements: Ruby 2.0, because the technique used involves module `prepend`-ing, which is not available in Ruby 1.9.
-Warning: tracking method calls adds time overhead (somewhere from 10% to 3x, depending on number of times the methods were called).
+*Warning:* tracking method calls adds time overhead (somewhere from 10% to 3x, depending on number of times the methods were called).
 
 ---
 
@@ -108,7 +119,7 @@ Warning: tracking method calls adds time overhead (somewhere from 10% to 3x, dep
 class MyClass
   def run_something
     WTF.sql %q{SELECT * FROM `my_records` WHERE `attribute`='value' AND `etc`}
-    WTF.sql %q{UPDATE `my_records` SET `some_values`=NULL}
+    WTF.sql /^UPDATE `my_records` SET .*?`some_values`=/, size: 10
     # lots of code
   end
 end
@@ -122,7 +133,7 @@ This will add a `WTF?`-style dump in the default location, containing stacktrace
 Configuration
 -------------
 
-Configure WTF before using the above-mentioned facilities. Rails initializer dir is a good place for it.
+Configure WTF before using the above-mentioned facilities. Rails initializers directory is a good place for it.
 
 ```ruby
 WTF.options = {
@@ -134,9 +145,18 @@ WTF.options = {
 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/lib/wtf-tools.rb

@@ -30,8 +30,8 @@ module WTF
       WTF::MethodTracker.finish
     end
 
-    def sql(sql)
-      WTF::QueryTracker.start_tracking(sql)
+    def sql(*args)
+      WTF::QueryTracker.start_tracking(*args)
     end
 
     def time(*args)

data/lib/wtf/query_tracker.rb

@@ -1,14 +1,16 @@
 module WTF
   module QueryTracker
+    Trackable = Struct.new(:pattern, :options)
+
     class << self
-      attr_reader :trackable
+      attr_reader :trackables
 
-      def start_tracking(sql)
-        if @trackable.nil?
+      def start_tracking(pattern, options = {})
+        if @trackables.nil?
           prepare_hook
-          @trackable = {}
+          @trackables = []
         end
-        @trackable[sql] = true
+        @trackables << Trackable.new(pattern, options)
       end
 
       def prepare_hook
@@ -24,8 +26,21 @@ module WTF
       end
 
       def on_sql(sql)
-        if trackable[sql]
-          WTF::Dumper.new(:sql, sql, *caller.take(30), :line)
+        trackables.each do |it|
+          if match(it.pattern, sql)
+            WTF::Dumper.new(:sql, sql, *caller.take(it.options[:size] || 30), :line)
+          end
+        end
+      end
+
+      def match(pattern, sql)
+        case pattern
+        when Regexp
+          pattern.match(sql)
+        when String
+          pattern == sql
+        when Proc
+          pattern.call(sql)
         end
       end
     end

data/wtf-tools.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'wtf-tools'
-  s.version         = '1.0.0'
+  s.version         = '1.0.1'
   s.date            = '2014-10-14'
   s.platform        = Gem::Platform::RUBY
   s.required_ruby_version = Gem::Requirement.new(">= 2.0.0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wtf-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Remigijus Jodelis
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: tools for debugging and profiling Ruby on Rails projects