redcar-dev 0.12.17dev

data/plugins/redcar_debug/lib/redcar_debug.rb

@@ -0,0 +1,91 @@
+
+module Redcar
+  class Debug
+    def self.menus
+      Menu::Builder.build do
+        sub_menu "Debug" do
+          group(:priority => 30) do
+            item "Command History", Debug::OpenHistoryCommand
+            sub_menu "Profile" do
+              item "Start Profiling", Debug::StartProfilingCommand
+              item "Stop Profiling", Debug::StopProfilingCommand
+              separator
+              item "Show Call Graph", Debug::ShowCallGraphCommand
+              item "Show Call Tree",  Debug::ShowCallTreeCommand
+            end
+          end
+        end
+      end
+    end
+    
+    def self.loaded
+      if ARGV.include?('--profile')
+        # #run causes errors since we're still loading.
+        StartProfilingCommand.new.execute
+      end
+    end
+    
+    class << self
+      attr_accessor :profiling_result
+    end
+    
+    class StartProfilingCommand < Redcar::Command
+      def execute
+        $:.unshift(File.dirname(__FILE__) + '/../vendor/jruby-prof/lib/')
+        require 'jruby-prof'
+        JRubyProf.start
+      end
+    end
+
+    class StopProfilingCommand < Redcar::Command
+      def execute
+        Debug.profiling_result = JRubyProf.stop
+      end
+    end
+    
+    class ShowCallGraphCommand < Redcar::Command  
+      def execute
+        path = Redcar.user_dir + "/profile_output.html"
+        JRubyProf.print_graph_html(Debug.profiling_result, path)
+        tab = win.new_tab(ConfigTab)
+        tab.html_view.contents = File.read(path)
+        tab.focus
+        FileUtils.rm_f(path)
+      end
+    end
+
+    class ShowCallTreeCommand < Redcar::Command  
+      def execute
+        path = Redcar.user_dir + "/profile_output.html"
+        JRubyProf.print_tree_html(Debug.profiling_result, path)
+        tab = win.new_tab(ConfigTab)
+        tab.html_view.contents = File.read(path)
+        tab.focus
+        FileUtils.rm_f(path)
+      end
+    end
+    
+    class OpenHistoryCommand < Redcar::Command
+      
+      def execute
+        controller = Controller.new
+        tab = win.new_tab(ConfigTab)
+        tab.html_view.controller = controller
+        tab.focus
+      end
+        
+      class Controller
+        include Redcar::HtmlController
+        
+        def title
+          "History"
+        end
+      
+        def index
+          rhtml = ERB.new(File.read(File.join(File.dirname(__FILE__), "..", "views", "history.html.erb")))
+          rhtml.result(binding)
+        end
+      end
+    end
+  end
+end

data/plugins/redcar_debug/plugin.rb

@@ -0,0 +1,8 @@
+
+Plugin.define do
+  name    "redcar_debug"
+  version "1.0"
+  file    "lib", "redcar_debug"
+  object  "Redcar::Debug"
+  dependencies "redcar", ">0"
+end

data/plugins/redcar_debug/views/history.html.erb

@@ -0,0 +1,34 @@
+<% watermark  = File.expand_path(File.join(Redcar.root, %w(plugins html_view views watermark-48.png))) %>
+<% redcar_css = File.expand_path(File.join(Redcar.root, %w(plugins html_view views default.css))) %>
+<link rel="stylesheet" href="file://<%= redcar_css %>" type="text/css" media="screen">
+<div id="top">
+  <img src="file://<%=watermark%>" id="watermark"/>
+  <h1>Command History</h1>
+  <a href="controller/index">Refresh</a>
+</div>
+<div class="main">
+<table>
+  <tr>
+    <th>Completed</th>
+    <th>Description</th>
+  </tr>
+  <% Redcar.app.history.reverse.each do |command| %>
+    <tr class="<%= "error" if command.error %>">
+      <td><%#= command.completed_time.strftime("%X") %></td>
+      <td><%= CGI.escapeHTML(command.class.to_s) %></td>
+    </tr>
+    <% if e = command.error %>
+      <tr>
+        <td colspan="3">
+          <strong><%= e.class %></strong>
+          <%= CGI.escapeHTML(e.message) %>
+          <br /><br />
+          <% e.backtrace.each do |line| %>
+            <%= line %><br />
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  <% end %>
+</table>
+</div>

data/plugins/redcar_debug/views/index.html.erb

@@ -0,0 +1,36 @@
+<% redcar_css = File.expand_path(File.join(Redcar.root, %w(plugins html_view views default.css))) %>
+<% watermark  = File.expand_path(File.join(Redcar.root, %w(plugins html_view views watermark-48.png))) %>
+<link rel="stylesheet" href="file://<%= redcar_css %>" type="text/css" media="screen">
+
+<div id="top">
+  <img src="file://<%=watermark%>" id="watermark"/>
+  <h3>Command History</h3>
+  <a href="controller/index">Refresh</a>
+</div>
+<div class="main">
+  <table>
+    <tr>
+      <th>Completed</th>
+      <th>Description</th>
+    </tr>
+    <% Redcar.app.history.reverse.each do |command| %>
+      <tr class="<%= "error" if command.error %>">
+        <td><%#= command.completed_time.strftime("%X") %></td>
+        <td><%= CGI.escapeHTML(command.class.to_s) %></td>
+      </tr>
+      <% if e = command.error %>
+        <tr>
+          <td colspan="3">
+            <strong><%= e.class %></strong>
+            <%= CGI.escapeHTML(e.message) %>
+            <br /><br />
+            <% e.backtrace.each do |line| %>
+              <%= line %><br />
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    <% end %>
+  </table>
+</div>
+

data/plugins/repl/features/command_editing.feature

@@ -0,0 +1,55 @@
+Feature: Navigation and editing keys have special behaviour in a REPL
+
+  Background:
+    When I open a new repl
+    And I insert "clear" at the cursor
+    And I press the return key
+    And I insert "x = 4" at the cursor
+    When I move the cursor to the end of the document
+
+  Scenario: Backspace does not erase the prompt
+    And I press the backspace key
+    Then the current command should be "x = "
+    When I press the backspace key
+    Then the current command should be "x ="
+    When I press the backspace key
+    Then the current command should be "x "
+    When I press the backspace key
+    Then the current command should be "x"
+    When I press the backspace key
+    Then the current command should be blank
+    When I press the backspace key
+    Then the current command should be blank
+    And I should see ">> " in the edit tab
+
+  Scenario: Delete does not erase the prompt
+    When I move the cursor to 0
+    And I press the delete key
+    Then the current command should be "x = 4"
+    And I should see ">> " in the edit tab
+
+  Scenario: The home key sets the cursor at the start of the line and after the prompt
+    When I press the home key
+    Then the cursor should be at 3
+    When I replace 3 to 8 with "x = 4\ny = 9"
+    And I move the cursor to 11
+    And I press the home key
+    Then the cursor should be at 9
+
+  Scenario: Left and right arrow keys can be used to navigate the current command
+    When I press the left arrow key
+    Then the cursor should be at 7
+    When I press the left arrow key
+    Then the cursor should be at 6
+    When I press the left arrow key
+    Then the cursor should be at 5
+    When I press the right arrow key
+    Then the cursor should be at 6
+
+  Scenario: The left arrow key should not go beyond the prompt
+    When I press the return key
+    And I insert "clear" at the cursor
+    And I press the return key
+    Then the cursor should be at 3
+    When I press the left arrow key
+    Then the cursor should be at 3

data/plugins/repl/features/command_history.feature

@@ -0,0 +1,75 @@
+Feature: Command history
+
+Background:
+  When I open a new repl
+  And I insert "x = 4" at the cursor
+  And I press the return key
+  Then the current command should be blank
+  When I insert "y = 5" at the cursor
+  And I press the return key
+
+Scenario: Command History can be browsed using the arrow keys
+  When I press the up arrow key
+  Then the current command should be "y = 5"
+  When I press the up arrow key
+  Then the current command should be "x = 4"
+  When I press the up arrow key
+  Then the current command should be "x = 4"
+  When I press the down arrow key
+  Then the current command should be "y = 5"
+  When I press the down arrow key
+  Then the current command should be blank
+
+Scenario: Command history can be cleared from the screen but retained in the buffer
+  When I insert "clear" at the cursor
+  And I press the return key
+  And I press the up arrow key
+  Then the current command should be "clear"
+  When I press the up arrow key
+  Then the current command should be "y = 5"
+  When I press the up arrow key
+  Then the current command should be "x = 4"
+
+Scenario: Command history can be reset
+  When I insert "reset" at the cursor
+  And I press the return key
+  And I press the up arrow key
+  Then the current command should be blank
+  And I press the up arrow key
+  Then the current command should be blank
+  And I press the down arrow key
+  Then the current command should be blank
+
+Scenario: Command history is saved between REPL sessions
+  When I close the focussed tab
+  And I open a new repl
+  When I press the up arrow key
+  Then the current command should be "y = 5"
+  When I press the up arrow key
+  Then the current command should be "x = 4"
+
+Scenario: Uncommitted command is saved when navigating history
+  When I insert "x - y" at the cursor
+  And I press the up arrow key
+  Then the current command should be "y = 5"
+  When I press the down arrow key
+  Then the current command should be "x - y"
+
+Scenario: Command history buffer size can be set
+  When I insert "x * y" at the cursor
+  And I press the return key
+  When I insert "buffer 2" at the cursor
+  And I press the return key
+  Then the REPL output should be "Buffer size set to 2"
+  When I press the up arrow key
+  Then the current command should be "buffer 2"
+  And I press the up arrow key
+  Then the current command should be "x * y"
+  And I press the up arrow key
+  Then the current command should be "x * y"
+  When I press the return key
+  And I close the focussed tab
+  And I open a new repl
+  And I insert "buffer" at the cursor
+  And I press the return key
+  Then the REPL output should be "Current buffer size is 2"

data/plugins/repl/features/step_definitions/repl_steps.rb

@@ -0,0 +1,19 @@
+When /^I open a "([^"]*)" repl$/ do |repl|
+  Redcar.const_get(repl.camelize).const_get("Open" + repl.camelize + "REPL").new.run
+end
+
+When /^I open a new repl$/ do
+  Redcar::REPL::OpenFakeREPL.new.run
+end
+
+Then /^the REPL output should be "([^"]*)"$/ do |output|
+  current_tab.edit_view.document.mirror.last_output.should == output
+end
+
+Then /^the current command should be "([^"]*)"$/ do |cmd|
+  current_tab.current_command.should == cmd
+end
+
+Then /^the current command should be blank$/ do
+  current_tab.current_command.should == nil
+end

data/plugins/repl/features/support/env.rb

@@ -0,0 +1,24 @@
+
+require File.join File.dirname(__FILE__), 'fake_repl'
+
+Redcar::REPL::ReplMirror.class_eval do
+  def evaluator
+    @eval ||= Redcar::REPL::FakeEvaluator.new
+  end
+
+  def grammar_name
+    "Plain Text"
+  end
+
+  def format_error(e)
+    "An error was thrown: #{e}"
+  end
+end
+
+Before do
+  Redcar::REPL.storage['command_history'] = {}
+end
+
+def current_tab
+  Redcar.app.focussed_window.focussed_notebook_tab
+end

data/plugins/repl/features/support/fake_repl.rb

@@ -0,0 +1,16 @@
+
+module Redcar
+  class REPL
+    class FakeEvaluator
+      def execute(expr)
+        "#{expr} was entered"
+      end
+    end
+
+    class OpenFakeREPL < OpenREPL
+      def execute
+        open_repl(ReplMirror.new)
+      end
+    end
+  end
+end

data/plugins/repl/lib/repl.rb

@@ -0,0 +1,40 @@
+
+require 'repl/repl_mirror'
+require 'repl/repl_tab'
+require 'repl/repl_command'
+
+module Redcar
+  class REPL
+
+    DEFAULT_BUFFER_SIZE = 15
+
+    def self.sensitivities
+      [
+        Sensitivity.new(:open_repl_tab, Redcar.app, false, [:tab_focussed]) do |tab|
+          tab and
+          tab.is_a?(REPL::Tab) and
+          tab.edit_view.document.mirror.is_a?(REPL::ReplMirror)
+        end
+      ]
+    end
+
+    def self.storage
+      @storage ||= begin
+        storage = Plugin::Storage.new('repl')
+        storage.set_default(
+          'command_history_buffer_size',
+          DEFAULT_BUFFER_SIZE)
+        storage.set_default('command_history', {})
+        storage
+      end
+    end
+
+    class OpenREPL < Command
+      def open_repl(mirror)
+        tab = win.new_tab(Redcar::REPL::Tab)
+        tab.repl_mirror = mirror
+        tab.focus
+      end
+    end
+  end
+end

data/plugins/repl/lib/repl/repl_command.rb

@@ -0,0 +1,20 @@
+
+module Redcar
+  class REPL
+    class ReplCommand
+
+      attr_reader :title,:description,:regex
+
+      def initialize(title,regex,description,&block)
+        @title = title
+        @regex = regex
+        @description  = description
+        @block = block
+      end
+
+      def call(match_data)
+        @block.call match_data
+      end
+    end
+  end
+end

data/plugins/repl/lib/repl/repl_mirror.rb

@@ -0,0 +1,255 @@
+module Redcar
+  class REPL
+    class ReplMirror
+      attr_reader :history  , :command_history,
+              :command_index, :current_offset ,
+              :last_output
+
+      # A ReplMirror is a type of Document::Mirror
+      include Redcar::Document::Mirror
+
+      def initialize
+        @history = initial_preamble
+        @mutex = Mutex.new
+        initialize_command_history
+      end
+
+      def initialize_command_history
+        @command_history = REPL.storage['command_history'][title] || []
+        @command_history_buffer_size = REPL.storage['command_history_buffer_size']
+        @command_index = @command_history.size
+        set_current_offset
+      end
+
+      # What to display when the REPL is opened. Defaults to the title followed
+      # by a prompt
+      #
+      # @return [String]
+      def initial_preamble
+        "# #{title}\n# type 'help' for help\n\n#{prompt} "
+      end
+
+      # What to display when the help command is run
+      #
+      # @return [String]
+      def help
+        help = "Hello! I am a #{title}. I am here to assist you in exploring language APIs.\n\nCommands:\n"
+        special_commands.each do |cmd|
+          help << "#{cmd.title} : #{cmd.description}\n"
+        end
+        help
+      end
+
+      # The special commands supported by the REPL outside of the
+      # standard REPL syntax. Each entry is a command and description.
+      #
+      # @return [Hash]
+      def special_commands
+        [
+          ReplCommand.new('clear', /^clear$/,'Clear command output') do |last|
+            clear_history
+          end,
+          ReplCommand.new('reset', /^reset$/,
+            'Reset REPL to initial state and clear all command history') do |last|
+            reset_history
+          end,
+          ReplCommand.new('help',/^help$/,'Display this help text') do |last|
+            append_to_history help
+          end,
+          ReplCommand.new('buffer',/^buffer$/,'Displays command history buffer size') do |last|
+            append_to_history "Current buffer size is #{command_history_buffer_size}"
+          end,
+          ReplCommand.new('buffer [int]',/buffer (\d+)$/, 'Sets command history buffer size') do |last|
+            set_buffer_size last.captures.first.to_i
+            append_to_history "Buffer size set to #{command_history_buffer_size}"
+          end
+        ]
+      end
+
+      # The name of the textmate grammar to apply to the repl history.
+      #
+      # @return [String]
+      def grammar_name
+        raise "implement the grammar_name method on your REPL"
+      end
+
+      # The prompt to display when the REPL is ready to accept input.
+      # Default: ">>"
+      #
+      # @return [String]
+      def prompt
+        ">>"
+      end
+
+      # The tab title and preamble to display
+      # Default: "REPL"
+      #
+      # @return [String]
+      def title
+        "REPL"
+      end
+
+      # This returns an object that implements:
+      #   execute(str:String): String
+      def evaluator
+        raise "implement evaluator on your REPL"
+      end
+
+      # Format the language specific exception to be displayed in the Repl
+      #
+      # @param [Exception]
+      # @return [String]
+      def format_error(exception)
+        raise "implement format_error on your REPL"
+      end
+
+      # Execute a new statement. Accepts the entire pretty formatted history,
+      # within which it looks for the last statement and executes it.
+      #
+      # Do not override
+      #
+      # @param [String] a string with at least one prompt and statement in it
+      def commit(contents)
+        command = entered_expression(contents)
+        evaluate(command)
+      end
+
+      # What did the user just enter?
+      #
+      # @return [String]
+      def entered_expression(contents)
+        if contents.split("\n").last =~ /#{prompt}\s+$/
+          ""
+        else
+          last = contents.split(prompt).last
+          if last
+            last.strip
+          else
+            ""
+          end
+        end
+      end
+
+      # How many commands will be stored in command history
+      #
+      # @return [Integer]
+      def command_history_buffer_size
+        @command_history_buffer_size
+      end
+
+      def set_buffer_size(size)
+        @command_history_buffer_size = size
+        if @command_history.size > size
+          @command_history.shift(@command_history.size - size)
+        end
+        @command_index = @command_history.size
+        REPL.storage['command_history_buffer_size'] = size
+      end
+
+      # The previous command to the command currently displayed,
+      # or the last one executed, if none.
+      #
+      # @return [String]
+      def previous_command
+        if current = @command_index
+          if @command_history.size > 0 and current > 0
+            @command_index = current - 1
+            command = @command_history[@command_index]
+          end
+        end
+        command
+      end
+
+      # The next command to the command currently displayed,
+      # or blank, if none.
+      #
+      # @return [String]
+      def next_command
+        if @command_index and @command_history.size > @command_index + 1
+          @command_index = @command_index + 1
+          command = @command_history[@command_index]
+        else
+          @command_index = @command_history.size
+        end
+        command
+      end
+
+      # Evaluate an expression. Calls execute on the return value of evaluator
+      def evaluate(expr)
+        add_command(expr)
+        special = special_commands.select {|cmd| expr =~ cmd.regex}
+        if special.size > 0
+          cmd = special.first
+          expr =~ cmd.regex
+          cmd.call Regexp.last_match
+        else
+          begin
+            @last_output = evaluator.execute(expr)
+            @history += "=> " + @last_output
+          rescue Object => e
+            @history += "x> " + format_error(e)
+          end
+          @history += "\n" + prompt + " "
+          set_current_offset
+          notify_listeners(:change)
+        end
+      end
+
+      # Get the complete history as a pretty formatted string.
+      #
+      # @return [String]
+      def read
+        @history
+      end
+
+      def append_to_history(text)
+        @last_output = text
+        @history += "=> " + text
+        @history += "\n" + prompt + " "
+        set_current_offset
+        notify_listeners(:change)
+      end
+
+      def clear_history
+        @history = prompt + " "
+        set_current_offset
+        notify_listeners(:change)
+      end
+
+      def reset_history
+        @history = initial_preamble
+        history = REPL.storage['command_history']
+        history[title] = []
+        REPL.storage['command_history'] = history
+        initialize_command_history
+        notify_listeners(:change)
+      end
+
+      # REPLs always exist because there is no external resource to represent.
+      # Therefore, this returns true.
+      def exists?
+        true
+      end
+
+      # REPLs never change except for after commit operations.
+      def changed?
+        false
+      end
+
+      # Appends a command to history
+      def add_command(expr)
+        @history += expr + "\n"
+        @command_history.push expr
+        size = @command_history.size
+        buffer_size = @command_history_buffer_size
+        @command_history.shift(size - buffer_size) if size > buffer_size
+        @command_index = @command_history.size
+      end
+
+      # Set the position at which a command can begin
+      def set_current_offset
+        @current_offset = @history.split(//).length
+      end
+    end
+  end
+end