Upgrading highline 1 to 2
Breaking1.7.10 → 2.1.0Platform1New1Fixed3Other5
BreakingUpgrade verdict
A platform requirement change.
In plain terms
- This version of the library now requires Ruby 2.3 or newer.
Must act 1 item needs code or config changes
Ruby requirement changed in 2.1.0: >= 1.9.3 → >= 2.3.
What you must change
Platform1
Changes the minimum Ruby version requirement to 2.3.
API changes
Generated by DepDelta from published Ruby source. Not mixed with prose notes.
- removed:
const HighLine.BASIC_COLORS - removed:
const HighLine.COLORS - removed:
const HighLine.STYLES - removed:
static method HighLine.color(_, *) - removed:
static method HighLine.color_code(*) - removed:
static method HighLine.color_scheme() - removed:
static method HighLine.const_missing(_) - removed:
static method HighLine.uncolor(_) - removed:
static set HighLine.color_scheme(_) - removed:
static set HighLine.track_eof(_) - removed:
static set HighLine.use_color(_) - changed:
method HighLine.color(*) → method HighLine.color(_, *) - changed:
static method HighLine.track_eof?() → method HighLine.track_eof?() - changed:
static method HighLine.use_color?() → method HighLine.use_color?() - added:
class File - added:
class Tempfile - added:
method HighLine.get_response_character_mode(_) - added:
method HighLine.get_response_getc_mode(_) - added:
method HighLine.get_response_line_mode(_) - added:
method HighLine.new_scope() - added:
method HighLine.puts(*) - added:
method HighLine.render_statement(_) - added:
method HighLine.reset_use_color() - added:
method HighLine.shell_style_lambda(_) - added:
method IOConsoleCompatible.getch() - added:
method IOConsoleCompatible.winsize() - added:
module IOConsoleCompatible - added:
property HighLine.input: reader - added:
property HighLine.key: accessor - added:
property HighLine.output: reader - added:
property HighLine.terminal: reader - added:
property HighLine.track_eof: accessor - added:
property HighLine.use_color: accessor - added:
property IOConsoleCompatible.echo: accessor - added:
static method HighLine.find_or_create_style(_) - added:
static method HighLine.find_or_create_style_list(*) - added:
static method HighLine.reset() - added:
static method HighLine.reset_color_scheme() - added:
static property HighLine.color_scheme: accessor - added:
static property HighLine.default_instance: accessor
- removed:
class BLACK_STYLE < Style.new(:name=>:black, :builtin=>true, :code=>"\e[30m", :rgb=>[0, 0, 0]) - removed:
class BLINK_STYLE < Style.new(:name=>:blink, :builtin=>true, :code=>"\e[5m") - removed:
class BLUE_STYLE < Style.new(:name=>:blue, :builtin=>true, :code=>"\e[34m", :rgb=>[0, 0,128]) - removed:
class BOLD_STYLE < Style.new(:name=>:bold, :builtin=>true, :code=>"\e[1m") - removed:
class CLEAR_STYLE < Style.new(:name=>:clear, :builtin=>true, :code=>"\e[0m") - removed:
class CONCEALED_STYLE < Style.new(:name=>:concealed, :builtin=>true, :code=>"\e[8m") - removed:
class CYAN_STYLE < Style.new(:name=>:cyan, :builtin=>true, :code=>"\e[36m", :rgb=>[0,128,128]) - removed:
class DARK_STYLE < Style.new(:name=>:dark, :builtin=>true, :code=>"\e[2m") - removed:
class ERASE_CHAR_STYLE < Style.new(:name=>:erase_char, :builtin=>true, :code=>"\e[P") - removed:
class ERASE_LINE_STYLE < Style.new(:name=>:erase_line, :builtin=>true, :code=>"\e[K") - removed:
class GRAY_STYLE < Style.new(:name=>:gray, :builtin=>true, :code=>"\e[37m", :rgb=>[192,192,192]) - removed:
class GREEN_STYLE < Style.new(:name=>:green, :builtin=>true, :code=>"\e[32m", :rgb=>[0,128, 0]) - removed:
class GREY_STYLE < Style.new(:name=>:grey, :builtin=>true, :code=>"\e[37m", :rgb=>[192,192,192]) - removed:
class MAGENTA_STYLE < Style.new(:name=>:magenta, :builtin=>true, :code=>"\e[35m", :rgb=>[128, 0,128]) - removed:
class NONE_STYLE < Style.new(:name=>:none, :builtin=>true, :code=>"\e[38m", :rgb=>[0, 0, 0]) - removed:
class QuestionError < StandardError - removed:
class RED_STYLE < Style.new(:name=>:red, :builtin=>true, :code=>"\e[31m", :rgb=>[128, 0, 0]) - removed:
class RESET_STYLE < Style.new(:name=>:reset, :builtin=>true, :code=>"\e[0m") - removed:
class REVERSE_STYLE < Style.new(:name=>:reverse, :builtin=>true, :code=>"\e[7m") - removed:
class UNDERLINE_STYLE < Style.new(:name=>:underline, :builtin=>true, :code=>"\e[4m") - removed:
class UNDERSCORE_STYLE < Style.new(:name=>:underscore, :builtin=>true, :code=>"\e[4m") - removed:
class WHITE_STYLE < Style.new(:name=>:white, :builtin=>true, :code=>"\e[37m", :rgb=>[192,192,192]) - removed:
class YELLOW_STYLE < Style.new(:name=>:yellow, :builtin=>true, :code=>"\e[33m", :rgb=>[128,128, 0]) - removed:
const SystemExtensions.CHARACTER_MODE - removed:
const SystemExtensions.JRUBY - removed:
const SystemExtensions.JRUBY_OVER_17 - removed:
method SystemExtensions.get_character(_ = …) - removed:
method SystemExtensions.initialize_system_extensions() - removed:
method SystemExtensions.raw_no_echo_mode() - removed:
method SystemExtensions.restore_mode() - removed:
method SystemExtensions.terminal_size() - removed:
module SystemExtensions - removed:
property Question.question: accessor - removed:
property Question.responses: reader - changed:
method Menu.choice(_, _ = …) → method Menu.choice(_, _ = …, _ = …) - changed:
method Question.build_responses(_ = …, _ = …) → method Question.build_responses(_ = …) - changed:
method Question.convert(_) → method Question.convert() - changed:
method Question.in_range?(_) → method Question.in_range?() - changed:
method Question.valid_answer?(_) → method Question.valid_answer?() - added:
class List - added:
class ListRenderer - added:
class Paginator - added:
class QuestionAsker - added:
class Statement - added:
class String < ::String - added:
class TemplateRenderer - added:
class Terminal - added:
const BuiltinStyles.BASIC_COLORS - added:
const BuiltinStyles.COLORS - added:
const BuiltinStyles.COLOR_LIST - added:
const BuiltinStyles.STYLES - added:
const BuiltinStyles.STYLE_LIST - added:
const SampleColorScheme.SAMPLE_SCHEME - added:
const StringExtensions.STYLE_METHOD_NAME_PATTERN - added:
constructor List(_, _ = …) - added:
constructor ListRenderer(_, _ = …, _ = …, _) - added:
constructor Paginator(_) - added:
constructor QuestionAsker(_, _) - added:
constructor Statement(_, _) - added:
constructor TemplateRenderer(_, _, _) - added:
constructor Terminal(_, _) - added:
method List.col_down() - added:
method List.list() - added:
method List.row_join_str_size() - added:
method List.row_join_string() - added:
method List.slice_by_cols() - added:
method List.slice_by_rows() - added:
method List.to_a() - added:
method List.to_s() - added:
method List.transpose() - added:
method ListRenderer.render() - added:
method Menu.add_item(_) - added:
method Menu.all_items() - added:
method Menu.build_item(*) - added:
method Menu.decorate_index(_) - added:
method Menu.decorate_item(_, _) - added:
method Menu.find_item_from_selection(_, _) - added:
method Menu.gather_selected(_, _, _ = …) - added:
method Menu.get_item_by_letter(_, _) - added:
method Menu.get_item_by_number(_, _) - added:
method Menu.map_items_by_index() - added:
method Menu.map_items_by_name() - added:
method Menu.mark_for_decoration(_, _) - added:
method Menu.parse_list() - added:
method Menu.show_default_if_any() - added:
method Menu.value_for_array_selections(_, _, _) - added:
method Menu.value_for_hash_selections(_, _, _) - added:
method Menu.value_for_selected_item(_, _) - added:
method Paginator.continue_paging?() - added:
method Paginator.page_print(_) - added:
method Question.ask_on_error_msg() - added:
method Question.build_responses_new_hash(_) - added:
method Question.check_range() - added:
method Question.choices_complete(_) - added:
method Question.confirm_question(_) - added:
method Question.default_responses_hash() - added:
method Question.final_response(_) - added:
method Question.final_responses() - added:
method Question.format_answer(_) - added:
method Question.get_echo_for_response(_) - added:
method Question.get_response(_) - added:
method Question.get_response_or_default(_) - added:
method Question.responses() - added:
method Question.show_question(_) - added:
method QuestionAsker.ask_once() - added:
method QuestionAsker.gather_answers() - added:
method QuestionAsker.gather_hash() - added:
method QuestionAsker.gather_integer() - added:
method QuestionAsker.gather_regexp() - added:
method Statement.statement() - added:
method Statement.to_s() - added:
method TemplateRenderer.menu() - added:
method TemplateRenderer.render() - added:
method Terminal.character_mode() - added:
method Terminal.get_character() - added:
method Terminal.get_line(_, _) - added:
method Terminal.get_line_default(_) - added:
method Terminal.get_line_with_readline(_, _) - added:
method Terminal.initialize_system_extensions() - added:
method Terminal.jruby?() - added:
method Terminal.raw_no_echo_mode() - added:
method Terminal.raw_no_echo_mode_exec() - added:
method Terminal.readline_read(_) - added:
method Terminal.restore_mode() - added:
method Terminal.rubinius?() - added:
method Terminal.terminal_size() - added:
method Terminal.windows?() - added:
module BuiltinStyles - added:
module CustomErrors - added:
module Wrapper - added:
property List.col_down_mode: reader - added:
property List.cols: reader - added:
property List.items: reader - added:
property List.row_join_string: writer - added:
property List.transpose_mode: reader - added:
property ListRenderer.highline: reader - added:
property ListRenderer.items: reader - added:
property ListRenderer.mode: reader - added:
property ListRenderer.option: reader - added:
property Menu.index_color: accessor - added:
property Paginator.highline: reader - added:
property Question.answer: accessor - added:
property Question.template: accessor - added:
property QuestionAsker.question: reader - added:
property Statement.highline: reader - added:
property Statement.source: reader - added:
property Statement.template_string: reader - added:
property TemplateRenderer.highline: reader - added:
property TemplateRenderer.source: reader - added:
property TemplateRenderer.template: reader - added:
property Terminal.input: reader - added:
property Terminal.output: reader - added:
set List.cols(_) - added:
static method Question.build(_, _ = …) - added:
static method Statement.const_missing(_) - added:
static method StringExtensions.define_builtin_style_methods(_) - added:
static method StringExtensions.define_style_support_methods(_) - added:
static method Style.clear_index() - added:
static method TemplateRenderer.const_missing(_) - added:
static method Terminal.get_terminal(_, _) - added:
static method Wrapper.actual_length(_) - added:
static method Wrapper.wrap(_, _) - added:
static property Menu.index_color: reader - added:
static property Menu.index_color: writer
- added:
const ClassMethods.RGB_COLOR_PATTERN - added:
method ClassMethods.const_missing(_) - added:
module ClassMethods
- added:
class ExplainableError < StandardError - added:
class NoAutoCompleteMatch < ExplainableError - added:
class NoConfirmationQuestionError < ExplainableError - added:
class NotInRangeQuestionError < ExplainableError - added:
class NotValidQuestionError < ExplainableError - added:
class QuestionError < ExplainableError - added:
method ExplainableError.explanation_key() - added:
method NoAutoCompleteMatch.explanation_key() - added:
method NoConfirmationQuestionError.explanation_key() - added:
method NotInRangeQuestionError.explanation_key() - added:
method NotValidQuestionError.explanation_key() - added:
method QuestionError.explanation_key()
- removed:
class String < ::String
- added:
class Item - added:
constructor Item(_, _) - added:
method Item.item_help() - added:
property Item.action: reader - added:
property Item.help: reader - added:
property Item.name: reader - added:
property Item.text: reader
- removed:
class NoAutoCompleteMatch < StandardError - added:
class AnswerConverter - added:
constructor AnswerConverter(_) - added:
method AnswerConverter.convert() - added:
method AnswerConverter.to_array() - added:
method AnswerConverter.to_file() - added:
method AnswerConverter.to_float() - added:
method AnswerConverter.to_integer() - added:
method AnswerConverter.to_pathname() - added:
method AnswerConverter.to_proc() - added:
method AnswerConverter.to_regexp() - added:
method AnswerConverter.to_string() - added:
method AnswerConverter.to_symbol()
- removed:
const WinAPI.Handle - removed:
module WinAPI - removed:
static method WinAPI.GetConsoleScreenBufferInfo() - removed:
static method WinAPI.GetConsoleScreenBufferInfo(_, _) - removed:
static method WinAPI.GetStdHandle() - removed:
static method WinAPI.GetStdHandle(_) - removed:
static method WinAPI._getch()
- removed:
class Crt < Handle.new("msvcrt") - removed:
class Kernel32 < Handle.new("kernel32")
- added:
class IOConsole < Terminal - added:
class NCurses < Terminal - added:
class UnixStty < Terminal - added:
method IOConsole.get_character() - added:
method IOConsole.raw_no_echo_mode() - added:
method IOConsole.restore_mode() - added:
method IOConsole.terminal_size() - added:
method NCurses.raw_no_echo_mode() - added:
method NCurses.restore_mode() - added:
method NCurses.terminal_size() - added:
method UnixStty.get_character(_ = …) - added:
method UnixStty.raw_no_echo_mode() - added:
method UnixStty.restore_mode() - added:
method UnixStty.terminal_size()