xprint 0.5.0 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2cc60a347d36661e3bb0fcc6d1ae58ab46f236eeefd8ba40fc869a1cd20439a
-  data.tar.gz: c0c48517b86a17e3a4219bc9734cd7cf19548883c05b4ba15f3fee783d2ed5d9
+  metadata.gz: 0a2df6a9e5eeff509346a2faa00414a4aa87a6abb1ea6bd426edeb9f9050bda2
+  data.tar.gz: b6cac4edf725cf6cadf55262a013fb63d8f2dd0b4e9d7cf77d0eeef34a33854a
 SHA512:
-  metadata.gz: 9f46bcb7bc0b0536bb83803b623c625dc91c17151ea4bf47173bf50d5def8f1c45408fef73c117742757f4b7f9db6724b0c8255fe1db7f269c2003b022ebe4be
-  data.tar.gz: 611aceb397a9dcc19788be147711cc253e7b348d39c7dd15880c3476718d9d9c0254f11c47e690ed077aede60a2bc20a5148b52ba61ca62045204672fb670578
+  metadata.gz: e5e8257c53b8577455262226b7cd69ae599c53ee82e63ae031e8124bdeb8bf557a11cbce4d8f43a17b791843a0ae0df0f2982512e7daf56e7c3c4db05a73ae49
+  data.tar.gz: bf0d3df1881063303b08024197ce55313573de893f339f65fd17d5dc24033953a2f963d54d2a0915579ea7e8d289a36db03b5bc07dc17dbcb5efad2d06d301f6

data/lib/version.rb

@@ -1,3 +1,3 @@
 module XPrint
-    VERSION = '0.5.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,63 +8,190 @@ 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)
-        @tab = kwargs[:tab] unless kwargs[:tab].nil?
-        @show_indexes = kwargs[:show_indexes] unless kwargs[:show_indexes].nil?
+        set_vars = {
+            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|
+            if set_vars.key? keyword
+                set_vars[keyword].(arg)
+            end
+        end
+    
+        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)
         args.each do |arg|
-            puts self.xpand(arg, tab: @tab)
+            xpanded_text = self.xpand(arg, tab: @tab)
+
+            unless @braces
+                xpanded_text = self.shift_indentation_down(xpanded_text).lstrip()
+            end
+
+            puts xpanded_text
         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 
+        return text if text.match?(/^\S/)
+        result = ''
+
+        text.each_line do |line|
+            result += (
+                if line.start_with? @tab
+                    line[@tab.length..-1]
+                else
+                    line
+                end
+            )
+        end
+
+        return result
+    end
+
     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
+            type = x.lambda? ? 'Lambda' : 'Proc'
             source, line = x.source_location
-            source = source.gsub('\\', '/').split('/')[-2..-1].join('/')
+            source = source.gsub('\\', '/')
             
-            return "<Proc @ #{source} [Line #{line}]>"
+            unless @full_proc_path
+                source = source.split('/')[-2..-1].join('/')
+            end
+            
+            return colorize("<#{type} @ #{source} [Line #{line}]>", :proc)
+        
+        elsif x.class == Class
+            return colorize("<Class #{x}>", :classobject)
+        
         # X is an Array, print list of all items.
         elsif x.class == Array
-            result = "[\n"
+            result = "#{@braces ? '[' : ''}\n"
     
             x.each_with_index do |item, index|
                 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
-                    result += ", \n"
+                    result += "#{@braces ? ', ' : ''} \n"
                 end
             end
     
-            result += "\n#{indent}]"
+            result += "\n#{indent}]" if @braces
             return result
+        
         # X is a Hash, print all keys and values.
         elsif x.class == Hash
-            result = "{\n"
+            result = "#{@braces ? '{' : ''}\n"
 
             longest_key = (
                 x.keys.filter do |k, v|
@@ -74,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)}"
@@ -91,36 +228,63 @@ module XPrint
                 result += "#{_indent}#{data_key} => #{data_value}"
 
                 unless index + 1 == x.length
-                    result += ", \n"
+                    result += "#{@braces ? ', ' : ''} \n"
                 end
             end
 
-            result += "\n#{indent}}"
+            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}(\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"
             end
 
-            result += "#{indent})"
+            result += "#{indent})" if @braces
 
             return result
+        
         # X is any arbitrary object; print all instance variables.
         else
-            result = "#{x.class}(\n"
+            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
             longest_var = ivars.map { |v| v.to_s.length }.max()
     
             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,
@@ -130,7 +294,7 @@ module XPrint
                 result += "#{_indent}#{attr_name} = #{attr_data}\n"
             end
     
-            result += "#{indent})"
+            result += "#{ivars.length > 0 ? indent: ''})" if @braces
     
             return result
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xprint
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.9
 platform: ruby
 authors:
 - JCabr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies: []
 description: Gem that allows for pretty printing data over multiple lines and with
   indentation, and works with objects as well as basic data types.