qtool 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.tmproj
+*.gem

data/README.mdown

@@ -0,0 +1,29 @@
+#q is for query
+
+q is a small tool for performing repetitive tasks from the console. Where you use rake to automate a project’s tasks, you’d use q to automate your own workflow a little. q commands are relatively free-form, with a few built-in ones that I use frequently enough:
+
+1. Searching via Google:
+
+		q search search terms
+	
+	Searches for the passed-in terms on Google. Synonyms are `google`, `g`.
+
+
+2. Looking up Wikipedia articles:
+
+		q wikipedia toast
+	
+	Looks up the named article on Wikipedia. A synonym is `wp`.
+
+
+3. Looking up Ruby core class docs:
+
+		q ruby Hash
+	
+	Looks up the docs for Hash on ruby-doc.org. A synonym is `rb`.
+
+4. Looking up Cocoa/related documentation:
+
+		q ns Array
+	
+	Looks up the docs for NSArray in the on-disk filesystem (uses globbing to find them); therefore it doesn’t require an internet connection and finishes very quickly. Synonyms are: ca, cf, cg, dom, eagl, gl, glu, ib, qt, ui, web.

data/Rakefile

@@ -0,0 +1,7 @@
+task :build do |t|
+	%x{gem build q.gemspec}
+end
+
+task :install do |t|
+	%x{gem install *.gem}
+end

data/bin/q

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+module Q
+	begin
+		require "q"
+	rescue LoadError
+		require "rubygems"
+		require "q"
+	end
+end

data/lib/q.rb

@@ -0,0 +1,40 @@
+module Q
+	@@registered_commands = {}
+	@@unique_commands = []
+	
+	def self.register_command(shortcut, command)
+		if shortcut.is_a? Array
+			shortcut.each do |s|
+				register_command(s, command)
+			end
+		else
+			@@registered_commands[shortcut.to_sym] = command
+			@@unique_commands << command unless @@unique_commands.include? command
+			command.registered_shortcuts << shortcut.to_sym
+		end
+	end
+	
+	def self.commands
+		@@registered_commands
+	end
+	
+	def self.unique_commands
+		@@unique_commands
+	end
+	
+	require "q/command"
+	require "q/commands/glob"
+	require "q/commands/help"
+	require "q/commands/search"
+	
+	DEFAULT_SHORTCUT = :search
+	SHORTCUT = if ARGV.empty?
+		:help
+	elsif @@registered_commands.has_key? ARGV.first.to_sym
+		ARGV.shift.to_sym
+	else
+		DEFAULT_SHORTCUT
+	end
+	
+	puts @@registered_commands[SHORTCUT].execute(SHORTCUT, ARGV)
+end

data/lib/q/command.rb

@@ -0,0 +1,23 @@
+module Q
+	class Command
+		def initialize(usage)
+			@usage = usage
+			@registered_shortcuts = []
+		end
+		
+		
+		def execute(shortcut, terms)
+			"#{shortcut} is unimplemented"
+		end
+		
+		def help(shortcut, terms)
+			usage || "#{shortcut} is undocumented"
+		end
+		
+		def usage
+			registered_shortcuts.map{ |shortcut| shortcut.to_s }.join("|") + " " + @usage
+		end
+		
+		attr_reader :registered_shortcuts
+	end
+end

data/lib/q/commands/glob.rb

@@ -0,0 +1,71 @@
+module Q
+	class Glob < Command
+		def initialize(patterns, usage)
+			@patterns = patterns
+			super(usage)
+		end
+		
+		def execute(shortcut, terms)
+			matches = []
+			@patterns.each do |pattern|
+				matches = Dir.glob(interpolate_pattern(pattern, [shortcut.to_s] + terms))
+				unless matches.empty?
+					%x{open -a Safari "#{matches.first}"}
+					break
+				end
+			end
+			matches.first
+		end
+		
+		def help(shortcut, terms)
+			short = usage
+			if terms.include?("-v") or terms.include?("--verbose")
+				long = $/ + @patterns.join($/) + $/ + $/ + "(%{0}, %{1}, ... are replaced with the shortcut and terms)"
+				short + $/ + long
+			else
+				short + $/ + "(use `q help #{shortcut} --verbose` or `q help #{shortcut} -v` for the relevant patterns)"
+			end
+		end
+		
+		protected
+		
+		def interpolate_pattern(pattern, terms)
+			pattern.gsub(/%\{(\d+?)\}/) do |match|
+				terms[$1.to_i]
+			end
+		end
+	end
+	
+	DOCSET_PATHS = [ # docsets to search within
+		"/Library/Developer/Shared/Documentation/DocSets/*.docset",
+		"/Developer/Documentation/DocSets/*.docset",
+		"/Developer/Platforms/*.platform/Developer/Documentation/DocSets/*.docset"
+	]
+	DOCSET_CONTENTS_PATH = "/Contents/Resources/Documents/documentation/*/Reference/"
+	PATTERNS = [ # these patterns are matched within <docset>/Contents/Resources/Documents/documentation/*/Reference/
+		"%{0}%{1}/Reference/reference.html", # iPhone/CoreGraphics
+		"%{0}%{1}Ref/index.html", # iPhone CoreFoundation
+		"%{0}%{1}Ref/Reference/reference.html", # CoreFoundation
+		"%{0}%{1}_Class/%{0}%{1}/%{0}%{1}.html", # iPhone/UIKit
+		"%{0}%{1}_Class/%{0}%{1}ClassReference/%{0}%{1}ClassReference.html",
+		"%{0}%{1}_Class/Introduction/Introduction.html",
+		"%{0}%{1}_class/Reference/%{0}%{1}.html",
+		"%{0}%{1}_class/Reference/Reference.html",
+		"%{0}%{1}_ClassRef/Reference/%{0}%{1}.html", # iPhone/OpenGL ES
+		"%{0}%{1}_protocol/Reference/%{0}%{1}.html",
+		"%{0}%{1}_protocol/Reference/Reference.html",
+		"*/Protocols/%{0}%{1}_protocol/Reference/Reference.html",
+		"*/Classes/%{0}%{1}_Class/Introduction/Introduction.html",
+		"*/Classes/%{0}%{1}_Class/Reference/%{0}%{1}.html",
+		"*/Classes/%{0}%{1}_Class/Reference/Reference.html",
+		"Foundation/Classes/%{0}%{1}_Class/Reference/Reference.html",
+		"ManPages/man3/%{0}%{1}.3.html", # man pages, e.g. OpenGL man pages
+		"*/Classes/%{0}%{1}_Class/%{0}%{1}.html",
+		"*/Classes/%{0}%{1}_WebKitAdditions/Reference/Reference.html",
+	]
+	PATTERN_PATHS = (DOCSET_PATHS.reduce([]){ |memo, docset_path| memo + PATTERNS.collect{ |pattern| docset_path + DOCSET_CONTENTS_PATH + pattern } }).flatten
+	
+	PREFIXES = %w(ca cf cg dom eagl gl glu ib ns qt ui web)
+	
+	register_command(PREFIXES.collect{ |prefix| prefix.to_sym }, Glob.new(PATTERN_PATHS, "CLASS -- glob through Cocoa documentation for CLASS"))
+end

data/lib/q/commands/help.rb

@@ -0,0 +1,25 @@
+module Q
+	class Help < Command
+		def initialize
+			super("COMMAND -- print help for COMMAND")
+		end
+		
+		def execute(shortcut, terms)
+			shortcut = terms.shift.to_sym unless terms.empty?
+			if command = Q.commands[shortcut]
+				command.help(shortcut, terms)
+			else
+				shortcut.to_s + ": unknown command"
+			end
+		end
+		
+		def help(shortcut, terms)
+			([	%q{Usage: q [SHORTCUT] [TERM] ...},
+				%q{Perform the command specified by SHORTCUT for the specified TERMs.},
+				""
+			] + Q.unique_commands.map{ |command| "  " + command.usage }.sort).join($/)
+		end
+	end
+	
+	register_command(:help, Help.new)
+end

data/lib/q/commands/search.rb

@@ -0,0 +1,19 @@
+module Q
+	class Search < Command
+		def initialize(url_pattern, usage)
+			@url_pattern = url_pattern
+			super(usage)
+		end
+		
+		
+		def execute(shortcut, terms)
+			url = @url_pattern % terms.join("+")
+			%x{osascript -e 'open location "#{url}"'}
+			url
+		end
+	end
+	
+	register_command([:search, :google, :g], Search.new("http://www.google.com/search?q=%s", "TERM ... -- search for TERMs on google"))
+	register_command([:ruby, :rb], Search.new("http://ruby-doc.org/core/classes/%s.html", "CLASS -- look up CLASS on ruby-doc.org"))
+	register_command([:wikipedia, :wp], Search.new("http://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go", "ARTICLE -- look up [article] on wikipedia"))
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: qtool
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rob Rix
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-08 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Automate bits of your everyday workflow with q commands.
+email: rob@monochromeindustries.com
+executables: 
+- q
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.mdown
+- Rakefile
+- bin/q
+- lib/q.rb
+- lib/q/command.rb
+- lib/q/commands/glob.rb
+- lib/q/commands/help.rb
+- lib/q/commands/search.rb
+has_rdoc: true
+homepage: https://github.com/robrix/q/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: q is for query.
+test_files: []
+