Module: IRB::HistorySavingAbility

Included in:
ReadlineInputMethod, RelineInputMethod
Defined in:
lib/irb/history.rb

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#load_history ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/irb/history.rb', line 13

def load_history
  history = self.class::HISTORY

  if history_file = IRB.conf[:HISTORY_FILE]
    history_file = File.expand_path(history_file)
  end
  history_file = IRB.rc_file("_history") unless history_file
  if history_file && File.exist?(history_file)
    File.open(history_file, "r:#{IRB.conf[:LC_MESSAGES].encoding}") do |f|
      f.each { |l|
        l = l.chomp
        if self.class == RelineInputMethod and history.last&.end_with?("\\")
          history.last.delete_suffix!("\\")
          history.last << "\n" << l
        else
          history << l
        end
      }
    end
    @loaded_history_lines = history.size
    @loaded_history_mtime = File.mtime(history_file)
  end
end

#reset_history_counter ⇒ Object 



9
10
11
 
# File 'lib/irb/history.rb', line 9

def reset_history_counter
  @loaded_history_lines = self.class::HISTORY.size
end

#save_history ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/irb/history.rb', line 37

def save_history
  history = self.class::HISTORY.to_a

  if num = IRB.conf[:SAVE_HISTORY] and (num = num.to_i) != 0
    if history_file = IRB.conf[:HISTORY_FILE]
      history_file = File.expand_path(history_file)
    end
    history_file = IRB.rc_file("_history") unless history_file

    # When HOME and XDG_CONFIG_HOME are not available, history_file might be nil
    return unless history_file

    # Change the permission of a file that already exists[BUG #7694]
    begin
      if File.stat(history_file).mode & 066 != 0
        File.chmod(0600, history_file)
      end
    rescue Errno::ENOENT
    rescue Errno::EPERM
      return
    rescue
      raise
    end

    if File.exist?(history_file) &&
       File.mtime(history_file) != @loaded_history_mtime
      history = history[@loaded_history_lines..-1] if @loaded_history_lines
      append_history = true
    end

    pathname = Pathname.new(history_file)
    unless Dir.exist?(pathname.dirname)
      warn "Warning: The directory to save IRB's history file does not exist. Please double check `IRB.conf[:HISTORY_FILE]`'s value."
      return
    end

    File.open(history_file, (append_history ? 'a' : 'w'), 0o600, encoding: IRB.conf[:LC_MESSAGES]&.encoding) do |f|
      hist = history.map{ |l| l.scrub.split("\n").join("\\\n") }
      unless append_history
        begin
          hist = hist.last(num) if hist.size > num and num > 0
        rescue RangeError # bignum too big to convert into `long'
          # Do nothing because the bignum should be treated as infinity
        end
      end
      f.puts(hist)
    end
  end
end

#support_history_saving? ⇒ Boolean

Returns:

  • (Boolean) 


5
6
7
 
# File 'lib/irb/history.rb', line 5

def support_history_saving?
  true
end