puts_debuggerer 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23082ac8b052016747f52fc3ed37c17ee1f9c8d1
-  data.tar.gz: 8dd8dd68fabe0aaef0c6ba78912688cfa2160897
+  metadata.gz: 6051847f09b1366d57fe622110440f277c85a872
+  data.tar.gz: d8ee66acfbb3daea757a5bb5599aed56f9f7d182
 SHA512:
-  metadata.gz: 2b798fcdf87f121abda0664bbf190fb2de2ba258eb431dfd7a287061aaa03dc408e7101c5d96ceaa725a31294324eb68cb36fdeb44165b13abd434f296e1b12d
-  data.tar.gz: c884b97e883fb7b5e85c4e0a094dc87a463df2a4a7efef72b34fd7110d4358bbb5ff5ed7402895c79e4a6f3f6bdf47f4a98c78364779723508d4a521f8ee35a3
+  metadata.gz: 7df9317401c68f2f90bc10f3bccc5410883e3c712339432299aacf6761f516576c62d58477bfa00cb8648a68c7d94a6b166f21d36e81a26fcc0f73fc1b9ad60f
+  data.tar.gz: 02f85ec1f441cfc02785b5701a4b0104203fd0e2b2bdc020301b54d66435d87d12ce634b235f1be8338289cf88d2f033c34f2b078a7020853a474ed47b4a2fec

data/README.md

@@ -1,4 +1,4 @@
-# puts_debuggerer v0.6.0
+# puts_debuggerer v0.7.0
 [![Gem Version](https://badge.fury.io/rb/puts_debuggerer.svg)](http://badge.fury.io/rb/puts_debuggerer)
 [![Build Status](https://travis-ci.org/AndyObtiva/puts_debuggerer.svg?branch=master)](https://travis-ci.org/AndyObtiva/puts_debuggerer)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/puts_debuggerer/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/puts_debuggerer?branch=master)
@@ -25,7 +25,7 @@ Love PD?! Why not promote with [merchandise](https://www.zazzle.com/i+heart+pd+g
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.6.0'
+gem 'puts_debuggerer', '~> 0.7.0'
 ```
 
 This is the recommended way for [Rails](rubyonrails.org) apps. Optionally, you may create an initializer under `config/initializers` named `puts_debuggerer_options.rb` to enable further customizations as per the [Options](#options) section below.
@@ -35,7 +35,7 @@ This is the recommended way for [Rails](rubyonrails.org) apps. Optionally, you m
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.6.0
+gem install puts_debuggerer -v0.7.0
 ```
 
 ```ruby
@@ -348,6 +348,75 @@ Prints out:
      /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/context.rb:381:in \`evaluate\'
 ```
 
+#### `PutsDebuggerer.run_at`
+(default = nil)
+
+Set condition for when to run as specified by an index, array, or range.
+* Default value is `nil` meaning always
+* Value as an Integer index (1-based) specifies at which run to print once
+* Value as an Array of indices specifies at which runs to print multiple times
+* Value as a range specifies at which runs to print multiple times,
+  indefinitely if it ends with ..-1 or ...-1
+
+Can be set globally via `PutsDebuggerer.run_at` or piecemeal via `pd object, run_at: run_at_value`
+
+Global usage should be good enough for most cases. When there is a need to track
+a single expression among several, you may add the option piecemeal, but it expects
+the same exact `object` passed to `pd` for counting.
+
+Examples (global):
+
+  PutsDebuggerer.run_at = 1
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints nothing
+
+  PutsDebuggerer.run_at = 2
+  pd (x=1) # prints nothing
+  pd (x=1) # prints standard PD output
+
+  PutsDebuggerer.run_at = [1, 3]
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints nothing
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints nothing
+
+  PutsDebuggerer.run_at = 3..5
+  pd (x=1) # prints nothing
+  pd (x=1) # prints nothing
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints nothing
+  pd (x=1) # prints nothing
+
+  PutsDebuggerer.run_at = 3...6
+  pd (x=1) # prints nothing
+  pd (x=1) # prints nothing
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints standard PD output
+  pd (x=1) # prints nothing
+
+  PutsDebuggerer.run_at = 3..-1
+  pd (x=1) # prints nothing
+  pd (x=1) # prints nothing
+  pd (x=1) # prints standard PD output
+  pd (x=1) ... continue printing indefinitely on all subsequent runs
+
+  PutsDebuggerer.run_at = 3...-1
+  pd (x=1) # prints nothing
+  pd (x=1) # prints nothing
+  pd (x=1) # prints standard PD output
+  pd (x=1) ... continue printing indefinitely on all subsequent runs
+
+You may reset the run_at number counter via:
+`PutsDebuggerer.reset_run_at_global_number` for global usage.
+
+And:
+`PutsDebuggerer.reset_run_at_number` or
+`PutsDebuggerer.reset_run_at_numbers`
+for piecemeal usage.
+
 ### Bonus
 
 puts_debuggerer comes with a number of bonus goodies.
@@ -405,6 +474,8 @@ Prints out `puts __caller_source_line__`
 
 ## Release Notes
 
+* v0.7.0: `run_at` option, global and piecemeal.
+* v0.6.1: updated README and broke apart specs
 * v0.6.0: unofficial erb support, returning evaluated object/expression, removed static syntax support (replaced with header support)
 * v0.5.1: support for print engine lambdas and smart defaults for leveraging Rails and AwesomePrint debuggers in Rails
 * v0.5.0: custom formatter, caller backtrace, per-puts piecemeal options, and multi-line support

data/lib/puts_debuggerer.rb

@@ -14,6 +14,9 @@ module PutsDebuggerer
       puts data[:footer] if data[:footer]
     }
   CALLER_DEPTH_ZERO = 4 #depth includes pd + with_options method + nested block + build_pd_data method
+  OBJECT_RUN_AT = {}
+  STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
+  STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
 
   class << self
     # Application root path to exclude when printing out file path
@@ -258,7 +261,8 @@ module PutsDebuggerer
         app_path: app_path,
         announcer: announcer,
         formatter: formatter,
-        caller: caller
+        caller: caller,
+        run_at: run_at
       }
     end
 
@@ -268,14 +272,115 @@ module PutsDebuggerer
         send("#{option}=", value)
       end
     end
+
+    # When to run as specified by an index, array, or range.
+    # * Default value is `nil` meaning always
+    # * Value as an Integer index (1-based) specifies at which run to print once
+    # * Value as an Array of indices specifies at which runs to print multiple times
+    # * Value as a range specifies at which runs to print multiple times,
+    #   indefinitely if it ends with ..-1
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.run_at = 1
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints nothing
+    #
+    #   PutsDebuggerer.run_at = 2
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints standard PD output
+    #
+    #   PutsDebuggerer.run_at = [1, 3]
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints nothing
+    #
+    #   PutsDebuggerer.run_at = 3..5
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints nothing
+    #
+    #   PutsDebuggerer.run_at = 3...6
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) # prints nothing
+    #
+    #   PutsDebuggerer.run_at = 3..-1
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) ... continue printing indefinitely on all subsequent runs
+    #
+    #   PutsDebuggerer.run_at = 3...-1
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints nothing
+    #   pd (x=1) # prints standard PD output
+    #   pd (x=1) ... continue printing indefinitely on all subsequent runs
+    attr_reader :run_at
+
+    def run_at=(value)
+      @run_at = value
+    end
+
+    def run_at?
+      !!@run_at
+    end
+
+    attr_reader :run_at_global_number
+
+    def run_at_global_number=(value)
+      @run_at_global_number = value
+    end
+
+    def init_run_at_global_number(object, run_at)
+      @run_at_global_number = 1
+    end
+
+    def increment_run_at_global_number(object, run_at)
+      @run_at_global_number += 1
+    end
+
+    def reset_run_at_global_number(object, run_at)
+      @run_at_global_number = nil
+    end
+
+    def run_at_number(object, run_at)
+      PutsDebuggerer::OBJECT_RUN_AT[[object,run_at]]
+    end
+
+    def init_run_at_number(object, run_at)
+      PutsDebuggerer::OBJECT_RUN_AT[[object,run_at]] = 1
+    end
+
+    def increment_run_at_number(object, run_at)
+      PutsDebuggerer::OBJECT_RUN_AT[[object,run_at]] += 1
+    end
+
+    def reset_run_at_number(object, run_at)
+      PutsDebuggerer::OBJECT_RUN_AT.delete([object, run_at])
+    end
+
+    def reset_run_at_numbers
+      PutsDebuggerer::OBJECT_RUN_AT.clear
+    end
+
   end
 end
 
 PutsDebuggerer.print_engine = PutsDebuggerer::PRINT_ENGINE_DEFAULT
 PutsDebuggerer.announcer = PutsDebuggerer::ANNOUNCER_DEFAULT
 PutsDebuggerer.formatter = PutsDebuggerer::FORMATTER_DEFAULT
-PutsDebuggerer.app_path = nil #TODO also have it set Rails root on first PD
+PutsDebuggerer.app_path = nil
 PutsDebuggerer.caller = nil
+PutsDebuggerer.run_at = nil
 
 # Prints object with bonus info such as file name, line number and source
 # expression. Optionally prints out header and footer.
@@ -307,16 +412,48 @@ PutsDebuggerer.caller = nil
 #     => "Show me the source of the bug: beattle"
 #   [PD] /Users/User/finance_calculator_app/pd_test.rb:4 "What line number am I?"
 def pd(object, options=nil)
-  __with_pd_options__(options) do |print_engine_options|
-    formatter_pd_data = __build_pd_data__(object, print_engine_options) #depth adds build method
-    PutsDebuggerer.formatter.call(formatter_pd_data)
+  run_at = ((options && options[:run_at]) || PutsDebuggerer.run_at)
+
+  if __run_pd__(object, run_at)
+    __with_pd_options__(options) do |print_engine_options|
+      formatter_pd_data = __build_pd_data__(object, print_engine_options) #depth adds build method
+      PutsDebuggerer.formatter.call(formatter_pd_data)
+    end
   end
+
   object
 end
 
-
-STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
-STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
+def __run_pd__(object, run_at)
+  run_pd = false
+  if run_at.nil?
+    run_pd = true
+  else
+    if PutsDebuggerer.run_at_global_number.nil?
+      if PutsDebuggerer.run_at_number(object, run_at).nil?
+        PutsDebuggerer.init_run_at_number(object, run_at)
+      else
+        PutsDebuggerer.increment_run_at_number(object, run_at)
+      end
+      run_number = PutsDebuggerer.run_at_number(object, run_at)
+    else
+      if PutsDebuggerer.run_at_global_number.nil?
+        PutsDebuggerer.init_run_at_global_number
+      else
+        PutsDebuggerer.increment_run_at_global_number
+      end
+      run_number = PutsDebuggerer.run_at_global_number
+    end
+    if run_at.is_a?(Integer)
+      run_pd = true if run_at == run_number
+    elsif run_at.is_a?(Array)
+      run_pd = true if run_at.include?(run_number)
+    elsif run_at.is_a?(Range)
+      run_pd = true if run_at.cover?(run_number) || (run_at.end == -1 && run_number >= run_at.begin)
+    end
+  end
+  run_pd
+end
 
 # Provides caller line number starting 1 level above caller of
 # this method.
@@ -329,7 +466,7 @@ STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
 #
 # prints out `3`
 def __caller_line_number__(caller_depth=0)
-  caller[caller_depth][STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
+  caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
 end
 
 # Provides caller file starting 1 level above caller of
@@ -342,7 +479,7 @@ end
 #
 # prints out `lib/example.rb`
 def __caller_file__(caller_depth=0)
-  caller[caller_depth][STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
+  caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print