schlueter-rushmate 0.0.7 → 0.0.8

data/History.txt

@@ -1,3 +1,6 @@
+== 0.0.8 / 2008-08-18
+  * documentation release
+
 == 0.0.7 / 2008-08-14
   * added texts
   * rename input -> user_input

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nicholas Schlueter (http://simpltry.com)
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -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
 
@@ -9,6 +10,7 @@ Rushmate attempts to make Textmate (http://macromates.com) custom command writin
 == Install
 
 gem sources -a http://gems.github.com
+
 sudo gem install schlueter-rushmate
 
 == Sample

data/Rakefile

@@ -1,5 +1,24 @@
-task :coverage do
+task :coverage => :cleanup do
   system("rm -fr coverage")
   system("export TM_SUPPORT_PATH=/Applications/TextMate.app/Contents/SharedSupport/Support && rcov --sort=coverage --threshold=100 --exclude=gems/*,TextMate.app --sort=coverage test/*_test.rb")
   system("open coverage/index.html")
+end
+
+task :install => :cleanup do
+  puts %x{gem build rushmate.gemspec}
+  puts %x{sudo gem install --local -f rushmate}
+end
+
+task :uninstall do
+  puts %x{sudo gem uninstall rushmate}
+end
+
+task :cleanup do
+  %x{rm -rf coverage}
+  %x{rm -f rushmate-*}
+  %x{rm -rf doc}
+end
+
+task :rdoc => :cleanup do
+  %x{rdoc -o doc -m README lib/rushmate/**.rb README MIT-LICENSE}
 end

data/lib/rushmate/command.rb

@@ -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

data/lib/rushmate/exit.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

data/lib/rushmate/textmate_helper.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

data/lib/rushmate/user_input.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

data/rushmate.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "rushmate"
-  s.version = "0.0.7"
+  s.version = "0.0.8"
   s.email = "schlueter@gmail.com"
   s.homepage = "http://github.com/schlueter/rushmate"
   s.description = "Makes writing TextMate commands easier by providing convient methods for getting environment variables and getting user input."
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.authors = ["Nicholas Schlueter"]
   s.files = [
     "History.txt",
+    "MIT-LICENSE",
     "Manifest.txt",
     "README",
     "Rakefile",
@@ -29,7 +30,7 @@ Gem::Specification.new do |s|
   
   s.has_rdoc = true
   s.rdoc_options = ["--main", "README"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README"]
+  s.extra_rdoc_files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README"]
   s.add_dependency(%q<rush>, [">= 0.4"])
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: schlueter-rushmate
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Nicholas Schlueter
@@ -29,10 +29,12 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
+- MIT-LICENSE
 - Manifest.txt
 - README
 files: 
 - History.txt
+- MIT-LICENSE
 - Manifest.txt
 - README
 - Rakefile