ruber 0.0.9 → 0.0.10

data/CHANGES

@@ -1,9 +1,48 @@
 h1. Changes
 
-h2. Ruber 0.0.9
+h2. Ruber 0.0.10
 
 h3. Features
 
+* Added a RI plugin. You can now insert the class or method name in the RI tool widget
+  and see the documentation in a nice HTML format inside the tool widget itself.
+  This plugin requires RDoc version 3.x (it isn't tested with version 2.x).
+* Added an IRB plugin
+* The syntax checker plugin has been rewritten. Now other plugins can check the
+  syntax of a document
+* Ruby and YAML syntax checker now are in their own plugin, rather than being part
+  of the syntax checker plugin
+* The auto end plugin doesn't use indentation anymore to decide whether the end keyword
+  should be inserted or not. Instead, it performs a syntax check and only inserts
+  end if ruby reports a missing end keyword. This should improve the accuracy of
+  the plugin
+* The Auto End plugin now inserts the @end@ keyword after a @case@ expression
+* Clicking on a file name in an output widget with the middle mouse button now
+  prevents the tool widget from being hidden, as if the pin button were clicked
+* Changed the interface to specify patterns in the RSpec plugin
+* The RSpec plugin now supports specs inside subdirectories. You can also specify
+  subdirectories inside the pattern to match code file and the respective spec
+  file
+* When choosing the Run Specs for Current File action in the RSpec plugin, if the current
+  document is associated with a code file, all the specs associated with it are
+  run (previously, only one of them was run)
+* When choosing the Run Current Spec action in the RSpec plugin, if the current
+  document is a code file, the plugin will look at the most recently activated
+  editor containing a spec file for the current file to determine which is the
+  current spec.
+* The behaviour of output widgets when clicking on a file name which requires
+  opening a new editor has changed. The choice made by the user to open the editor
+  in the current tab by splitting the current editor is ignored if the current 
+  tab already contains more than one editor. The reason is that usually there
+  won't be enough space on the sceen to comfortably accomodate more than two
+  editors.
+  
+h3. Bug fixes
+
+* Do not crash when closing with unsaved files
+* Horizontal scrollbar in the RSpec tool widget will be displayed when the spec
+  description is larger than the widget but the rest of the text isn't
+
 h2. Ruber 0.0.9
 
 h3. Features
@@ -20,6 +59,8 @@ h3. Bug fixes
 * The RSpec plugin now correctly displays pending examples
 * Fixed a crash when creating a new document and saving it as a ruby file while
   using the Syntax Checker plugin
+* When clicking on a file name in an output widget, give focus to the editor instead
+  of keeping it in  the tool widget
   
 h2. Ruber 0.0.8
 

data/lib/ruber/application/application.rb

@@ -62,7 +62,8 @@ 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 auto_end project_browser]
+    DEFAULT_PLUGINS = %w[ruby_development find_in_files rake command syntax_checker
+    state auto_end project_browser ruby_syntax_checker yaml_syntax_checker]
     
     include PluginLike
     
@@ -74,7 +75,6 @@ Currently, they are: ruby_development, find_in_files, syntax_checker, command an
     attr_reader :cmd_line_options
     
 =begin rdoc
-<<<<<<< HEAD
 =======
 The state Ruber is in
 
@@ -87,7 +87,6 @@ Ruber can be in three states:
 - *quitting*:= from when the user chooses to quit Ruber onwards
 - *asking_to_quit*:= while asking the user to confirm quitting Ruber
 
->>>>>>> master
 @return [Symbol] the status of the application. It can be: @:starting@, @:running@
   or @:quitting@
 =end
@@ -117,6 +116,7 @@ and is fired as soon as the event loop starts.
       @plugin_dirs = []
       load_core_components
       @status = :starting
+      @chdir_lock = Mutex.new
       Qt::Timer.single_shot(0, self, SLOT(:setup))
     end
     
@@ -251,6 +251,25 @@ or sorting dependencies.
       @components.load_plugins plugins, dirs || @plugin_dirs, &blk
       
     end
+    
+=begin rdoc
+Thread-safe Dir.chdir
+
+@Dir.chdir@ is not thread-safe, meaning that a Dir.chdir done in a thread will
+change the directory in all other threads. To avoid this unpleasant behaviour,
+don't use Dir.chdir. Instead, use this method, which uses a mutex to control calls
+to Dir.chdir.
+@param [String] dir the directory to change to
+@yield the block to execute from within _dir_. The current directory will
+  be changed back after executing the block.
+@raise [LocalJumpError] if no block is given
+@return [Object] the value returned by the block otherwise
+=end
+    def chdir dir
+      @chdir_lock.synchronize do
+        Dir.chdir(dir){yield}
+      end
+    end
 
     private
 
@@ -304,7 +323,7 @@ At the end, the main window is shown
         #{e.message}
         
         Ruber will start with no plugin loaded. Please, use the Choose Plugins menu entry in the Settings menu to solve the issue.
-        EOS
+EOS
       end
       begin 
         availlable_plugins = ComponentManager.find_plugins @plugin_dirs, true
@@ -316,7 +335,7 @@ At the end, the main window is shown
 Ruber couldn't find some plugins it has been configured to automatically load at startup. They are:
 #{missing.join("\n")}
 Do you want to start the application without them or to quit Ruber?
-          EOS
+EOS
           ans = KDE::MessageBox.question_yes_no nil, question, 'Missing plugins',
               KDE::GuiItem.new('Start Ruber'), KDE::GuiItem.new('Quit')
           exit if ans == KDE::MessageBox::No
@@ -397,6 +416,7 @@ necessary to to them later
     def register_with_config
       config = Ruber[:config]
       @plugin_description.config_options.each_value{|o| config.add_option o}
+      @plugin_description.config_widgets.each{|w| config.add_widget w}
       load_settings
       connect config, SIGNAL(:settings_changed), self, SLOT(:load_settings)
       nil

data/lib/ruber/application/plugin.yaml

@@ -1,16 +1,8 @@
 name: app
 description: The application itself
-require: [application, project_files_widget, project_files_list]
+require: [application]
 class: 'Ruber::Application'
 config_options: 
  :general:
    :plugin_dirs: {:default: Ruber::Application::DEFAULT_PLUGIN_PATHS}
-   :plugins: {:default: Ruber::Application::DEFAULT_PLUGINS}
-   :auto_load_project: {:default: false }
-config_widgets:
- - {:caption: General, :pixmap: configure, :code: "w=Qt::CheckBox.new('&Open last project at startup');w.object_name='kcfg_general_auto_load_project';w"}
-project_options:
- general:
-  project_files: {default: {:include: [], :exclude: [], :extensions: ["*.rb"]}}
-extensions:
- project_files: {class: ProjectFilesList}
+   :plugins: {:default: Ruber::Application::DEFAULT_PLUGINS}

data/lib/ruber/component_manager.rb

@@ -429,7 +429,7 @@ possible kinds of dependency errors.
     def self.find_plugins dirs, info = false
       res = {}
       dirs.each do |dir|
-        Dir.entries(dir)[2..-1].each do |name|
+        Dir.entries(dir).sort[2..-1].each do |name|
           next if res[name.to_sym]
           d = File.join dir, name
           if File.directory?(d) and File.exist?(File.join d, 'plugin.yaml')
@@ -861,7 +861,7 @@ Method required for the Plugin interface. Does nothing
     def locate_plugins dirs
       plugin_files = {}
       dirs.reverse.each do |d|
-        Dir.entries(d)[2..-1].each do |f| 
+        Dir.entries(d).sort[2..-1].each do |f| 
           full_dir = File.join d, f
           if File.directory?(full_dir) and File.exist?(File.join(full_dir, 'plugin.yaml'))
             plugin_files[f] = File.join full_dir, 'plugin.yaml'

data/lib/ruber/document_project.rb

@@ -54,7 +54,6 @@ didn't exist. This means that it will be overwritten when the project is saved.
 The reason for this behaviour is that there should be no user file in the directory
 where document projects are saved.
 =end
-#       $CALLED = 0
       def initialize file
         @old_files = []
         begin super file_for(file)
@@ -157,9 +156,12 @@ The comparison is made using <tt>Document#file_type_match?</tt>. This method ret
 rule's scope includes +:document+
 =end
     def match_rule? obj
+      doc_place  = if !@document.path.empty?
+        @document.url.local_file? ? :local : :remote
+      else :local
+      end
       if !super then false
-      elsif !obj.place.include?(@document.url.local_file? ? :local : :remote) 
-        false
+      elsif !obj.place.include? doc_place then false
       elsif !@document.file_type_match? obj.mimetype, obj.file_extension then false
       else true
       end

data/lib/ruber/editor/document.rb

@@ -92,7 +92,8 @@ module Ruber
 'view_created(QObject*, QObject*)', 'closing(QObject*)', :activated, :deactivated,
 'modified_on_disk(QObject*, bool, KTextEditor::ModificationInterface::ModifiedOnDiskReason)',
 'sig_query_close(bool*, bool*)', 'canceled(QString)', 'completed()', 'completed1(bool)',
-'started(KIO::Job*)', 'set_status_bar_text(QString)', 'setWindowCaption(QString)'
+'started(KIO::Job*)', 'set_status_bar_text(QString)', 'setWindowCaption(QString)',
+'document_saved_or_uploaded(QObject*, bool)' 
     
 =begin rdoc
 Signal emitted before a view associated with the document is closed
@@ -127,7 +128,7 @@ Creates a new Ruber::Document.
       interface('modification_interface').modified_on_disk_warning = true
       @modified_on_disk = false
       @project = DocumentProject.new self
-      
+      @project.finalize
       @doc.connect(SIGNAL('modifiedChanged(KTextEditor::Document*)')) do |doc|
         emit modified_changed(@doc.modified?, self)
       end
@@ -155,7 +156,7 @@ Creates a new Ruber::Document.
         begin
           emit text_inserted(r, self)
         rescue ArgumentError => e
-          ExceptionDialog.new e, nil, true, "An exception was raised when writing text. See issue number 6 at http://github.com/stcrocco/ruber/issues"
+          ExceptionDialog.new e, nil, true, "An exception was raised from emit text_inserted. See issue number 6 at http://github.com/stcrocco/ruber/issues"
         end
       end
       
@@ -357,7 +358,7 @@ Return the project with wider scope the document belongs to. This is:
     def project
       prj = Ruber[:world].active_project
       return @project if path.empty? or !prj
-      prj.project_files.file_in_project?(url.to_encoded.to_s) ? prj : @project
+      prj.file_in_project?(url.to_encoded.to_s) ? prj : @project
     end
     
 =begin rdoc

data/lib/ruber/editor/ktexteditor_wrapper.rb

@@ -133,7 +133,7 @@ containing the information for the signal and slot to create.
 def __emit_#{name}_signal(#{old_args.size.times.map{|i| "a#{i}"}.join ', '})
   emit #{name}(#{d[1].map{|i| i ? "a#{i}" : 'self'}.join ', '})
 end
-        EOS
+EOS
         cls.class_eval method_def
       end
       res

data/lib/ruber/exception_widgets.rb

@@ -233,7 +233,7 @@ are suitable for use by a block passed to {ComponentManager#load_plugins}.
     def exec
       res = super
       case res
-      when KDE::Dialog::Yes then dlg.silently? ? :silent : true
+      when KDE::Dialog::Yes then silently? ? :silent : true
       when KDE::Dialog::No then false
       when KDE::Dialog::Cancel then :skip
       else res

data/lib/ruber/main_window/main_window.rb

@@ -1,5 +1,5 @@
 =begin 
-    Copyright (C) 2010 by Stefano Crocco   
+    Copyright (C) 2010, 2011 by Stefano Crocco   
     stefano.crocco@alice.it   
   
     This program is free software; you can redistribute it andor modify  
@@ -538,13 +538,14 @@ In the second and third cases, the method simply returns respectively *true* or
   can be carried on and *false* if the user chose to abort it
 =end
     def save_documents docs = nil
-      docs ||= Ruber[:docs]
+      docs ||= Ruber[:world].documents
       to_save = docs.select{|d| d.modified?}
       until to_save.empty?
         dlg = SaveModifiedFilesDlg.new to_save, self
+        to_save = dlg.to_save
         case dlg.exec
         when KDE::Dialog::Yes
-          to_save = Ruber[:docs].save_documents dlg.to_save
+          to_save.delete_if{|doc| doc.save}
           unless to_save.empty?
             msg = "The following documents couldn't be saved: #{to_save.join "\n"}\nPlease, choose how to proceed"
             KDE::MessageBox.sorry nil, KDE.i18n(msg)

data/lib/ruber/main_window/main_window_actions.rb

@@ -1,5 +1,5 @@
 =begin 
-    Copyright (C) 2010 by Stefano Crocco   
+    Copyright (C) 2010, 2011 by Stefano Crocco   
     stefano.crocco@alice.it   
   
     This program is free software; you can redistribute it andor modify  
@@ -280,7 +280,7 @@ informing the user
         pl.save_settings
         loaded << pl.plugin_name
       end
-      loaded.each{|pl| Ruber[:components].unload_plugin pl}
+      loaded.reverse_each{|pl| Ruber[:components].unload_plugin pl}
       res = Ruber[:app].safe_load_plugins dlg.plugins.keys.map(&:to_s)
       close unless res
       nil

data/lib/ruber/main_window/main_window_internal.rb

@@ -1,5 +1,5 @@
 =begin 
-    Copyright (C) 2010 by Stefano Crocco   
+    Copyright (C) 2010, 2011 by Stefano Crocco   
     stefano.crocco@alice.it   
   
     This program is free software; you can redistribute it andor modify  

data/lib/ruber/output_widget.rb

@@ -757,7 +757,9 @@ option is used.
       existing = (Qt::MetaModifier & modifiers) == 0 ? :always : :never
       display_hints = hints.merge(:line =>  line, :existing => existing)
       ed = Ruber[:main_window].display_document file, display_hints
-      Ruber[:main_window].hide_tool self unless pinned_down?
+      hide_tool = pinned_down? and Qt::Application.mouse_buttons != Qt::MidButton
+      Ruber[:main_window].hide_tool self if hide_tool
+      ed.set_focus if ed
       ed
     end
     
@@ -771,11 +773,21 @@ however, that the @:existing@ entry won't be used.
 @return [Hash] see the description for the _hints_ argument of {MainWindow#editor_for!}
 =end
     def hints
-      case Ruber[:config][:general, :tool_open_files]
-      when :split_horizontally then {:new => :current_tab, :split => :horizontal}
-      when :split_vertically then {:new => :current_tab, :split => :vertical}
-      else {:new => :new_tab}
+      hints = {:new => :new_tab}
+      choice = Ruber[:config][:general, :tool_open_files]
+      case choice
+      when :split_horizontally then hints[:split] = :horizontal
+      when :split_vertically then hints[:split] = :vertical
       end
+      if hints[:split]
+        env = Ruber[:world].active_environment
+        view = env.active_editor
+        n_views = view ? env.tab(view).views.count : 0
+        if n_views == 1 then hints[:new] = :current_tab
+        else hints.delete :split
+        end
+      end
+      hints
     end
     
 =begin rdoc

data/lib/ruber/project.rb

@@ -24,6 +24,7 @@ require 'yaml'
 require 'ruber/plugin'
 require 'ruber/settings_container'
 require 'ruber/project_backend'
+require 'ruber/project_dir_scanner'
 
 module Ruber
 
@@ -130,7 +131,6 @@ When the project is created, it's not active.
       @project_extensions = {}
       Ruber[:components].named_connect(SIGNAL('component_loaded(QObject*)'), "register_component_with_project #{object_id}"){|c| c.register_with_project self}
       Ruber[:components].named_connect(SIGNAL('unloading_component(QObject*)'), "remove_component_from_project #{object_id}"){|c| c.remove_from_project self}
-      Ruber[:components].each_component{|c| c.register_with_project self}
     end
     
 =begin rdoc
@@ -324,6 +324,22 @@ will be removed (calling their @remove_from_project@ method if they have one).
       true
     end
     
+=begin rdoc
+Registers each component with the project
+
+This is done in {#initialize} because, at least for {DocumentProject}, the extensions
+may try to access the project (directly or not) before it has fully been created.
+
+This method should only be called from the object calling {.new}
+
+@note This method has nothing to do with finalizers
+@return [nil]
+=end
+    def finalize
+      Ruber[:components].each_component{|c| c.register_with_project self}
+      nil
+    end
+    
   end
   
 =begin rdoc
@@ -378,6 +394,16 @@ AbstractProject::InvalidProjectFile will be raised.
         raise Ruber::AbstractProject::InvalidProjectFile, e.message
       end
       super Ruber[:world], back, name
+      finalize
+      @dir_scanner = ProjectDirScanner.new self
+      @dir_scanner.connect(SIGNAL('file_added(QString)')) do |f|
+        @files << f if @files
+      end
+      @dir_scanner.connect(SIGNAL('file_removed(QString)')) do |f|
+        @files.delete f if @files
+      end
+      @dir_scanner.connect(SIGNAL(:rules_changed)){@files = nil}
+      @files = nil
     end
     
 =begin rdoc
@@ -417,9 +443,14 @@ to the project.
 <b>Note:</b> this method uses the <tt>project_files</tt> extension
 =end
     def files
-      @project_extensions[:project_files].project_files
+      @files ||= @dir_scanner.project_files
+      ProjectFiles.new project_directory, @files
+    end
+    alias_method :project_files, :files
+
+    def file_in_project? file
+      @dir_scanner.file_in_project? file
     end
-    
   end
   
 =begin rdoc

data/lib/ruber/project_dir_scanner.rb

@@ -0,0 +1,171 @@
+=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 'set'
+require 'find'
+require 'delegate'
+
+require 'kio'
+
+module Ruber
+  
+  class ProjectDirScanner < Qt::Object
+    
+    signals :rules_changed
+    
+    signals 'file_added(QString)'
+    
+    signals 'file_removed(QString)'
+    
+    def initialize prj
+      super
+      @project = prj
+      #The /? at the end is there to avoid depending on whether Project#project_directory
+      #returns a string ending with / or not
+      @regexp = %r[^#{Regexp.quote @project.project_directory}/?]
+      make_rules
+      @watcher = KDE::DirWatch.new self do
+        add_dir prj.project_directory, 
+            KDE::DirWatch::WatchFiles | KDE::DirWatch::WatchSubDirs
+      end
+      @watcher.connect(SIGNAL('created(QString)')) do |f|
+        emit file_added(f) if file_in_project? f
+      end
+      @watcher.connect(SIGNAL('deleted(QString)')) do |f|
+        emit file_removed(f) if file_in_project? f
+      end
+      @project.connect(SIGNAL('option_changed(QString, QString)')) do |g, n|
+        if g == 'general' and n == 'project_files'
+          if @project[:general, :project_files] != @rules
+            make_rules
+            emit rules_changed
+          end
+        end
+      end
+      @watcher.start_scan false
+    end
+    
+    def file_in_project? file
+      if file.start_with? '/'
+        file = file.dup
+        return false unless file.sub! @regexp, ''
+      end
+      return nil if file.end_with? '/'
+      if file =~ %r{^([\w+-.]+)://(.+)}
+        if $1 == 'file' then file = $2
+        else return false
+        end
+      end
+      return false if @exclude_regexp =~ file
+      return false if @exclude_files.include? file
+      return true if @extensions.any?{|e| File.fnmatch?(e, file, File::FNM_DOTMATCH)}
+      return true if @include_regexp =~ file or @include_files.include? file
+      false
+    end
+    
+    def project_files
+      res = Set.new
+      dir = @project.project_directory
+      Ruber[:app].chdir dir do
+        Find.find '.' do |f|
+          next if File.directory? f
+          #remove the leading './'
+          f = f[2..-1]
+          res << File.join(dir, f) if file_in_project? f
+        end
+      end
+      res
+    end
+    
+    private
+    
+    def make_rules
+      rules = @project[:general, :project_files]
+      @include_regexp = Regexp.union(*(rules[:include].select{|r| r.is_a?(Regexp)}))
+      @exclude_regexp = Regexp.union(*(rules[:exclude].select{|r| r.is_a?(Regexp)}))
+      @exclude_files = rules[:exclude].select{|rule| rule.is_a? String}.map{|f| f.sub(%r{^\./}, '')}
+      @include_files = rules[:include].select{|rule| rule.is_a? String}.map{|f| f.sub(%r{^\./}, '')}
+      @include_files-= @exclude_files
+      @extensions = rules[:extensions]
+      @rules = YAML.load(YAML.dump rules)
+    end
+    
+  end
+  
+  class ProjectFiles < Delegator
+    
+    include Enumerable
+    
+    def initialize project_dir, set
+      super set
+      @set = set
+      @project_dir = project_dir.dup
+      @project_dir << '/' unless @project_dir.end_with? '/'
+    end
+    
+    def __getobj__
+      @set
+    end
+    
+    def __setobj__ obj
+      @set = obj
+    end
+    
+    def dup
+      self.class.new @project_dir, @set
+    end
+    
+    def clone
+      res = dup
+      dup.freeze if frozen?
+      res
+    end
+    
+    def to_set
+      Set.new self
+    end
+    
+    def each_relative
+      if block_given?
+        l = @project_dir.size
+        @set.each{|f| yield f[l, f.size-l]}
+      else self.to_enum :each_relative
+      end
+    end
+    alias_method :rel, :each_relative
+    
+    def each
+      if block_given?
+        @set.each{|f| yield f}
+      else self.to_enum
+      end
+    end
+    alias_method :abs, :each
+    
+    [:<<, :add, :clear, :collect!, :delete, :delete_if, :flatten!, :keep_if,
+        :map!, :merge, :reject!, :replace, :subtract].each do |m|
+      define_method m do |*args|
+        raise NoMethodError
+      end
+    end
+        
+  end
+  
+end