puts_debuggerer 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85cc76378a88f1e7c8019f347e69070190ca4f051619fc60dee05d2ff3e83dda
-  data.tar.gz: fb66e2375aa5624c8910d429032e9d99367b1ed5560aa7e364bd431167f5a291
+  metadata.gz: 9dcb8700ea76c5b172428f7a4c08285244da367442f8a5bb90b45d1c25f7b107
+  data.tar.gz: ee730414f3252a164a5ff1d0f4321564dc9c11e36e72f7e2f63998128dbf2c1a
 SHA512:
-  metadata.gz: e61dc7234af7e6392bc61a8510a63846c65a6cf305e5ba2dd2ce807d6ec72d259675cf0f32bddb45709d0d823e2123d8e3ce4ecce14c8165bb15874354128c24
-  data.tar.gz: 5140b36a4d575b4f27e19929c70437d8e30a45d5085b682106868c2e915e49be6744a6aea772946b8e05b3ec2d1ed4d3be21ba163dec2db56a21eeaa6b991650
+  metadata.gz: 40dcf3829312a9d2d30f77371c7296d0f4511d41917263e26248d8d9add0950847effe52a1afb4cec823e8afa4449426a4ab5e2f2aa86e107458aca4ac78ee4a
+  data.tar.gz: efc7adc8820b1ff2a483e88e4255a3dc3280fee16d22750a079e16c7f4de82023d811efa0dbf47e100cb4777e518e7c2c845c70a01878b47e8aa5b67ac9c99c4

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Change Log
 
+## 0.13.0
+
+- Support `h: :t` shortcut to passing `header: true`
+- Support `f: :t` shortcut to passing `footer: true`
+- Support `w: :t` shortcut to passing `wrapper: true`
+
 ## 0.12.0
 
-- Upgrade `awesome_print` to `~> 0.9.2`
+- Upgrade `awesome_print` to `~> 1.9.2`
 - Support passing pd options as part of a printed hash instead of requiring a separate hash (e.g. `pd(path: path, header: true)` instead of `pd({path: path}, header: true)` )
 - Support empty use of pd statement + options (e.g. `pd` or `pd header: true`)
 

data/README.md

@@ -114,7 +114,7 @@ Output:
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
 
-What if you would like to add a header for faster findability of groups of related pd statements? Just use the `header` option:
+What if you would like to add a header for faster findability of groups of related pd statements? Just use the `header` option (or `h`):
 
 ```ruby
 pd order_total, header: true
@@ -177,7 +177,7 @@ Output:
  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 ```
 
-Need a quick stack trace? Just use the `caller` option (you may surround with header and footer too via `wrapper`).
+Need a quick stack trace? Just use the `caller` option (you may surround with header and footer too via `wrapper` or `w`).
 
 ```ruby
 pd order_total, caller: true, wrapper: true
@@ -279,7 +279,7 @@ pd order_details
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
 
-There are many more options and powerful features in [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) as detailed below.
+There are many more options and features in [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) as detailed below.
 
 ## Instructions
 
@@ -288,7 +288,7 @@ There are many more options and powerful features in [puts_debuggerer](https://r
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.12.0'
+gem 'puts_debuggerer', '~> 0.13.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.
@@ -298,7 +298,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.12.0
+gem install puts_debuggerer -v0.13.0
 ```
 
 ```ruby
@@ -493,6 +493,21 @@ Prints out:
   => "1"
 ```
 
+Shortcut Example:
+
+```ruby
+pd (x=1), h: :t
+```
+
+Prints out:
+
+```bash
+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+[PD] /Users/User/example.rb:1
+   > pd (x=1), h: :t
+  => "1"
+```
+
 Global Option Example:
 
 ```ruby
@@ -538,6 +553,21 @@ Prints out:
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 ```
 
+Shortcut Example:
+
+```ruby
+pd (x=1), f: :t
+```
+
+Prints out:
+
+```bash
+[PD] /Users/User/example.rb:1
+   > pd (x=1), f: :t
+  => "1"
+<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+```
+
 Global Option Example:
 
 ```ruby
@@ -584,6 +614,22 @@ Prints out:
 ********************************************************************************
 ```
 
+Shortcut Example:
+
+```ruby
+pd (x=1), w: :t
+```
+
+Prints out:
+
+```bash
+********************************************************************************
+[PD] /Users/User/example.rb:1
+   > pd x=1, w: :t
+  => "1"
+********************************************************************************
+```
+
 Global Option Example:
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0

data/lib/puts_debuggerer.rb

@@ -63,7 +63,12 @@ module PutsDebuggerer
   STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
   STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
   STACK_TRACE_CALL_SOURCE_FILE_REGEX_OPAL = /(http[^\)]+)/
-  OPTIONS = [:app_path, :source_line_count, :header, :wrapper, :footer, :printer, :print_engine, :announcer, :formatter, :caller, :run_at]
+  OPTIONS = [:app_path, :source_line_count, :header, :h, :wrapper, :w, :footer, :f, :printer, :print_engine, :announcer, :formatter, :caller, :run_at]
+  OPTION_ALIASES = {
+    h: :header,
+    f: :footer,
+    w: :wrapper
+  }
 
   class << self
     # Application root path to exclude when printing out file path
@@ -471,14 +476,18 @@ module PutsDebuggerer
 
     def determine_options(objects)
       if objects.size > 1 && objects.last.is_a?(Hash)
-        objects.delete_at(-1)
+        convert_options(objects.delete_at(-1))
       elsif objects.size == 1 && objects.first.is_a?(Hash)
         hash = objects.first
-        hash.slice(*OPTIONS).tap do
+        convert_options(hash.slice(*OPTIONS).tap do
           hash.delete_if {|option| OPTIONS.include?(option)}
-        end
+        end)
       end
     end
+    
+    def convert_options(hash)
+      Hash[hash.map { |key, value| OPTION_ALIASES[key] ? ( value == :t ?  [OPTION_ALIASES[key], true] : [OPTION_ALIASES[key], value] ) : [key, value]}]
+    end
 
     def determine_object(objects)
       objects.compact.size > 1 ? objects : objects.first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Ruby library for improved puts debugging, automatically displaying bonus