ruber 0.0.7 → 0.0.8

data/CHANGES

@@ -1,5 +1,59 @@
 h1. Changes
 
+h2. Ruber 0.0.8
+
+h3. Features
+
+* Added a new plugin: Auto End. As the name says, it automatically inserts @end@
+  keywords after @module@, @class@, @if@... Its implementation is a bit naive at
+  the moment (in particular, it doesn't know whether the current line is in the
+  middle of a string or of a block comment), so it can insert @end@ in the wrong
+  places. If it does, just Undo the last action and the end'll go away
+* Changed the way you open a file in the editor from a tool widget without closing
+  the tool widget itself. Now there's a little button on the right of the tool
+  widget with a pin on it. Clicking on it prevents the widget being closed when
+  clicking on a file name. This change was made because the Meta key is now used
+  for something else
+* When clicking on a file name while keeping the Meta key pressed, a new editor
+  for the file is open (even if there was already one open). The new editor can
+  be opened by splitting the current editor or in a new tab, depending on an
+  option chosen by the user
+* The RSpec tool widget now displays an horizontal scroll bar if a failure description
+  is too long to fit on the tool widget. Unfortunately, I haven't as yet found
+  out how to do the same for the example descriptions
+* Replaced Switch to File and Switch to Spec menu entries in the Ruby/Test menu
+  with a single menu entry, which changes its name and behaviour depending on
+  whether the current file is a spec file or not
+* Added an option allowing to choose whether switching from spec file to code file
+  (and the other way round) should be done by opening another tab or splitting
+  the current editor
+* Added a widget to display the output in the Command plugin. The widget is hidden
+  by default and can be shown using a button
+* Added menu entries (with the corresponding shortcuts) to move between split views
+  in the current pane
+* Disabled autoscrolling in tool widgets if the scroll bar is not at the end. This
+  way, the user can look at a particular piece of output while other lines are
+  appended at the end. This behaviour is the same used, for example, by Konsole
+
+h3. Minor changes
+
+* Scrolling on an editor using the mouse wheel gives focus to the editor
+
+h3. Bug fixes
+
+* Restored the Close Current Tab menu entry, which disappeared during the previous
+  round of changes to ruberui.rc
+* Do not attempt to require @kio@ if using KDE 4.4. @kio.rb@ was split from
+  @korundum4.rb@ in KDE 4.5, so requiring it in KDE 4.4 fails
+* When an exception is raised while executing code from the Command plugin, display
+  an OK button, rather than a Quit Ruber button, since pressing the button will
+  not (and should not) quit Ruber
+* Fixed a crash involved nested split views
+* Fixed a crash happening every time you tried to customize shortcuts after closing
+  a document (which meant always if you use the State plugin). The problem was
+  was caused by the Window/Switch to Document submenu being updated incorrectly
+  when a document was closed
+
 h2. Ruber 0.0.7
 
 * Ability to split views in tabs

data/bin/ruber

@@ -22,12 +22,23 @@ module QtEnumerable
 end
 
 require 'korundum4'
-require 'kio'
+
+#In korundum 4.4, there's no kio.rb. So, check whether KDE::IconButton (one of
+#the classes defined in kio.rb in korundum 4.5) is defined and only attempt to
+#require kio if it isn't.
+#
+#In theory, one should check the KDE version, but there's no way to do that (at
+#least as far as I know)
+unless defined? KDE::IconButton
+  require 'kio'
+end
+
 require 'facets/kernel/require_relative'
 
 require 'ruber/version'
 require 'ruber/qt_sugar'
 require 'ruber/kde_sugar'
+require 'ruber/ktexteditor_sugar'
 require 'ruber/utils'
 require 'ruber/exception_widgets'
 require 'ruber/component_manager.rb'

data/data/share/apps/ruber/ruberui.rc

@@ -79,6 +79,11 @@
   </Menu>
   <Menu name="window">
     <text>&amp;Window</text>
+    <Action name="window-next_horizontally"/>
+    <Action name="window-next_vertically"/>
+    <Action name="window-previous_horizontally"/>
+    <Action name="window-previous_vertically"/>
+    <Separator/>
     <Action name="window-split_horizontally"/>
     <Action name="window-split_vertically"/>
     <Separator/>

data/lib/ruber/application/application.rb

@@ -62,7 +62,7 @@ The default plugins to load
     
 Currently, they are: ruby_development, find_in_files, syntax_checker, command and state
 =end
-    DEFAULT_PLUGINS = %w[ruby_development find_in_files rake command syntax_checker state]
+    DEFAULT_PLUGINS = %w[ruby_development find_in_files rake command syntax_checker state auto_end project_browser]
     
     include PluginLike
     

data/lib/ruber/documents/document_list.rb

@@ -409,4 +409,4 @@ attempts to save each document
 
   end
 
-end
+end

data/lib/ruber/editor/document.rb

@@ -349,14 +349,34 @@ Returns the path of the document
     end
 
 =begin rdoc
-Returns the text in the document
----
-We can't just delegate this method to the internal <tt>KTextEditor::Document</tt>
-because its +text+ method returns nil if there's no text in the document, instead
+The document's text
+
+@overload text
+  The text in the whole document
+  @return [String] the text in the whole document
+@overload text range, block = false
+  The text contained in the given range
+  @param [KTextEditor::Range] range the range of text to retrieve
+  @param [Boolean] block whether or not to consider the range as a visual block
+  @return [String] the text inside the range. An empty string is returned if
+    the range is invalid
+@note We can't just delegate this method to the internal @KTextEditor::Document@
+because its @text@ method returns nil if there's no text in the document, instead
 of an empty string.
 =end
-    def text
-      @doc.text || ''
+    def text *args
+      @doc.text(*args) || ''
+    end
+    
+=begin rdoc
+As @KTextEditor::Document#line@
+
+@param [Integer] n the line number
+@return [String] the text in the given line or an empty string if the line is out
+  of range
+=end
+    def line n
+      @doc.line(n) || ''
     end
     
 =begin rdoc

data/lib/ruber/editor/editor_view.rb

@@ -106,10 +106,30 @@ module Ruber
       
       @view.context_menu = @view.default_context_menu(Qt::Menu.new(@view))
       
+      self.focus_policy = Qt::WheelFocus
+      
+    end
+    
+=begin rdoc
+Moves the cursor of the given amount
+
+If the cursor ends up being out of range, nothing is done
+@param [Integer] row the amount of rows to move the cursor of. If it's negative,
+  the cursor will be moved upwards, otherwise it'll be moved downwards
+@param [Integer] col the amount of columns to move the cursor of. If it's negative,
+  the cursor will be moved to the left, otherwise it'll be moved to the right
+@return [Boolean] *true* if the cursor was moved successfully and *false* if it
+  was out of range
+=end
+    def move_cursor_by row, col
+      cur = @view.cursor_position
+      cur.line += row
+      cur.column += col
+      @view.set_cursor_position cur
     end
     
     def go_to row, col
-      @view.cursor_position = KTextEditor::Cursor.new(row, col)
+      @view.set_cursor_position KTextEditor::Cursor.new(row, col)
     end
 
     def show_annotation_border
@@ -127,7 +147,6 @@ module Ruber
     def close
       emit closing self
       super
-#       delete_later
     end
 
     def set_annotation_border_visible vis

data/lib/ruber/filtered_output_widget.rb

@@ -84,7 +84,7 @@ will be used
       connect view.selection_model, SIGNAL('selectionChanged(QItemSelection, QItemSelection)'), self, SLOT('selection_changed(QItemSelection, QItemSelection)')
       @editor = KDE::LineEdit.new self
       connect @editor, SIGNAL('returnPressed(QString)'), self, SLOT(:create_filter_from_editor)
-      layout.add_widget @editor, 1, 0
+      layout.add_widget @editor, 2, 0
       def @editor.keyReleaseEvent e
         super
         hide if e.key == Qt::Key_Escape and e.modifiers == 0

data/lib/ruber/ktexteditor_sugar.rb

@@ -0,0 +1,124 @@
+=begin 
+    Copyright (C) 2011 by Stefano Crocco   
+    stefano.crocco@alice.it   
+  
+    This program is free software; you can redistribute it andor modify  
+    it under the terms of the GNU General Public License as published by  
+    the Free Software Foundation; either version 2 of the License, or     
+    (at your option) any later version.                                   
+  
+    This program is distributed in the hope that it will be useful,       
+    but WITHOUT ANY WARRANTY; without even the implied warranty of        
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         
+    GNU General Public License for more details.                          
+  
+    You should have received a copy of the GNU General Public License     
+    along with this program; if not, write to the                         
+    Free Software Foundation, Inc.,                                       
+    59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             
+=end
+
+require 'korundum4'
+require 'ktexteditor'
+
+module KTextEditor
+  
+  class Cursor
+    
+=begin rdoc
+Override of @Object#inspect@
+
+@return [String] a string representation of the cursor which displays line and column
+  number
+=end
+    def inspect
+      if !disposed?
+        "<#{self.class}:#{object_id} line=#{line} column=#{column}>"
+      else "<#{self.class}:#{object_id} DISPOSED>"
+      end
+    end
+    
+=begin rdoc
+Override of @Object#==@
+
+@param [Object] other the object to compare with *self*
+@return [Boolean] *true* if _other_ is a @KTextEditor::Cursor@ with the same line
+  and column number and *false* otherwise
+=end
+    def == other
+      return false unless other.is_a? KTextEditor::Cursor
+      line == other.line and column == other.column
+    end
+    
+=begin rdoc
+Override of @Object#dup@
+
+@return [Cursor] a {Cursor} with the same line and column number
+=end
+    def dup
+      self.class.new self.line, self.column
+    end
+
+=begin rdoc
+Override of @Object#clone@
+
+@return [Cursor] a {Cursor} with the same line and column number
+=end
+    def clone
+      res = dup
+      res.freeze if self.frozen?
+      res
+    end
+    
+  end
+  
+  class Range
+   
+=begin rdoc
+Override of @Object#inspect@
+
+@return [String] a string representation of the cursor which displays the
+  start and end line and column
+=end
+    def inspect
+      return "<#{self.class}:#{object_id} DISPOSED>" if disposed?
+      start_c = self.start
+      end_c = self.end
+      "<#{self.class}:#{object_id} start=(#{start_c.line};#{start_c.column}) end=(#{end_c.line};#{end_c.column})>"
+    end
+
+=begin rdoc
+Override of @Object#==@
+
+@param [Object] other the object to compare with *self*
+@return [Boolean] *true* if _other_ is a @KTextEditor::Range@ with the same start
+  and end and *false* otherwise
+=end
+    def == other
+      return false unless other.is_a? KTextEditor::Range
+      start == other.start and self.end == other.end
+    end
+
+=begin rdoc
+Override of @Object#dup@
+
+@return [Range] a {Range} with the same start and end
+=end
+    def dup
+      self.class.new self.start, self.end
+    end
+
+=begin rdoc
+Override of @Object#clone@
+
+@return [Range] a {Range} with the same start and end
+=end
+    def clone
+      res = dup
+      res.freeze if self.frozen?
+      res
+    end
+    
+  end
+  
+end

data/lib/ruber/main_window/main_window.rb

@@ -249,7 +249,7 @@ hint, a new one will be created, unless the @create_if_needed@ hint is *false*.
   the given document should be created if none exists. This is different from
   passing @:always@ as the value of the @:existing@ option because the latter would
   cause a new editor to be created in case no one already exists for the document
-@option hints [Symbol, Array<Symbol>] :stategy ([:current, :current_tab, :first])
+@option hints [Symbol, Array<Symbol>] :strategy ([:current, :current_tab, :first])
   how to choose the exisiting editor to use in case there's more than one. If it
   is an array, the strategies will be applied in turn until one has success.
   If none of the given strategies succeed, @:first@ will be used. The possible
@@ -275,6 +275,9 @@ hint, a new one will be created, unless the @create_if_needed@ hint is *false*.
   current editor
   * @:current_tab@: place the new editor in the pane obtained splitting the first
   editor in the current tab
+  * @:replace@: replace the current editor, if any, with the new one. If no active
+    editor exists, it's the same as @:new_tab@. This value (if there's an active
+    editor), implies that the @:existing@ option is set to @:never@
   * an integer: place the new editor in the tab associated with that index (0-based),
   in the pane obtained by splitting the first view
   * an {EditorView}: place the new editor in the pane obtained splitting the
@@ -295,6 +298,13 @@ hint, a new one will be created, unless the @create_if_needed@ hint is *false*.
 =end
     def editor_for! doc, hints = DEFAULT_HINTS
       hints = DEFAULT_HINTS.merge hints
+      if hints[:new] == :replace
+        if active_editor
+          hints[:existing] = :never
+          hints[:show] = false
+        else hints[:new] = :new_tab
+        end
+      end
       docs = Ruber[:documents].documents
       unless doc.is_a? Document
         unless hints.has_key? :close_starting_document
@@ -313,7 +323,11 @@ hint, a new one will be created, unless the @create_if_needed@ hint is *false*.
         doc = Ruber[:documents].document url
       end
       return unless doc
-      @view_manager.without_activating{@view_manager.editor_for doc, hints}
+      ed = @view_manager.without_activating{@view_manager.editor_for doc, hints}
+      if hints[:new] == :replace
+        replace_editor active_editor, ed
+      else ed
+      end
     end
     
 =begin rdoc
@@ -461,20 +475,24 @@ This method is similar to {#editor_for!} but, after retrieving the editor (creat
 it and/or the document as needed), it activates and gives focus to it and moves
 the cursor to the given position.
 
+Besides the keys listed in {#editor_for!}, _hints_ can also contain the two entries
+@:line@ and @:column@.
+
 @see #editor_for! editor_for! for the possible entries in _hints_
 @param (see #editor_for!)
-@param [Integer,nil] line the line number to move the cursor to (0-based). Ignored if eiter
-  it or _col_ is *nil*
-@param [Integer,nil] col the column number to move the cursor to (0-based). Ignored if eiter
-  it or _col_ is *nil*
+@option hints [Integer,nil] line (nil) the line to move the cursor to. If *nil*,
+  the cursor won't be moved
+@option hints [Integer] column (0) the column to move the cursor to. Ignored if
+  the @:line@ entry is *nil*
 @return [EditorView,nil] the editor which has been activated or *nil* if the
   editor couldn't be found (or created)
 =end
-    def display_doc doc, line = nil, col = nil, hints = DEFAULT_HINTS
+    def display_doc doc, hints = DEFAULT_HINTS
       ed = editor_for! doc, hints
       return unless ed
       activate_editor ed
-      ed.go_to line, col if line and col
+      line = hints[:line]
+      ed.go_to line, hints[:column] || 0 if line
       ed.set_focus
       ed
     end
@@ -528,20 +546,20 @@ the latter will be closed without affecting the document.
   method directly, unless you want to leave the corresponding document without a view
 =end
     def close_editor editor, ask = true
-      editor_tab = self.tab(editor)
-      has_focus = editor_tab.is_active_window if editor_tab
-      if has_focus
-        views = editor_tab.to_a
-        idx = views.index(editor)
-        new_view = views[idx-1] || views[idx+1]
-      end
+#       editor_tab = self.tab(editor)
+#       has_focus = editor_tab.is_active_window if editor_tab
+#       if has_focus
+#         views = editor_tab.to_a
+#         idx = views.index(editor)
+#         new_view = views[idx-1] || views[idx+1]
+#       end
       doc = editor.document
       if doc.views.size > 1 
         editor.close
         true
       else doc.close ask
       end
-      focus_on_editor new_view if new_view
+#       focus_on_editor new_view if new_view
     end
     
 =begin rdoc

data/lib/ruber/main_window/main_window_actions.rb

@@ -459,7 +459,7 @@ It splits the active view horizontally, so that a new copy of the view is create
 =end
     def split_horizontally
       ed = active_editor
-      display_document ed.document, nil, nil, :existing => :never, :new => ed, :split => :horizontal
+      display_document ed.document, :existing => :never, :new => ed, :split => :horizontal
     end
     slots :split_horizontally
 
@@ -473,7 +473,7 @@ It splits the active view vertically, so that a new copy of the view is created.
 =end
     def split_vertically
       ed = active_editor
-      new_ed = display_document ed.document, nil, nil, :existing => :never, :new => ed, :split => :vertical
+      new_ed = display_document ed.document, :existing => :never, :new => ed, :split => :vertical
     end
     slots :split_vertically
     
@@ -519,8 +519,7 @@ This method is called whenever a document is created or deleted. It updates the
 action list so that it contains an action for each of the open documents
 =end
     def update_switch_to_list
-      unplug_action_list 'window-switch_to_open_document_list'
-      @switch_to_actions.each{|a| a.delete_later}
+      unplug_action_list "window-switch_to_open_document_list"
       @switch_to_actions = Ruber[:documents].map do |doc|
         a = action_collection.add_action "switch_to_#{doc.document_name}", self, SLOT(:switch_to_document)
         a.text = KDE.i18n("Switch to %s") % [doc.document_name]
@@ -528,7 +527,7 @@ action list so that it contains an action for each of the open documents
         a
       end
       @switch_to_actions = @switch_to_actions.sort_by{|a| a.object_name}
-      plug_action_list 'window-switch_to_open_document_list', @switch_to_actions
+      plug_action_list "window-switch_to_open_document_list", @switch_to_actions
     end
     slots :update_switch_to_list
     
@@ -567,6 +566,73 @@ for it, replaces the active editor with it and gives focus to it.
     end
     slots 'switch_to_recent_file(KUrl)'
     
+=begin rdoc
+Slot associated with the Next/Previous View Horizontally/Vertically actions
+
+According to the name of the action, it gives focus to the next/previous view in
+the current tab going horizontally/vertically. If the current tab only contains
+one view, nothing is done.
+
+@note@ this method uses @sender@ to find out which action emitted the signal,
+  so you can't call it directly
+@return [EditorView] the view which received focus
+=end
+    def move_among_views
+      action_name = sender.object_name
+      direction = action_name.match('next') ? :next : :previous
+      orientation = action_name.match(/horizontal/) ? Qt::Horizontal : Qt::Vertical
+      pane = find_next_pane active_editor.parent, orientation, direction
+      view = pane ? pane.view : @tabs.current_widget.views[direction == :next ? 0 : -1]
+      focus_on_editor view 
+    end
+    slots :move_among_views
+    
+=begin rdoc
+Finds the next or previous pane in single view mode from a given pane
+
+According to the second argument, the direction will be either horizontal or
+vertical.
+    
+The search will be carried out first among siblings and their children, then among
+ancestors.
+
+@param [Pane] from the pane next/previous is relative to. It *must* be a single
+  view pane
+@param [Integer] orientation whether to look for the next/previous pane horizontally
+  or vertically. It may be either @Qt::Horizontal@ or @Qt::Vertical@
+@param [Symbol] direction whether to look for the next or previous pane. It must
+  be either @:next@ or @:previous@
+@return [Pane,nil] the next/previous single view mode pane or *nil* if no such pane
+  has been found (either because the pane is toplevel or because it's the first/last)
+@todo Maybe move this method to {Pane} class
+=end
+    def find_next_pane from, orientation, direction
+      loop do
+        parent = from.parent_pane
+        return nil unless parent
+        idx = parent.splitter.index_of from
+        if parent.orientation == orientation
+          new_idx = idx + (direction == :next ? 1 : -1)
+          pane = parent.splitter.widget new_idx
+          return pane.views[0].parent if pane
+        end
+        to_try = parent.panes[direction == :next ? (idx+1)..-1 : 0...idx]
+        until to_try.empty? do
+          idx = direction == :next ? 0 : -1
+          pane = to_try[idx]
+          if pane.single_view? then to_try.delete_at idx
+          else
+            if pane.orientation == orientation then return pane.views[idx].parent
+            else 
+              to_try.delete_at idx
+              to_try.unshift *pane.panes
+            end
+          end
+        end
+        from = parent
+      end
+    end
+    
   end
   
 =begin rdoc
@@ -574,6 +640,12 @@ Class containing the settings associated with the main window
 =end
   class MainWindowSettingsWidget < Qt::Widget
     
+=begin rdoc
+Mapping between modes to open files from tool widgets and indexes in the corresponding
+combo box
+=end
+    TOOL_OPEN_FILES = [:split_horizontally, :split_vertically, :new_tab]
+    
 =begin rdoc
 @param [Qt::Widget,nil] parent the parent widget
 =end
@@ -594,6 +666,27 @@ Override of @Qt::Widget#sizeHint@
       Qt::Size.new(380,150)
     end
     
+=begin rdoc
+Read method for the @general/tool_open_files@ setting
+@param [Symbol] value the value of the option. It can have any value contained
+  in the {TOOL_OPEN_FILES} array
+@return [Symbol] value
+=end
+    def tool_open_files= value
+      @ui._general__tool_open_files.current_index = TOOL_OPEN_FILES.index(value) || 0
+      value
+    end
+    
+=begin rdoc
+Store method for the @general/tool_open_files@ setting
+
+@return [Integer] the entry in {TOOL_OPEN_FILES} corresponding to the one selected in
+the combo box
+=end
+    def tool_open_files
+      TOOL_OPEN_FILES[@ui._general__tool_open_files.current_index]
+    end
+    
   end
   
 =begin rdoc