xprint 0.7.9 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2df6a9e5eeff509346a2faa00414a4aa87a6abb1ea6bd426edeb9f9050bda2
-  data.tar.gz: b6cac4edf725cf6cadf55262a013fb63d8f2dd0b4e9d7cf77d0eeef34a33854a
+  metadata.gz: 22338ca33f15d9dedc61c673da48fe9ca2393ec2f3da632371bae995eeac2c11
+  data.tar.gz: e8ec4ae742f88be96a58841d550d870866f871454fe1f178f20c0ceaa130ad61
 SHA512:
-  metadata.gz: e5e8257c53b8577455262226b7cd69ae599c53ee82e63ae031e8124bdeb8bf557a11cbce4d8f43a17b791843a0ae0df0f2982512e7daf56e7c3c4db05a73ae49
-  data.tar.gz: bf0d3df1881063303b08024197ce55313573de893f339f65fd17d5dc24033953a2f963d54d2a0915579ea7e8d289a36db03b5bc07dc17dbcb5efad2d06d301f6
+  metadata.gz: 144471fa158be54e4fdb2c7e8ab7b5696dae11824ba9944f3bd5c2138c138ebe575a27abcefb3cf25ade46bb09fc48e588d4baca1c2cb5b2f1cb3bed05c12689
+  data.tar.gz: c6d3de4b9333e7edc0304eb2a31ecc4aebe8f536bd6bbc59d124122261ff9762da3901bb52e22762f2f17d315bfa9fce6b827e5b731319ef6304cb9dc7f84d89

data/lib/version.rb

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

data/lib/xprint.rb

@@ -1,40 +1,53 @@
 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"
-    @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
+    @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 = {
+    @color_codes       = {
         black:      "\e[30m",
         blue:       "\e[94m",
         darkblue:   "\e[34m",
@@ -50,30 +63,59 @@ module XPrint
         darkpurple: "\e[35m",
         yellow:     "\e[93m",
         darkyellow: "\e[33m",
-        reset:      "\e[0m"
+        default:    "\e[0m"
     }
 
     def self.set(**kwargs)
-        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
+            self.instance_variable_set "@#{keyword}", arg
         end
     
         return
     end
 
+    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
+
+    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
@@ -103,7 +145,7 @@ module XPrint
     end
 
     private_class_method def self.reset_color()
-        @color_codes[:reset]
+        @color_codes[:default]
     end
 
     private_class_method def self.colorize(text, type)
@@ -133,7 +175,7 @@ module XPrint
         return result
     end
 
-    def self.xpand(x, indent: '', tab: "\t")
+    def self.xpand(x, indent: '', tab: '  ')
 
         _indent = "#{tab}#{indent}"
 
@@ -172,26 +214,38 @@ module XPrint
         
         # 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 += "#{colorize("[#{index}]", :index)} " if @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|
@@ -225,62 +279,84 @@ 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 += "#{@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('}', :curly_brace)}" 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)
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("DateTime#{p1}#{datetime}#{p2}", :datetime)
         
         elsif x.class == Date
             date = x.strftime @date_format
-            return colorize("Date(#{date})", :date)
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("Date#{p1}#{date}#{p2}", :date)
         
         elsif x.class == Time
             time = x.strftime @time_format
-            return colorize("Time(#{time})", :time)
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("Time#{p1}#{time}#{p2}", :time)
         
         elsif x.class == BigDecimal
-            return colorize("BigDecimal(#{x.to_s('f')})", :bigdecimal)
+            p1 = colorize('(', :parentheses)
+            p2 = colorize(')', :parentheses)
+            return colorize("BigDecimal#{p1}#{x.to_s('f')}#{p2}", :bigdecimal)
         
         elsif x.class == Rational
-            return colorize("Rational(#{x})", :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
-            struct_word = colorize('Struct', :classname)
-            classname = colorize(x.class, :classname)
-            result = "#{struct_word} #{classname}#{@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 = 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}"
+                result += "\n" unless result.end_with? "\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
-            classname = colorize(classname, :classname)
-            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)
@@ -291,10 +367,11 @@ module XPrint
                     tab: tab
                 )
 
-                result += "#{_indent}#{attr_name} = #{attr_data}\n"
+                result += "#{_indent}#{attr_name} #{eq_sign} #{attr_data}"
+                result += "\n" unless result.end_with? "\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.7.9
+  version: 0.9.5
 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: []