object_inspector 0.6.2 → 0.6.3

data/lib/object_inspector/scope.rb

@@ -1,132 +1,141 @@
 # frozen_string_literal: true
 
-module ObjectInspector
-  # ObjectInspector::Scope defines a predicate method that matches {#name} and
-  # responds with `true`. This is a prettier way to test for a given type of
-  # "scope" within objects.
-  #
-  # It is possible to pass in multiple scope names to match on.
-  # `:all` is a "wild card" scope name, and will match on all scope names.
-  # Passing a block to a scope predicate falls back to the out-of-scope
-  # placeholder (`*` by default) if the scope does not match.
-  #
-  # @see ActiveSupport::StringInquirer
-  #   http://api.rubyonrails.org/classes/ActiveSupport/StringInquirer.html
+# :reek:TooManyMethods
+
+# ObjectInspector::Scope defines a predicate method that matches {#names} and
+# responds with `true`. This is a prettier way to test for a given type of
+# "scope" within objects.
+#
+# It is possible to pass in multiple scope names to match on.
+#
+# `:all` is a "wild card" scope name, and will match on all scope names.
+#
+# Passing a block to a scope predicate falls back to the out-of-scope
+# placeholder (`*` by default) if the scope does not match.
+#
+# @see ActiveSupport::StringInquirer
+#   http://api.rubyonrails.org/classes/ActiveSupport/StringInquirer.html
+#
+# @attr names [Array<#to_s>]
+class ObjectInspector::Scope
+  attr_reader :names
+
+  def initialize(names = %w[self])
+    @names = Array(names).map { |name| String(name) }
+  end
+
+  # Join the passed in name parts with the passed in separator.
   #
-  # @attr names [Array<#to_s>]
-  class Scope
-    attr_reader :names
+  # @param parts [Array<#to_s>]
+  # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
+  def join_name(parts,
+                separator: ObjectInspector.configuration.name_separator)
+    _join(parts, separator)
+  end
 
-    def initialize(names = %w[self])
-      @names = Array(names).map { |name| String(name) }
-    end
+  # Join the passed in flags with the passed in separator.
+  #
+  # @param flags [Array<#to_s>]
+  # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
+  def join_flags(flags,
+                 separator: ObjectInspector.configuration.flags_separator)
+    _join(flags, separator)
+  end
 
-    # Join the passed-in name parts with the passed in separator.
-    #
-    # @param parts [Array<#to_s>]
-    # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
-    def join_name(parts,
-                  separator: ObjectInspector.configuration.name_separator)
-      _join(parts, separator)
-    end
+  # Join the passed in issues with the passed in separator.
+  #
+  # @param issues [Array<#to_s>]
+  # @param separator [#to_s] (ObjectInspector.configuration.issues_separator)
+  def join_issues(issues,
+                  separator: ObjectInspector.configuration.issues_separator)
+    _join(issues, separator)
+  end
 
-    # Join the passed-in flags with the passed in separator.
-    #
-    # @param flags [Array<#to_s>]
-    # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
-    def join_flags(flags,
-                   separator: ObjectInspector.configuration.flags_separator)
-      _join(flags, separator)
-    end
+  # Join the passed in items with the passed in separator.
+  #
+  # @param items [Array<#to_s>]
+  # @param separator [#to_s] (ObjectInspector.configuration.info_separator)
+  def join_info(items,
+                separator: ObjectInspector.configuration.info_separator)
+    _join(items, separator)
+  end
 
-    # Join the passed-in issues with the passed in separator.
-    #
-    # @param issues [Array<#to_s>]
-    # @param separator [#to_s] (ObjectInspector.configuration.issues_separator)
-    def join_issues(issues,
-                    separator: ObjectInspector.configuration.issues_separator)
-      _join(issues, separator)
-    end
+  # Compare self with the passed in object.
+  #
+  # @return [TrueClass] if self and `other` resolve to the same set of objects
+  # @return [FalseClass] if self and `other` resolve to a different set of
+  #   objects
+  def ==(other)
+    @names.sort == Array(other).map(&:to_s).sort
+  end
+  alias_method :eql?, :==
 
-    # Join the passed-in items with the passed in separator.
-    #
-    # @param items [Array<#to_s>]
-    # @param separator [#to_s] (ObjectInspector.configuration.info_separator)
-    def join_info(items,
-                  separator: ObjectInspector.configuration.info_separator)
-      _join(items, separator)
-    end
+  # @return [String] the contents of {#names}, joined by `, `.
+  def to_s(separator: ", ")
+    to_a.join(separator)
+  end
 
-    # Compare self with the passed in object.
-    #
-    # @return [TrueClass] if self and `other` resolve to the same set of objects
-    # @return [FalseClass] if self and `other` resolve to a different set of
-    #   objects
-    def ==(other)
-      @names.sort == Array(other).map(&:to_s).sort
-    end
-    alias_method :eql?, :==
+  # @return (see #names)
+  def to_a
+    names
+  end
 
-    def to_s(separator: ", ")
-      to_a.join(separator)
-    end
+  private
 
-    def to_a
-      @names
+  def method_missing(method_name, *args, &block)
+    if method_name[-1] == "?"
+      scope_name = method_name[0..-2]
+      evaluate_match(scope_name, &block)
+    else
+      super
     end
+  end
 
-    private
+  def evaluate_match(scope_name, &block)
+    is_a_match = match?(scope_name)
 
-    def method_missing(method_name, *args, &block)
-      if method_name[-1] == "?"
-        scope_name = method_name[0..-2]
-        evaluate_match(scope_name, &block)
-      else
-        super
-      end
+    if block
+      evaluate_block_if(is_a_match, &block)
+    else
+      is_a_match
     end
+  end
 
-    def evaluate_match(scope_name, &block)
-      is_a_match = match?(scope_name)
+  # :reek:ControlParameter (`condition`)
 
-      if block
-        evaluate_block_if(is_a_match, &block)
-      else
-        is_a_match
-      end
+  def evaluate_block_if(condition)
+    if condition
+      yield(self)
+    else
+      ObjectInspector.configuration.out_of_scope_placeholder
     end
+  end
 
-    def evaluate_block_if(condition)
-      if condition
-        yield(self)
-      else
-        ObjectInspector.configuration.out_of_scope_placeholder
-      end
-    end
+  # :reek:FeatureEnvy (`items.`)
 
-    def _join(items, separator)
-      items = Array(items)
-      items.flatten!
-      items.compact!
-      items.join(separator) unless items.empty?
-    end
+  def _join(items, separator)
+    items = Array(items)
+    items.flatten!
+    items.compact!
+    items.join(separator) unless items.empty?
+  end
 
-    def match?(scope_name)
-      any_names_match?(scope_name) ||
-        wild_card_scope?
-    end
+  def match?(scope_name)
+    any_names_match?(scope_name) ||
+      wild_card_scope?
+  end
 
-    def wild_card_scope?
-      @wild_card_scope ||=
-        any_names_match?(ObjectInspector.configuration.wild_card_scope)
-    end
+  def wild_card_scope?
+    @wild_card_scope ||=
+      any_names_match?(ObjectInspector.configuration.wild_card_scope)
+  end
 
-    def any_names_match?(other_name)
-      @names.any? { |name| name == other_name }
-    end
+  def any_names_match?(other_name)
+    @names.any?(other_name)
+  end
 
-    def respond_to_missing?(method_name, include_private = false)
-      method_name[-1] == "?" || super
-    end
+  # :reek:BooleanParameter
+  def respond_to_missing?(method_name, include_private = false)
+    method_name[-1] == "?" || super
   end
 end

data/lib/object_inspector/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module ObjectInspector
-  VERSION = "0.6.2"
+  # The current ObjectInspector gem version.
+  VERSION = "0.6.3"
 end

data/lib/object_inspector.rb

@@ -3,14 +3,18 @@
 # ObjectInspector is the base namespace for all modules/classes related to the
 # object_inspector gem.
 module ObjectInspector
+  # Accessor for the {ObjectInspector::Configuration} object.
   def self.configuration
     @configuration ||= Configuration.new
   end
 
+  # @yieldparam configuration [ObjectInspector::Configuration]
   def self.configure
     yield(configuration)
   end
 
+  # Reset the current configuration settings memoized by
+  # {ObjectInspector.configuration}.
   def self.reset_configuration
     @configuration = Configuration.new
   end
@@ -18,6 +22,8 @@ module ObjectInspector
   # ObjectInspector::Configuration stores the default configuration options for
   # the ObjectInspector gem. Modification of attributes is possible at any time,
   # and values will persist for the duration of the running process.
+  #
+  # :reek:TooManyInstanceVariables
   class Configuration
     attr_reader :formatter_class,
                 :inspect_method_prefix,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdobb-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -178,27 +192,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 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.
+description: 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 represents objects. Great for the
+  console, logging, etc.
 email:
 - p.dobbinschmaltz@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop"
-- ".rubocop.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/object_inspector.rb
 - lib/object_inspector/conversions.rb
 - lib/object_inspector/formatters/base_formatter.rb
@@ -209,13 +214,15 @@ files:
 - lib/object_inspector/object_interrogator.rb
 - lib/object_inspector/scope.rb
 - lib/object_inspector/version.rb
-- object_inspector.gemspec
-- scripts/benchmarking/formatters.rb
-- scripts/benchmarking/object_inspector.rb
 homepage: https://github.com/pdobb/object_inspector
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/pdobb/object_inspector/issues
+  changelog_uri: https://github.com/pdobb/object_inspector/releases
+  source_code_uri: https://github.com/pdobb/object_inspector
+  homepage_uri: https://github.com/pdobb/object_inspector
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -224,16 +231,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: ObjectInspector builds uniformly formatted inspect output with customizable
+summary: Object Inspector builds uniformly formatted inspect output with customizable
   amounts of detail.
 test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.byebug_history
-*.gem
-.DS_Store

data/.rubocop

@@ -1,4 +0,0 @@
---display-cop-names
---display-style-guide
---extra-details
---format=fuubar

data/.rubocop.yml

@@ -1,158 +0,0 @@
-AllCops:
-  UseCache: true
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: false
-  TargetRubyVersion: 2.5.3
-
-Layout/ClassStructure:
-  Enabled: true
-  Categories:
-    module_inclusion:
-      - extend
-      - include
-      - prepend
-    attributes:
-      - attr_accessor
-      - attr_reader
-      - attr_writer
-  ExpectedOrder:
-    - constants
-    - module_inclusion
-    - attributes
-    - public_class_methods
-    - initializer
-    - public_methods
-    - predicates
-    - protected_methods
-    - private_methods
-
-Layout/DotPosition:
-  EnforcedStyle: trailing
-
-Layout/EmptyLineAfterGuardClause:
-  Enabled: true
-
-Layout/EndOfLine:
-  EnforcedStyle: lf
-
-Layout/IndentFirstArgument:
-  EnforcedStyle: consistent_relative_to_receiver
-
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Layout/IndentFirstHashElement:
-  EnforcedStyle: consistent
-
-Layout/IndentFirstParameter:
-  Enabled: false # Revisit if more settings become available.
-
-Layout/MultilineAssignmentLayout:
-  Enabled: true
-
-Layout/MultilineMethodCallBraceLayout:
-  EnforcedStyle: same_line
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver
-
-Layout/MultilineMethodDefinitionBraceLayout:
-  EnforcedStyle: same_line
-
-Layout/MultilineOperationIndentation:
-  Enabled: false # Waiting for e.g. `indented_relative_to_receiver`.
-
-Lint/AmbiguousOperator:
-  Enabled: false # Conflicts with other rules.
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false # Conflicts with other rules.
-
-Lint/Void:
-  CheckForMethodsWithNoSideEffects: true
-
-Metrics/BlockLength:
-  ExcludedMethods:
-    - new
-    - describe # Tests
-    - context # Tests
-    - ips # Benchmarking
-
-Metrics/ClassLength:
-  Exclude:
-    - "test/**/*"
-    - "lib/object_inspector/formatters/templating_formatter.rb"
-
-Metrics/LineLength:
-  Max: 80
-  Exclude:
-    - "test/**/*"
-    - "object_inspector.gemspec"
-
-Naming/UncommunicativeMethodParamName:
-  AllowedNames:
-    - a
-    - b
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/BlockDelimiters:
-  Enabled: false # Reconsider later.
-
-Style/ClassAndModuleChildren:
-  AutoCorrect: true
-  Exclude:
-    - "test/**/*"
-
-Style/CollectionMethods:
-  Enabled: true
-  PreferredMethods:
-    collect: map
-    collect!: map!
-    find_all: select
-    detect: detect
-    inject: inject
-
-Style/EmptyElse:
-  # It"s helpful to show intent by including a comment in an else block.
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/ExpandPathArguments:
-  Exclude:
-    - "object_inspector.gemspec"
-
-Style/FormatString:
-  Enabled: false # % notation with an Array just reads better sometimes.
-
-Style/Lambda:
-  EnforcedStyle: literal
-
-Style/NumericPredicate:
-  AutoCorrect: true
-
-Style/RegexpLiteral:
-  EnforcedStyle: mixed
-
-Style/RescueStandardError:
-  EnforcedStyle: implicit
-
-Style/ReturnNil:
-  Enabled: true
-
-Style/StringMethods:
-  Enabled: true
-
-Style/SingleLineMethods:
-  Exclude:
-    - "test/**/*_test.rb"
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,49 +0,0 @@
-### 0.6.2 - 2022-12-30
-- Internal spruce-up for Ruby 3.2. No outward-facing changes.
-- Remove travis-ci config since travis-ci is no longer in use.
-
-### 0.6.1 - 2019-06-27
-- Flatten and compact arrays of `nil`s as well as nested arrays of `nil`s in join_* methods.
-
-### 0.6.0 - 2019-03-13
-- Fix inspection of delegating wrapper objects.
-- Allow clearing output of inspect methods.
-
-### 0.5.2 - 2019-02-24
-- Automatically compact nils in join_* methods.
-
-### 0.5.1 - 2018-06-12
-- Don't include empty strings from Scope#join_* methods when applicable.
-
-### 0.5.0 - 2018-06-11
-- Add `inspect_issues` to ObjectInspector::TemplatingFormatter.
-- Add ObjectInspector::Scope#join_name.
-- Add configurable ObjectInspector.configuration.presented_object_separator.
-
-### 0.4.0 - 2018-05-25
-- Feature: Add ObjectInspector::Configuration#default_scope setting -- can be used to override the default Scope for object inspection.
-- Implement ObjectInspector::Scope#== for comparing scopes with scopes and/or scopes with (Arrays of) Strings, Symbols, etc.
-
-### 0.3.1 - 2018-04-15
-- Add ObjectInspector::Configuration#formatter_class setting for overriding the default Formatter.
-
-### 0.3.0 - 2018-04-14
-- Remove optional dependency on ActiveSupport::StringInquirer. [Scopes are now objects](https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/scope.rb) that act like ActiveSupport::StringInquirer objects.
-- Add ObjectInspector::Scope.join_flags helper method.
-- Add ObjectInspector::Scope.join_info helper method.
-- Scope: Show an out-of-scope-placeholder symbol (*) when predicate is not matched and a block is given.
-- Scope: Add wild-card "all" scope that is always evaluated as true / a match.
-- Add ability to specify multiple scopes. e.g. my_object.inspect(scope: %i[verbose complex]).
-- Add gem defaults configuration.
-
-### 0.2.0 - 2018-04-12
-- Automatically inspect wrapped Objects, if applicable.
-- Use `display_name` if defined on object, in place of `inspect_name`.
-- Add on-the-fly inspect methods when Symbols are passed in to #inspect.
-- Update the `flags` and `info` demarcation symbols.
-- Add ObjectInspector::TemplatingFormatter, and use it as the new default since it's faster.
-- Rename ObjectInspector::DefaultFormatter to ObjectInspector::CombiningFormatter.
-
-
-### 0.1.0 - 2018-04-09
-- Initial release!

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in object_inspector.gemspec
-gemspec