README.md in object_inspector-0.5.1 vs README.md in object_inspector-0.5.2

- old
+ new

@@ -3,11 +3,11 @@ [![Gem Version](https://badge.fury.io/rb/object_inspector.svg)](https://badge.fury.io/rb/object_inspector) [![Build Status](https://travis-ci.org/pdobb/object_inspector.svg?branch=master)](https://travis-ci.org/pdobb/object_inspector) [![Test Coverage](https://api.codeclimate.com/v1/badges/34e821263d9e0c33d536/test_coverage)](https://codeclimate.com/github/pdobb/object_inspector/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/34e821263d9e0c33d536/maintainability)](https://codeclimate.com/github/pdobb/object_inspector/maintainability) -ObjectInspector takes Object#inspect to the next level. Specify any combination of identification attributes, flags, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc. +ObjectInspector takes Object#inspect to the next level. Specify any combination of identification attributes, flags, issues, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc. Because object inspection code should be uniform, easy to build, and its output should be easy to read! If you'd like to just jump into an example: [Full Example](#full-example). @@ -33,11 +33,12 @@ Tested MRI Ruby Versions: * 2.2.10 * 2.3.7 * 2.4.4 -* 2.5.1 +* 2.5.3 +* 2.6.1 * edge ObjectInspector has no other dependencies. @@ -56,10 +57,11 @@ config.wild_card_scope = "all" config.out_of_scope_placeholder = "*" config.presenter_inspect_flags = " ⇨ " config.name_separator = " - " config.flags_separator = " / " + config.issues_separator = " | " config.info_separator = " | " end ``` @@ -85,15 +87,16 @@ Use the `identification`, `flags`, `info`, and/or `name` options to customize inspect output. ```ruby class MyObject def inspect - ObjectInspector::Inspector.inspect(self, - identification: "My Object", - flags: "FLAG1 / FLAG2", - info: "INFO", - name: "NAME") + ObjectInspector::Inspector.inspect( + self, + identification: "My Object", + flags: "FLAG1 / FLAG2", + info: "INFO", + name: "NAME") end end MyObject.new.inspect # => "<My Object(FLAG1 / FLAG2) INFO :: NAME>" ``` @@ -244,11 +247,14 @@ - `join_info` -- Joins info items with ` | ` by default ```ruby scope = ObjectInspector::Scope.new(:verbose) scope.join_name([1, 2, 3]) # => "1 - 2 - 3" +scope.join_name([1, 2, 3, nil]) # => "1 - 2 - 3" scope.join_flags([1, 2, 3]) # => "1 / 2 / 3" +scope.join_flags([1, 2, 3, nil]) # => "1 / 2 / 3" scope.join_info([1, 2, 3]) # => "1 | 2 | 3" +scope.join_info([1, 2, 3, nil]) # => "1 | 2 | 3" ``` ## Full Example