object_shadow 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ebcf54f524f3ab83fac7d05282f3510682a8e75b1c6f4744616aef84f2291f0
-  data.tar.gz: 6db42ef5f1cfff3b3927662cfddc774b779196521c023d3b224bf3b37a41e258
+  metadata.gz: 503cc7d716417cc40c00e2b193b89ffb8f3946f140d3c04699b6ca36ed31c6d1
+  data.tar.gz: 3fc4e0ed0b2f42afd5d0ec4f670ba361214fe992bc6a78d7fbe47f04318361be
 SHA512:
-  metadata.gz: 7350dd92d83503c51dc1d4a3172d8eda8713f2dcee47d41fdc324c289ab809ff93410cb49a18f5297218536f5bb0dfbb38ca8a1b42d603049ce724a9afdac7dc
-  data.tar.gz: 516a2e61c66368c4cfef098878e1493eccb536e5a26788b861013875be14bccdaedf415674d08c8adef07f5906d5810c378da830556f723c45bfeeada5659a16
+  metadata.gz: f27bf9d3d9df00608b20b6c4500720c2db309f89e01df17a85ea0297b63a3ced0715c3d8608975e430db58015c8a850cdfdac1b63344bd914e0e6587eb12d835
+  data.tar.gz: cdb3f92aeaf8b2a3718ee211037b87037ded6f020359af6d3418437b88648f5f61d579742f241d4a66c837dc1926cd155b8888b91c84fa7865364ffe7e67782a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## CHANGELOG
 
+### 1.1.0
+
+* Add DeepInspect mode
+
 ### 1.0.0
 
 * Initial release

data/Gemfile

@@ -4,3 +4,6 @@ gemspec
 
 gem "minitest"
 gem "rake"
+gem "irb"
+gem "wirb"
+gem "paint"

data/README.md

@@ -1,6 +1,8 @@
-# Object#shadow [![[version]](https://badge.fury.io/rb/object.svg)](https://badge.fury.io/rb/object)  [![[travis]](https://travis-ci.org/janlelis/object.svg)](https://travis-ci.org/janlelis/object)
+# Object#shadow [![[version]](https://badge.fury.io/rb/object_shadow.svg)](https://badge.fury.io/rb/object_shadow)  [![[travis]](https://travis-ci.org/janlelis/object_shadow.svg)](https://travis-ci.org/janlelis/object_shadow)
 
-Have you ever been [confused by some of Ruby's meta-programming methods](https://idiosyncratic-ruby.com/25-meta-methodology.html). If your answer is *Yes*, you have come to the right place:
+Have you ever been [confused by some of Ruby's meta-programming methods?](https://idiosyncratic-ruby.com/25-meta-methodology.html)
+
+If your answer is *Yes*, you have come to the right place:
 
 ![Object and Shadow](/object_shadow.png)
 
@@ -55,8 +57,8 @@ end
 ### # Get an Overview
 
 ```ruby
-object.shadow
-# ObjectShadow of Object #47023274596520
+require "object_shadow"
+object.shadow # ObjectShadow of Object #47023274596520
 
 ## Lookup Chain
 
@@ -188,6 +190,18 @@ Some of Ruby's core classes use `@`-less instance variables, such as [Structs](h
 
 Only some aspects of Ruby meta-programming are covered. However, **shadow** aims to cover all kinds of meta-programming. Maybe you have an idea about how to integrate `eval`, `method_missing`, and friends?
 
+### Does this Gem Include a Secret Mode which Activates an Improved Shadow Inspect?
+
+Yes, run the following command.
+
+```ruby
+ObjectShadow.include(ObjectShadow::DeepInspect)
+42.shadow
+```
+
+Requires the following gems: **paint**, **wirb**, **io-console**
+
+
 ## J-_-L
 
 Copyright (C) 2019 Jan Lelis <https://janlelis.com>. Released under the MIT license.

data/lib/object_shadow.rb

@@ -8,6 +8,7 @@ require_relative "object_shadow/wrap"
 require_relative "object_shadow/instance_variables"
 require_relative "object_shadow/method_introspection"
 require_relative "object_shadow/info_inspect"
+require_relative "object_shadow/deep_inspect"
 
 class ObjectShadow
   include Wrap

data/lib/object_shadow/deep_inspect.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+begin
+  require "paint"
+  require "wirb"
+  require "io/console"
+rescue LoadError
+  warn "Not loading ObjectShadow::DeepInspect (required gems missing/not bundled)"
+end
+
+class ObjectShadow
+  # Improve shadow#inspect
+  # Optional, because it requires the following gems to be installed:
+  # - paint
+  # - wirb
+  # - io-console
+  module DeepInspect
+    def inspect
+      public_methods = methods(scope: :public)
+      protected_methods = methods(scope: :protected)
+      private_methods = methods(scope: :private)
+
+      inherit_till = object.instance_of?(Object) ? :all : Object
+      lookup_chain = (method_lookup_chain(inherit: inherit_till) + ["…"]).inspect
+
+      res = \
+        Paint["# ObjectShadow of Object #%{object_id}\n\n", :underline] +
+        Paint["## Lookup Chain\n\n", :bold] +
+        "%{method_lookup_chain}\n\n"
+
+      unless variables.empty?
+        res += Paint["## %{variables_count} Instance Variable%{variables_plural}\n\n%{variables}\n\n", :bold]
+      end
+
+      unless public_methods.empty?
+        res += Paint["## %{public_methods_count} Public Method%{public_methods_plural} (Non-Class/Object)\n\n%{public_methods}\n\n", :bold]
+      end
+
+      unless protected_methods.empty?
+        res += Paint["## %{protected_methods_count} Protected Method%{protected_methods_plural} (Non-Class/Object)\n\n%{protected_methods}\n\n", :bold]
+      end
+
+      unless private_methods.empty?
+        res += Paint["## %{private_methods_count} Private Method%{private_methods_plural} (Non-Class/Object)\n\n%{private_methods}\n\n", :bold]
+      end
+
+      res += \
+        Paint["## Object Inspect\n\n", :bold] +
+        "%{object_inspect}\n\n"
+
+      res % {
+        object_id: object.object_id,
+        method_lookup_chain: ::Wirb.colorize_result(DeepInspect.column100(lookup_chain)),
+        variables_count: variables.size,
+        variables_plural: variables.size == 1 ? "" : "s",
+        variables: ::Wirb.colorize_result(DeepInspect.column100(variables.inspect)),
+        public_methods_count: public_methods.size,
+        public_methods_plural: public_methods.size == 1 ? "" : "s",
+        public_methods: ::Wirb.colorize_result(DeepInspect.column100(public_methods.inspect)),
+        protected_methods_count: protected_methods.size,
+        protected_methods_plural: protected_methods.size == 1 ? "" : "s",
+        protected_methods: ::Wirb.colorize_result(DeepInspect.column100(protected_methods.inspect)),
+        private_methods_count: private_methods.size,
+        private_methods_plural: private_methods.size == 1 ? "" : "s",
+        private_methods: ::Wirb.colorize_result(DeepInspect.column100(private_methods.inspect)),
+        object_inspect: ::Wirb.colorize_result(DeepInspect.column100(object.inspect))
+      }
+    end
+
+    class << self
+      def column100(input)
+        terminal_size = STDOUT.winsize[1] || 100
+        words = input.split(" ")
+        lines = [""]
+        words.each{ |word|
+          if lines[-1].size + word.size < terminal_size - 9 # x - 1 word space - 4 indent spaces x2
+            lines[-1] = lines[-1] + word + " "
+          else
+            lines << word + " "
+          end
+        }
+
+        lines.map{ |line|
+          "    #{line}"
+        }.join("\n")
+      end
+    end
+  end
+end

data/lib/object_shadow/version.rb

@@ -3,5 +3,5 @@
 require_relative "basic_object"
 
 class ObjectShadow
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_shadow
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies: []
 description: provides a simple convenient API for accessing an object's state.
 email:
@@ -28,6 +28,7 @@ files:
 - Rakefile
 - lib/object_shadow.rb
 - lib/object_shadow/basic_object.rb
+- lib/object_shadow/deep_inspect.rb
 - lib/object_shadow/info_inspect.rb
 - lib/object_shadow/instance_variables.rb
 - lib/object_shadow/method_introspection.rb