xprint 0.6.0 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f22ce4523589e6cbeb06e54a7a1977a75ec1756ab30f089732bcc8c3b45dff1
-  data.tar.gz: fb2846b5666efd1edcc52724f9abfbb1800d519c2a38677e7307fc819e935555
+  metadata.gz: 18c9cf643712db2a4ea35df4719149c8d768c38405112414dde3340145b7b06f
+  data.tar.gz: 1d7a04da4c419a33d4c913e5b55bda84505fa49470684d40faff7f6db4e4afbd
 SHA512:
-  metadata.gz: 9b92e59c74c96172d0f8a30922588d0cfae72eb7eff4ad7c3ca0eaa97c6884b93a06866d70559fac46ce76818dfeb978e94f044b1a4ceccaffea7c9ecbb20304
-  data.tar.gz: 38a4585448847ffebc5c873dafa351f16a4ef082f2d41c121161b7d6e405f4b660d648197600f332549da5d835e346c5684a21f5365ac046c5e4c223b983cfbb
+  metadata.gz: d3a7d4aa21c08354ca7435cdca38cc7aa44ae45a3090664328195b47dc6b7b7ad86016974ee1901a653b0d02339f52f103b0990a919f73e9192cafb06e2666a1
+  data.tar.gz: f29a49b31589be8642d0c43742612a40c5a3ab324195e06c4000b43c9a7275adfcac0dfdb3752b5f1f3834ab0562a752e11852e5a4f50a03585dfe3d3f19a8f2

data/lib/version.rb

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

data/lib/xprint.rb

@@ -1,37 +1,131 @@
+require 'bigdecimal'
+require 'date'
+require 'yaml'
+
+# TODO: Add ability for alphabetically sorting
+#       items in hashes and objects.
 module XPrint
-    @data_classes = [
+    @data_classes      = [
         String, Integer, Float, TrueClass, FalseClass, NilClass,
-        Symbol
+        Symbol, Date, Time, DateTime, BigDecimal, Rational
     ]
     @hash_name_classes = @data_classes + [Proc]
-    @tab = "\t"
-    @show_indexes = true
-    @full_proc_path = false
-    @braces = true
+    @tab               = "  "
+    @indexes           = true
+    @full_proc_path    = false
+    @braces            = true
+    @date_format       = '%F'
+    @time_format       = '%c'
+    @datetime_format   = '%FT%T%:z'
+    @hash_separator    = ' => '
+    @commas            = true
+    @color             = true
+    @colors            = {
+        attribute:      :blue,
+        bigdecimal:     :darkcyan,
+        classname:      :darkgreen,
+        classobject:    :green,
+        comma:          :default,
+        curly_brace:    :default,
+        date:           :red,
+        datetime:       :purple,
+        equals:         :default,
+        false:          :darkred,
+        float:          :cyan,
+        hash_separator: :default,
+        index:          :darkgrey,
+        integer:        :cyan,
+        module:         :green,
+        nil:            :darkpurple,
+        parentheses:    :default,
+        proc:           :darkyellow,
+        rational:       :darkcyan,
+        string:         :yellow,
+        struct:         :green,
+        square_brace:   :default,
+        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",
+        default:    "\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 }
-        }
-    
         kwargs.each do |keyword, arg|
-            if set_vars.key? keyword
-                set_vars[keyword].(arg)
-            end
+            self.instance_variable_set "@#{keyword}", arg
         end
     
         return
     end
 
-    def self.tab()
-        @tab
+    def self.load_file(config)
+        config_data = YAML.load( File.read config )
+        config_data = self.symbolize_keys(config_data)
+
+        if config_data.key? :general
+            self.set **config_data[:general]
+        end
+
+        if config_data.key? :colors
+            color_data = config_data[:colors]
+
+            color_data.each do |name, color|
+                color_data[name] = color.to_sym
+            end
+
+            self.set_color_for **config_data[:colors]
+        end
+
+        if config_data.key? :'color codes'
+            self.set_color_code_for **config_data[:'color codes']
+        end
+    end
+
+    def self.load(config)
+        calling_file = caller_locations.first.absolute_path
+        base_dir = File.dirname calling_file
+        relative_config = File.expand_path config, base_dir
+
+        self.load_file relative_config
     end
 
-    def self.show_indexes()
-        @show_indexes
+    private_class_method def self.symbolize_keys(hash)
+        hash.inject({}) do |result, (key, value)|
+            new_key = key.to_sym
+            new_value = value.is_a?(Hash) ? symbolize_keys(value) : value
+
+            result[new_key] = new_value
+            
+            result
+        end
+    end
+
+    def self.set_color_for(**kwargs)
+        kwargs.each do |keyword, arg|
+            @colors[keyword] = arg
+        end
+    end
+
+    def self.set_color_code_for(**kwargs)
+        kwargs.each do |keyword, arg|
+            @color_codes[keyword] = arg
+        end
     end
 
     def self.xp(*args)
@@ -46,6 +140,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[:default]
+    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 
@@ -65,14 +175,27 @@ module XPrint
         return result
     end
 
-    def self.xpand(x, indent: '', tab: "\t")
+    def self.xpand(x, indent: '', tab: '  ')
 
         _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,30 +207,45 @@ 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"
+            result = "#{@braces ? colorize('[', :square_brace) : ''}\n"
+            comma = colorize(',', :comma)
     
             x.each_with_index do |item, index|
                 data = xpand(item, indent: _indent, tab: tab)
                 
                 result += "#{_indent}"
-                result += "[#{index}] " if @show_indexes
+                if @indexes
+                    adjustment = x.length.to_s.length + 3
+                    # Account for characters used for color coding.
+                    adjustment += 9 if @color
+
+                    result += "#{colorize("[#{index}]", :index)} ".
+                                ljust(adjustment)
+                end
                 result += "#{data}"
     
                 unless index + 1 == x.length
-                    result += "#{@braces ? ', ' : ''} \n"
+                    show_commas = @commas && @braces
+
+                    result += "#{show_commas ? "#{comma}" : ''}"
+                    result += "\n" unless result.end_with? "\n"
                 end
             end
     
-            result += "\n#{indent}]" if @braces
+            result += "\n#{indent}#{colorize(']', :square_brace)}" if @braces
             return result
+        
         # X is a Hash, print all keys and values.
         elsif x.class == Hash
-            result = "#{@braces ? '{' : ''}\n"
+            comma = colorize(',', :comma)
+            result = "#{@braces ? colorize('{', :curly_brace) : ''}\n"
 
             longest_key = (
                 x.keys.filter do |k, v|
@@ -120,6 +258,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)}"
@@ -134,51 +279,97 @@ module XPrint
 
                 data_value = xpand(value, indent: _indent, tab: tab)
 
-                result += "#{_indent}#{data_key} => #{data_value}"
+                hash_separator = colorize(@hash_separator, :hash_separator)
+                result += "#{_indent}#{data_key}#{hash_separator}#{data_value}"
 
                 unless index + 1 == x.length
-                    result += ", \n"
+                    show_commas = @commas && @braces
+                    result += "#{show_commas ? "#{comma} " : ''}"
+                    result += "\n" unless result.end_with? "\n"
                 end
             end
 
-            result += "\n#{indent}}" if @braces
+            result += "\n#{indent}#{colorize('}', :curly_brace)}" if @braces
     
             return result
+
+        # X is a commonly used special kind of object.
+        elsif x.class == DateTime
+            datetime = x.strftime @datetime_format
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("DateTime#{p1}#{datetime}#{p2}", :datetime)
+        
+        elsif x.class == Date
+            date = x.strftime @date_format
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("Date#{p1}#{date}#{p2}", :date)
+        
+        elsif x.class == Time
+            time = x.strftime @time_format
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("Time#{p1}#{time}#{p2}", :time)
+        
+        elsif x.class == BigDecimal
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("BigDecimal#{p1}#{x.to_s('f')}#{p2}", :bigdecimal)
+        
+        elsif x.class == Rational
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("Rational#{p1}#{x}#{p2}", :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', :struct)
+            classname = colorize(x.class, :struct)
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            result = "#{struct_word} #{classname}#{@braces ? p1 : ''}\n"
             longest_item = x.members.map { |m| m.to_s.length }.max()
+            eq_sign = colorize('=', :equals)
 
             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"
+                result += "#{_indent}#{attr_name} #{eq_sign} #{attr_data}\n"
             end
 
-            result += "#{indent})" if @braces
+            result += "#{indent}#{p2}" if @braces
 
             return result
+        
         # X is any arbitrary object; print all instance variables.
         else
-            classname = x.class == Module ? "Module #{x}" : x.class
-            result = "#{classname}#{@braces ? '(' : ''}"
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+
+            is_module = x.class == Module
+            classname = is_module ? "Module #{x}" : x.class
+            classname = colorize(classname, is_module ? :module : :classname)
+            result = "#{classname}#{@braces ? p1 : ''}"
             ivars = x.instance_variables
             result += "\n" if ivars.length > 0
             longest_var = ivars.map { |v| v.to_s.length }.max()
+            eq_sign = colorize('=', :equals)
     
             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,
                     tab: tab
                 )
 
-                result += "#{_indent}#{attr_name} = #{attr_data}\n"
+                result += "#{_indent}#{attr_name} #{eq_sign} #{attr_data}\n"
             end
     
-            result += "#{ivars.length > 0 ? indent: ''})" if @braces
+            result += "#{ivars.length > 0 ? indent: ''}#{p2}" if @braces
     
             return result
         end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: xprint
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.4
 platform: ruby
 authors:
 - JCabr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-26 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.
+  indentation, and works with objects as well as basic data types. Also allows color,
+  and loading settings via a YAML config file.
 email:
 - jcabr.dev@gmail.com
 executables: []