@@ -1,6 +1,7 @@ = Rushmate -Rushmate attempts to make Textmate (http://macromates.com) custom command writing in ruby cleaner and smaller. It does this by leveraging rush (http://rush.heroku.com/). +Rushmate attempts to make Textmate (http://macromates.com) custom command writing in ruby +cleaner and smaller. It does this by leveraging rush (http://rush.heroku.com/). == Dependencies README @@ -3,24 +3,45 @@ module Rushmate class Command include TextmateHelper attr_accessor :shell + # Class construction is designed to take a block that gets executed + # as part of the class + # + # Example: + # + # Rushmate::Command.new { + # exit.show_tool_tip project_directory['**/*.rb'].line_count + # } def initialize(&block) setup_shell self.instance_eval(&block) if block end + # execute the parameter against a Rush::Shell instance def execute(thing) shell.execute(thing) $last_res end + # anything not defined in Rushmate::Command should be defered to + # Rushmate::Command#execute def method_missing(sym, *args, &block) execute sym.to_s end + # return a reference to Rushmate::Exit + # This is useful for shortening up your code + # Example: + # + # exit.show_tool_tip("nothing found") def exit Rushmate::Exit end + # return a reference to Rushmate::UserInput + # This is useful for shortening up your code + # Example: + # + # user_input.quick_menu_from_array(['opt 1', 'opt 2']) def user_input Rushmate::UserInput end lib/rushmate/command.rb @@ -1,40 +1,58 @@ module Rushmate + # Rushmate::Exit provides a list of methods for exiting + # a command and changing the output type in Textmate + # + # For instance if you specified the command to be + # output: Discard + # it may be benificial to show a tooltip if the command + # could not do what it was tasked to do + # + # Example: + # + # Rushmate::Exit.show_tool_tip("could not find file") module Exit class << self def discard exit 200 end + # changes output to replace selected text def replace_text(out = nil) print out if out exit 201 end + # changes output to replace selected document def replace_document(out = nil) print out if out exit 202 end + # changes output to insert text at editor position def insert_text(out = nil) print out if out exit 203 end + # changes output to insert a snippet at editor position def insert_snippet(out = nil) print out if out exit 204 end + # changes output to show html def show_html(out = nil) print out if out exit 205 end + # changes output to show a tool tip def show_tool_tip(out = nil) print out if out exit 206 end + # changes output to create a new document def create_new_document(out = nil) print out if out exit 207 lib/rushmate/exit.rb @@ -1,33 +1,53 @@ module Rushmate + # Rushmate::TextmateHelper provides convenience methods to Environment + # variables that Textmate exposes to your command module TextmateHelper + # returns the current line in the editor window def current_line ENV["TM_CURRENT_LINE"] end + # returns the current word in the editor window def current_word ENV['TM_CURRENT_WORD'] end + # returns the directory of the active file in the + # editor window + # + # return type Rush::Dir def tm_directory root[ENV['TM_DIRECTORY'] + "/"] end + # returns the file of the active file in + # the editor window + # + # return type Rush::File def tm_file root[ENV['TM_FILEPATH']] end + # returns the file name of the active file in the + # editor window def tm_filename ENV["TM_FILENAME"] end + # indicates if the command was activeted from a file + # within a textmate project def project_directory? ENV['TM_PROJECT_DIRECTORY'] end + # returns the directory of the textmate project + # + # return type Rush::Dir def project_directory root[ENV['TM_PROJECT_DIRECTORY'] + "/"] end + # returns the text selected within Textmate def selected_text ENV["TM_SELECTED_TEXT"] end lib/rushmate/textmate_helper.rb @@ -1,6 +1,16 @@ module Rushmate + # The Rushmate::UserInput class is a convenience class + # it provides higher level apis to methods defined in TextMate::UI module UserInput class << self + # quick_menu_from_array takes an array of strings and presents them + # as menu options similar to the context menu + # + # Return type is the string the user selected + # + # This method blocks until the user chooses an option, if the user + # presses esc the command is terminated without notifing the + # command script def quick_menu_from_array(strings) strings[TextMate::UI.menu(strings)] end lib/rushmate/user_input.rb 6e19042c6ae34c5f89d42f7e1cbdf86fa24db943 Nicholas Schlueter schlueter@gmail.com http://github.com/schlueter/rushmate/commit/e94d90e7ddbf70778975a7e3c5b80c9262088846 e94d90e7ddbf70778975a7e3c5b80c9262088846 2008-08-18T17:23:59-07:00 2008-08-18T17:23:59-07:00 added rdocs 4cd6e9f52ed8f2812b091f4c7f7ecf008dd95b77 Nicholas Schlueter schlueter@gmail.com