ruber 0.0.9 → 0.0.10

data/plugins/ruberri/method_formatter.rb

@@ -0,0 +1,90 @@
+=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 'rdoc/ri/driver'
+require 'rdoc/ri/store'
+require 'rdoc/markup/document'
+require 'rdoc/markup/to_html'
+
+module Ruber
+  
+  module RI
+    
+    class MethodFormatter
+      
+      def initialize method, store, store_type
+        @store = RDoc::RI::Store.new store, store_type
+        cls= method.split(/(?:::)|#/, 2)[0]
+        @method = @store.load_method cls, method
+      end
+      
+      def to_html
+        title = "#{@method.full_name}"
+        title << " (from #{@store.friendly_path})" unless @store.friendly_path =~ /ruby core/
+        parts = [RDoc::Markup::Heading.new(1, title)]
+        parts << format_aliases
+        parts << format_arglists
+        parts << @method.comment
+        parts.compact!
+        doc = RDoc::Markup::Document.new
+        last = parts.count - 1
+        parts.each_with_index do |prt, i|
+          if prt.is_a? Array then prt.each{|x| doc << x}
+          else doc << prt
+          end
+          doc << RDoc::Markup::Rule.new(1) unless i == last
+        end
+        formatter = RDoc::Markup::ToHtml.new
+        doc.accept formatter
+      end
+      
+      private
+      
+      def format_arglists
+        return unless @method.arglists
+        res = []
+        arglists = @method.arglists.chomp.split("\n")
+        arglists.each do |l|
+          res << RDoc::Markup::Verbatim.new(l)
+        end
+        res
+      end
+      
+      def format_aliases
+        return if @method.aliases.empty?
+        res = [RDoc::Markup::Heading.new(1, 'Also known as')]
+        items = @method.aliases.map do |a|
+          RDoc::Markup::ListItem.new nil, RDoc::Markup::Paragraph.new(a)
+        end
+        list = RDoc::Markup::List.new :BULLET, *items
+        res << list
+        res
+      end
+      
+    end
+    
+  end
+  
+end
+
+if $0 == __FILE__
+  mth, store, store_type = *ARGV
+  puts Ruber::RI::MethodFormatter.new(mth, store, store_type.to_sym).to_html
+end

data/plugins/ruberri/plugin.yaml

@@ -0,0 +1,13 @@
+name: ruberri
+version: 0.0.1
+about:
+ authors: [Stefano Crocco, stefano.crocco@alice.it]
+ license: gpl
+ description: Search the ri documentation from within Ruber
+ bug_address: http://github.com/stcrocco/ruber/issues
+ icon: help-contents
+ human_name: RI
+deps: [ruby_development]
+class: Ruber::RI::Plugin
+require: ruberri
+tool_widgets: {:class: Ruber::RI::ToolWidget, :caption: RI, :position: :bottom, :name: ri_widget, var_name: tool_widget}

data/plugins/ruberri/ruberri.rb

@@ -0,0 +1,226 @@
+=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_relative 'ui/tool_widget'
+
+require 'rdoc/ri/driver'
+require 'rdoc/ri/store'
+require 'open3'
+require 'yaml'
+
+module Ruber
+  
+  module RI
+    
+    class Plugin < Ruber::Plugin
+      
+      def search text
+        cmd = [ruby, File.join(File.dirname(__FILE__), 'search.rb'), text]
+        list = nil
+        err = nil
+        status = nil
+        Open3.popen3(*cmd) do |stdin, stdout, stderr, thr|
+          list = stdout.read
+          err = stderr.read
+          status = thr.value
+        end
+        if status.success?
+          display_search_result YAML.load(list)
+        else
+          text = <<-EOS
+<h1>Error</h1>
+<p>It was impossible to search the RI database. The reported error was:</p>
+<verbatim>
+#{err}
+</verbatim>
+EOS
+          @tool_widget.content = text
+        end
+        
+      end
+      
+      private
+      
+      def ruby
+        Ruber[:ruby_development].interpreter_for Ruber[:world].active_document
+      end
+      
+      def display_search_result found
+        if found[:list] and found[:list].count > 1
+          if found[:type] == :class then content = format_class_list found[:list]
+          else content = format_method_list found[:list]
+          end
+          @tool_widget.content = content
+        elsif found[:list] and found[:list].count == 1
+          obj = found[:list][0]
+          display found[:type], obj[:store], obj[:store_type], obj[:name]
+        else @tool_widget.content = '<h1>Nothing found</h1>'
+        end
+      end
+      
+      def display_url url
+        scheme = url.scheme
+        store, type, name = url.path.split('$', 3)
+        display scheme.to_sym, store, type.to_sym, name
+      end
+      slots 'display_url(QUrl)'
+      
+      def display type, store, store_type, name
+        if type == :method
+          @tool_widget.content = format_method name, store, store_type
+        else 
+          @tool_widget.content = format_class name, store, store_type
+        end
+      end
+      
+      def format_class_list classes
+        res = "<h1>Results from RI</h1>"
+        classes.each do |data|
+          encoded_name = Qt::Url.to_percent_encoding data[:name]
+          url = "class://#{data[:store]}$#{data[:store_type]}$#{encoded_name}"
+          res << %[<p><a href="#{url}">#{data[:name]} &ndash; from #{data[:friendly_store]}</a></p>]
+        end
+        res
+      end
+      
+      def format_method_list methods
+        res = "<h1>Results from RI</h1>"
+        methods.each do |data|
+          encoded_name = Qt::Url.to_percent_encoding(data[:name])
+          url = "method://#{data[:store]}$#{data[:store_type]}$#{encoded_name}"
+          res << %[<p><a href="#{url}">#{data[:name]} &ndash; from #{data[:friendly_store]}</a></p>]
+        end
+        res
+      end
+      
+      def format_class cls, store, store_type
+        cmd = [ruby, File.join(File.dirname(__FILE__), 'class_formatter.rb'), cls, store, store_type.to_s]
+        html = nil
+        err = nil
+        status = nil
+        Open3.popen3(*cmd) do |stdin, stdout, stderr, thr|
+          html = stdout.read
+          err = stderr.read
+          status = thr.value
+        end
+        if status.success?
+          @tool_widget.content = html
+        else
+          text = <<-EOS
+<h1>Error</h1>
+<p>It was impossible to loop #{cls} up in the RI database. The reported error was:</p>
+<verbatim>
+#{err}
+</verbatim>
+EOS
+        end
+        
+      end
+      
+      def format_method method, store, store_type
+        cmd = [ruby, File.join(File.dirname(__FILE__), 'method_formatter.rb'), method, store, store_type.to_s]
+        html = nil
+        err = nil
+        status = nil
+        Open3.popen3(*cmd) do |stdin, stdout, stderr, thr|
+          html = stdout.read
+          err = stderr.read
+          status = thr.value
+        end
+        if status.success?
+          @tool_widget.content = html
+        else
+          text = <<-EOS
+<h1>Error</h1>
+<p>It was impossible to look #{method} up the RI database. The reported error was:</p>
+<verbatim>
+#{err}
+</verbatim>
+EOS
+        end
+      end
+      
+      def find_classes drv, name
+        begin cls = drv.expand_class(Regexp.quote(name))
+        rescue RDoc::RI::Driver::NotFoundError
+          return 
+        end
+        stores = drv.classes[cls]
+        return unless stores
+        classes = []
+        stores.each do |s|
+          classes << [s.load_class(cls), s]
+        end
+        classes
+      end
+      
+      def find_methods drv, name
+        found = drv.load_methods_matching name
+        return nil if found.empty?
+        filtered = drv.filter_methods found, name
+        methods = []
+        filtered.each do |store, mthds|
+          mthds.each{|m| methods << [m, store]}
+        end
+        methods.empty? ? nil : methods
+      end
+      
+    end
+    
+    class ToolWidget < Qt::Widget
+      
+      def initialize parent = nil
+        super
+        @ui = Ui::RIToolWidget.new
+        @ui.setup_ui self
+        connect @ui.search_term, SIGNAL(:returnPressed), @ui.search, SIGNAL(:clicked)
+        connect @ui.search, SIGNAL(:clicked), self, SLOT(:start_search)
+        @ui.content.open_links = false
+        connect @ui.content, SIGNAL('anchorClicked(QUrl)'), Ruber[:ruberri], SLOT('display_url(QUrl)')
+      end
+      
+      def content
+        @ui.content.to_html
+      end
+      
+      def content= txt
+        @ui.content.text = txt
+      end
+      
+      def set_focus reason = Qt::OtherFocusReason
+        super
+        @ui.search_term.set_focus
+      end
+
+      private
+      
+      def start_search
+        text = @ui.search_term.text
+        unless text.empty?
+          Ruber[:ruberri].search text
+        end
+      end
+      slots :start_search
+      
+    end
+    
+  end
+  
+end

data/plugins/ruberri/search.rb

@@ -0,0 +1,111 @@
+=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 'yaml'
+require 'rdoc/ri/driver'
+
+module Ruber
+  
+  module RI
+    
+    class Search
+      
+      def search text
+        drv = RDoc::RI::Driver.new
+        classes = find_classes drv, text
+        methods = find_methods drv, text
+        if classes then content = prepare_class_list classes
+        elsif methods then content = prepare_method_list methods
+        elsif !(hash = drv.classes).empty?
+          regexp = /::#{Regexp.quote text}$/
+          list = []
+          hash.each_key do |cls|
+            list << find_classes(drv, cls) if cls =~ regexp
+          end
+          content = prepare_class_list list
+        else content = {}
+        end
+        content
+      end
+      
+      def prepare_class_list classes
+        found = {:type => :class}
+        list = []
+        classes.each do |cls, store|
+          data = {
+            :store => store.path,
+            :friendly_store => store.friendly_path,
+            :store_type => store.type,
+            :name => cls.full_name
+          }
+          list << data
+        end
+        found[:list] = list
+        found
+      end
+      
+      def prepare_method_list methods
+        found = {:type => :method}
+        list = []
+        methods.each do |mth, store|
+          data = {
+            :store => store.path,
+            :friendly_store => store.friendly_path,
+            :store_type => store.type,
+            :name => mth.full_name
+          }
+          list << data
+        end
+        found[:list] = list
+        found
+      end
+
+      def find_classes drv, name
+        begin cls = drv.expand_class(Regexp.quote(name))
+        rescue RDoc::RI::Driver::NotFoundError
+          return 
+        end
+        stores = drv.classes[cls]
+        return unless stores
+        classes = []
+        stores.each do |s|
+          classes << [s.load_class(cls), s]
+        end
+        classes
+      end
+      
+      def find_methods drv, name
+        found = drv.load_methods_matching name
+        return nil if found.empty?
+        filtered = drv.filter_methods found, name
+        methods = []
+        filtered.each do |store, mthds|
+          mthds.each{|m| methods << [m, store]}
+        end
+        methods.empty? ? nil : methods
+      end
+      
+    end
+    
+  end
+  
+end
+
+puts YAML.dump(Ruber::RI::Search.new.search(ARGV[0] || ''))

data/plugins/ruberri/ui/tool_widget.rb

@@ -0,0 +1,73 @@
+=begin
+** Form generated from reading ui file 'tool_widget.ui'
+**
+** Created: gio ago 11 14:56:44 2011
+**      by: Qt User Interface Compiler version 4.7.3
+**
+** WARNING! All changes made in this file will be lost when recompiling ui file!
+=end
+
+class Ui_RIToolWidget
+    attr_reader :gridLayout
+    attr_reader :label
+    attr_reader :search_term
+    attr_reader :search
+    attr_reader :content
+
+    def setupUi(rIToolWidget)
+    if rIToolWidget.objectName.nil?
+        rIToolWidget.objectName = "rIToolWidget"
+    end
+    rIToolWidget.resize(676, 300)
+    @gridLayout = Qt::GridLayout.new(rIToolWidget)
+    @gridLayout.objectName = "gridLayout"
+    @label = Qt::Label.new(rIToolWidget)
+    @label.objectName = "label"
+
+    @gridLayout.addWidget(@label, 0, 0, 1, 1)
+
+    @search_term = KDE::LineEdit.new(rIToolWidget)
+    @search_term.objectName = "search_term"
+
+    @gridLayout.addWidget(@search_term, 0, 1, 1, 1)
+
+    @search = Qt::PushButton.new(rIToolWidget)
+    @search.objectName = "search"
+
+    @gridLayout.addWidget(@search, 0, 2, 1, 1)
+
+    @content = Qt::TextBrowser.new(rIToolWidget)
+    @content.objectName = "content"
+
+    @gridLayout.addWidget(@content, 1, 0, 1, 3)
+
+    @label.buddy = @search_term
+    Qt::Widget.setTabOrder(@search_term, @search)
+    Qt::Widget.setTabOrder(@search, @content)
+
+    retranslateUi(rIToolWidget)
+
+    Qt::MetaObject.connectSlotsByName(rIToolWidget)
+    end # setupUi
+
+    def setup_ui(rIToolWidget)
+        setupUi(rIToolWidget)
+    end
+
+    def retranslateUi(rIToolWidget)
+    rIToolWidget.windowTitle = Qt::Application.translate("RIToolWidget", "Form", nil, Qt::Application::UnicodeUTF8)
+    @label.text = Qt::Application.translate("RIToolWidget", "Find", nil, Qt::Application::UnicodeUTF8)
+    @search.text = Qt::Application.translate("RIToolWidget", "&Search", nil, Qt::Application::UnicodeUTF8)
+    end # retranslateUi
+
+    def retranslate_ui(rIToolWidget)
+        retranslateUi(rIToolWidget)
+    end
+
+end
+
+module Ui
+    class RIToolWidget < Ui_RIToolWidget
+    end
+end  # module Ui
+