xprint 0.5.0

checksums.yaml

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

data/lib/version.rb

@@ -0,0 +1,3 @@
+module XPrint
+    VERSION = '0.5.0'
+end

data/lib/xprint.rb

@@ -0,0 +1,146 @@
+module XPrint
+    @data_classes = [
+        String, Integer, Float, TrueClass, FalseClass, NilClass,
+        Symbol
+    ]
+    @hash_name_classes = @data_classes + [Proc]
+    @tab = "\t"
+    @show_indexes = true
+
+    def self.set(**kwargs)
+        @tab = kwargs[:tab] unless kwargs[:tab].nil?
+        @show_indexes = kwargs[:show_indexes] unless kwargs[:show_indexes].nil?
+    end
+
+    def self.tab()
+        @tab
+    end
+
+    def self.show_indexes()
+        @show_indexes
+    end
+
+    def self.xp(*args)
+        args.each do |arg|
+            puts self.xpand(arg, tab: @tab)
+        end
+    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
+        # X is a Proc, print more compact version of standard Proc.inspect
+        # text.
+        elsif x.class == Proc
+            source, line = x.source_location
+            source = source.gsub('\\', '/').split('/')[-2..-1].join('/')
+            
+            return "<Proc @ #{source} [Line #{line}]>"
+        # X is an Array, print list of all items.
+        elsif x.class == Array
+            result = "[\n"
+    
+            x.each_with_index do |item, index|
+                data = xpand(item, indent: _indent, tab: tab)
+                
+                result += "#{_indent}"
+                result += "[#{index}] " if @show_indexes
+                result += "#{data}"
+    
+                unless index + 1 == x.length
+                    result += ", \n"
+                end
+            end
+    
+            result += "\n#{indent}]"
+            return result
+        # X is a Hash, print all keys and values.
+        elsif x.class == Hash
+            result = "{\n"
+
+            longest_key = (
+                x.keys.filter do |k, v|
+                    @hash_name_classes.include? k.class
+                end.
+                map do |k, v| 
+                    k.to_s.length 
+                end.
+                max()
+            )
+
+            longest_key = 0 if longest_key.nil?
+    
+            x.each_with_index do |(key, value), index|
+                data_key   = "#{xpand(key, indent: _indent, tab: tab)}"
+
+                data_key = (
+                    if @hash_name_classes.include? key.class
+                        data_key.ljust(longest_key + 1)
+                    else
+                        data_key.ljust(data_key.length + longest_key)
+                    end
+                )
+
+                data_value = xpand(value, indent: _indent, tab: tab)
+
+                result += "#{_indent}#{data_key} => #{data_value}"
+
+                unless index + 1 == x.length
+                    result += ", \n"
+                end
+            end
+
+            result += "\n#{indent}}"
+    
+            return result
+        # X is a Structure; essentially a special case of X being an object.
+        elsif x.is_a? Struct
+            result = "Struct #{x.class}(\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_data = xpand(value, indent: _indent, tab: tab)
+
+                result += "#{_indent}#{attr_name} = #{attr_data}\n"
+            end
+
+            result += "#{indent})"
+
+            return result
+        # X is any arbitrary object; print all instance variables.
+        else
+            result = "#{x.class}(\n"
+            ivars = x.instance_variables
+            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_data = xpand(
+                    x.instance_variable_get(var),
+                    indent: _indent,
+                    tab: tab
+                )
+
+                result += "#{_indent}#{attr_name} = #{attr_data}\n"
+            end
+    
+            result += "#{indent})"
+    
+            return result
+        end
+    end    
+end
+
+def xp(*args)
+    XPrint::xp(*args)
+end
+
+def xpand(item, tab: "\t")
+    XPrint::xpand(item, tab: tab)
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: xprint
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- JCabr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-20 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.
+email:
+- jcabr.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/version.rb
+- lib/xprint.rb
+homepage: https://github.com/JCabr/xprint.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Gem for pretty printing any kind of object.
+test_files: []