puts_debug 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5045d6b353e5ed671ecd5593e5cca502d7c5b8f50a90e9b476b374e557538f
-  data.tar.gz: 20cdf993397c80391642843b642447b52cc14188609b54ed9b99a8aa7f29e7fb
+  metadata.gz: 3356209ac7938c3d9f056c7aa40195ed60f99c79b0fefc44974e74ae0ffe94b7
+  data.tar.gz: e46f3e1a03a7db00ef005e8a40e0db34332ebd0fb76019e5d75ed03ad6e601b9
 SHA512:
-  metadata.gz: a96703aca8706f660e2ffa8f3accf0b54cf923e79a3048389b9e95426d8c0c407df328ffe0cb36c4e88ff5a2f9100a6dc9e5e8802d4169615e110507a595b9b3
-  data.tar.gz: df06601eff1b8812d7ef839039bb4ceafd65ba39aee8760c42d3482019980625c1ed487efc3e74f4a0f29f35783a87285caf5f162f418c39f552d362a72f53aa
+  metadata.gz: b0f652b644c6ee3181fd37123cead208ff25b32ee175b402feec8382ae6247c29012d882653cc99cfb6c369ef672434b73ce5dc17ffd5d564c2d5e6527d06563
+  data.tar.gz: bf4c72e4a614a04df8f52ae781fad2d12d258e24260065e0bb1aee32225ad54af1387239712733ab77687580eb66fd275538ecbe11458f4a17fa3d03d96e2711

data/README.md

@@ -41,47 +41,35 @@ then you can
 
 # Method signature: 
 
-def pd(h = {}, line_symbol = nil, show_lines = :both, empty_lines_margin = nil)
+def pd(args)
   # ...
 end  
 
 
-pd('something') # => 
-something       
-   
-pd({name: 'Yogurt', calories: 200}) # =>
+pd('something') =>
+============================================================
+something
+============================================================
+
+pd(data: 'something', data_color: 'magenta', lines: :none) =>
+something
+
+pd(name: 'Yogurt') =>
+============================================================
 name: Yogurt
-calories: 200
-  
-  
-pd(1, '-', :both, 1) #=>
+============================================================
   
+pd(data: 1, symbol: '-', margin: 1) =>
+ 
 ------------------------------------------------------------
 1
 ------------------------------------------------------------
-  
-pd({a: 1, b: 3}, '*', :both, 2) #=>
- 
 
+pd(data: {a: 1, b: 3}, symbol: '*') =>
 ************************************************************
 a: 1
 b: 3
 ************************************************************
-
-
-pd({a: 1, b: 3}, '=', :top, 1)
-pd('In the midlle')
-pd({c:2, d: 33}, '=', :bottom, 1)  
-#=>
-
-============================================================
-a: 1
-b: 3
-In the midlle
-c: 2
-d: 33
-============================================================
-
 ```
 
 ## Development

data/lib/puts_debug/version.rb

@@ -1,3 +1,3 @@
 module PutsDebug
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/puts_debug.rb

@@ -1,7 +1,6 @@
 require "puts_debug/version"
 
 module Kernel
-
   ##
   # For easier puts debugging (pd). Defined in Kernel module which is included into Object class so this method
   # is accessible from everywhere. Output is sent to standard error stream (stderr) so it could be further separated
@@ -18,44 +17,92 @@ module Kernel
   #   Examples:
   #
   #     pd('something') =>
+  #     ============================================================
+  #     something
+  #     ============================================================
+  #
+  #     pd(data: 'something', data_color: 'magenta', lines: :none) =>
   #     something
   #
   #     pd(name: 'Yogurt') =>
+  #     ============================================================
   #     name: Yogurt
+  #     ============================================================
   #
-  #     pd(1, '-', :both, 1) =>
+  #     pd(data: 1, symbol: '-', margin: 1) =>
   #
   #     ------------------------------------------------------------
   #     1
   #     ------------------------------------------------------------
   #
-  #     pd({a: 1, b: 3}, '*', :both, 2) =>
-  #
-  #
+  #     pd(data: {a: 1, b: 3}, symbol: '*') =>
   #     ************************************************************
   #     a: 1
   #     b: 3
   #     ************************************************************
-  #
-  #
-  def pd(h = {}, line_symbol = nil, show_lines = :both, empty_lines_margin = nil)
+  def pd(args)
+    params = nil
+
+    if args.is_a? Hash
+      if args[:data].nil?
+        params = { data: args }
+      else
+        params = args
+      end
+    else
+      params = { data: args }
+    end
+
+    # parameters
+    data       = params[:data]
+    symbol     = params[:symbol] || '='
+    line_color = params[:color] || 'red'
+    data_color = params[:data_color] || nil
+    margin     = params[:margin] || 0
+    lines      = params[:lines] || :both
+    title      = params[:title]
+    epilogue   = params[:epilogue]
 
-    return unless Rails.env.development?
+    # locals
+    line_str   = Rainbow(symbol * 60).try(line_color)
+    margin_str = "\n" * margin
 
-    $stderr.puts "\n" * empty_lines_margin if empty_lines_margin.present? && show_lines.in?([:both, :top])
-    $stderr.puts (line_symbol * 60) if line_symbol.present? && show_lines.in?([:both, :top])
+    $stderr.puts margin_str if margin > 0 && lines.in?([:both, :top])
+    $stderr.puts line_str if lines.in?([:both, :top])
 
-    if h.is_a? Hash
-      h.each do |k, v|
-        $stderr.puts "#{k}: #{v}"
+    if title.present?
+      title_str = if title.ends_with? ':'
+        "#{title}\n"
+      else
+        "#{title}:\n"
       end
+
+      $stderr.puts Rainbow(title_str).try(line_color)
+    end
+
+    data_str = case data
+    when Hash
+      data.map { |k, v| "#{k}: #{v}" }.join("\n")
+    when Array
+      data.map { |v| "#{v}" }.join(",\n")
     else
-      $stderr.puts h
+      data.to_s
     end
 
-    $stderr.puts line_symbol * 60 if line_symbol.present? && show_lines.in?([:both, :bottom])
-    $stderr.puts "\n" * empty_lines_margin if empty_lines_margin.present? && show_lines.in?([:both, :bottom])
+    data_str = Rainbow(data_str).try(data_color) if data_color.present?
 
+    $stderr.puts data_str
+
+    if title.present?
+      $stderr.puts ''
+    end
+
+    $stderr.puts Rainbow(epilogue).try(line_color) if epilogue.present?
+
+    if lines.present?
+      $stderr.puts line_str if lines.in?([:both, :bottom])
+      $stderr.puts margin_str if margin > 0 && lines.in?([:both, :bottom])
+    end
   end
 
 end

data/puts_debug.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'rainbow', '~> 3'  # Gem for colorizing printed text on ANSI terminals
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puts_debug
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Oleh Novosad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-01 00:00:00.000000000 Z
+date: 2018-12-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement