class Pry # The History class is responsible for maintaining the user's input history, both # internally and within Readline. class History attr_accessor :loader, :saver, :pusher, :clearer def initialize @history = [] @saved_lines = 0 restore_default_behavior end # Assign the default methods for loading, saving, pushing, and clearing. def restore_default_behavior @loader = method(:read_from_file) @saver = method(:write_to_file) @pusher = method(:push_to_readline) @clearer = method(:clear_readline) end # Load the input history using `History.loader`. # @return [Integer] The number of lines loaded def load @loader.call do |line| @pusher.call(line.chomp) @history << line.chomp end @saved_lines = @history.length end # Write this session's history using `History.saver`. # @return [Integer] The number of lines saved def save history_to_save = @history[@saved_lines..-1] @saver.call(history_to_save) @saved_lines = @history.length history_to_save.length end # Add a line to the input history, ignoring blank and duplicate lines. # @param [String] line # @return [String] The same line that was passed in def push(line) unless line.empty? || (@history.last && line == @history.last) @pusher.call(line) @history << line end line end alias << push # Clear all history. Anything the user entered before this point won't be # saved, but anything they put in afterwards will still be appended to the # history file on exit. def clear @clearer.call @history = [] @saved_lines = 0 end # Return an Array containing all stored history. # @return [Array] An Array containing all lines of history loaded # or entered by the user in the current session. def to_a @history.dup end private # The default loader. Yields lines from `Pry.history.config.file`. def read_from_file begin history_file = File.expand_path(Pry.config.history.file) if File.exists?(history_file) File.foreach(history_file) { |line| yield(line) } end rescue => error unless error.message.empty? warn "History file not loaded, received an error: #{error.message}" end end end # The default saver. Appends the given lines to `Pry.history.config.file`. # @param [Array] lines def write_to_file(lines) history_file = File.expand_path(Pry.config.history.file) begin File.open(history_file, 'a') do |f| lines.each { |ln| f.puts ln } end rescue Errno::EACCES # We should probably create an option Pry.show_warnings?!?!?! warn 'Unable to write to your history file, history not saved' end end # The default pusher. Appends the given line to Readline::HISTORY. # @param [String] line def push_to_readline(line) Readline::HISTORY << line end # The default clearer. Clears Readline::HISTORY. def clear_readline Readline::HISTORY.shift until Readline::HISTORY.empty? end end end