ruco 0.0.56 → 0.1.0

data/Gemfile

@@ -3,6 +3,7 @@ source :rubygems
 gem 'clipboard', '>=0.9.4'
 
 group :dev do # not development <-> would add unneeded development dependencies in gemspec
+  gem 'ffi', :platform => [:mingw]
   gem 'rake'
   gem 'rspec', '~>2'
   gem 'jeweler'

data/Gemfile.lock

@@ -25,6 +25,7 @@ PLATFORMS
 
 DEPENDENCIES
   clipboard (>= 0.9.4)
+  ffi
   jeweler
   rake
   rspec (~> 2)

data/Rakefile

@@ -8,7 +8,7 @@ end
 
 task :run do
   file = 'spec/temp.txt'
-  File.open(file, 'w'){|f|f.write("12345\n1234\n#{'abcdefg'*20}\n123")}
+  File.open(file, 'wb'){|f|f.write("12345\n1234\n#{'abcdefg'*20}\n123")}
   exec "./bin/ruco #{file}"
 end
 
@@ -19,6 +19,25 @@ task :try do
   Curses.getch
 end
 
+task :try_color do
+  require 'curses'
+  if Curses::has_colors?
+    Curses::start_color
+    # initialize every color we want to use
+    # id, foreground, background
+    Curses::init_pair( Curses::COLOR_BLACK, Curses::COLOR_BLACK, Curses::COLOR_BLACK )
+    Curses::init_pair( Curses::COLOR_RED, Curses::COLOR_RED, Curses::COLOR_BLACK )
+    Curses::init_pair( Curses::COLOR_GREEN, Curses::COLOR_GREEN, Curses::COLOR_BLACK )
+  end
+
+  Curses.setpos(0,0)
+  Curses.attrset(Curses.color_pair(Curses::COLOR_RED)) # fetch color pair with the id xxx
+  Curses.addstr("xxxxxxxx\nyyyyyyy");
+  Curses.attrset(Curses.color_pair(Curses::COLOR_GREEN))
+  Curses.addstr("xxxxxxxx\nyyyyyyy");
+  Curses.getch
+end
+
 task :key do
   require 'curses'
 

data/Readme.md

@@ -1,4 +1,4 @@
-Simple, extendable, test-driven commandline editor written in ruby.
+Simple, extendable, test-driven commandline editor written in ruby, for Linux/Mac/Windows.
 
 Features:
 
@@ -81,6 +81,7 @@ TIPS
 
 TODO
 =====
+ - slow when opening file with 10,000+ short lines -> investigate
  - check writable status every x seconds (e.g. in background) -> faster while typing
  - search help e.g. 'Nothing found' '#4 of 6 hits' 'no more hits, start from beginning ?'
  - highlight current work when reopening search (so typing replaces it)
@@ -96,8 +97,13 @@ TODO
  - add auto-confirm to 'replace?' dialog -> type s == skip, no enter needed
  - 1.8: unicode support <-> already finished but unusable due to Curses (see encoding branch)
 
-Author
-======
+Authors
+=======
+
+### [Contributors](http://github.com/grosser/ruco/contributors)
+ - [AJ Palkovic](https://github.com/ajpalkovic)
+
+
 [Michael Grosser](http://grosser.it)<br/>
 grosser.michael@gmail.com<br/>
 Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -1 +1 @@
-0.0.56
+0.1.0

data/bin/ruco

@@ -20,6 +20,7 @@ Usage:
 Options:
 BANNER
     opts.on("-c", "--convert-tabs","Convert tabs to spaces") { options[:convert_tabs] = true }
+    opts.on("-u", "--undo-stack-size SIZE","Maximum size of the undo stack.  0 allows for a complete undo stack.") {|size| options[:undo_stack_size] = size.to_i }
     opts.on("--debug-cache","Show caching in action") { options[:debug_cache] = true }
     opts.on("--debug-keys", "Show pressed keys") { options[:debug_keys] = true }
     opts.on("-v", "--version","Show Version"){
@@ -55,6 +56,7 @@ def init_screen
   begin
     yield
   ensure
+    Curses.clear # needed to clear the menu/status bar on windows
     Curses.close_screen
   end
 end
@@ -107,7 +109,7 @@ def debug_key(key)
 end
 
 def log(stuff)
-  File.open('ruco.log','a'){|f| f.puts stuff }
+  File.open('ruco.log','ab'){|f| f.puts stuff }
 end
 
 @options = parse_options
@@ -116,6 +118,7 @@ require 'ruco'
 
 app = Ruco::Application.new(ARGV[0],
   :convert_tabs => @options[:convert_tabs],
+  :undo_stack_size => @options[:undo_stack_size],
   :lines => Curses.stdscr.maxy, :columns => Curses.stdscr.maxx
 )
 

data/lib/ruco/application.rb

@@ -155,7 +155,7 @@ module Ruco
 
       action :quit do
         if editor.modified?
-          ask("Loose changes? Enter=Yes Esc=Cancel") do
+          ask("Lose changes? Enter=Yes Esc=Cancel") do
             editor.store_session
             :quit
           end
@@ -253,7 +253,7 @@ module Ruco
       @status_lines = 1
 
       editor_options = @options.slice(
-        :columns, :convert_tabs, :convert_newlines
+        :columns, :convert_tabs, :convert_newlines, :undo_stack_size
       ).merge(
         :window => @options.nested(:window),
         :history => @options.nested(:history),

data/lib/ruco/core_ext/file.rb

@@ -1,5 +1,17 @@
 class File
   def self.write(to, content)
-    File.open(to, 'w'){|f| f.write(content) }
+    File.open(to, 'wb'){|f| f.write(content) }
+  end
+  
+  # Open files in binary mode. On linux this is ignored by ruby.
+  # On Windows ruby open files in text mode by default, so it replaces \r with \n,
+  # so the specs fail. If files are opened in binary mode, which is the only mode 
+  # on linux, it does not replace the newlines. This thread has slightly more information:
+  # http://groups.google.com/group/rubyinstaller/browse_thread/thread/c7fbe346831e58cc
+  def self.binary_read(file)
+    io = File.open(file, 'rb')
+    content = io.read
+    io.close
+    content
   end
 end

data/lib/ruco/editor.rb

@@ -2,10 +2,11 @@ module Ruco
   class Editor
     attr_reader :file
     attr_reader :text_area
+    attr_reader :history
     private :text_area
     delegate :view, :style_map, :cursor, :position,
       :insert, :indent, :unindent, :delete, :delete_line,
-      :redo, :undo,
+      :redo, :undo, :save_state,
       :selecting, :selection, :text_in_selection, :reset,
       :move, :resize, :move_line,
       :to => :text_area
@@ -19,7 +20,7 @@ module Ruco
         raise "#{@file} is larger than 1MB, did you really want to open that with Ruco?"
       end
 
-      content = (File.exist?(@file) ? File.read(@file) : '')
+      content = (File.exist?(@file) ? File.binary_read(@file) : '')
       content.tabs_to_spaces! if @options[:convert_tabs]
 
       # cleanup newline formats
@@ -29,6 +30,7 @@ module Ruco
 
       @saved_content = content
       @text_area = EditorArea.new(content, @options)
+      @history = @text_area.history
       restore_session
     end
 
@@ -51,7 +53,7 @@ module Ruco
       lines << '' if @options[:blank_line_before_eof_on_save] and lines.last.to_s !~ /^\s*$/
       content = lines * @newline
 
-      File.open(@file,'w'){|f| f.write(content) }
+      File.open(@file,'wb'){|f| f.write(content) }
       @saved_content = content.gsub(/\r?\n/, "\n")
 
       true

data/lib/ruco/editor/history.rb

@@ -1,9 +1,11 @@
 module Ruco
   class Editor
     module History
+      attr_reader :history
+      
       def initialize(content, options)
         super(content, options)
-        @history = Ruco::History.new((options[:history]||{}).reverse_merge(:state => state, :track => [:content], :entries => 100, :timeout => 2))
+        @history = Ruco::History.new((options[:history]||{}).reverse_merge(:state => state, :track => [:content], :entries => options[:undo_stack_size], :timeout => 2))
       end
 
       def undo
@@ -15,7 +17,7 @@ module Ruco
         @history.redo
         self.state = @history.state
       end
-
+      
       def view
         @history.add(state)
         super

data/lib/ruco/file_store.rb

@@ -1,4 +1,5 @@
 require "digest/md5"
+require "fileutils"
 
 module Ruco
   class FileStore
@@ -8,21 +9,27 @@ module Ruco
     end
 
     def set(key, value)
-      `mkdir -p #{@folder}` unless File.exist? @folder
+      FileUtils.mkdir_p @folder unless File.exist? @folder
       File.write(file(key), serialize(value))
       cleanup
     end
 
     def get(key)
       file = file(key)
-      deserialize File.read(file) if File.exist?(file)
+      deserialize File.binary_read(file) if File.exist?(file)
     end
 
     private
 
+    def entries
+      (Dir.entries(@folder) - ['.','..']).
+        map{|entry| File.join(@folder, entry) }.
+        sort_by{|file| File.mtime(file) }
+    end
+
     def cleanup
-      delete = `ls -t #{@folder}`.split("\n")[@options[:keep]..-1] || []
-      delete.each{|f| File.delete("#{@folder}/#{f}") }
+      delete = entries[0...-@options[:keep]] || []
+      delete.each{|f| File.delete(f) }
     end
 
     def file(key)
@@ -37,4 +44,4 @@ module Ruco
       Marshal.load(value)
     end
   end
-end
+end

data/lib/ruco/history.rb

@@ -1,41 +1,65 @@
 module Ruco
   class History
     attr_accessor :timeout
+    attr_reader :stack, :position
 
     def initialize(options)
       @options = options
-      @stack = [@options.delete(:state)]
+      @options[:entries] ||= 100
       @timeout = options.delete(:timeout) || 0
-      timeout!
+
+      @stack = [{:mutable => false, :created_at => 0, :type => :initial, :state => @options.delete(:state)}]
       @position = 0
     end
 
     def state
-      @stack[@position]
+      @stack[@position][:state]
     end
 
     def add(state)
       return unless tracked_field_changes?(state)
       remove_undone_states
-      if merge_timeout?
+      unless merge? state
+        # can no longer modify previous states
+        @stack[@position][:mutable] = false
+
+        state_type = type(state)
         @position += 1
-        @last_merge = Time.now.to_f
+        @stack[@position] = {:mutable => true, :type => state_type, :created_at => Time.now.to_f}
       end
-      @stack[@position] = state
+      @stack[@position][:state] = state
       limit_stack
     end
 
     def undo
-      timeout!
       @position = [@position - 1, 0].max
     end
 
     def redo
-      timeout!
       @position = [@position + 1, @stack.size - 1].min
     end
 
     private
+    def type(state)
+      @options[:track].each do |field|
+        if state[field].is_a?(String) && @stack[@position][:state][field].is_a?(String)
+          diff = state[field].length - @stack[@position][:state][field].length
+          if diff > 0
+            return :insert
+          elsif diff < 0
+            return :delete
+          end
+        end
+      end
+      nil
+    end
+
+    def merge?(state)
+      top = @stack[@position]
+      top[:mutable] &&
+        top[:type] == type(state) &&
+        top[:created_at]+@timeout > Time.now.to_f
+    end
 
     def remove_undone_states
       @stack.slice!(@position + 1, 9999999)
@@ -48,18 +72,11 @@ module Ruco
     end
 
     def limit_stack
+      return if @options[:entries] == 0
       to_remove = @stack.size - @options[:entries]
       return if to_remove < 1
       @stack.slice!(0, to_remove)
       @position -= to_remove
     end
-
-    def timeout!
-      @last_merge = 0
-    end
-
-    def merge_timeout?
-      (Time.now.to_f - @last_merge) > @timeout
-    end
   end
 end

data/ruco.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruco}
-  s.version = "0.0.56"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2011-05-11}
+  s.date = %q{2011-05-20}
   s.default_executable = %q{ruco}
   s.email = %q{michael@grosser.it}
   s.executables = ["ruco"]

data/spec/ruco/application_spec.rb

@@ -15,11 +15,11 @@ describe Ruco::Application do
   end
 
   def write(content)
-    File.open(@file,'w'){|f| f.write(content) }
+    File.open(@file,'wb'){|f| f.write(content) }
   end
 
   def read
-    File.read(@file)
+    File.binary_read(@file)
   end
 
   def editor_part(view)
@@ -110,7 +110,7 @@ describe Ruco::Application do
     it "asks before closing changed file -- escape == no" do
       app.key('a')
       app.key(:"Ctrl+w")
-      app.view.split("\n").last.should include("Loose changes")
+      app.view.split("\n").last.should include("Lose changes")
       app.key(:escape).should_not == :quit
       app.key("\n").should_not == :quit
     end
@@ -118,7 +118,7 @@ describe Ruco::Application do
     it "asks before closing changed file -- enter == yes" do
       app.key('a')
       app.key(:"Ctrl+w")
-      app.view.split("\n").last.should include("Loose changes")
+      app.view.split("\n").last.should include("Lose changes")
       app.key(:enter).should == :quit
     end
   end

data/spec/ruco/editor_spec.rb

@@ -2,11 +2,11 @@ require File.expand_path('spec/spec_helper')
 
 describe Ruco::Editor do
   def write(content)
-    File.open(@file,'w'){|f| f.write(content) }
+    File.open(@file,'wb'){|f| f.write(content) }
   end
 
   def read
-    File.read(@file)
+    File.binary_read(@file)
   end
 
   let(:editor){
@@ -753,6 +753,25 @@ describe Ruco::Editor do
   end
 
   describe 'history' do
+    it "does not overwrite the initial state" do
+      write("a")
+      editor.insert("b")
+      editor.view # trigger save point
+      stack = editor.history.stack
+      stack.length.should == 2
+      stack[0][:state][:content].should == "a"
+      stack[1][:state][:content].should == "ba"
+      
+      editor.undo
+      editor.history.position.should == 0
+      
+      editor.insert("c")
+      editor.view # trigger save point
+      stack.length.should == 2
+      stack[0][:state][:content].should == "a"
+      stack[1][:state][:content].should == "ca"
+    end
+    
     it "can undo an action" do
       write("a")
       editor.insert("b")
@@ -768,6 +787,7 @@ describe Ruco::Editor do
 
     it "removes selection on undo" do
       editor.insert('a')
+      editor.view # trigger save point
       editor.selecting{move(:to, 1,1)}
       editor.selection.should_not == nil
       editor.view # trigger save point
@@ -777,7 +797,6 @@ describe Ruco::Editor do
 
     it "sets modified on undo" do
       editor.insert('a')
-      editor.view # trigger save point
       editor.save
       editor.modified?.should == false
       editor.undo
@@ -790,14 +809,14 @@ describe Ruco::Editor do
       write('xxx')
       editor.insert('a')
       editor.save.should == true
-      File.read(@file).should == 'axxx'
+      File.binary_read(@file).should == 'axxx'
     end
 
     it 'creates the file' do
       `rm #{@file}`
       editor.insert('a')
       editor.save.should == true
-      File.read(@file).should == 'a'
+      File.binary_read(@file).should == 'a'
     end
 
     it 'does not crash when it cannot save a file' do

data/spec/ruco/file_store_spec.rb

@@ -1,6 +1,10 @@
 require File.expand_path('spec/spec_helper')
 
 describe Ruco::FileStore do
+  def mark_all_as_old
+    store.send(:entries).each{|e| File.utime(1,1,e) }
+  end
+
   before do
     @folder = 'spec/sessions'
     `rm -rf #{@folder}`
@@ -21,23 +25,10 @@ describe Ruco::FileStore do
     store.set('xxx', 1)
     store.set('yyy', 1)
     store.set('zzz', 1)
-    store.set('aaa', 1)
-    store.get('xxx').should == nil
-  end
-
-  it "drops least recently used key" do
-    store.set('xxx', 1)
-    sleep(0.1)
-    store.set('yyy', 1)
-    sleep(0.1)
-    store.set('xxx', 1)
-    sleep(0.1)
-    store.set('zzz', 1)
-    sleep(0.1)
-    store.set('aaa', 1)
-    sleep(0.1)
-    store.get('xxx').should == 1
-    store.get('yyy').should == nil
+    mark_all_as_old
+    store.set('aaa', 2)
+    store.get('aaa').should == 2
+    ['xxx','yyy','zzz'].map{|f| store.get(f) }.should =~ [1,1,nil]
   end
 
   it "does not drop if used multiple times" do
@@ -45,6 +36,7 @@ describe Ruco::FileStore do
     store.set('yyy', 1)
     store.set('zzz', 1)
     store.set('zzz', 1)
+    mark_all_as_old
     store.set('zzz', 1)
     store.set('zzz', 1)
     store.get('xxx').should == 1

data/spec/ruco/history_spec.rb

@@ -74,6 +74,20 @@ describe Ruco::History do
     history.undo
     history.state.should == {:x => 3}
   end
+  
+  describe 'with strings' do
+    let(:history){ Ruco::History.new(:state => {:x => 'a'}, :track => [:x], :timeout => 0.1) }
+    
+    it "triggers a new state on insertion and deletion" do
+      %w{ab abc ab a a}.each{|state| history.add(:x => state)}
+      
+      history.undo
+      history.state.should == {:x => "abc"}
+      
+      history.undo
+      history.state.should == {:x => "a"}
+    end
+  end
 
   describe 'with timeout' do
     let(:history){ Ruco::History.new(:state => {:x => 1}, :track => [:x], :entries => 3, :timeout => 0.1) }
@@ -114,4 +128,16 @@ describe Ruco::History do
       history.state.should == {:x => 3}
     end
   end
+  
+  describe 'with no entry limit' do
+    let(:history){ Ruco::History.new(:state => {:x => 1}, :track => [:x], :entries => 0, :timeout => 0) }
+    
+    it "should track unlimited states" do
+      200.times do |i|
+        history.add(:x => i+5)
+      end
+      history.stack.length.should == 201
+    end
+  end
+
 end

data/spec/ruco/status_bar_spec.rb

@@ -29,8 +29,11 @@ describe Ruco::StatusBar do
   end
 
   it "indicates not writable" do
-    editor.stub!(:file).and_return '/etc/sudoers'
-    bar.view.should include('!')
+    # this test will always fail on Windows with cygwin because of how cygwin sets up permissions
+    unless RUBY_PLATFORM =~ /mingw/
+      editor.stub!(:file).and_return '/etc/sudoers'
+      bar.view.should include('!')
+    end
   end
 
   it "shows line and column and right side" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruco
 version: !ruby/object:Gem::Version 
-  hash: 111
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 56
-  version: 0.0.56
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael Grosser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 +02:00
+date: 2011-05-20 00:00:00 +02:00
 default_executable: ruco
 dependencies: 
 - !ruby/object:Gem::Dependency