Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ruby/irb] Print deprecation warning for
help
command
(ruby/irb#567) * Give show_doc its own command class * Print deprecation warning for `help` command
- Loading branch information
Showing
4 changed files
with
91 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,23 @@ | ||
# frozen_string_literal: false | ||
# | ||
# help.rb - helper using ri | ||
# | ||
# frozen_string_literal: true | ||
|
||
require_relative "nop" | ||
require_relative "show_doc" | ||
|
||
module IRB | ||
# :stopdoc: | ||
|
||
module ExtendCommand | ||
class Help < Nop | ||
class << self | ||
def transform_args(args) | ||
# Return a string literal as is for backward compatibility | ||
if args.empty? || string_literal?(args) | ||
args | ||
else # Otherwise, consider the input as a String for convenience | ||
args.strip.dump | ||
end | ||
end | ||
end | ||
|
||
class Help < ShowDoc | ||
category "Context" | ||
description "Enter the mode to look up RI documents." | ||
|
||
def execute(*names) | ||
require 'rdoc/ri/driver' | ||
|
||
unless self.class.const_defined?(:Ri) | ||
opts = RDoc::RI::Driver.process_args([]) | ||
self.class.const_set(:Ri, RDoc::RI::Driver.new(opts)) | ||
end | ||
description "[DEPRECATED] Enter the mode to look up RI documents." | ||
|
||
if names.empty? | ||
Ri.interactive | ||
else | ||
names.each do |name| | ||
begin | ||
Ri.display_name(name.to_s) | ||
rescue RDoc::RI::Error | ||
puts $!.message | ||
end | ||
end | ||
end | ||
DEPRECATION_MESSAGE = <<~MSG | ||
[Deprecation] The `help` command will be repurposed to display command help in the future. | ||
For RI document lookup, please use the `show_doc` command instead. | ||
For command help, please use `show_cmds` for now. | ||
MSG | ||
|
||
nil | ||
rescue LoadError, SystemExit | ||
warn "Can't display document because `rdoc` is not installed." | ||
def execute(*names) | ||
warn DEPRECATION_MESSAGE | ||
super | ||
end | ||
end | ||
end | ||
|
||
# :startdoc: | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# frozen_string_literal: true | ||
|
||
require_relative "nop" | ||
|
||
module IRB | ||
module ExtendCommand | ||
class ShowDoc < Nop | ||
class << self | ||
def transform_args(args) | ||
# Return a string literal as is for backward compatibility | ||
if args.empty? || string_literal?(args) | ||
args | ||
else # Otherwise, consider the input as a String for convenience | ||
args.strip.dump | ||
end | ||
end | ||
end | ||
|
||
category "Context" | ||
description "Enter the mode to look up RI documents." | ||
|
||
def execute(*names) | ||
require 'rdoc/ri/driver' | ||
|
||
unless ShowDoc.const_defined?(:Ri) | ||
opts = RDoc::RI::Driver.process_args([]) | ||
ShowDoc.const_set(:Ri, RDoc::RI::Driver.new(opts)) | ||
end | ||
|
||
if names.empty? | ||
Ri.interactive | ||
else | ||
names.each do |name| | ||
begin | ||
Ri.display_name(name.to_s) | ||
rescue RDoc::RI::Error | ||
puts $!.message | ||
end | ||
end | ||
end | ||
|
||
nil | ||
rescue LoadError, SystemExit | ||
warn "Can't display document because `rdoc` is not installed." | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters