yap-rawline 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c58de0866271a9994af05648f35a469fa12fc8
-  data.tar.gz: fb7199d0dd979db6e7ca55a7999fe74a5c98fbb9
+  metadata.gz: faf5249796b514e5aeed4e79a1de38d1559bf431
+  data.tar.gz: 893634b11c7c908ab2e983c51b5dac5996f46e58
 SHA512:
-  metadata.gz: 9c0680fb3b2323de92e914f7cf798e46f6e11c68ddcec6e04dd505d14fcb75eddbe71120e34483c6c2486933689ff3e8fa4524b84b488a2db5324ee9074df295
-  data.tar.gz: 00e4152cd8285b61aa5ec59fe9556179e14f9b7f9b2fd98b4ab3a6ce396c5f0a1cff1489b51ba8d55d7c1a24657c05cf473444d7b0ee1d664708f83877392742
+  metadata.gz: 1309021069574aba5c5b597342c9602caa858b1c211c88f79375d17380b7ab57a75f63198d151db981d2ffb90fb6805b606d6eb0a9007695c31f4baf2558fb37
+  data.tar.gz: 63ff4a40b302a64c1017a3b00993ce08750305e950109506f3a7a08b277ee9d40b8bb299ffe1fded63d034c8976e071a0c684f82b29b02a16e111fae4435138d

data/examples/rawline_shell.rb

@@ -74,7 +74,7 @@ editor.bind(:ctrl_w){
 # History forward, but if at the end of the history then give user a
 # blank line rather than remain on the last command
 editor.bind(:down_arrow) {
-  if editor.history.searching? && !editor.history.end?
+  if editor.history && !editor.history.end?
     editor.history_forward
   else
     editor.overwrite_line ""

data/lib/rawline/editor.rb

@@ -90,13 +90,14 @@ module RawLine
     class Environment
       attr_accessor :keys, :completion_class, :history, :word_separator
       attr_accessor :keyboard_input_processors
+      attr_accessor :terminal
 
       # * <tt>@history_size</tt> - the size of the editor history buffer (30).
       # * <tt>@keys</tt> - the keys (arrays of character codes) bound to specific actions.
       # * <tt>@line_history_size</tt> - the size of the editor line history buffer (50).
-      def initialize(env: nil)
+      def initialize(env: nil, terminal: nil)
         @env = env
-        @keys = KeyBindings.new
+        @keys = KeyBindings.new(terminal: terminal)
         @keyboard_input_processors = []
 
         @completion_class = Completer
@@ -133,7 +134,7 @@ module RawLine
       @renderer = renderer
       @terminal = terminal
 
-      @env_stack = [Environment.new]
+      @env_stack = [Environment.new(terminal: terminal)]
 
       @word_break_characters = " \t\n\"'@><=;|&{()}"
       @mode = :insert
@@ -537,9 +538,9 @@ module RawLine
     # with <tt>new_line</tt>, and optionally reset the cursor position to
     # <tt>position</tt>.
     #
-    def overwrite_line(new_line, position=nil, options={})
-      Treefell['editor'].puts "overwrite_line new_line=#{new_line} position=#{position} options=#{options.inspect}"
-      if @line_editor.overwrite_line(new_line, position, options)
+    def overwrite_line(new_line, position: nil, highlight_up_to: nil)
+      Treefell['editor'].puts "overwrite_line new_line=#{new_line} position=#{position} highlight_up_to=#{highlight_up_to}"
+      if @line_editor.overwrite_line(new_line, position: position, highlight_up_to: highlight_up_to)
         @event_loop.add_event name: "render", source: focused_input_box
       end
     end
@@ -722,7 +723,7 @@ module RawLine
         @terminal.puts sprintf("%-#{max_index_width}d %s\n", i+1, item)
       end
       render(reset: true)
-      overwrite_line(text, pos)
+      overwrite_line(text, position: pos)
     end
 
     #
@@ -813,7 +814,7 @@ module RawLine
       # terminal.puts "Character at Position: [#{text[pos].chr}] (#{text[pos]})" unless pos >= @line.length
       # terminal.puts "Current Word: [#{word[:text]}] (#{word[:start]} -- #{word[:end]})"
       clear_line
-      overwrite_line(text, pos)
+      overwrite_line(text, position: pos)
     end
 
     def focus_input_box(box)
@@ -893,7 +894,7 @@ module RawLine
         return unless line
 
         cursor_position = nil
-        overwrite_line(line, cursor_position, highlight_up_to: cursor_position)
+        overwrite_line(line, position: cursor_position, highlight_up_to: cursor_position)
       end
     end
 
@@ -904,7 +905,7 @@ module RawLine
         return unless line
 
         cursor_position = nil
-        overwrite_line(line, cursor_position, highlight_up_to: cursor_position)
+        overwrite_line(line, position: cursor_position, highlight_up_to: cursor_position)
       end
     end
 

data/lib/rawline/history_buffer.rb

@@ -46,10 +46,6 @@ module RawLine
       @position = nil
     end
 
-    def searching?
-      !!@position
-    end
-
     #
     # Resize the buffer, resetting <tt>@position</tt> to nil.
     #
@@ -61,6 +57,26 @@ module RawLine
       @position = nil
     end
 
+    def find_match_backward(text)
+      regex = to_regex(text)
+      offset = @position ? length - position : 0
+      reverse[offset..-1].detect.with_index do |item, index|
+        if item.match(regex)
+          @position = length - index - (offset + 1)
+        end
+      end
+    end
+
+    def find_match_forward(text)
+      regex = to_regex(text)
+      offset = @position ? @position + 1 : 0
+      self[offset..-1].detect.with_index do |item, index|
+        if item.match(regex)
+          @position = index + offset
+        end
+      end
+    end
+
     #
     # Clear the content of the buffer and reset <tt>@position</tt> to nil.
     #
@@ -74,7 +90,7 @@ module RawLine
     #
     def get
       return nil unless length > 0
-      return nil unless @position
+      @position = length-1 unless @position
       at(@position).dup
     end
 
@@ -148,8 +164,7 @@ module RawLine
     # Add a new item to the buffer.
     #
     def push(item)
-
-      if !@duplicates && self[-1] == item
+      if !@duplicates && include?(item)
         # skip adding this line
         return
       end
@@ -168,6 +183,12 @@ module RawLine
 
     alias << push
 
+    private
+
+    def to_regex(text)
+      return text if text.is_a?(Regexp)
+      /#{Regexp.escape(text)}/
+    end
   end
 
 end

data/lib/rawline/line.rb

@@ -1,4 +1,4 @@
-#!usr/bin/env ruby
+require 'ansi_string'
 
 #
 #  line.rb
@@ -56,6 +56,10 @@ module RawLine
       @text = ANSIString.new(val)
     end
 
+    def text_up_to_position
+      text[0...position]
+    end
+
     #
     # Return information about the current word, as a Hash composed by the following
     # elements:

data/lib/rawline/line_editor.rb

@@ -144,13 +144,14 @@ module RawLine
     # with <tt>new_line</tt>, and optionally reset the cursor position to
     # <tt>position</tt>.
     #
-    def overwrite_line(new_line, position=nil, options={})
+    def overwrite_line(new_line, position: nil, highlight_up_to: nil)
+      position = @line.position if position == :preserve
       text = @line.text
       @highlighting = false
 
-      if options[:highlight_up_to]
+      if highlight_up_to
         @highlighting = true
-        new_line = highlight_text_up_to(new_line, options[:highlight_up_to])
+        new_line = highlight_text_up_to(new_line, highlight_up_to)
       end
 
       @line.position = position || new_line.length

data/lib/rawline/version.rb

@@ -1,3 +1,3 @@
 module RawLine
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/editor_spec.rb

@@ -38,6 +38,8 @@ describe RawLine::Editor do
   let(:dom) { RawLine::DomTree.new }
   let(:renderer) do
     instance_double(RawLine::Renderer,
+      pause: nil,
+      unpause: nil,
       render_cursor: nil,
       render: nil
     )
@@ -335,7 +337,7 @@ describe RawLine::Editor do
     input << "test #8a"
     input.rewind
     @editor.event_loop.tick
-    @editor.overwrite_line("test #8b", 2)
+    @editor.overwrite_line("test #8b", position: 2)
     expect(@editor.line.text).to eq("test #8b")
     expect(@editor.line.position).to eq(2)
   end

data/spec/history_buffer_spec.rb

@@ -3,8 +3,7 @@
 require_relative "../lib/rawline/history_buffer.rb"
 
 describe RawLine::HistoryBuffer do
-
-  before :each do
+  before do
     @history = RawLine::HistoryBuffer.new(5)
   end
 
@@ -18,15 +17,15 @@ describe RawLine::HistoryBuffer do
     @history << "line #2"
     @history << "line #3"
     @history << "line #2"
-    expect(@history).to eq(["line #1", "line #3", "line #2"])
+    expect(@history).to eq(["line #1",  "line #2", "line #3"])
     @history.duplicates = true
     @history << "line #3"
-    expect(@history).to eq(["line #1", "line #3", "line #2", "line #3"])
+    expect(@history).to eq(["line #1", "line #2", "line #3", "line #3"])
     @history.exclude = lambda { |i| i.match(/line #[456]/) }
     @history << "line #4"
     @history << "line #5"
     @history << "line #6"
-    expect(@history).to eq(["line #1", "line #3", "line #2", "line #3"])
+    expect(@history).to eq(["line #1", "line #2", "line #3", "line #3"])
   end
 
   it "does not overflow" do
@@ -103,4 +102,83 @@ describe RawLine::HistoryBuffer do
     expect(@history.size).to eq(6)
     expect(@history.position).to eq(nil)
   end
+
+  describe 'finding matches in history, forward and backward' do
+    before do
+      @history.resize(100)
+      @history << 'echo foo'
+      @history << 'echo bar'
+      @history << 'echo baz'
+      @history << 'echo food'
+      @history << 'echo bark'
+      @history << 'echo bonanza'
+    end
+
+    describe '#find_match_backward' do
+      context 'when the position starts as nil' do
+        it 'finds the first item back that matches' do
+          @history.clear_position
+          expect(@history.find_match_backward('bonanza')).to eq 'echo bonanza'
+
+          @history.clear_position
+          expect(@history.find_match_backward('foo')).to eq 'echo food'
+        end
+
+        it 'can find consecutive matches, skipping unmatched items' do
+          @history.clear_position
+          expect(@history.find_match_backward('foo')).to eq 'echo food'
+          $z = true
+          expect(@history.find_match_backward('foo')).to eq 'echo foo'
+        end
+      end
+
+      context 'when the position starts as non-nil' do
+        it 'finds the first item back that matches from the current position' do
+          3.times { @history.back }
+          expect(@history.find_match_backward('bar')).to eq 'echo bar'
+        end
+      end
+    end
+
+    describe '#find_match_forward' do
+      context 'when the position starts as nil' do
+        it 'finds the first item from the beginning that matches' do
+          @history.clear_position
+          expect(@history.find_match_forward('bar')).to eq 'echo bar'
+          expect(@history.position).to eq @history.index('echo bar')
+
+          @history.clear_position
+          expect(@history.find_match_forward('foo')).to eq 'echo foo'
+          expect(@history.position).to eq @history.index('echo foo')
+        end
+
+        it 'can find consecutive matches, skipping unmatched items' do
+          @history.clear_position
+          expect(@history.find_match_forward('foo')).to eq 'echo foo'
+          expect(@history.position).to eq @history.index('echo foo')
+
+          expect(@history.find_match_forward('foo')).to eq 'echo food'
+          expect(@history.position).to eq @history.index('echo food')
+        end
+      end
+
+      context 'when the position starts as non-nil' do
+        it 'finds the first item back that matches from the current position' do
+          3.times { @history.back }
+          expect(@history.find_match_forward('bar')).to eq 'echo bark'
+          expect(@history.position).to eq @history.index('echo bark')
+        end
+      end
+
+      context 'when its gone all the way back, and we want to go forward' do
+        it 'd' do
+          @history.length.times do
+            @history.find_match_backward('bar')
+          end
+          expect(@history.find_match_forward('bar')).to eq 'echo bark'
+        end
+      end
+    end
+
+  end
 end

data/spec/keycode_parser_spec.rb

@@ -6,32 +6,23 @@ describe RawLine::KeycodeParser do
   subject(:keycode_parser) { described_class.new(keymap) }
   let(:keymap) { {} }
 
-  describe "#parse_bytes" do
-    def parse_bytes(bytes)
-      keycode_parser.parse_bytes(bytes)
+  describe "#parse_bytes_into_sequences" do
+    let(:parse) do
+      keycode_parser.parse_bytes_into_sequences(bytes)
     end
+    let(:bytes){ fail 'Implement :bytes in context/describe for relevant example' }
 
     context "given a char that isn't in the keymap" do
+      let(:bytes){ "a".bytes }
       it "returns the byte as a keycode" do
-        expect(parse_bytes(["a"])).to eq ["a".ord]
-      end
-    end
-
-    context "given a char that isn't in the keymap" do
-      it "returns the byte as a keycode" do
-        expect(parse_bytes([97])).to eq ["a".ord]
-      end
-    end
-
-    context "given multiple characters that aren't in the keymap" do
-      it "returns the bytes as individual keycodes" do
-        expect(parse_bytes(["a", "b", "C"])).to eq ["a", "b", "C"].map(&:ord)
+        expect(parse).to eq ["a"]
       end
     end
 
     context "given multiple characters that aren't in the keymap" do
+      let(:bytes){ "abC".bytes }
       it "returns the bytes as individual keycodes" do
-        expect(parse_bytes([97, 98, 67])).to eq ["a", "b", "C"].map(&:ord)
+        expect(parse).to eq ["abC"]
       end
     end
 
@@ -39,9 +30,10 @@ describe RawLine::KeycodeParser do
       let(:keymap) do
         { backspace: [?\C-?.ord] }
       end
+      let(:bytes){ [127] }
 
       it "returns the bytes as a single key code" do
-        expect(parse_bytes([127])).to eq [[127]]
+        expect(parse).to eq ["", [127]]
       end
     end
 
@@ -49,9 +41,10 @@ describe RawLine::KeycodeParser do
       let(:keymap) do
         { backspace: [?\C-?.ord] }
       end
+      let(:bytes) { [97, 127, 67] }
 
       it "returns the key codes appropriately" do
-        expect(parse_bytes([97, 127, 67])).to eq [97, [127], 67]
+        expect(parse).to eq ["a", [127], "C"]
       end
     end
 
@@ -59,9 +52,10 @@ describe RawLine::KeycodeParser do
       let(:keymap) do
         { left_arrow: [?\e.ord, ?[.ord, ?D.ord] }
       end
+      let(:bytes) { [?\e.ord, ?[.ord, ?D.ord] }
 
       it "returns a single key code" do
-        expect(parse_bytes([?\e.ord, ?[.ord, ?D.ord])).to eq [[?\e.ord, ?[.ord, ?D.ord]]
+        expect(parse).to eq ["", [27, 91, 68]]
       end
     end
 
@@ -69,9 +63,10 @@ describe RawLine::KeycodeParser do
       let(:keymap) do
         { left_arrow: [?\e.ord, ?[.ord, ?D.ord] }
       end
+      let(:bytes) { ["a".ord, ?\e.ord, ?[.ord, ?D.ord, "C".ord] }
 
       it "returns a keycodes appropriately" do
-        expect(parse_bytes([97, ?\e.ord, ?[.ord, ?D.ord, 67])).to eq [97, [?\e.ord, ?[.ord, ?D.ord], 67]
+        expect(parse).to eq ["a", [?\e.ord, ?[.ord, ?D.ord], "C"]
       end
     end
 

data/spec/line_spec.rb

@@ -8,7 +8,7 @@ require_relative "../lib/rawline/line.rb"
 
 describe RawLine::Line do
 
-  before :each do
+  before do
     @line = RawLine::Line.new(5) {|l| l.prompt = "=>" }
   end
 
@@ -55,4 +55,17 @@ describe RawLine::Line do
     expect(@line.word).to eq({:start => 5, :end => 6, :text => "is"})
   end
 
+  describe '#text_up_to_position' do
+    subject(:line) { described_class.new }
+
+    it 'returns the text up to, but not including the current position' do
+      line << 'abcdefghij'
+      line.position = 1
+      expect(line.text_up_to_position).to eq('a')
+
+      line.position = 7
+      expect(line.text_up_to_position).to eq('abcdefg')
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yap-rawline
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Fabio Cevasco
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A library for defining custom key bindings and perform line editing operations