object_inspector 0.6.2 → 0.7.0

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

data/Gemfile.lock

@@ -1,83 +0,0 @@
-PATH
-  remote: .
-  specs:
-    object_inspector (0.6.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.2)
-    benchmark-ips (2.10.0)
-    builder (3.2.4)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    docile (1.4.0)
-    json (2.6.3)
-    kwalify (0.7.2)
-    method_source (1.0.0)
-    minitest (5.16.3)
-    minitest-reporters (1.5.0)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    object_identifier (0.4.1)
-    parallel (1.22.1)
-    parser (3.1.3.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    reek (6.1.3)
-      kwalify (~> 0.7.0)
-      parser (~> 3.1.0)
-      rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rubocop (1.41.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.1.2.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  benchmark-ips
-  bundler
-  byebug
-  minitest
-  minitest-reporters
-  object_identifier
-  object_inspector!
-  pry
-  pry-byebug
-  rake
-  reek
-  rubocop
-  simplecov
-
-BUNDLED WITH
-   2.4.1

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: :test

data/bin/console

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "object_inspector"
-require "object_identifier"
-require "ostruct"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "pry"
-Pry.start
-
-# require "irb"
-# IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/object_inspector.gemspec

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "object_inspector/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "object_inspector"
-  spec.version       = ObjectInspector::VERSION
-  spec.authors       = ["Paul DobbinSchmaltz"]
-  spec.email         = ["p.dobbinschmaltz@icloud.com"]
-
-  spec.summary       = "ObjectInspector builds uniformly formatted inspect output with customizable amounts of detail."
-  spec.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."
-  spec.homepage      = "https://github.com/pdobb/object_inspector"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
-
-  spec.files =
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
-    end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "benchmark-ips"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "object_identifier"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "reek"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
-end

data/scripts/benchmarking/formatters.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-# Play from the console with:
-#   play scripts/benchmarking/formatters.rb
-
-require "ostruct"
-require "benchmark/ips"
-
-custom_formatter_klasses ||= []
-
-formatter_klasses = [
-  ObjectInspector::TemplatingFormatter,
-  ObjectInspector::CombiningFormatter,
-  *Array(custom_formatter_klasses)
-]
-
-INSPECTOR_WITH_FLAGS_AND_INFO_AND_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2",
-    info: "INFO",
-    name: "NAME")
-INSPECTOR_WITH_FLAGS_AND_INFO ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2",
-    info: "INFO")
-INSPECTOR_WITH_FLAGS_AND_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2",
-    name: "NAME")
-INSPECTOR_WITH_INFO_AND_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    info: "INFO",
-    name: "NAME")
-INSPECTOR_WITH_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    name: "NAME")
-INSPECTOR_WITH_FLAGS ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2")
-INSPECTOR_WITH_INFO ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    info: "INFO")
-INSPECTOR_WITH_BASE ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION")
-
-puts "== Averaged ============================================================="
-Benchmark.ips { |x|
-  formatter_klasses.each do |formatter_klass|
-    x.report(formatter_klass) {
-      formatter_klass.new(INSPECTOR_WITH_FLAGS_AND_INFO_AND_NAME).call
-      formatter_klass.new(INSPECTOR_WITH_FLAGS_AND_INFO).call
-      formatter_klass.new(INSPECTOR_WITH_FLAGS_AND_NAME).call
-      formatter_klass.new(INSPECTOR_WITH_INFO_AND_NAME).call
-      formatter_klass.new(INSPECTOR_WITH_NAME).call
-      formatter_klass.new(INSPECTOR_WITH_FLAGS).call
-      formatter_klass.new(INSPECTOR_WITH_INFO).call
-      formatter_klass.new(INSPECTOR_WITH_BASE).call
-    }
-  end
-
-  x.compare!
-}
-puts "== Done"
-
-puts "== Individualized ======================================================="
-Benchmark.ips { |x|
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Flags and Info and Name") {
-      formatter_klass.new(INSPECTOR_WITH_FLAGS_AND_INFO_AND_NAME).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Flags and Info") {
-      formatter_klass.new(INSPECTOR_WITH_FLAGS_AND_INFO).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Flags and Name") {
-      formatter_klass.new(INSPECTOR_WITH_FLAGS_AND_NAME).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Info and Name") {
-      formatter_klass.new(INSPECTOR_WITH_INFO_AND_NAME).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Name") {
-      formatter_klass.new(INSPECTOR_WITH_NAME).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Flags") {
-      formatter_klass.new(INSPECTOR_WITH_FLAGS).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Info") {
-      formatter_klass.new(INSPECTOR_WITH_INFO).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Base") {
-      formatter_klass.new(INSPECTOR_WITH_BASE).call
-    }
-  end
-
-  x.compare!
-}
-puts "== Done"

data/scripts/benchmarking/object_inspector.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-# Play from the console with:
-#   play scripts/benchmarking/object_inspector.rb
-
-require "ostruct"
-require "benchmark/ips"
-
-inspector_klass = ObjectInspector::Inspector
-
-OBJECT_WITH_FLAGS_AND_INFO_AND_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2",
-    info: "INFO",
-    name: "NAME")
-OBJECT_WITH_FLAGS_AND_INFO ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2",
-    info: "INFO")
-OBJECT_WITH_FLAGS_AND_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2",
-    name: "NAME")
-OBJECT_WITH_INFO_AND_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    info: "INFO",
-    name: "NAME")
-OBJECT_WITH_NAME ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    name: "NAME")
-OBJECT_WITH_FLAGS ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    flags: "FLAG1 | FLAG2")
-OBJECT_WITH_INFO ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION",
-    info: "INFO")
-OBJECT_WITH_BASE ||=
-  OpenStruct.new(
-    identification: "IDENTIFICATION")
-
-puts "== Averaged ============================================================="
-Benchmark.ips { |x|
-  x.report(inspector_klass) {
-    inspector_klass.inspect(OBJECT_WITH_FLAGS_AND_INFO_AND_NAME)
-    inspector_klass.inspect(OBJECT_WITH_FLAGS_AND_INFO)
-    inspector_klass.inspect(OBJECT_WITH_FLAGS_AND_NAME)
-    inspector_klass.inspect(OBJECT_WITH_INFO_AND_NAME)
-    inspector_klass.inspect(OBJECT_WITH_NAME)
-    inspector_klass.inspect(OBJECT_WITH_FLAGS)
-    inspector_klass.inspect(OBJECT_WITH_INFO)
-    inspector_klass.inspect(OBJECT_WITH_BASE)
-  }
-
-  x.report("Ruby") {
-    OBJECT_WITH_FLAGS_AND_INFO_AND_NAME.inspect
-    OBJECT_WITH_FLAGS_AND_INFO.inspect
-    OBJECT_WITH_FLAGS_AND_NAME.inspect
-    OBJECT_WITH_INFO_AND_NAME.inspect
-    OBJECT_WITH_NAME.inspect
-    OBJECT_WITH_FLAGS.inspect
-    OBJECT_WITH_INFO.inspect
-    OBJECT_WITH_BASE.inspect
-  }
-
-  x.compare!
-}
-puts "== Done"