ruco 0.0.1 → 0.0.2

data/Readme.md

@@ -1,9 +1,13 @@
 Commandline editor written in ruby
 
-Alpha, do not use...
+Alpha, lets see if this works...
 
 Finished:
+
  - viewing / scrolling / editing / saving / creating
+ - change-indicator
+ - writeable indicator
+ - backspace
 
 Install
 =======
@@ -15,12 +19,11 @@ Usage
 
 TODO
 =====
+ - indentation + paste support
  - delete key !?
  - warnings / messages
- - help
  - syntax highlighting
 
-
 Author
 ======
 [Michael Grosser](http://grosser.it)  

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/ruco

@@ -1,8 +1,31 @@
 #!/usr/bin/env ruby
 require 'curses'
-
+require 'optparse'
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'ruco'
+
+def parse_options
+  options = OptionParser.new do |opts|
+    opts.banner = <<BANNER
+[Ru]by [Co]mmandline editor
+
+Shortcuts:
+ Ctrl+w/q   Exit
+ Ctrl+s     Save
+
+Usage:
+    ruco FILE
+
+Options:
+BANNER
+    opts.on("-h", "--help","Show this.") { puts opts; exit }
+  end
+  options.parse!
+
+  if ARGV.empty?
+    puts options
+    exit
+  end
+end
 
 def write(line,row,text)
   Curses.setpos(line,row)
@@ -22,19 +45,30 @@ def init_screen
   end
 end
 
-editor = Ruco::Editor.new(ARGV[0], :lines => Curses.stdscr.maxy, :columns => Curses.stdscr.maxx)
+def display(widget, offset, color)
+  Curses.attrset color
+  lines = widget.view.naive_split("\n")
+  Curses.stdscr.maxy.times do |i|
+    line = lines[i] || ''
+    clearer = Curses.stdscr.maxx - line.size
+    clearer = " " * clearer
+    write(i + offset, 0, line + clearer)
+  end
+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 = Ruco::StatusBar.new(editor, :columns => Curses.stdscr.maxx)
 
 init_screen do
   loop do
-    lines = editor.view.split("\n")
-    Curses.stdscr.maxy.times do |i|
-      line = lines[i] || ''
-      clearer = Curses.stdscr.maxx - line.size
-      clearer = " " * clearer
-      write(i, 0, line + clearer)
-    end
+    display status, 0, Curses::A_REVERSE
+    display editor, editor_offset, Curses::A_NORMAL
 
-    Curses.setpos(editor.cursor_line, editor.cursor_column)
+    Curses.setpos(editor.cursor_line + editor_offset, editor.cursor_column)
 
     key = Curses.getch
 
@@ -46,6 +80,7 @@ init_screen do
     when 32..126 then editor.insert(key.chr) # printable
     when 10 then editor.insert("\n") # enter
     when 263 then editor.delete(-1) # backspace
+    when ?\C-s then editor.save
     when ?\C-w, ?\C-q then break # quit
     end
   end

data/lib/ruco.rb

@@ -1,4 +1,5 @@
 require 'ruco/editor'
+require 'ruco/status_bar'
 require 'ruco/core_ext/string'
 require 'ruco/core_ext/array'
 

data/lib/ruco/editor.rb

@@ -2,7 +2,7 @@ module Ruco
   class Editor
     SCROLLING_OFFSET = 20
 
-    attr_reader :cursor_line, :cursor_column
+    attr_reader :cursor_line, :cursor_column, :file
 
     def initialize(file, options)
       @file = file
@@ -14,6 +14,7 @@ module Ruco
       @cursor_column = 0
       @scrolled_lines = 0
       @scrolled_columns = 0
+      @modified = false
       @options[:line_scrolling_offset] ||= @options[:lines] / 2
       @options[:column_scrolling_offset] ||= @options[:columns] / 2
     end
@@ -34,6 +35,7 @@ module Ruco
     def insert(text)
       insert_into_content cursor_index, text
       move_according_to_insert(text)
+      @modified = true
     end
 
     def delete(count)
@@ -42,6 +44,7 @@ module Ruco
       else
         backspace(count.abs)
       end
+      @modified = true
     end
 
     def backspace(count)
@@ -53,16 +56,22 @@ module Ruco
 
       @content.slice!(start_index, count)
       set_cursor_to_index start_index
+      @modified = true
     end
 
     def save
       File.open(@file,'w'){|f| f.write(@content) }
+      @modified = false
     end
 
     def cursor
       [cursor_line, cursor_column]
     end
 
+    def modified?
+      @modified
+    end
+
     private
 
     def lines

data/lib/ruco/status_bar.rb

@@ -0,0 +1,27 @@
+module Ruco
+  class StatusBar
+    def initialize(editor, options)
+      @editor = editor
+      @options = options
+    end
+
+    def view
+      "Ruco #{Ruco::VERSION} -- #{@editor.file}#{change_indicator}#{writable_indicator}"
+    end
+
+    def format
+      Curses::A_REVERSE
+    end
+
+    def change_indicator
+      @editor.modified? ? '*' : ' '
+    end
+
+    def writable_indicator
+      @writeable ||= begin
+        writable = (not File.exist?(@editor.file) or system("test -w #{@editor.file}"))
+        writable ? ' ' : '!'
+      end
+    end
+  end
+end

data/ruco.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruco}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
@@ -24,8 +24,11 @@ Gem::Specification.new do |s|
     "lib/ruco/core_ext/array.rb",
     "lib/ruco/core_ext/string.rb",
     "lib/ruco/editor.rb",
+    "lib/ruco/status_bar.rb",
     "ruco.gemspec",
     "spec/ruco/core_ext/string_spec.rb",
+    "spec/ruco/editor_spec.rb",
+    "spec/ruco/status_bar_spec.rb",
     "spec/ruco_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -35,6 +38,8 @@ Gem::Specification.new do |s|
   s.summary = %q{Commandline editor written in ruby}
   s.test_files = [
     "spec/ruco/core_ext/string_spec.rb",
+    "spec/ruco/editor_spec.rb",
+    "spec/ruco/status_bar_spec.rb",
     "spec/ruco_spec.rb",
     "spec/spec_helper.rb"
   ]

data/spec/ruco/editor_spec.rb

@@ -0,0 +1,263 @@
+require File.expand_path('spec/spec_helper')
+
+describe Ruco::Editor do
+  def write(content)
+    File.open(@file,'w'){|f| f.write(content) }
+  end
+
+  let(:editor){ Ruco::Editor.new(@file, :lines => 3, :columns => 5, :line_scrolling_offset => 5, :column_scrolling_offset => 5) }
+
+  before do
+    @file = 'spec/temp.txt'
+  end
+
+  describe 'moving' do
+    before do
+      write("    \n    \n    ")
+    end
+
+    it "starts at 0,0" do
+      editor.cursor.should == [0,0]
+    end
+
+    it "can move" do
+      editor.move(1,2)
+      editor.cursor.should == [1,2]
+      editor.move(1,1)
+      editor.cursor.should == [2,3]
+    end
+
+    it "can move in empty file" do
+      write("\n\n\n")
+      editor.move(2,0)
+      editor.cursor.should == [2,0]
+    end
+
+    it "cannot move left/top off screen" do
+      editor.move(-1,-1)
+      editor.cursor.should == [0,0]
+    end
+
+    it "cannot move right of characters" do
+      editor.move(2,6)
+      editor.cursor.should == [2,4]
+    end
+
+    it "gets reset to empty line when moving past lines" do
+      write("    ")
+      editor.move(6,3)
+      editor.cursor.should == [1,0]
+    end
+
+    describe 'column scrolling' do
+      it "can scroll columns" do
+        write("123456789\n123")
+        editor.move(0,4)
+        editor.view.should == "12345\n123\n\n"
+        editor.cursor_column.should == 4
+
+        editor.move(0,1)
+        editor.view.should == "6789\n\n\n"
+        editor.cursor_column.should == 0
+      end
+
+      it "cannot scroll past the screen" do
+        write('123456789')
+        editor.move(0,4)
+        6.times{ editor.move(0,1) }
+        editor.view.should == "6789\n\n\n"
+        editor.cursor_column.should == 4
+      end
+
+      it "can scroll columns backwards" do
+        write('123456789')
+        editor.move(0,5)
+        editor.view.should == "6789\n\n\n"
+
+        editor.move(0,-1)
+        editor.view.should == "12345\n\n\n"
+        editor.cursor_column.should == 4
+      end
+    end
+
+    describe 'line scrolling' do
+      before do
+        write("1\n2\n3\n4\n5\n6\n7\n8\n9")
+      end
+
+      it "can scroll lines down (at maximum of screen size)" do
+        editor.move(2,0)
+        editor.view.should == "1\n2\n3\n"
+
+        editor.move(1,0)
+        editor.view.should == "4\n5\n6\n"
+        editor.cursor_line.should == 0
+      end
+
+      it "can scroll till end of file" do
+        editor.move(15,0)
+        editor.view.should == "\n\n\n"
+        editor.cursor_line.should == 0
+      end
+    end
+  end
+
+  describe 'viewing' do
+    before do
+      write('')
+    end
+
+    it "displays an empty screen" do
+      editor.view.should == "\n\n\n"
+    end
+
+    it "displays short file content" do
+      write('xxx')
+      editor.view.should == "xxx\n\n\n"
+    end
+
+    it "displays long file content" do
+      write('1234567')
+      editor.view.should == "12345\n\n\n"
+    end
+
+    it "displays multiline-file content" do
+      write("xxx\nyyy\nzzz\niii")
+      editor.view.should == "xxx\nyyy\nzzz\n"
+    end
+  end
+
+  describe 'inserting' do
+    before do
+      write('')
+    end
+
+    it "can insert new chars" do
+      write('123')
+      editor.move(0,1)
+      editor.insert('ab')
+      editor.view.should == "1ab23\n\n\n"
+      editor.cursor.should == [0,3]
+    end
+
+    it "can insert new newlines" do
+      editor.insert("ab\nc")
+      editor.view.should == "ab\nc\n\n"
+      editor.cursor.should == [1,1]
+    end
+
+    it "jumps to correct column when inserting newline" do
+      write("abc\ndefg")
+      editor.move(1,2)
+      editor.insert("1\n23")
+      editor.view.should == "abc\nde1\n23fg\n"
+      editor.cursor.should == [2,2]
+    end
+
+    it "jumps to correct column when inserting 1 newline" do
+      write("abc\ndefg")
+      editor.move(1,2)
+      editor.insert("\n")
+      editor.view.should == "abc\nde\nfg\n"
+      editor.cursor.should == [2,0]
+    end
+
+    it "can add newlines to the end" do
+      write('')
+      editor.insert("\n")
+      editor.insert("\n")
+      editor.cursor.should == [2,0]
+    end
+
+    it "can add newlines to the moveable end" do
+      write('')
+      editor.move(1,0)
+      editor.insert("\n")
+      editor.cursor.should == [2,0]
+    end
+  end
+
+  describe 'save' do
+    it 'stores the file' do
+      write('xxx')
+      editor.insert('a')
+      editor.save
+      File.read(@file).should == 'axxx'
+    end
+
+    it 'creates the file' do
+      `rm #{@file}`
+      editor.insert('a')
+      editor.save
+      File.read(@file).should == 'a'
+    end
+  end
+
+  describe 'delete' do
+    it 'removes a char' do
+      write('123')
+      editor.delete(1)
+      editor.view.should == "23\n\n\n"
+      editor.cursor.should == [0,0]
+    end
+
+    it 'removes a line' do
+      write("123\n45")
+      editor.move(0,3)
+      editor.delete(1)
+      editor.view.should == "12345\n\n\n"
+      editor.cursor.should == [0,3]
+    end
+
+    it "cannot backspace over 0,0" do
+      write("aa")
+      editor.move(0,1)
+      editor.delete(-3)
+      editor.view.should == "a\n\n\n"
+      editor.cursor.should == [0,0]
+    end
+
+    it 'backspaces a char' do
+      write('123')
+      editor.move(0,3)
+      editor.delete(-1)
+      editor.view.should == "12\n\n\n"
+      editor.cursor.should == [0,2]
+    end
+
+    it 'backspaces a newline' do
+      write("1\n234")
+      editor.move(1,0)
+      editor.delete(-1)
+      editor.view.should == "1234\n\n\n"
+      editor.cursor.should == [0,1]
+    end
+  end
+
+  describe :changes? do
+    it "is unchanged by default" do
+      editor.modified?.should == false
+    end
+
+    it "is changed after insert" do
+      editor.insert('x')
+      editor.modified?.should == true
+    end
+
+    it "is changed after delete" do
+      editor.delete(1)
+      editor.modified?.should == true
+    end
+
+    it "is not changed after move" do
+      editor.move(1,1)
+      editor.modified?.should == false
+    end
+
+    it "is unchanged after save" do
+      editor.insert('x')
+      editor.save
+      editor.modified?.should == false
+    end
+  end
+end

data/spec/ruco/status_bar_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path('spec/spec_helper')
+
+describe Ruco::StatusBar do
+  let(:file){ 'spec/temp.txt' }
+  let(:editor){ Ruco::Editor.new(file, :lines => 5, :columns => 10) }
+  let(:bar){ Ruco::StatusBar.new(editor, :columns => 10) }
+
+  it "shows name and version" do
+    bar.view.should include("Ruco #{Ruco::VERSION}") 
+  end
+
+  it "shows the file" do
+    bar.view.should include(file)
+  end
+
+  it "indicates modified" do
+    bar.view.should_not include('*')
+    editor.insert('x')
+    bar.view.should include('*')
+  end
+
+  it "indicates writable" do
+    bar.view.should_not include('!')
+  end
+
+  it "indicates writable if file is missing" do
+    editor.stub!(:file).and_return '/gradasadadsds'
+    bar.view.should_not include('!')
+  end
+
+  it "indicates not writable" do
+    editor.stub!(:file).and_return '/etc/sudoers'
+    bar.view.should include('!')
+  end
+end

data/spec/ruco_spec.rb

@@ -1,240 +1,7 @@
 require File.expand_path('spec/spec_helper')
 
 describe Ruco do
-  def write(content)
-    File.open(@file,'w'){|f| f.write(content) }
-  end
-
-  let(:editor){ Ruco::Editor.new(@file, :lines => 3, :columns => 5, :line_scrolling_offset => 5, :column_scrolling_offset => 5) }
-
   it "has a VERSION" do
     Ruco::VERSION.should =~ /^\d+\.\d+\.\d+$/
   end
-
-  before do
-    @file = 'spec/temp.txt'
-  end
-
-  describe 'moving' do
-    before do
-      write("    \n    \n    ")
-    end
-
-    it "starts at 0,0" do
-      editor.cursor.should == [0,0]
-    end
-
-    it "can move" do
-      editor.move(1,2)
-      editor.cursor.should == [1,2]
-      editor.move(1,1)
-      editor.cursor.should == [2,3]
-    end
-
-    it "can move in empty file" do
-      write("\n\n\n")
-      editor.move(2,0)
-      editor.cursor.should == [2,0]
-    end
-
-    it "cannot move left/top off screen" do
-      editor.move(-1,-1)
-      editor.cursor.should == [0,0]
-    end
-
-    it "cannot move right of characters" do
-      editor.move(2,6)
-      editor.cursor.should == [2,4]
-    end
-
-    it "gets reset to empty line when moving past lines" do
-      write("    ")
-      editor.move(6,3)
-      editor.cursor.should == [1,0]
-    end
-
-    describe 'column scrolling' do
-      it "can scroll columns" do
-        write("123456789\n123")
-        editor.move(0,4)
-        editor.view.should == "12345\n123\n\n"
-        editor.cursor_column.should == 4
-
-        editor.move(0,1)
-        editor.view.should == "6789\n\n\n"
-        editor.cursor_column.should == 0
-      end
-
-      it "cannot scroll past the screen" do
-        write('123456789')
-        editor.move(0,4)
-        6.times{ editor.move(0,1) }
-        editor.view.should == "6789\n\n\n"
-        editor.cursor_column.should == 4
-      end
-
-      it "can scroll columns backwards" do
-        write('123456789')
-        editor.move(0,5)
-        editor.view.should == "6789\n\n\n"
-
-        editor.move(0,-1)
-        editor.view.should == "12345\n\n\n"
-        editor.cursor_column.should == 4
-      end
-    end
-
-    describe 'line scrolling' do
-      before do
-        write("1\n2\n3\n4\n5\n6\n7\n8\n9")
-      end
-
-      it "can scroll lines down (at maximum of screen size)" do
-        editor.move(2,0)
-        editor.view.should == "1\n2\n3\n"
-
-        editor.move(1,0)
-        editor.view.should == "4\n5\n6\n"
-        editor.cursor_line.should == 0
-      end
-
-      it "can scroll till end of file" do
-        editor.move(15,0)
-        editor.view.should == "\n\n\n"
-        editor.cursor_line.should == 0
-      end
-    end
-  end
-
-  describe 'viewing' do
-    before do
-      write('')
-    end
-
-    it "displays an empty screen" do
-      editor.view.should == "\n\n\n"
-    end
-
-    it "displays short file content" do
-      write('xxx')
-      editor.view.should == "xxx\n\n\n"
-    end
-
-    it "displays long file content" do
-      write('1234567')
-      editor.view.should == "12345\n\n\n"
-    end
-
-    it "displays multiline-file content" do
-      write("xxx\nyyy\nzzz\niii")
-      editor.view.should == "xxx\nyyy\nzzz\n"
-    end
-  end
-
-  describe 'inserting' do
-    before do
-      write('')
-    end
-
-    it "can insert new chars" do
-      write('123')
-      editor.move(0,1)
-      editor.insert('ab')
-      editor.view.should == "1ab23\n\n\n"
-      editor.cursor.should == [0,3]
-    end
-
-    it "can insert new newlines" do
-      editor.insert("ab\nc")
-      editor.view.should == "ab\nc\n\n"
-      editor.cursor.should == [1,1]
-    end
-
-    it "jumps to correct column when inserting newline" do
-      write("abc\ndefg")
-      editor.move(1,2)
-      editor.insert("1\n23")
-      editor.view.should == "abc\nde1\n23fg\n"
-      editor.cursor.should == [2,2]
-    end
-
-    it "jumps to correct column when inserting 1 newline" do
-      write("abc\ndefg")
-      editor.move(1,2)
-      editor.insert("\n")
-      editor.view.should == "abc\nde\nfg\n"
-      editor.cursor.should == [2,0]
-    end
-
-    it "can add newlines to the end" do
-      write('')
-      editor.insert("\n")
-      editor.insert("\n")
-      editor.cursor.should == [2,0]
-    end
-
-    it "can add newlines to the moveable end" do
-      write('')
-      editor.move(1,0)
-      editor.insert("\n")
-      editor.cursor.should == [2,0]
-    end
-  end
-
-  describe 'save' do
-    it 'stores the file' do
-      write('xxx')
-      editor.insert('a')
-      editor.save
-      File.read(@file).should == 'axxx'
-    end
-
-    it 'creates the file' do
-      `rm #{@file}`
-      editor.insert('a')
-      editor.save
-      File.read(@file).should == 'a'
-    end
-  end
-
-  describe 'delete' do
-    it 'removes a char' do
-      write('123')
-      editor.delete(1)
-      editor.view.should == "23\n\n\n"
-      editor.cursor.should == [0,0]
-    end
-
-    it 'removes a line' do
-      write("123\n45")
-      editor.move(0,3)
-      editor.delete(1)
-      editor.view.should == "12345\n\n\n"
-      editor.cursor.should == [0,3]
-    end
-
-    it "cannot backspace over 0,0" do
-      write("aa")
-      editor.move(0,1)
-      editor.delete(-3)
-      editor.view.should == "a\n\n\n"
-      editor.cursor.should == [0,0]
-    end
-
-    it 'backspaces a char' do
-      write('123')
-      editor.move(0,3)
-      editor.delete(-1)
-      editor.view.should == "12\n\n\n"
-      editor.cursor.should == [0,2]
-    end
-
-    it 'backspaces a newline' do
-      write("1\n234")
-      editor.move(1,0)
-      editor.delete(-1)
-      editor.view.should == "1234\n\n\n"
-      editor.cursor.should == [0,1]
-    end
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruco
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Grosser
@@ -38,8 +38,11 @@ files:
 - lib/ruco/core_ext/array.rb
 - lib/ruco/core_ext/string.rb
 - lib/ruco/editor.rb
+- lib/ruco/status_bar.rb
 - ruco.gemspec
 - spec/ruco/core_ext/string_spec.rb
+- spec/ruco/editor_spec.rb
+- spec/ruco/status_bar_spec.rb
 - spec/ruco_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -78,5 +81,7 @@ specification_version: 3
 summary: Commandline editor written in ruby
 test_files: 
 - spec/ruco/core_ext/string_spec.rb
+- spec/ruco/editor_spec.rb
+- spec/ruco/status_bar_spec.rb
 - spec/ruco_spec.rb
 - spec/spec_helper.rb