Class: RBS::CLI::Diff

Inherits:
Object
  • Object
show all
Defined in:
lib/rbs/cli/diff.rb,
sig/cli/diff.rbs

Instance Method Summary collapse

Constructor Details

#initialize(stdout: $stdout, stderr: $stderr) ⇒ Diff

Returns a new instance of Diff.

Parameters:

  • stdout: (_IO) (defaults to: $stdout)
  • stderr: (_IO) (defaults to: $stderr) 


6
7
8
9
 
# File 'lib/rbs/cli/diff.rb', line 6

def initialize(stdout: $stdout, stderr: $stderr)
  @stdout = stdout
  @stderr = stderr
end

Instance Method Details

#run(argv:, library_options:) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rbs/cli/diff.rb', line 11

def run(argv:, library_options:)
  format = nil #: String?
  type_name = nil #: String?
  library_options = library_options
  before_path = [] #: Array[String]
  after_path = [] #: Array[String]
  detail = false

  opt = OptionParser.new do |o|
    o.banner = <<~HELP
      [Experimental] This command is experimental. API and output compatibility is not guaranteed.

      Usage:
        rbs diff --format markdown --type-name Foo --before before_sig --after after_sig

      Print diff for rbs environment dir

      Examples:

        # Diff dir1 and dir2 for Foo
        $ rbs diff --format markdown --type-name Foo --before dir1 --after dir2

        # Confirmation of methods related to Time class added by including stdlib/time
        $ rbs diff --format diff --type-name Time --after stdlib/time
    HELP
    o.on("--format NAME")    { |arg| format = arg }
    o.on("--type-name NAME") { |arg| type_name = arg }
    o.on("--before DIR")     { |arg| before_path << arg }
    o.on("--after DIR")      { |arg| after_path << arg }
    o.on("--[no-]detail")    { |arg| detail = arg }
  end
  opt.parse!(argv)

  unless format && type_name && ["markdown", "diff"].include?(format)
    @stderr.puts opt.banner
    return 1
  end

  diff = RBS::Diff.new(
    type_name: TypeName.parse(type_name).absolute!,
    library_options: library_options,
    after_path: after_path,
    before_path: before_path,
    detail: detail,
  )

  public_send("run_#{format}", diff)

  0
end

#run_diff(diff) ⇒ void

This method returns an undefined value.

Parameters:



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rbs/cli/diff.rb', line 62

def run_diff(diff)
  first = true
  io = RBS::CLI::ColoredIO.new(stdout: @stdout)
  diff.each_diff do |before, after|
    io.puts if !first
    io.puts_red   "- #{before}"
    io.puts_green "+ #{after}"
    first = false
  end
end

#run_markdown(diff) ⇒ void

This method returns an undefined value.

Parameters:



73
74
75
76
77
78
79
80
81
 
# File 'lib/rbs/cli/diff.rb', line 73

def run_markdown(diff)
  @stdout.puts "| before | after |"
  @stdout.puts "| --- | --- |"
  diff.each_diff do |before, after|
    before.gsub!("|", "\\|")
    after.gsub!("|", "\\|")
    @stdout.puts "| `#{before}` | `#{after}` |"
  end
end