lib/go/installer.rb lib/go/recursive_http_fetcher.rb test/fixtures/plugins/hello.rb test/fixtures/plugins/palace/party_palace.rb test/fixtures/plugins/panda.rb test/fixtures/plugins/panda_party.rb test/fixtures/plugins/todo.rb test/fixtures/reserved/commands.rb @@ -1,6 +1,5 @@ #!/usr/bin/ruby -path = File.join(File.dirname(__FILE__), '..', 'lib', 'go') -require path +require(File.join(File.dirname(__FILE__), '..', 'lib', 'go')) Go.application.run bin/go_dev @@ -2,22 +2,25 @@ $:.unshift(File.dirname(__FILE__) + "/go/") # System gems require 'rubygems' -require 'open-uri' require 'cooloptions' # Go Core classes require 'application' require 'plugin' +require 'installer' require 'extensions' +require 'recursive_http_fetcher' # Ruby libs +require 'open-uri' +require 'uri' module Go VERSION = '0.1' # Current Rake Application def self.application - @application ||= Go::Application.new + @application ||= Go::Application.new(ARGV) end # Set the current Rake application object. lib/go.rb @@ -1,32 +1,55 @@ module Go class Application +# class << self +# end + attr_reader :args, :plugin_commands, :sorted_plugins, :options + attr_accessor :plugin_path + ReservedCommands = %w(commands edit generate help list setup install plugin) + # Initializes a new Go::Application object - should always be called via a Singleton, e.g. # Go.application.run - def initialize + def initialize(args = ARGV) + @args = args + @options = OpenStruct.new end # Main Go Application entry point. # * Parses command-line options and calls methods accordingly def run - @options = CoolOptions.parse!("[options] (commands|edit|generate|help|setup)") do |o| + @options = CoolOptions.parse!("[options] (commands|edit|generate|help|list|setup)") do |o| o.desc "Go - the Extensible command-line tool for ninjas, pirates & pandas" - o.on "(v)erbose", "Turn on verbose mode", false + o.on "(v)erbose", "Turn on verbose mode", false + o.on "(f)orce", "Force (the action)", false o.after do |r| r.config_path = self.default_config_path if !File.exist?(r.config_path) setup exit end - r.params = ARGV.slice(1, ARGV.size) - r.action = ARGV.shift || 'commands' + r.full_command = @args.join(' ') + r.params = @args.slice(1, @args.size) + r.action = @args.empty? ? 'commands' : @args[0] end end case @options.action when 'commands', 'list' list_commands + when 'install' + install_plugin + when 'plugin' + case @options.params.first + when 'list' + list_commands + when 'install' + @option.params.shift + install_plugin + else + puts "Invalid command. Call go without any params for a list of valid commands." + list_commands + end when 'generate' generate when 'setup' @@ -41,23 +64,46 @@ module Go end + def install_plugin + if @options.params.empty? + raise "Please specify a URL from which to install the plugin, e.g.: go install http://gist.github.com/14933" + end + installer = Installer.new(@options.params.first, self) + installer.install + end + def run_plugin_command init_plugins - if @plugin_commands[@options.action] - klass = @plugin_commands[@options.action] + plugin_pair = nil + # They may have passed "panda party palace", "panda party", or "panda" + # We want to give the plugin with the most words -> highest priority + @args.size.downto(1) do |i| + cmd = @args.slice(0, i).join(' ') + plugin_pair = @sorted_plugins.detect {|pair| pair.first == cmd} + break if plugin_pair + end + if plugin_pair + klass = plugin_pair[1] plugin = klass.new(@options) plugin.run else - puts "No command found for action: #{@options.action}" + puts "No command found for action: #{@options.action}" unless test_env? end + #puts "\t Returning: #{plugin_pair.inspect}" + plugin_pair end def list_commands + justify = 40 init_plugins - puts "\n Go command list: " - @plugin_commands.each do |command, klass| - usage = klass.usage_raw ? " # go #{klass.usage_raw}" : '' - puts " #{command}\t #{usage}" + puts "\n Builtin Go commands\n\n" + show_command('install', "install <plugin_url>") + show_command('list', "list") + puts "\n Plugin commands\n " + @sorted_plugins.each do |pair| + command, klass = *pair + usage = klass.usage_raw ? klass.usage_raw : command + show_command(command, usage) end puts "\n" end @@ -76,22 +122,7 @@ module Go install_default_plugins - puts ' -Default config file has been created in: - - ~/.goconfig - -This will be the primary entry-point for editing any config options required by Go plugins. - -Default plugins have been placed in the go plugin directory: - - ~/.go - -To see a list of available go commands, run go without any arguments: - - go - -' + puts setup_txt end # Edit the config file (using the system editor) @@ -105,8 +136,24 @@ To see a list of available go commands, run go without any arguments: puts help_txt end + def init_plugins! + init_plugins + end + + def clear_plugins! + @plugin_commands, @sorted_plugins = nil, nil + end + + def go_dir + @plugin_path || File.join(ENV['HOME'], '.go') + end + protected + def show_command(command_name, usage, justify = 40) + puts " #{command_name.ljust(justify)}\t# go #{usage}" + end + def init_plugins contains = Dir.new(go_dir).entries contains.delete("."); contains.delete("..") @@ -115,18 +162,15 @@ To see a list of available go commands, run go without any arguments: if File.directory?(path) # Require all .rb files in this dir subfiles = Dir.new(path).entries - #puts "subfiles = #{subfiles.inspect}" subfiles.delete("."); subfiles.delete("..") subfiles.each do |sub| sub_path = File.join(path, sub) - #puts "\tsub_path = #{sub_path}" if !File.directory?(sub_path) && File.extname(sub_path) == '.rb' require sub_path end end elsif File.extname(path) == '.rb' # Require it if it's a ruby file - #puts "Requiring: #{path}" require path end end @@ -140,12 +184,44 @@ To see a list of available go commands, run go without any arguments: plugins.each do |p| command = p.command.to_s puts " Plugin: #{p} :: #{command}" if @options.verbose - @plugin_commands[command] = p + if ReservedCommands.include?(command) + puts "WARNING: #{p} attempted to init plugin with reserved command '#{command}' (plugin *not* loaded)" unless test_env? + else + @plugin_commands[command] = p + end end + @sorted_plugins = sort_plugins(@plugin_commands) end - def go_dir - File.join(ENV['HOME'], '.go') + def sort_plugins(plugin_commands) + # Now sort 'em - alphabetically first, thgen with higher priority (more words in the command string) + # plugins coming next. + sorted_plugins = [] + plugin_commands.each do |command, klass| + sorted_plugins << [command, klass] + end + sorted_plugins.sort! do |x,y| + cmd_x, cmd_y = x.first, y.first + cmd_x_size = cmd_x.split(' ').size + cmd_y_size = cmd_y.split(' ').size + if (cmd_x_size == cmd_y_size) && cmd_x_size == 1 + # Single word command (both), simply sort alphabetically + (cmd_x <=> cmd_y) + else + # One of the commands has multiple words, install the mutli-word command ahead of the other one + # if there is a sub-match + sub_cmd_x = cmd_x.split(' ')[0] + sub_cmd_y = cmd_y.split(' ')[0] + if sub_cmd_x == sub_cmd_y + # e.g. 'panda' and 'panda party' + cmd_y_size <=> cmd_x_size + else + # Otherwise sort alphabetically + cmd_x <=> cmd_y + end + end + end + sorted_plugins end def default_config_path @@ -159,7 +235,7 @@ To see a list of available go commands, run go without any arguments: end def help_txt - ' + txt = <<EOF To setup the initial config file, execute: go setup @@ -168,13 +244,38 @@ Edit go config using your system edtior: go edit -' +EOF + end + + def setup_txt + txt = <<EOF + + Default config file has been created in: + + ~/.goconfig + + This will be the primary entry-point for editing any config options required by Go plugins. + + Default plugins have been placed in the go plugin directory: + + ~/.go + + To see a list of available go commands, run go without any arguments: + + go + +EOF end def sample_config "name: Change Me" end + # Suppress noise when testing + def test_env? + defined?(Test::Unit::TestCase) + end + end end lib/go/application.rb @@ -5,6 +5,17 @@ class Time end end +class String + def to_underscore #(klass) + self.dup.gsub(/::/, '/'). + gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). + gsub(/([a-z\d])([A-Z])/,'\1_\2'). + tr("-", "_"). + downcase + end +end + + class Module def subclasses classes = [] lib/go/extensions.rb @@ -0,0 +1,48 @@ +require(File.join(File.dirname(__FILE__), '..', 'lib', 'go')) +require 'test/unit' +require 'set' + +class TestGo < Test::Unit::TestCase + + def test_fixture_plugins_loaded_as_subclasses + @app = Go::Application.new(['hello']) + @app.plugin_path = File.join(File.dirname(__FILE__), 'fixtures', 'plugins') + @app.instance_eval('init_plugins') + assert_equal [Hello, Panda, PandaParty, PartyPalace, Todo].to_set, Go::Plugin.subclasses.to_set + end + + def test_plugin_with_reserved_command_should_not_get_included_in_command_tree + @app = Go::Application.new([]) + @app.plugin_path = File.join(File.dirname(__FILE__), 'fixtures', 'reserved') + @app.instance_eval('init_plugins') + assert !@app.plugin_commands.keys.include?('commands') + end + + def test_command_with_most_required_params_has_highest_priority + @app = Go::Application.new(['panda party palace']) + @app.plugin_path = File.join(File.dirname(__FILE__), 'fixtures', 'plugins') + @app.instance_eval('init_plugins') + assert_equal ["panda party palace", PartyPalace], @app.run + end + + def test_command_with_next_most_params_has_next_highest_priority + @app = Go::Application.new(['panda party']) + @app.plugin_path = File.join(File.dirname(__FILE__), 'fixtures', 'plugins') + assert_equal ["panda party", PandaParty], @app.run + end + + def pending_test_single_word_command_with_params + @app = Go::Application.new(['panda', 'this app makes me feel sexy']) + @app.plugin_path = File.join(File.dirname(__FILE__), 'fixtures', 'plugins') + @app.init_plugins! + assert_equal ["panda", Panda], @app.run + end + + ## Installer tests + def test_installer_parse_pastie_txt + app = Go::Application.new([]) + app.plugin_path = File.join(File.dirname(__FILE__), 'fixtures', 'reserved') + inst = Go::Installer.new('http://pastie.org/285599.txt', app) + assert_equal 'http://pastie.org/285599.txt', inst.instance_eval('@url') #inst.send(:url) + end +end \ No newline at end of file test/test_go.rb d2106100dac75d112347b30e88338b569289d7d2 shanti sems@sparqs-macbook-pro-15.local http://github.com/sbraford/go/commit/4bd300c26fbc7c46b1fab851c60b9264a0739d10 4bd300c26fbc7c46b1fab851c60b9264a0739d10 2008-10-05T22:14:28-07:00 2008-10-05T22:14:28-07:00 install plugin working; some basic unit tests f4b8a12618ee9006ad0b6aa5982b47eea01aac4e shanti sems@sparqs-macbook-pro-15.local