Module: CheckPlease

Defined in:
lib/check_please.rb,
lib/check_please.rb,
lib/check_please/cli.rb,
lib/check_please/diff.rb,
lib/check_please/flag.rb,
lib/check_please/path.rb,
lib/check_please/diffs.rb,
lib/check_please/error.rb,
lib/check_please/flags.rb,
lib/check_please/version.rb,
lib/check_please/printers.rb,
lib/check_please/cli/parser.rb,
lib/check_please/cli/runner.rb,
lib/check_please/comparison.rb,
lib/check_please/reification.rb,
lib/check_please/path_segment.rb,
lib/check_please/printers/base.rb,
lib/check_please/printers/json.rb,
lib/check_please/printers/long.rb,
lib/check_please/path_segment_matcher.rb,
lib/check_please/printers/table_print.rb

Defined Under Namespace

Modules: CLI, Error, Printers, Reification Classes: BehaviorUndefined, Comparison, Diff, Diffs, DuplicateKeyError, Flag, Flags, InvalidFlag, InvalidPath, InvalidPathSegment, NoSuchKeyError, Path, PathSegment, PathSegmentMatcher, TypeMismatchError

Constant Summary collapse

ELEVATOR_PITCH =
"Tool for parsing and diffing two JSON documents."
VERSION =

NOTE: ‘check_please_rspec_matcher’ depends on this,

so try to keep them roughly in sync
"0.5.7"

Class Method Summary collapse

Class Method Details

.diff(reference, candidate, flags = {}) ⇒ Object



28
29
30
31
32
# File 'lib/check_please.rb', line 28

def self.diff(reference, candidate, flags = {})
  reference = maybe_parse(reference)
  candidate = maybe_parse(candidate)
  Comparison.perform(reference, candidate, flags)
end

.render_diff(reference, candidate, flags = {}) ⇒ Object



34
35
36
37
# File 'lib/check_please.rb', line 34

def self.render_diff(reference, candidate, flags = {})
  diffs = diff(reference, candidate, flags)
  Printers.render(diffs, flags)
end