object_inspector 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b35f6663bb2960940d4c0139ff728c37082c86ffef6a2bfedeb179fcbb54339
-  data.tar.gz: 53e84daa5e170088aeeaac38845eab86f717dacbebf0d9e795e557cd2e5f0f75
+  metadata.gz: d20f26835756f0ebb2f4ecb6371662cc35a4cb9d62e72682a5b76d8e96ca8290
+  data.tar.gz: c41e95352adedc432259b57f8ed0be5e16a9a0b7860ba23e5bbd8f8fa1cecf9f
 SHA512:
-  metadata.gz: fe9fb99c6ed1b74f269070f697119596f0ec9cfe074453fbc77166349b813163158dbe6ccf58646b340f7a0fca8fdab391da1db17e75986e904eebfca96598d5
-  data.tar.gz: 65ed4a72973c2cd5b38b56af6cd131d35a6c2c3affc292be8e13e11eae6c222ad10585b4eee3a475d1888fcd4e98cc17c1c1d940ae535f25472b65e815f83759
+  metadata.gz: 141e7e013e692ff025d7f6c2bc11f395ed6ff8499c30e5d161d7e5fc0219f2981b688ea1db6c01a80e87363553bf07a5b8319d04db744f688a3839bcf9ff1982
+  data.tar.gz: 4a811cba205e011f8d8ce390c89da2aa93dd01e21692ce28516739b35c7907c7f7e416f606c39fdfb92edba237f76ac439175dd90c1fefc498b7e8ad25bbcfae

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Paul Dobbins
+Copyright (c) 2023 Paul DobbinSchmaltz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,13 +1,11 @@
-# ObjectInspector
+# Object Inspector
 
 [![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, issues, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc.
+Object Inspector 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 represent 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!
+Why? 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).
 
@@ -32,18 +30,17 @@ Or install it yourself:
 ## Compatibility
 
 Tested MRI Ruby Versions:
-* 2.3
-* 2.4
-* 2.5
-* 2.6
-* edge
+* 2.7
+* 3.0
+* 3.1
+* 3.2
 
-ObjectInspector has no other dependencies.
+Object Inspector has no other dependencies.
 
 
 ## Configuration
 
-Global/default values for ObjectInspector can be configured via the ObjectInspector::Configuration object.
+Global/default values for Object Inspector can be configured via the ObjectInspector::Configuration object.
 
 _Note: In a Rails app, the following would go in e.g. `config/initializers/object_inspector.rb`_
 
@@ -392,13 +389,13 @@ class MyDelegatingWrapperObject
     @my_object = my_object
   end
 
-  def inspect(**kargs)
+  def inspect(**kwargs)
     super(identification: self.class.name,
           name: nil,
           flags: nil,
           info: nil,
           issues: nil,
-          **kargs)
+          **kwargs)
   end
 
   def to_model
@@ -512,7 +509,7 @@ See examples:
 
 ## Supporting Gems
 
-ObjectInspector works great with the [ObjectIdentifier](https://github.com/pdobb/object_identifier) gem.
+Object Inspector works great with the [Object Identifier](https://github.com/pdobb/object_identifier) gem.
 
 ```ruby
 class MyObject
@@ -545,14 +542,14 @@ MyObject.new.inspect
 
 ## Performance
 
-### Benchmarking ObjectInspector
+### Benchmarking Object Inspector
 
 ObjectInspetor is ~4x slower than Ruby's default inspect.
 
-Performance of ObjectInspect can be tested by playing the [ObjectInspector Benchmarking Scripts] in the pry console for this gem.
+Performance of Object Inspector can be tested by playing the [Object Inspector Benchmarking Script](https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/object_inspector.rb) in the pry console for this gem.
 
 ```ruby
-play scripts/benchmarking/object_inspector.rb
+play script/benchmarking/object_inspector.rb
 # Comparison:
 #                 Ruby:    30382.2 i/s
 # ObjectInspector::Inspector:     7712.2 i/s - 3.94x  slower
@@ -563,10 +560,10 @@ play scripts/benchmarking/object_inspector.rb
 
 [ObjectInspector::TemplatingFormatter] -- which is the default Formatter -- outperforms [ObjectInspector::CombiningFormatter] by about 30% on average.
 
-Performance of Formatters can be tested by playing the [Formatters Benchmarking Scripts] in the pry console for this gem.
+Performance of Formatters can be tested by playing the [Formatters Benchmarking Scripts](https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/formatters.rb) in the pry console for this gem.
 
 ```ruby
-play scripts/benchmarking/formatters.rb
+play script/benchmarking/formatters.rb
 # == Averaged =============================================================
 # ...
 #
@@ -585,7 +582,7 @@ Custom Formatters may be similarly gauged for comparison by adding them to the `
 ```ruby
 custom_formatter_klasses = [MyCustomFormatter]
 
-play scripts/benchmarking/formatters.rb
+play script/benchmarking/formatters.rb
 # == Averaged =============================================================
 # ...
 #
@@ -600,10 +597,20 @@ play scripts/benchmarking/formatters.rb
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Or, run `rake` to run the tests plus linters as well as `yard` (to confirm proper YARD documentation practices). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
+To release a new version, update the version number in `version.rb`, bump the latest ruby target versions etc. with `rake bump`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Documentation
+
+[YARD documentation](https://yardoc.org/index.html) can be generated and viewed live:
+1. Install YARD: `gem install yard`
+2. Run the YARD server: `yard server --reload`
+3. Open the live documentation site: `open http://localhost:8808`
+
+While the YARD server is running, documentation in the live site will be auto-updated on source code save (and site reload).
 
 ## Contributing
 
@@ -617,5 +624,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 [ObjectInspector::TemplatingFormatter]: https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/formatters/templating_formatter.rb
 [ObjectInspector::CombiningFormatter]: https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/formatters/combining_formatter.rb
-[ObjectInspector Benchmarking Scripts]: https://github.com/pdobb/object_inspector/blob/master/scripts/benchmarking/object_inspector.rb
-[Formatters Benchmarking Scripts]: https://github.com/pdobb/object_inspector/blob/master/scripts/benchmarking/formatters.rb
+[Object Inspector Benchmarking Scripts]: https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/object_inspector.rb
+[Formatters Benchmarking Scripts]: https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/formatters.rb

data/lib/object_inspector/conversions.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-module ObjectInspector
-  # ObjectInspector::Conversions defines conversion functions used by
-  # ObjectInspector.
-  module Conversions
-    module_function
+# ObjectInspector::Conversions defines conversion functions used by
+# ObjectInspector.
+module ObjectInspector::Conversions
+  module_function
 
-    # Convert the passed in value to an {ObjectInspector::Scope} object.
-    # Just returns the pass in value if it already is an
-    # {ObjectInspector::Scope} object.
-    #
-    # @return [ObjectInspector::Scope]
-    def Scope(value) # rubocop:disable Naming/MethodName
-      case value
-      when ObjectInspector::Scope
-        value
-      else
-        ObjectInspector::Scope.new(value)
-      end
+  # Convert the passed in value to an {ObjectInspector::Scope} object.
+  # Just returns the passed in value if it already is an
+  # {ObjectInspector::Scope} object.
+  #
+  # @return [ObjectInspector::Scope]
+  #
+  # :reek:UncommunicativeMethodName
+  def Scope(value) # rubocop:disable Naming/MethodName
+    case value
+    when ObjectInspector::Scope
+      value
+    else
+      ObjectInspector::Scope.new(value)
     end
   end
 end

data/lib/object_inspector/formatters/base_formatter.rb

@@ -1,71 +1,69 @@
 # frozen_string_literal: true
 
-module ObjectInspector
-  # ObjectInspector::BaseFormatter is an abstract base class that interfaces
-  # with {ObjectInspector::Inspector} objects to combine the supplied
-  # {#identification}, {#flags}, {#info}, and {#name} strings into a friendly
-  # "inspect" String.
-  class BaseFormatter
-    attr_reader :inspector
+# ObjectInspector::BaseFormatter is an abstract base class that interfaces
+# with {ObjectInspector::Inspector} objects to combine the supplied
+# {#identification}, {#flags}, {#info}, and {#name} strings into a friendly
+# "inspect" String.
+class ObjectInspector::BaseFormatter
+  attr_reader :inspector
 
-    # @param inspector [ObjectInspector::Inspector]
-    def initialize(inspector)
-      @inspector = inspector
-    end
+  # @param inspector [ObjectInspector::Inspector]
+  def initialize(inspector)
+    @inspector = inspector
+  end
 
-    # Perform the formatting routine.
-    #
-    # @return [String]
-    def call
-      raise NotImplementedError
-    end
+  # Perform the formatting routine.
+  #
+  # @return [String]
+  def call
+    raise NotImplementedError
+  end
 
-    # Delegates to {Inspector#wrapped_object_inspection_result}.
-    #
-    # @return [String] if given
-    # @return [NilClass] if not given
-    def wrapped_object_inspection_result
-      @wrapped_object_inspection_result ||=
-        @inspector.wrapped_object_inspection_result
-    end
+  # Delegates to {Inspector#wrapped_object_inspection_result}.
+  #
+  # @return [String] if given
+  # @return [NilClass] if not given
+  def wrapped_object_inspection_result
+    @wrapped_object_inspection_result ||=
+      @inspector.wrapped_object_inspection_result
+  end
 
-    # Delegates to {Inspector#identification}.
-    #
-    # @return [String] if given
-    def identification
-      @identification ||= @inspector.identification
-    end
+  # Delegates to {Inspector#identification}.
+  #
+  # @return [String] if given
+  def identification
+    @identification ||= @inspector.identification
+  end
 
-    # Delegates to {Inspector#flags}.
-    #
-    # @return [String] if given
-    # @return [NilClass] if not given
-    def flags
-      @flags ||= @inspector.flags
-    end
+  # Delegates to {Inspector#flags}.
+  #
+  # @return [String] if given
+  # @return [NilClass] if not given
+  def flags
+    @flags ||= @inspector.flags
+  end
 
-    # Delegates to {Inspector#issues}.
-    #
-    # @return [String] if given
-    # @return [NilClass] if not given
-    def issues
-      @issues ||= @inspector.issues
-    end
+  # Delegates to {Inspector#issues}.
+  #
+  # @return [String] if given
+  # @return [NilClass] if not given
+  def issues
+    @issues ||= @inspector.issues
+  end
 
-    # Delegates to {Inspector#info}.
-    #
-    # @return [String] if given
-    # @return [NilClass] if not given
-    def info
-      @info ||= @inspector.info
-    end
+  # Delegates to {Inspector#info}.
+  #
+  # @return [String] if given
+  # @return [NilClass] if not given
+  def info
+    @info ||= @inspector.info
+  end
 
-    # Delegates to {Inspector#name}.
-    #
-    # @return [String] if given
-    # @return [NilClass] if not given
-    def name
-      @name ||= @inspector.name
-    end
+  # Delegates to {Inspector#name}.
+  #
+  # @return [String] if given
+  # @return [NilClass] if not given
+  def name
+    @name ||= @inspector.name
   end
 end

data/lib/object_inspector/formatters/combining_formatter.rb

@@ -1,63 +1,61 @@
 # frozen_string_literal: true
 
-module ObjectInspector
-  # ObjectInspector::CombiningFormatter implements
-  # {ObjectInspector::BaseFormatter} to return the standard/default inspect
-  # output format by combining Strings.
+# ObjectInspector::CombiningFormatter implements
+# {ObjectInspector::BaseFormatter} to return the standard/default inspect
+# output format by combining Strings.
+#
+# @attr (see BaseFormatter)
+class ObjectInspector::CombiningFormatter < ObjectInspector::BaseFormatter
+  # Perform the formatting routine.
   #
-  # @attr (see BaseFormatter)
-  class CombiningFormatter < BaseFormatter
-    # Perform the formatting routine.
-    #
-    # @return [String]
-    def call
-      if wrapped_object_inspection_result
-        build_wrapped_object_string
-      else
-        build_string
-      end
+  # @return [String]
+  def call
+    if wrapped_object_inspection_result
+      build_wrapped_object_string
+    else
+      build_string
     end
+  end
 
-    private
+  private
 
-    def build_wrapped_object_string
-      "#{build_string} "\
+  def build_wrapped_object_string
+    "#{build_string} "\
       "#{ObjectInspector.configuration.presented_object_separator} "\
       "#{wrapped_object_inspection_result}"
-    end
+  end
 
-    def build_string
-      "<#{combine_strings}>"
-    end
+  def build_string
+    "<#{combine_strings}>"
+  end
 
-    def combine_strings
-      strings.join
-    end
+  def combine_strings
+    strings.join
+  end
 
-    # Override in subclasses as needed.
-    def strings
-      [
-        build_identification_string,
-        build_flags_string,
-        build_info_string,
-        build_name_string
-      ].compact
-    end
+  # Override in subclasses as needed.
+  def strings
+    [
+      build_identification_string,
+      build_flags_string,
+      build_info_string,
+      build_name_string,
+    ].compact
+  end
 
-    def build_identification_string
-      identification.to_s
-    end
+  def build_identification_string
+    identification.to_s
+  end
 
-    def build_flags_string
-      "(#{flags.to_s.upcase})" if flags
-    end
+  def build_flags_string
+    "(#{flags.to_s.upcase})" if flags
+  end
 
-    def build_info_string
-      " #{info}" if info
-    end
+  def build_info_string
+    " #{info}" if info
+  end
 
-    def build_name_string
-      " :: #{name}" if name
-    end
+  def build_name_string
+    " :: #{name}" if name
   end
 end