extra_print 1.1.6 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c00ec4f7670090331d6e7958c40082a4a1f553f8
-  data.tar.gz: 4da248a381e83dbf40cb855e5f2fd563eeb8df34
+SHA256:
+  metadata.gz: adbf386d2dfa9903c26eae3c7e38bd6fbb4c741d17b04bd330711e7ba1be6661
+  data.tar.gz: 7cd482d6bdaad59efacacf7fa4e2e2adda5d8c28a3b4e4a115844cf706f3bfc8
 SHA512:
-  metadata.gz: c7fcc4f3a4bfe8ebbf800a8083b16ae11e40161559937fc1e8ff8d2cfc36383aaf0632686f489f888aed7056f71dccb975055b40c72ea30a8567947f66dad40e
-  data.tar.gz: fcc38e669f719bd9febe2730a3b339d08b6aa28ce44690256961c12cc419ea185ac29ce562adfaae7900e3f6a7bc5afb992a525fc5005db7afb169e06c8c30f9
+  metadata.gz: 9113e14108294da5bfeebb56cac2a3811114a7e79099e2662fd808687385353bdbc8e66ec502555d3a5384895200511b8b8553fe54dbfbce333715176656667f
+  data.tar.gz: e89ae3160cf57bc03668386fe6dcda1a022faa05a2d307e56165b19735cdc0194bdcdc7ebd04d597426c2ebae78c6eb74e6ee8bdca29d8f15e3b7af31ec70947

data/lib/extra_print.rb

@@ -1,8 +1,8 @@
-$COLORS = {'red' => '031','green' => '032','yellow' => '033','blue' => '034','magenta' => '035','cyan' => '036'}
+$COLORS = {'red' => '031','green' => '032','yellow' => '033','blue' => '094','magenta' => '035','cyan' => '036', 'gray' => '037', 'light_red' => '091', 'light_green' => '092', 'light_magenta' => '095', 'light_cyan' => '096'}
 $EMOJIS = %w"😎 😈 👹 👺 👻 👿 💀 👽 😂 🤣 🎃 🐶 🦊 ⭐ 🌟 🏈 🏀 ⚽ ⛔ ♻️ ❓ 💽 🎁 🌠 🥓 🥑 🥦 🍤 🍗 🍖 🍕 🍰 🥃 💰 🍦 🍭 🤯 🤬 🐞 💛 💚 💙 💜"
 
 #### DEBUGGING gems ####
-# require 'awesome_print'
+# require 'amazing_print'
 # require 'pry-byebug'
 ########################
 
@@ -12,52 +12,94 @@ $EMOJIS = %w"😎 😈 👹 👺 👻 👿 💀 👽 😂 🤣 🎃 🐶 🦊
 # There are cleaner ways of doing the color manipulation
 # But this approach avoids extra dependencies, which is better :-)
 
-# Simply call ep or eap (extra_awesome_print) and pass a variable you want to inspect.
-# Alternatively, call ep or eap with no arguments to display an emoji line break when evaluated.
+# Simply call pe or pea (extra_amazing_print) and pass a variable you want to inspect.
+# Alternatively, call pe or pea with no arguments to display an emoji line break and calling line info.
+
+def pe(*args)
+  @caller_path = caller
+  return display_emoji_break if args.empty?
+  extra_print(args[0], args[1])
+  return_value(args[0])
+end
+
+def pea(*args)
+  @caller_path = caller
+  return display_emoji_break if args.empty?
+  extra_print(args[0], args[1], true)
+  return_value(args[0])
+end
+
+#######################################################################
+# NOTE: LEGACY CODE #ep #eap ensure compatibility for future versions #
+#######################################################################
 
 def ep(*args)
   @caller_path = caller
   return display_emoji_break if args.empty?
   extra_print(args[0], args[1])
-  args[0]
+  return_value(args[0])
 end
 
 def eap(*args)
   @caller_path = caller
   return display_emoji_break if args.empty?
   extra_print(args[0], args[1], true)
-  args[0]
+  return_value(args[0])
 end
 
 private
 
-def extra_print(variable = nil, msg = nil, add_awesome_print = false)
+def extra_print(variable = nil, msg = nil, add_amazing_print = false)
   # Set variables
-  @color = $COLORS.values.sample
+  @msg      = msg
   @variable = variable
-  @msg = msg ? msg : " FINISH "
-  # If the color being passed in is RED set secondary color to BLUE
-  @secondary_color = @color == '031' ? '034' : '031'
-
-  # View Methods
-  display_detail_header
-  display_variable(add_awesome_print)
-  display_footer
+  set_colors
+  # Build upper, center, lower sections
+  display_detail_bar(true)
+  display_variable(add_amazing_print)
+  @msg ? display_msg_footer : display_detail_bar(false)
+end
+
+def set_colors
+  # No red/green if calling from a spec
+  @secondary_color = '092'
+  if $0.split('.').last[/spec|test/]
+    $COLORS.delete('red')
+    $COLORS.delete('light_red')
+    $COLORS.delete('light_green')
+    $COLORS.delete('green')
+  end
+  @color = $COLORS.values.sample
+  # If primary color passed is GREEN set secondary color to RED
+  @secondary_color = '031' if @color == '092'
+  @secondary_color = '031' if @color == '032'
+end
+
+# Checks to see if running in a Ruby file
+# IF so returns value, enabling ep's from the end of a method without disrupting functionality.
+# ELSE returns nil, presuming it is running in a REPL and we don't want to see our output doubled because the REPL prints the return value as well.
+def return_value(val)
+  return val if defined?(Rails::Server)
+  return nil if defined?(Rails::Console)
+  return nil if $0.split('.').last.include? 'pry'
+  return nil if $0.split('.').last.include? 'irb'
+  return val if $0.split('.').last == 'rb'
+  val
 end
 
 def path_clip
   @caller_path[0].split('/').last(2).join('/').split(':in')[0]
 end
 
-def display_variable(add_awesome_print)
+def display_variable(add_amazing_print)
   proc = Proc.new { @variable }
-  if add_awesome_print
-    require 'awesome_print'
-    AwesomePrint.defaults = {
+  if add_amazing_print
+    require 'amazing_print'
+    AmazingPrint.defaults = {
       indent: -2, # left aligned
       sort_keys: true, # sort hash keys
     }
-    ap proc.call
+    ap @variable
   else
     p proc.call
   end
@@ -72,18 +114,19 @@ def display_emoji_break
 end
 
 # TODO: off by one error on dynamic footer length
-def display_footer
+def display_msg_footer
   str = "\033[#{@color}m⬆ " * ((@length / 4) - (@msg.length / 2) - 1)
   str += "\033[#{@secondary_color}m #{@msg} "
   str += "\033[#{@color}m⬆ \033[0m" * ((@length / 4))
   puts str
 end
 
-def display_detail_header
+def display_detail_bar(top_bar = true)
+  arrow = top_bar ? "⬇" : "⬆"
 
   # Initial arrows with a new line padding the top
   str = ""
-  str += "\033[#{@color}m⬇ \033[m" * 5
+  str += "\033[#{@color}m#{arrow} \033[m" * 5
 
   # Variable Class Display
   str += "\033[#{@color}m CLASS:\033[m"
@@ -100,10 +143,10 @@ def display_detail_header
   str += "\033[#{@secondary_color}m #{path_clip} \033[m"
 
   # Closing arrows
-  str += "\033[#{@color}m⬇ \033[m" * 5
+  str += "\033[#{@color}m#{arrow} \033[m" * 5
 
   # Output completed string
-  puts
+  puts if top_bar # add single line of top padding to eap output
   puts str
 
   # Set @length - non encoded string for use in footer

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: extra_print
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 2.1.2
 platform: ruby
 authors:
 - Hunter T. Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-01 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
-description: 'Debugging Companion: Informative variable wrappers || visual breaks.'
+        version: 1.1.0
+description: 'Debugging Companion: Informative variable inspection || visual breaks.'
 email: bootcoder@gmail.com
 executables: []
 extensions: []
@@ -56,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Easily spot variables printed in a busy console.