README.md in object_shadow-1.0.0 vs README.md in object_shadow-1.1.0

- old
+ new

@@ -1,9 +1,11 @@ -# 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) With **shadow**, every Ruby object has a shadow which encapsulates a clean API to access the object's variables and methods. Never again you will have to do the `x.methods - Object.methods` trick to get a meaningful method list. @@ -53,12 +55,12 @@ ``` ### # Get an Overview ```ruby -object.shadow -# ObjectShadow of Object #47023274596520 +require "object_shadow" +object.shadow # ObjectShadow of Object #47023274596520 ## Lookup Chain #<Class:#<C:0x00005588eb283150>> → C → P → Object → … @@ -185,9 +187,21 @@ [Currently not.](https://ruby-doc.org/core/doc/syntax/refinements_rdoc.html#label-Methods+Introspection) ### Other Meta Programming? 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.