123456789_123456789_123456789_123456789_123456789_

Class: Reline::History

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Array
Instance Chain:
self, Array
Inherits: Array
  • Object
Defined in: lib/reline/history.rb

Class Method Summary

Instance Method Summary

Constructor Details

.new(config) ⇒ History

[ GitHub ]

  
# File 'lib/reline/history.rb', line 2

def initialize(config)
  @config = config
end

Instance Method Details

#<<(val)

[ GitHub ]

  
# File 'lib/reline/history.rb', line 52

def <<(val)
  # If history_size is zero, all histories are dropped.
  return self if @config.history_size.zero?
  # If history_size is negative, history size is unlimited.
  if @config.history_size.positive?
    shift if size + 1 > @config.history_size
  end
  super(String.new(val, encoding: Reline.encoding_system_needs))
end

#[](index)

[ GitHub ]

  
# File 'lib/reline/history.rb', line 15

def [](index)
  index = check_index(index) unless index.is_a?(Range)
  super(index)
end

#[]=(index, val)

[ GitHub ]

  
# File 'lib/reline/history.rb', line 20

def []=(index, val)
  index = check_index(index)
  super(index, String.new(val, encoding: Reline.encoding_system_needs))
end

#check_index(index) (private)

Raises:

  • (IndexError)
[ GitHub ]

  
# File 'lib/reline/history.rb', line 62

private def check_index(index)
  index += size if index < 0
  if index < -2147483648 or 2147483647 < index
    raise RangeError.new("integer #{index} too big to convert to 'int'")
  end
  # If history_size is negative, history size is unlimited.
  if @config.history_size.positive?
    if index < -@config.history_size or @config.history_size < index
      raise RangeError.new("index=<#{index}>")
    end
  end
  raise IndexError.new("index=<#{index}>") if index < 0 or size <= index
  index
end

#concat(*val)

[ GitHub ]

  
# File 'lib/reline/history.rb', line 25

def concat(*val)
  val.each do |v|
    push(*v)
  end
end

#delete_at(index)

[ GitHub ]

  
# File 'lib/reline/history.rb', line 10

def delete_at(index)
  index = check_index(index)
  super(index)
end

#push(*val)

[ GitHub ]

  
# File 'lib/reline/history.rb', line 31

def push(*val)
  # If history_size is zero, all histories are dropped.
  return self if @config.history_size.zero?
  # If history_size is negative, history size is unlimited.
  if @config.history_size.positive?
    diff = size + val.size - @config.history_size
    if diff > 0
      if diff <= size
        shift(diff)
      else
        diff -= size
        clear
        val.shift(diff)
      end
    end
  end
  super(*(val.map{ |v|
    String.new(v, encoding: Reline.encoding_system_needs)
  }))
end

#to_s

[ GitHub ]

  
# File 'lib/reline/history.rb', line 6

def to_s
  'HISTORY'
end