extra_print 1.1.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 452f4942f9ce05acba72cf92e1472d83cda3684a
-  data.tar.gz: '089b882bf26e5af5376f076eb3797bd25f485991'
+SHA256:
+  metadata.gz: dfe8a5100f310b7b5da6bedb50b30d6d9185ed282018a53bfb194b6a4063197c
+  data.tar.gz: fce01555d9b632bccff51614eab30da00e137c8da9a036d1c549cf3dfbd4dfa0
 SHA512:
-  metadata.gz: ae04a466c7b6045c303f7937c294fff6b112607169ba65f49551e8701ab36172dc307f0b375caa89e50771740074b57738573022480ad5522635a9189e4db842
-  data.tar.gz: 884c0d4185457618de5615fdae36cf5baed380b49d27dc979bddf14dbd65b8dfb06e5792c2351b4b2c3631b63d20dffb9aad709e20fb9661d26736a33121e490
+  metadata.gz: 1ad32ddbd8a3b76e43e621c7177cb30f7e0c05954c7fbb4797c605475602f2fe7b4fd1e648e4f0d99994204ce99ff11f6fc394e499dd0b2a019a0359ceccb637
+  data.tar.gz: d5b5339c8e65a97c4f3a9811d9eee066640aaf8f20785a80961045e0b1febe2953eb275b3943207baa01ef8b38d5eba7ae09d011268a199375315a5ebff55f4d

data/lib/extra_print.rb

@@ -1,55 +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'
 ########################
 
+
 # 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 :-)
 
-def eap(*args)
+# 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)
-  args[0]
+  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)
+  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'
-    ap proc.call
+  if add_amazing_print
+    require 'amazing_print'
+    AmazingPrint.defaults = {
+      indent: -2, # left aligned
+      sort_keys: true, # sort hash keys
+    }
+    ap @variable
   else
     p proc.call
   end
@@ -64,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"
@@ -92,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,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: extra_print
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.1.0
 platform: ruby
 authors:
-- Hunter Chapman
+- Hunter T. Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-04-25 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: Simple gem to display variables and visual breaks.
+        version: 1.1.0
+description: 'Debugging Companion: Informative variable inspection || visual breaks.'
 email: bootcoder@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/extra_print.rb
-homepage: http://rubygems.org/gems/extra_print
+homepage: https://github.com/bootcoder/extra_print
 licenses:
 - MIT
 metadata: {}
@@ -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.