extra_print 1.1.5 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8179a954b0c0364adaec148cde8370e5078d936
-  data.tar.gz: 65c83c346a17992098a962d74a967a187ff525ad
+SHA256:
+  metadata.gz: ab2a835222a0008de12e9ea6bcc2c9102789e67468b9562b67110c577dbb69bc
+  data.tar.gz: 8a508b8d044cf3fb8c6eafb7c2a1b309dbf0a95a4804b3af9ab8f0fab5ee2794
 SHA512:
-  metadata.gz: 28577c268809b3f1e8d1f1ceea9a85277817e85c895607382078036311d177eab003520c70e69ef6d9d90efaed6636e1140842d54e2880759d987e0665634cd4
-  data.tar.gz: e630b74253541c969e190e6baeb53f090da5869630f28c0bde31054113e58318906ef5474ad837e0c3581e4ffc05aa1eb052dd40bf76269182bd9e4835aab33a
+  metadata.gz: 1c1d08125dcf03a993a339925a5ef6987230c4f13ce92214e372c0c2a1f00ad828c5d5a107d487ac16febd57532b2cff44316ee766c96c4bf359647eb1c219d7
+  data.tar.gz: 856c29c79fe87cd9e5d94a9f9d7d8e16b62f2c6414237ba65cb9dde140ed4c184fb86dcbc54f15e51fdf472c3c6f67adb65b59450bb11892355a23dfea448add

data/lib/extra_print.rb

@@ -1,62 +1,102 @@
 $COLORS = {'red' => '031','green' => '032','yellow' => '033','blue' => '034','magenta' => '035','cyan' => '036'}
-$EMOJIS = %w"😎 😈 👹 👺 👻 👿 💀 👽 😂 🤣 🎃 🐶 🦊 ⭐ 🌟 🏈 🏀 ⚽ ⛔ ❓ 💽 🎁 🌠 🥓 🍤 🍗 🍖 🍕 🍰 🍦 🍭"
+$EMOJIS = %w"😎 😈 👹 👺 👻 👿 💀 👽 😂 🤣 🎃 🐶 🦊 ⭐ 🌟 🏈 🏀 ⚽ ⛔ ♻️ ❓ 💽 🎁 🌠 🥓 🥑 🥦 🍤 🍗 🍖 🍕 🍰 🥃 💰 🍦 🍭 🤯 🤬 🐞 💛 💚 💙 💜"
 
 #### DEBUGGING gems ####
-# require 'awesome_print'
+# require 'amazing_print'
 # require 'pry-byebug'
 ########################
 
-# 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.
 
 # Using ANSI color coding to spruce things up
 # SYNTAX: \033[COLOR_CODEmINNER_TEXT\033[0m
 # There are cleaner ways of doing the color manipulation
 # But this approach avoids extra dependencies, which is better :-)
 
+# 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'
+
+  # No red/green if calling from a spec
+  if $0.split('.').last[/spec|test/]
+    $COLORS.delete('red')
+    $COLORS.delete('green')
+    @color = $COLORS.values.sample
+    @secondary_color = '034'
+  else
+    @color = $COLORS.values.sample
+    # If the color being passed in is RED set secondary color to BLUE
+    @secondary_color = @color == '031' ? '034' : '031'
+  end
 
   # View Methods
-  display_detail_header
-  display_variable(add_awesome_print)
-  display_footer
+  display_detail_bar(true)
+  display_variable(add_amazing_print)
+  @msg ? display_msg_footer : display_detail_bar(false)
+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
@@ -71,18 +111,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"
@@ -99,7 +140,7 @@ 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

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: extra_print
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 2.1.1
 platform: ruby
 authors:
 - Hunter T. Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2020-06-01 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.