redcar 0.9.2 → 0.10

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

@@ -1,3 +1,19 @@
 When /^I open a "([^"]*)" repl$/ do |repl|
-  Redcar::REPL.const_get(repl.camelize + "OpenREPL").new.run
+  Redcar.const_get(repl.camelize).const_get(repl.camelize + "OpenREPL").new.run
 end
+
+When /^I open a new repl$/ do
+  Redcar::REPL::FakeOpenREPL.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 FakeOpenREPL < OpenREPL
+      def execute
+        open_repl(ReplMirror.new)
+      end
+    end
+  end
+end

data/plugins/repl/lib/repl.rb

@@ -1,97 +1,40 @@
+
 require 'repl/repl_mirror'
-require 'repl/ruby_mirror'
-require 'repl/clojure_mirror'
-require 'repl/groovy_mirror'
 require 'repl/repl_tab'
+require 'repl/repl_command'
 
 module Redcar
   class REPL
-    def self.menus
-      Menu::Builder.build do
-        sub_menu "Plugins" do
-          sub_menu "REPL", :priority => 180 do
-            item "Open Ruby REPL",    REPL::RubyOpenREPL
-            item "Open Clojure REPL", REPL::ClojureOpenREPL
-            item "Open Groovy REPL", REPL::GroovyOpenREPL
-            item "Execute", REPL::CommitREPL
-            item "Clear History", REPL::ClearHistoryREPL
-          end
-        end
-      end
-    end
 
-    def self.keymaps
-      osx = Keymap.build("main", :osx) do
-        link "Cmd+Shift+R", REPL::RubyOpenREPL
-        link "Cmd+M",       REPL::CommitREPL
-      end
-
-      linwin = Keymap.build("main", [:linux, :windows]) do
-        link "Ctrl+Shift+R", REPL::RubyOpenREPL
-        link "Ctrl+M",       REPL::CommitREPL
-      end
-
-      [linwin, osx]
-    end
+    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::ReplTab) and
+          tab.is_a?(REPL::Tab) and
           tab.edit_view.document.mirror.is_a?(REPL::ReplMirror)
         end
       ]
     end
 
-    class OpenREPL < Command
+    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(REPL::ReplTab)
+        tab = win.new_tab(Redcar::REPL::Tab)
         tab.repl_mirror = mirror
         tab.focus
       end
     end
-
-    class RubyOpenREPL < OpenREPL
-      def execute
-        open_repl(RubyMirror.new)
-      end
-    end
-
-    class ClojureOpenREPL < OpenREPL
-      def execute
-        open_repl(ClojureMirror.new)
-      end
-    end
-
-    class GroovyOpenREPL < OpenREPL
-      def execute
-        open_repl(GroovyMirror.new)
-      end
-    end
-
-    class ReplCommand < Command
-      sensitize :open_repl_tab
-    end
-
-    class CommitREPL < ReplCommand
-
-      def execute
-        edit_view = win.focussed_notebook.focussed_tab.edit_view
-        edit_view.document.save!
-      end
-    end
-
-    class ClearHistoryREPL < ReplCommand
-
-      def execute
-        mirror = win.focussed_notebook.focussed_tab.edit_view.document.mirror
-        mirror.clear_history
-      end
-    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

@@ -1,31 +1,78 @@
 module Redcar
   class REPL
     class ReplMirror
-      attr_reader :history
-      
+      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\n#{prompt} "
+        "# #{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: ">>"
       #
@@ -33,21 +80,29 @@ module Redcar
       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] 
+      #
+      # @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.
       #
@@ -58,7 +113,7 @@ module Redcar
         command = entered_expression(contents)
         evaluate(command)
       end
-      
+
       # What did the user just enter?
       #
       # @return [String]
@@ -66,20 +121,78 @@ module Redcar
         if contents.split("\n").last =~ /#{prompt}\s+$/
           ""
         else
-          contents.split(prompt).last.strip
+          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)
-        @history += expr + "\n"
-        begin
-          @history += "=> " + evaluator.execute(expr)
-        rescue Object => e
-          @history += "x> " + format_error(e)
+        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
-        @history += "\n" + prompt + " "
-        notify_listeners(:change)
       end
 
       # Get the complete history as a pretty formatted string.
@@ -88,9 +201,27 @@ module Redcar
       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 = @history.split("\n").last
+        @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
 
@@ -104,6 +235,21 @@ module Redcar
       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