wtf-tools 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b03d032d5d09b5261862248f5cc65b8e4932d16
-  data.tar.gz: dcfd4c3e52e98bedbd466691a2d06bd4d5b70e51
+  metadata.gz: 57c0c8fb5737da67755dd7eb6736617ece8b31b7
+  data.tar.gz: 3f53602929c2cbb6a99e69ab2f54ad7f17024dc7
 SHA512:
-  metadata.gz: 00326e4785fcbb49bb840148ea29b82f6be03fe967b910f97aea15203a499251873b2603c0b99a62aeffe3fc4c9c69014fb73db3c24fbc778804cd9d61f648fe
-  data.tar.gz: 9ccf0185977fc76a51582adb8c78fac32db6fa149ca4ed35a65f047b1c3dc4def4a2af0314ca7f1b802d9c370e57fa072af790f6409e7d6662c95973febaa776
+  metadata.gz: d3037df787128aee6fff83d936488f9870256f800c188ab935aa473ddb7b5c8d85f2ff225fdf75ecfb1c00e71bacc9b23397580ac5e7212c1b0f97c80b6029a2
+  data.tar.gz: 244a0c3410d67d00a1cc62962f80828b25a39a7f414f61a1c6526e06b8bd92721f7af49f039c0b9a7abea2d69a839150ea8e071406e189e0aa17c8b86ae2386b

data/README.md

@@ -21,6 +21,7 @@ Usage examples
 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
@@ -43,12 +44,9 @@ Formatting
   :bare      modifier, ActiveRecord with just id attributs: #<MyClass id: 1234>
 
 Output control
-  (default)  to the chosen logger (see configuration)
-  :log       to Rails default logger
+  :puts      to STDOUT (default)
   :file      to a separate file in configured location
-  :page      to a thread variable Thread.current[:wtf]
-  :redis     to a Redis list on key 'wtf', expiring in 30min
-  :raise     raise the string containing data as exception
+  :error     raise the string containing data as exception
 ```
 
 ---

data/example/dump.rb

@@ -7,8 +7,10 @@ require 'active_support/logger'
 require 'fileutils'
 
 WTF.options = {
-  :default => ActiveSupport::Logger.new('./example.log'),
-  :files => './wtf',
+  files: './wtf',
+  output: {
+    default: ActiveSupport::Logger.new('./example.log'),
+  }
 }
 
 data = { 'some' => { 'nested' => { 'data' => 17 } }, :question => %w(life universe and everything), :answer => 42 }
@@ -24,3 +26,5 @@ WTF? data, :pp, :nl
 WTF? data, :json, :nl
 
 WTF? data, :yaml, :no, :file
+
+data.wtf(:file).size

data/example/timing.rb

@@ -9,7 +9,9 @@ WTF.time {
 
 # logging time with specified precision and options
 WTF.options = {
-  :default => ActiveSupport::Logger.new('./example.log'),
+  output: {
+    default: ActiveSupport::Logger.new('./example.log'),
+  }
 }
 result = WTF.time(4, :nl) {
   sleep 3.12346

data/lib/wtf-tools.rb

@@ -13,8 +13,16 @@ module WTF
     end
 
     def files_path
-      dirs = FileUtils.mkdir_p(options[:files])
-      dirs.first
+      if options[:files]
+        dirs = FileUtils.mkdir_p(options[:files])
+        dirs.first
+      else
+        Dir.getwd
+      end
+    end
+
+    def output_options
+      Hash(options[:output])
     end
 
     # TODO: separately track ActiveRecord finders usage in the related methods
@@ -42,7 +50,7 @@ module WTF
       before = AbsoluteTime.now
       result = yield
       duration = AbsoluteTime.now - before
-      WTF::Dumper.new(duration.round(precision), *args)
+      WTF::Dumper.new(duration.round(precision), *args).call
       result
     end
   end
@@ -50,7 +58,12 @@ end
 
 Object.class_eval do
   def WTF?(*args)
-    WTF::Dumper.new(*args)
+    WTF::Dumper.new(*args).call
     nil
   end
+
+  def wtf(*args)
+    WTF::Dumper.new(self, *args).call
+    self
+  end
 end

data/lib/wtf/dumper.rb

@@ -1,26 +1,32 @@
 module WTF
   class Dumper
-    OPTIONS = [
-      :time, :nl, :no,                       # prefix
-      :pp, :yaml, :json, :text, :line, :csv, # format
-      :bare,                                 # modify
-      :page, :file, :raise, :redis, :log,    # output
-    ].freeze
+    PREFIX_OPTIONS = [:time, :nl, :no].freeze
+    FORMAT_OPTIONS = [:pp, :yaml, :json, :text, :line, :csv].freeze
+    MODIFY_OPTIONS = [:bare].freeze
+    OUTPUT_OPTIONS = [:puts, :error, :file].freeze
+
+    OPTIONS = (PREFIX_OPTIONS + FORMAT_OPTIONS + MODIFY_OPTIONS + OUTPUT_OPTIONS).freeze
 
     attr_reader :options
 
     def initialize(*args)
       @options = {}
-      while OPTIONS.include?(args.last)
+      while is_option?(args.last)
         @options[args.pop] = true
       end
+    end
 
+    def call
       data = prefix(args) << format(args)
       output(data)
     end
 
     private
 
+    def is_option?(sym)
+      OPTIONS.include?(sym) or WTF.output_options.key?(sym)
+    end
+
     def prefix(args)
       data = ''
       return data if options[:no]
@@ -54,28 +60,6 @@ module WTF
       end
     end
 
-    def output(data)
-      case
-      when options[:page]
-        (Thread.current[:wtf] ||= []) << data
-      when options[:file]
-        time = Time.now.strftime('%m%d_%H%M%S')
-        file = "#{WTF.files_path}/wtf_#{time}_#{rand(10000)}.txt"
-        File.write(file, data)
-      when options[:raise]
-        raise StandardError, data
-      when options[:redis]
-        WTF.options[:redis].rpush('wtf', data)
-        WTF.options[:redis].expire('wtf', 30*60)
-      when options[:log]
-        Rails.logger.info(data)
-      when WTF.options[:default]
-        WTF.options[:default].info(data)
-      else
-        puts data
-      end
-    end
-
     def cleanup(str, bare = false)
       # remove array parentheses
       str.gsub!(/^\[|\]$/,'')
@@ -83,5 +67,46 @@ module WTF
       str.gsub!(/#<[A-Z]\w+ id: \d+\K.*?>/, '>') if bare
       str
     end
+
+    def output(data)
+      selected = (OUTPUT_OPTIONS + WTF.output_options.keys).select { |how| options[how] }
+      selected << :default if selected.empty?
+      selected.each do |how|
+        Output.new(data).call(how)
+      end
+    end
+
+    class Output
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def call(meth)
+        if block = WTF.output_options[meth]
+          block.call(meth)
+        else
+          send(meth)
+        end
+      end
+
+      private
+
+      def puts
+        STDOUT.puts(data)
+      end
+      alias_method :default, :puts
+
+      def file
+        time = Time.now.strftime('%m%d_%H%M%S')
+        file = File.join(WTF.files_path, "wtf_#{time}_#{rand(10000)}.txt")
+        File.write(file, data)
+      end
+
+      def error
+        raise StandardError, data
+      end
+    end
   end
 end

data/lib/wtf/method_tracker.rb

@@ -82,7 +82,8 @@ module WTF
         data.unshift(%w(class method count time heap_mb))
 
         time = Time.now.strftime('%m%d_%H%M%S')
-        File.write("#{WTF.files_path}/track_#{time}_#{rand(10000)}.csv", data.map(&:to_csv).join)
+        file = File.join(WTF.files_path, "track_#{time}_#{rand(10000)}.csv")
+        File.write(file, data.map(&:to_csv).join)
       end
     end
   end

data/lib/wtf/query_tracker.rb

@@ -28,7 +28,7 @@ module WTF
       def on_sql(sql)
         trackables.each do |it|
           if match(it.pattern, sql)
-            WTF::Dumper.new(:sql, sql, *caller.take(it.options[:size] || 30), :line)
+            WTF::Dumper.new(:sql, sql, *caller.take(it.options[:size] || 30), :line).call
           end
         end
       end

data/wtf-tools.gemspec

@@ -1,24 +1,24 @@
-Gem::Specification.new do |s|
-  s.name            = 'wtf-tools'
-  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")
-  s.summary         = 'tools for debugging and profiling Ruby on Rails projects'
-  s.license         = 'MIT'
-
-  s.description = <<-EOF
-WTF-tools offers some flexible options for your puts-style Ruby debugging needs,
-and method-level profiling for Ruby on Rails projects.
-EOF
-
-  s.files           = Dir['{lib/**/*,example/*,test/*}'] + %w(LICENSE Rakefile README.md wtf-tools.gemspec)
-  s.require_path    = 'lib'
-  s.test_files      = Dir['test/*.rb']
-
-  s.author          = 'Remigijus Jodelis'
-  s.email           = 'remigijus.jodelis@gmail.com'
-  s.homepage        = 'http://github.com/remigijusj/wtf-tools'
-
-  s.add_runtime_dependency 'absolute_time', '~> 1.0'
-end
+Gem::Specification.new do |s|
+  s.name            = 'wtf-tools'
+  s.version         = '1.0.2'
+  s.date            = '2014-10-14'
+  s.platform        = Gem::Platform::RUBY
+  s.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+  s.summary         = 'tools for debugging and profiling Ruby on Rails projects'
+  s.license         = 'MIT'
+
+  s.description = <<-EOF
+WTF-tools offers some flexible options for your puts-style Ruby debugging needs,
+and method-level profiling for Ruby on Rails projects.
+EOF
+
+  s.files           = Dir['{lib/**/*,example/*,test/*}'] + %w(LICENSE Rakefile README.md wtf-tools.gemspec)
+  s.require_path    = 'lib'
+  s.test_files      = Dir['test/*.rb']
+
+  s.author          = 'Remigijus Jodelis'
+  s.email           = 'remigijus.jodelis@gmail.com'
+  s.homepage        = 'http://github.com/remigijusj/wtf-tools'
+
+  s.add_runtime_dependency 'absolute_time', '~> 1.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wtf-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Remigijus Jodelis
@@ -42,9 +42,6 @@ files:
 - lib/wtf/dumper.rb
 - lib/wtf/method_tracker.rb
 - lib/wtf/query_tracker.rb
-- test/test_dumper.rb
-- test/test_method_tracker.rb
-- test/test_timing.rb
 - wtf-tools.gemspec
 homepage: http://github.com/remigijusj/wtf-tools
 licenses:
@@ -66,11 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: tools for debugging and profiling Ruby on Rails projects
-test_files:
-- test/test_dumper.rb
-- test/test_method_tracker.rb
-- test/test_timing.rb
+test_files: []

data/test/test_dumper.rb

@@ -1,8 +0,0 @@
-require 'minitest/autorun'
-require 'wtf-tools'
-
-class TestWtfDumper < Minitest::Unit::TestCase
-  def test_dump
-    # TODO
-  end
-end

data/test/test_method_tracker.rb

@@ -1,8 +0,0 @@
-require 'minitest/autorun'
-require 'wtf-tools'
-
-class TestWtfMethodTracker < Minitest::Unit::TestCase
-  def test_track
-    # TODO
-  end
-end

data/test/test_timing.rb

@@ -1,8 +0,0 @@
-require 'minitest/autorun'
-require 'wtf-tools'
-
-class TestWtfTiming < Minitest::Unit::TestCase
-  def test_timing
-    # TODO
-  end
-end