ruco 0.0.2 → 0.0.4

data/Readme.md

@@ -5,9 +5,12 @@ Alpha, lets see if this works...
 Finished:
 
  - viewing / scrolling / editing / saving / creating
+ - Home/End
+ - basic Tab support (tab == 2 space)
  - change-indicator
  - writeable indicator
- - backspace
+ - backspace / delete
+ - find
 
 Install
 =======
@@ -19,8 +22,9 @@ Usage
 
 TODO
 =====
+ - cursor move + delete/backspace inside find field
+ - smart staying at end of line/column when changing line
  - indentation + paste support
- - delete key !?
  - warnings / messages
  - syntax highlighting
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.4

data/bin/ruco

@@ -59,27 +59,56 @@ end
 parse_options
 
 require 'ruco'
-editor_offset = 1
-editor = Ruco::Editor.new(ARGV[0], :lines => Curses.stdscr.maxy - editor_offset, :columns => Curses.stdscr.maxx)
+status_lines = 1
+command_lines = 1
+editor_lines = Curses.stdscr.maxy - status_lines - command_lines
+
+editor = Ruco::Editor.new(ARGV[0], :lines => editor_lines, :columns => Curses.stdscr.maxx)
 status = Ruco::StatusBar.new(editor, :columns => Curses.stdscr.maxx)
+command = Ruco::CommandBar.new(:columns => Curses.stdscr.maxx)
+command.cursor_line = editor_lines
+
+focused = editor
 
 init_screen do
   loop do
     display status, 0, Curses::A_REVERSE
-    display editor, editor_offset, Curses::A_NORMAL
+    display editor, status_lines, Curses::A_NORMAL
+    display command, status_lines + editor_lines, Curses::A_REVERSE
 
-    Curses.setpos(editor.cursor_line + editor_offset, editor.cursor_column)
+    Curses.setpos(focused.cursor_line + status_lines, focused.cursor_column)
 
     key = Curses.getch
 
     case key
-    when Curses::Key::UP then editor.move(-1,0)
-    when Curses::Key::DOWN then editor.move(1,0)
-    when Curses::Key::RIGHT then editor.move(0,1)
-    when Curses::Key::LEFT then editor.move(0,-1)
-    when 32..126 then editor.insert(key.chr) # printable
-    when 10 then editor.insert("\n") # enter
-    when 263 then editor.delete(-1) # backspace
+
+    # move
+    when Curses::Key::UP then focused.move(-1,0)
+    when Curses::Key::DOWN then focused.move(1,0)
+    when Curses::Key::RIGHT then focused.move(0,1)
+    when Curses::Key::LEFT then focused.move(0,-1)
+    when Curses::KEY_END then focused.move_to_eol
+    when Curses::KEY_HOME then focused.move_to_bol
+
+    # modify
+    when 9 then focused.insert(key.chr) # tab
+    when 32..126 then focused.insert(key.chr) # printable
+    when 10 then # enter
+      result = focused.insert("\n")
+      if result.is_a?(Ruco::Command)
+        result.send_to(editor)
+        focused = editor
+      end
+    when 263 then focused.delete(-1) # backspace
+    when Curses::KEY_DC then focused.delete(1) # delete
+
+    # misc
+    when ?\C-f then
+      focused = command
+      command.find
+    when 27 then
+      focused.reset
+      focused = editor # escape from focused
     when ?\C-s then editor.save
     when ?\C-w, ?\C-q then break # quit
     end

data/lib/ruco/command.rb

@@ -0,0 +1,19 @@
+module Ruco
+  # Used to pass around commands
+  class Command
+    attr_reader :method, :args
+
+    def initialize(method, *args)
+      @method = method
+      @args = args
+    end
+
+    def send_to(object)
+      object.send(@method, *@args)
+    end
+
+    def ==(other)
+      other.method == method and other.args == args
+    end
+  end
+end

data/lib/ruco/command_bar.rb

@@ -0,0 +1,64 @@
+module Ruco
+  class CommandBar
+    include Focusable
+
+    attr_accessor :cursor_line
+
+    SHORTCUTS = [
+      '^W Exit',
+      '^S Save',
+      '^F Find',
+      '^D Delete line'
+    ]
+
+    SEARCH_PREFIX = "Find: "
+
+    def initialize(options)
+      @options = options
+      reset
+    end
+
+    def view
+      if @find_mode
+        SEARCH_PREFIX + @find_term
+      else
+        available_shortcuts
+      end
+    end
+
+    def find
+      @find_mode = true
+    end
+
+    def insert(text)
+      @find_term += text
+      if @find_term.include?("\n")
+        @find_term.gsub!("\n",'')
+        Command.new(:find, @find_term)
+      end
+    end
+
+    def reset
+      @find_mode = false
+      @find_term = ''
+    end
+
+    def cursor_column
+      view.size
+    end
+
+    private
+
+    def available_shortcuts
+      used_columns = 0
+      spacer = '    '
+      shortcuts_that_fit = SHORTCUTS.select do |shortcut|
+        used_columns += shortcut.size
+        it_fits = (used_columns <= @options[:columns])
+        used_columns += spacer.size
+        it_fits
+      end
+      shortcuts_that_fit * spacer
+    end
+  end
+end

data/lib/ruco/core_ext/string.rb

@@ -11,4 +11,13 @@ class String
     found << string
     found
   end
+
+  def nth_index(text, n)
+    offset = -1
+    (n+1).times do
+      offset += 1
+      offset = index(text, offset) or return
+    end
+    offset
+  end
 end

data/lib/ruco/editor.rb

@@ -1,5 +1,7 @@
 module Ruco
   class Editor
+    include Focusable
+
     SCROLLING_OFFSET = 20
 
     attr_reader :cursor_line, :cursor_column, :file
@@ -7,7 +9,7 @@ module Ruco
     def initialize(file, options)
       @file = file
       @options = options
-      @content = (File.exist?(@file) ? File.read(@file) : '')
+      @content = tabs_to_spaces((File.exist?(@file) ? File.read(@file) : ''))
       @line = 0
       @column = 0
       @cursor_line = 0
@@ -28,11 +30,50 @@ module Ruco
     def move(line, column)
       @line =    [[@line   + line,    0].max, lines.size].min
       @column =  [[@column + column, 0].max, (lines[@line]||'').size].min
+      adjust_view
+    end
 
+    def move_to(line, column)
+      @line = line
+      @column = column
       adjust_view
     end
 
+    def move_to_line(line)
+      move_to(line, @column)
+    end
+
+    def move_to_column(column)
+      move_to(@line, column)
+    end
+
+    def move_to_eol
+      after_last_word = current_line.index(/\s*$/)
+      after_last_whitespace = current_line.size
+
+      if @column == after_last_whitespace or @column < after_last_word
+        move_to_column after_last_word
+      else
+        move_to_column after_last_whitespace
+      end
+    end
+
+    def move_to_bol
+      before_first_word = current_line.index(/[^\s]/) || 0
+      if @column == 0 or @column > before_first_word
+        move_to_column before_first_word
+      else
+        move_to_column 0
+      end
+    end
+
+    def find(text)
+      index = @content.index(text, cursor_index+1) || cursor_index
+      move_to *cursor_for_index(index)
+    end
+
     def insert(text)
+      text = tabs_to_spaces(text)
       insert_into_content cursor_index, text
       move_according_to_insert(text)
       @modified = true
@@ -55,7 +96,7 @@ module Ruco
       end
 
       @content.slice!(start_index, count)
-      set_cursor_to_index start_index
+      move_to *cursor_for_index(start_index)
       @modified = true
     end
 
@@ -126,17 +167,19 @@ module Ruco
       @content.insert(index, text)
     end
 
+    def current_line
+      lines[@line] || ''
+    end
+
     def cursor_index
-      insertion_point = lines[0...@line].join("\n").size + @column
-      insertion_point += 1 if @line > 0 # account for missing newline
-      insertion_point
+      index = lines[0...@line].join("\n").size + @column
+      index += 1 if @line > 0 # account for missing newline
+      index
     end
 
-    def set_cursor_to_index(index)
+    def cursor_for_index(index)
       jump = @content.slice(0, index).to_s.naive_split("\n")
-      @line = jump.size - 1
-      @column = jump.last.size
-      reposition_cursor
+      [jump.size - 1, jump.last.size]
     end
 
     def move_according_to_insert(text)
@@ -149,5 +192,9 @@ module Ruco
         move(inserted_lines.size - 1, inserted_lines.last.size)
       end
     end
+
+    def tabs_to_spaces(text)
+      text.gsub("\t",' ' * Ruco::TAB_SIZE)
+    end
   end
 end

data/lib/ruco/focusable.rb

@@ -0,0 +1,11 @@
+module Ruco
+  # Stub so things do not explode
+  module Focusable
+    def reset;end
+    def move(line, column);end
+    def move_to_eol;end
+    def move_to_bol;end
+    def insert(char);end
+    def delete(count);end
+  end
+end

data/lib/ruco.rb

@@ -1,8 +1,13 @@
+require 'ruco/focusable'
+require 'ruco/command'
+
 require 'ruco/editor'
 require 'ruco/status_bar'
+require 'ruco/command_bar'
 require 'ruco/core_ext/string'
 require 'ruco/core_ext/array'
 
 module Ruco
   VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  TAB_SIZE = 2
 end

data/ruco.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruco}
-  s.version = "0.0.2"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2011-01-08}
+  s.date = %q{2011-01-09}
   s.default_executable = %q{ruco}
   s.email = %q{michael@grosser.it}
   s.executables = ["ruco"]
@@ -21,11 +21,16 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/ruco",
     "lib/ruco.rb",
+    "lib/ruco/command.rb",
+    "lib/ruco/command_bar.rb",
     "lib/ruco/core_ext/array.rb",
     "lib/ruco/core_ext/string.rb",
     "lib/ruco/editor.rb",
+    "lib/ruco/focusable.rb",
     "lib/ruco/status_bar.rb",
     "ruco.gemspec",
+    "spec/ruco/command_bar_spec.rb",
+    "spec/ruco/command_spec.rb",
     "spec/ruco/core_ext/string_spec.rb",
     "spec/ruco/editor_spec.rb",
     "spec/ruco/status_bar_spec.rb",
@@ -37,6 +42,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Commandline editor written in ruby}
   s.test_files = [
+    "spec/ruco/command_bar_spec.rb",
+    "spec/ruco/command_spec.rb",
     "spec/ruco/core_ext/string_spec.rb",
     "spec/ruco/editor_spec.rb",
     "spec/ruco/status_bar_spec.rb",

data/spec/ruco/command_bar_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path('spec/spec_helper')
+
+describe Ruco::CommandBar do
+  let(:bar){ Ruco::CommandBar.new(:columns => 30) }
+
+  it "shows shortcuts by default" do
+    bar.view.should == "^W Exit    ^S Save    ^F Find"
+  end
+
+  it "shows less shortcuts when space is low" do
+    bar = Ruco::CommandBar.new(:columns => 29)
+    bar.view.should == "^W Exit    ^S Save    ^F Find"
+    bar = Ruco::CommandBar.new(:columns => 28)
+    bar.view.should == "^W Exit    ^S Save"
+  end
+
+  describe :find do
+    it "sets command bar into search mode" do
+      bar.find
+      bar.view.should == "Find: "
+      bar.cursor_column.should == 6
+    end
+
+    it "can enter stuff" do
+      bar.find
+      bar.insert('abc')
+      bar.view.should == "Find: abc"
+      bar.cursor_column.should == 9
+    end
+
+    it "can reset the search" do
+      bar.find
+      bar.insert('abc')
+      bar.insert("\n")
+      bar.reset
+
+      bar.view.should include("^W Exit ") # default view
+      bar.find
+      bar.view.should == "Find: " # term removed
+    end
+
+    it "can execute a search" do
+      bar.find
+      bar.insert('abc')
+      result = bar.insert("d\n")
+      result.should == Ruco::Command.new(:find, 'abcd')
+    end
+
+    it "finds with offset when same search is entered again" do
+      bar.find
+      bar.insert('abcd')
+      bar.insert("\n")
+      result = bar.insert("\n")
+      result.should == Ruco::Command.new(:find, 'abcd')
+    end
+  end
+end

data/spec/ruco/command_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path('spec/spec_helper')
+
+describe Ruco::Command do
+  it "can invoke a recorded command" do
+    Ruco::Command.new(:slice, 0,1).send_to("ab1").should == 'a'
+  end
+
+  it "can invoke a recorded command without arguments" do
+    Ruco::Command.new(:strip).send_to(" a ").should == 'a'
+  end
+end

data/spec/ruco/core_ext/string_spec.rb

@@ -14,4 +14,19 @@ describe String do
       "".naive_split('a').should == ['']
     end
   end
+
+  describe :nth_index do
+    it "finds the first by default" do
+      "a a a".nth_index('a',0).should == 0
+    end
+
+    it "finds the n-th index" do
+      "a a a".nth_index('a',2).should == 4
+    end
+
+    it "is nil when not found" do
+      "b b b".nth_index('a',0).should == nil
+      "b b b".nth_index('a',1).should == nil
+    end
+  end
 end

data/spec/ruco/editor_spec.rb

@@ -11,7 +11,12 @@ describe Ruco::Editor do
     @file = 'spec/temp.txt'
   end
 
-  describe 'moving' do
+  it "reads tab as spaces" do
+    write("\t\ta")
+    editor.view.should == "    a\n\n\n"
+  end
+
+  describe :move do
     before do
       write("    \n    \n    ")
     end
@@ -102,7 +107,92 @@ describe Ruco::Editor do
     end
   end
 
-  describe 'viewing' do
+  describe :move_to_eol do
+    before do
+      write("\n aa \n  ")
+    end
+
+    it 'stays at start when line is empty' do
+      editor.move_to_eol
+      editor.cursor.should == [0,0]
+    end
+
+    it 'moves after last word if cursor was before it' do
+      editor.move(1,1)
+      editor.move_to_eol
+      editor.cursor.should == [1,3]
+    end
+
+    it 'moves after last whitespace if cursor was after last word' do
+      editor.move(1,3)
+      editor.move_to_eol
+      editor.cursor.should == [1,4]
+    end
+
+    it 'moves after last work if cursor was after last whitespace' do
+      editor.move(1,4)
+      editor.move_to_eol
+      editor.cursor.should == [1,3]
+    end
+  end
+
+  describe :move_to_bol do
+    before do
+      write("\n  aa \n  ")
+    end
+
+    it 'stays at start when line is empty' do
+      editor.move_to_bol
+      editor.cursor.should == [0,0]
+    end
+
+    it 'moves before first work if at start of line' do
+      editor.move(1,0)
+      editor.move_to_bol
+      editor.cursor.should == [1,2]
+    end
+
+    it 'moves to start of line if before first word' do
+      editor.move(1,1)
+      editor.move_to_bol
+      editor.cursor.should == [1,0]
+
+      editor.move(0,2)
+      editor.move_to_bol
+      editor.cursor.should == [1,0]
+    end
+
+    it 'moves before first word if inside line' do
+      editor.move(1,5)
+      editor.move_to_bol
+      editor.cursor.should == [1,2]
+    end
+  end
+
+  describe :find do
+    before do
+      write("\n ab\n ab")
+    end
+
+    it "moves to first occurrence" do
+      editor.find('ab')
+      editor.cursor.should == [1,1]
+    end
+
+    it "moves to next occurrence" do
+      editor.move(1,1)
+      editor.find('ab')
+      editor.cursor.should == [2,1]
+    end
+
+    it "stays in place when nothing was found" do
+      editor.move(2,1)
+      editor.find('ab')
+      editor.cursor.should == [2,1]
+    end
+  end
+
+  describe :view do
     before do
       write('')
     end
@@ -127,7 +217,7 @@ describe Ruco::Editor do
     end
   end
 
-  describe 'inserting' do
+  describe :insert do
     before do
       write('')
     end
@@ -175,9 +265,15 @@ describe Ruco::Editor do
       editor.insert("\n")
       editor.cursor.should == [2,0]
     end
+
+    it "inserts tab as spaces" do
+      editor.insert("\t")
+      editor.view.should == "  \n\n\n"
+      editor.cursor.should == [0,2]
+    end
   end
 
-  describe 'save' do
+  describe :save do
     it 'stores the file' do
       write('xxx')
       editor.insert('a')
@@ -193,7 +289,7 @@ describe Ruco::Editor do
     end
   end
 
-  describe 'delete' do
+  describe :delete do
     it 'removes a char' do
       write('123')
       editor.delete(1)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruco
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Michael Grosser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-08 00:00:00 +01:00
+date: 2011-01-09 00:00:00 +01:00
 default_executable: ruco
 dependencies: []
 
@@ -35,11 +35,16 @@ files:
 - VERSION
 - bin/ruco
 - lib/ruco.rb
+- lib/ruco/command.rb
+- lib/ruco/command_bar.rb
 - lib/ruco/core_ext/array.rb
 - lib/ruco/core_ext/string.rb
 - lib/ruco/editor.rb
+- lib/ruco/focusable.rb
 - lib/ruco/status_bar.rb
 - ruco.gemspec
+- spec/ruco/command_bar_spec.rb
+- spec/ruco/command_spec.rb
 - spec/ruco/core_ext/string_spec.rb
 - spec/ruco/editor_spec.rb
 - spec/ruco/status_bar_spec.rb
@@ -80,6 +85,8 @@ signing_key:
 specification_version: 3
 summary: Commandline editor written in ruby
 test_files: 
+- spec/ruco/command_bar_spec.rb
+- spec/ruco/command_spec.rb
 - spec/ruco/core_ext/string_spec.rb
 - spec/ruco/editor_spec.rb
 - spec/ruco/status_bar_spec.rb