Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Commit

Permalink
Move ObjectInspection.inspect
Browse files Browse the repository at this point in the history
It isn't good to name a method `inspect`, even if it's on the class
level. This prevents the class from being inspected, which can easily
happen automatically in an IRB console.
  • Loading branch information
mcmire committed Feb 14, 2021
1 parent 27b9b33 commit a0aef2e
Show file tree
Hide file tree
Showing 12 changed files with 160 additions and 100 deletions.
8 changes: 8 additions & 0 deletions lib/super_diff.rb
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ def self.configuration
@_configuration ||= Configuration.new
end

def self.inspect_object(object, as_single_line:, indent_level: 0)
ObjectInspection::Inspectors::Main.call(
object,
as_single_line: as_single_line,
indent_level: indent_level,
)
end

def self.time_like?(value)
# Check for ActiveSupport's #acts_like_time? for their time-like objects
# (like ActiveSupport::TimeWithZone).
Expand Down
2 changes: 1 addition & 1 deletion lib/super_diff/diff_formatters/collection.rb
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def build_chunk_for(operation, prefix:, icon:)
end

def build_chunk_by_inspecting(value, prefix:, icon:)
inspection = ObjectInspection.inspect(
inspection = SuperDiff.inspect_object(
value,
as_single_line: false,
)
Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/equality_matchers/array.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ def fail
Helpers.style(
:expected,
"Expected: " +
ObjectInspection.inspect(expected, as_single_line: true),
SuperDiff.inspect_object(expected, as_single_line: true),
)
}
#{
Helpers.style(
:actual,
" Actual: " +
ObjectInspection.inspect(actual, as_single_line: true),
SuperDiff.inspect_object(actual, as_single_line: true),
)
}
Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/equality_matchers/default.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ def expected_line
Helpers.style(
:expected,
"Expected: " +
ObjectInspection.inspect(expected, as_single_line: true),
SuperDiff.inspect_object(expected, as_single_line: true),
)
end

def actual_line
Helpers.style(
:actual,
" Actual: " +
ObjectInspection.inspect(actual, as_single_line: true),
SuperDiff.inspect_object(actual, as_single_line: true),
)
end

Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/equality_matchers/hash.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ def fail
Helpers.style(
:expected,
"Expected: " +
ObjectInspection.inspect(expected, as_single_line: true),
SuperDiff.inspect_object(expected, as_single_line: true),
)
}
#{
Helpers.style(
:actual,
" Actual: " +
ObjectInspection.inspect(actual, as_single_line: true),
SuperDiff.inspect_object(actual, as_single_line: true),
)
}
Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/equality_matchers/multiline_string.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ def fail
Helpers.style(
:expected,
"Expected: " +
ObjectInspection.inspect(expected, as_single_line: true),
SuperDiff.inspect_object(expected, as_single_line: true),
)
}
#{
Helpers.style(
:actual,
" Actual: " +
ObjectInspection.inspect(actual, as_single_line: true),
SuperDiff.inspect_object(actual, as_single_line: true),
)
}
Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/equality_matchers/primitive.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ def fail
Helpers.style(
:expected,
"Expected: " +
ObjectInspection.inspect(expected, as_single_line: true),
SuperDiff.inspect_object(expected, as_single_line: true),
)
}
#{
Helpers.style(
:actual,
" Actual: " +
ObjectInspection.inspect(actual, as_single_line: true),
SuperDiff.inspect_object(actual, as_single_line: true),
)
}
OUTPUT
Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/equality_matchers/singleline_string.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ def fail
Helpers.style(
:expected,
"Expected: " +
ObjectInspection.inspect(expected, as_single_line: true),
SuperDiff.inspect_object(expected, as_single_line: true),
)
}
#{
Helpers.style(
:actual,
" Actual: " +
ObjectInspection.inspect(actual, as_single_line: true),
SuperDiff.inspect_object(actual, as_single_line: true),
)
}
OUTPUT
Expand Down
8 changes: 0 additions & 8 deletions lib/super_diff/object_inspection.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,5 @@ module ObjectInspection
autoload :InspectionTree, "super_diff/object_inspection/inspection_tree"
autoload :Inspectors, "super_diff/object_inspection/inspectors"
autoload :Nodes, "super_diff/object_inspection/nodes"

def self.inspect(object, as_single_line:, indent_level: 0)
Inspectors::Main.call(
object,
as_single_line: as_single_line,
indent_level: indent_level,
)
end
end
end
2 changes: 1 addition & 1 deletion lib/super_diff/object_inspection/nodes/inspection.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def evaluate(object, indent_level:, as_single_line:)
immediate_value
end

SuperDiff::ObjectInspection.inspect(
SuperDiff.inspect_object(
value,
indent_level: indent_level,
as_single_line: as_single_line,
Expand Down
4 changes: 2 additions & 2 deletions lib/super_diff/rspec/monkey_patches.rb
Original file line number Diff line number Diff line change
Expand Up @@ -255,12 +255,12 @@ module Support
class ObjectFormatter
# Override to use our formatting algorithm
def self.format(value)
SuperDiff::ObjectInspection.inspect(value, as_single_line: true)
SuperDiff.inspect_object(value, as_single_line: true)
end

# Override to use our formatting algorithm
def format(value)
SuperDiff::ObjectInspection.inspect(value, as_single_line: true)
SuperDiff.inspect_object(value, as_single_line: true)
end
end
end
Expand Down
Loading

0 comments on commit a0aef2e

Please sign in to comment.