xprint 0.6.0 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f22ce4523589e6cbeb06e54a7a1977a75ec1756ab30f089732bcc8c3b45dff1
-  data.tar.gz: fb2846b5666efd1edcc52724f9abfbb1800d519c2a38677e7307fc819e935555
+  metadata.gz: 0a2df6a9e5eeff509346a2faa00414a4aa87a6abb1ea6bd426edeb9f9050bda2
+  data.tar.gz: b6cac4edf725cf6cadf55262a013fb63d8f2dd0b4e9d7cf77d0eeef34a33854a
 SHA512:
-  metadata.gz: 9b92e59c74c96172d0f8a30922588d0cfae72eb7eff4ad7c3ca0eaa97c6884b93a06866d70559fac46ce76818dfeb978e94f044b1a4ceccaffea7c9ecbb20304
-  data.tar.gz: 38a4585448847ffebc5c873dafa351f16a4ef082f2d41c121161b7d6e405f4b660d648197600f332549da5d835e346c5684a21f5365ac046c5e4c223b983cfbb
+  metadata.gz: e5e8257c53b8577455262226b7cd69ae599c53ee82e63ae031e8124bdeb8bf557a11cbce4d8f43a17b791843a0ae0df0f2982512e7daf56e7c3c4db05a73ae49
+  data.tar.gz: bf0d3df1881063303b08024197ce55313573de893f339f65fd17d5dc24033953a2f963d54d2a0915579ea7e8d289a36db03b5bc07dc17dbcb5efad2d06d301f6

data/lib/version.rb

@@ -1,3 +1,3 @@
 module XPrint
-    VERSION = '0.6.0'
+    VERSION = '0.7.9'
 end

data/lib/xprint.rb

@@ -1,3 +1,6 @@
+require 'bigdecimal'
+require 'date'
+
 module XPrint
     @data_classes = [
         String, Integer, Float, TrueClass, FalseClass, NilClass,
@@ -5,16 +8,61 @@ module XPrint
     ]
     @hash_name_classes = @data_classes + [Proc]
     @tab = "\t"
-    @show_indexes = true
+    @indexes = true
     @full_proc_path = false
     @braces = true
+    @date_format = '%F'
+    @time_format = '%c'
+    @datetime_format = '%FT%T%:z'
+    @color = false
+    @colors = {
+        attribute:   :blue,
+        bigdecimal:  :darkcyan,
+        classname:   :darkgreen,
+        classobject: :green,
+        date:        :red,
+        datetime:    :purple,
+        false:       :darkred,
+        float:       :cyan,
+        index:       :darkgrey,
+        integer:     :cyan,
+        nil:         :darkpurple,
+        proc:        :darkyellow,
+        rational:    :darkcyan,
+        string:      :yellow,
+        symbol:      :darkblue,
+        time:        :darkblue,
+        true:        :darkgreen
+    }
+    @color_codes = {
+        black:      "\e[30m",
+        blue:       "\e[94m",
+        darkblue:   "\e[34m",
+        cyan:       "\e[96m",
+        darkcyan:   "\e[36m",
+        green:      "\e[92m",
+        darkgreen:  "\e[32m",
+        grey:       "\e[37m",
+        darkgrey:   "\e[90m",
+        red:        "\e[91m",
+        darkred:    "\e[31m",
+        purple:     "\e[95m",
+        darkpurple: "\e[35m",
+        yellow:     "\e[93m",
+        darkyellow: "\e[33m",
+        reset:      "\e[0m"
+    }
 
     def self.set(**kwargs)
         set_vars = {
-            tab:            ->(data) { @tab            = data },
-            show_indexes:   ->(data) { @show_indexes   = data },
-            full_proc_path: ->(data) { @full_proc_path = data },
-            braces:         ->(data) { @braces         = data }
+            tab:             ->(data) { @tab             = data },
+            indexes:         ->(data) { @indexes         = data },
+            full_proc_path:  ->(data) { @full_proc_path  = data },
+            braces:          ->(data) { @braces          = data },
+            date_format:     ->(data) { @date_format     = data },
+            time_format:     ->(data) { @time_format     = data },
+            datetime_format: ->(data) { @datetime_format = data },
+            color:           ->(data) { @color           = data }
         }
     
         kwargs.each do |keyword, arg|
@@ -26,12 +74,16 @@ module XPrint
         return
     end
 
-    def self.tab()
-        @tab
+    def self.set_color_for(**kwargs)
+        kwargs.each do |keyword, arg|
+            @colors[keyword] = arg
+        end
     end
 
-    def self.show_indexes()
-        @show_indexes
+    def self.set_color_code_for(**kwargs)
+        kwargs.each do |keyword, arg|
+            @color_codes[keyword] = arg
+        end
     end
 
     def self.xp(*args)
@@ -46,6 +98,22 @@ module XPrint
         end
     end
 
+    private_class_method def self.color_for(colorname)
+        @color_codes[colorname]
+    end
+
+    private_class_method def self.reset_color()
+        @color_codes[:reset]
+    end
+
+    private_class_method def self.colorize(text, type)
+        if @color
+            item_color = color_for @colors[type]
+            "#{item_color}#{text}#{reset_color}"
+        else
+            text
+        end
+    end
 
     private_class_method def self.shift_indentation_down(text)
         # Only shift if no 
@@ -68,11 +136,24 @@ module XPrint
     def self.xpand(x, indent: '', tab: "\t")
 
         _indent = "#{tab}#{indent}"
-    
+
         # X is a "primitive" kind of data that has no subitems, so
         # we can just print it.
-        if @data_classes.include? x.class
-            return x.inspect
+        if x.class == String
+            return colorize(x.inspect, :string)
+        elsif x.class == Integer
+            return colorize(x.inspect, :integer)
+        elsif x.class == Float
+            return colorize(x.inspect, :float)
+        elsif x.class == TrueClass
+            return colorize(x.inspect, :true)
+        elsif x.class == FalseClass
+            return colorize(x.inspect, :false)
+        elsif x.class == NilClass
+            return colorize(x.inspect, :nil)
+        elsif x.class == Symbol
+            return colorize(x.inspect, :symbol)
+        
         # X is a Proc, print more compact version of standard Proc.inspect
         # text.
         elsif x.class == Proc
@@ -84,10 +165,12 @@ module XPrint
                 source = source.split('/')[-2..-1].join('/')
             end
             
-            return "<#{type} @ #{source} [Line #{line}]>"
-        # X is an Array, print list of all items.
+            return colorize("<#{type} @ #{source} [Line #{line}]>", :proc)
+        
         elsif x.class == Class
-            return "<Class #{x}>"
+            return colorize("<Class #{x}>", :classobject)
+        
+        # X is an Array, print list of all items.
         elsif x.class == Array
             result = "#{@braces ? '[' : ''}\n"
     
@@ -95,7 +178,7 @@ module XPrint
                 data = xpand(item, indent: _indent, tab: tab)
                 
                 result += "#{_indent}"
-                result += "[#{index}] " if @show_indexes
+                result += "#{colorize("[#{index}]", :index)} " if @indexes
                 result += "#{data}"
     
                 unless index + 1 == x.length
@@ -105,6 +188,7 @@ module XPrint
     
             result += "\n#{indent}]" if @braces
             return result
+        
         # X is a Hash, print all keys and values.
         elsif x.class == Hash
             result = "#{@braces ? '{' : ''}\n"
@@ -120,6 +204,13 @@ module XPrint
             )
 
             longest_key = 0 if longest_key.nil?
+
+            # Color codes throw the text length, so we need to add the
+            # length of the color code and the code to reset the color
+            # that wrap around the colored word.
+            # The color code is like "\e[99m" and the reset "\e[0m",
+            # so the total length to add when using color is 9.
+            longest_key += 9 if @color
     
             x.each_with_index do |(key, value), index|
                 data_key   = "#{xpand(key, indent: _indent, tab: tab)}"
@@ -137,20 +228,42 @@ module XPrint
                 result += "#{_indent}#{data_key} => #{data_value}"
 
                 unless index + 1 == x.length
-                    result += ", \n"
+                    result += "#{@braces ? ', ' : ''} \n"
                 end
             end
 
             result += "\n#{indent}}" if @braces
     
             return result
+
+        # X is a commonly used special kind of object.
+        elsif x.class == DateTime
+            datetime = x.strftime @datetime_format
+            return colorize("DateTime(#{datetime})", :datetime)
+        
+        elsif x.class == Date
+            date = x.strftime @date_format
+            return colorize("Date(#{date})", :date)
+        
+        elsif x.class == Time
+            time = x.strftime @time_format
+            return colorize("Time(#{time})", :time)
+        
+        elsif x.class == BigDecimal
+            return colorize("BigDecimal(#{x.to_s('f')})", :bigdecimal)
+        
+        elsif x.class == Rational
+            return colorize("Rational(#{x})", :rational)
+        
         # X is a Structure; essentially a special case of X being an object.
         elsif x.is_a? Struct
-            result = "Struct #{x.class}#{@braces ? '(' : ''}\n"
+            struct_word = colorize('Struct', :classname)
+            classname = colorize(x.class, :classname)
+            result = "#{struct_word} #{classname}#{@braces ? '(' : ''}\n"
             longest_item = x.members.map { |m| m.to_s.length }.max()
 
             x.each_pair do |name, value|
-                attr_name = name.to_s.ljust(longest_item)
+                attr_name = colorize(name.to_s.ljust(longest_item), :attribute)
                 attr_data = xpand(value, indent: _indent, tab: tab)
 
                 result += "#{_indent}#{attr_name} = #{attr_data}\n"
@@ -159,9 +272,11 @@ module XPrint
             result += "#{indent})" if @braces
 
             return result
+        
         # X is any arbitrary object; print all instance variables.
         else
             classname = x.class == Module ? "Module #{x}" : x.class
+            classname = colorize(classname, :classname)
             result = "#{classname}#{@braces ? '(' : ''}"
             ivars = x.instance_variables
             result += "\n" if ivars.length > 0
@@ -169,6 +284,7 @@ module XPrint
     
             ivars.each_with_index do |var, index|
                 attr_name = var.to_s.ljust(longest_var)
+                attr_name = colorize(attr_name, :attribute)
                 attr_data = xpand(
                     x.instance_variable_get(var),
                     indent: _indent,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xprint
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.9
 platform: ruby
 authors:
 - JCabr