rapt 0.1.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+
+= 0.1.0
+
+* Converted from original Rails plugin code

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006 Geoffrey Grosenbach boss@topfunky.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

@@ -0,0 +1,4 @@
+Rapt
+====
+
+A plugin manager for Ruby on Rails.

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+$:.unshift(File.dirname(__FILE__) + "/lib/commands")
+require 'plugin'
+
+PKG_NAME      = 'rapt'
+PKG_VERSION   = '0.1.0'
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = PKG_NAME
+RUBY_FORGE_USER    = "topfunky"
+
+desc "Default Task"
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Genereate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Rapt -- Rails plugin manager"
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/plugin.rb')
+  rdoc.rdoc_files.include('lib/plugin/*.rb')
+}
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "Rails plugin manager."
+  s.description = %q{Install, remove, and discover new plugins for your Ruby on Rails app.}
+  s.version = PKG_VERSION
+
+  s.authors = ["Ryan Tomayko", "Geoffrey Grosenbach"]
+  s.email = "boss@topfunky.com"
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.homepage = "http://nubyonrails.com/pages/rapt"
+
+  s.has_rdoc = false
+  s.requirements << 'none'
+  s.require_path = 'lib'
+
+  s.files = [ "Rakefile", "README", "CHANGELOG", "MIT-LICENSE" ]
+  %w(bin lib test).each do |dir|
+    s.files = s.files + Dir.glob( "#{dir}/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  end
+  s.executables = ["rapt"]
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+# desc "Publish the API documentation"
+# task :pgem => [:package] do 
+#   Rake::SshFilePublisher.new("boss@topfunky.com", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
+# end
+

data/bin/rapt

@@ -0,0 +1,6 @@
+#!/usr/local/bin/ruby
+
+require "commands/plugin"
+
+Commands::Plugin.parse!
+

data/lib/commands/plugin.rb

@@ -0,0 +1,65 @@
+# Rails Plugin Manager.
+# 
+# Listing available plugins:
+#
+#   $ ./script/plugin list
+#   continuous_builder            http://dev.rubyonrails.com/svn/rails/plugins/continuous_builder
+#   asset_timestamping            http://svn.aviditybytes.com/rails/plugins/asset_timestamping
+#   enumerations_mixin            http://svn.protocool.com/rails/plugins/enumerations_mixin/trunk
+#   calculations                  http://techno-weenie.net/svn/projects/calculations/
+#   ...
+#
+# Installing plugins:
+#
+#   $ ./script/plugin install continuous_builder asset_timestamping
+#
+# Finding Repositories:
+#
+#   $ ./script/plugin discover
+# 
+# Adding Repositories:
+#
+#   $ ./script/plugin source http://svn.protocool.com/rails/plugins/
+#
+# How it works:
+# 
+#   * Maintains a list of subversion repositories that are assumed to have
+#     a plugin directory structure. Manage them with the (source, unsource,
+#     and sources commands)
+#     
+#   * The discover command scrapes the following page for things that
+#     look like subversion repositories with plugins:
+#     http://wiki.rubyonrails.org/rails/pages/Plugins
+# 
+#   * Unless you specify that you want to use svn, script/plugin uses plain old
+#     HTTP for downloads.  The following bullets are true if you specify
+#     that you want to use svn.
+#
+#   * If `vendor/plugins` is under subversion control, the script will
+#     modify the svn:externals property and perform an update. You can
+#     use normal subversion commands to keep the plugins up to date.
+# 
+#   * Or, if `vendor/plugins` is not under subversion control, the
+#     plugin is pulled via `svn checkout` or `svn export` but looks
+#     exactly the same.
+# 
+# This is Free Software, copyright 2005 by Ryan Tomayko (rtomayko@gmail.com) 
+# and is licensed MIT: (http://www.opensource.org/licenses/mit-license.php)
+
+$verbose = false
+
+require 'open-uri'
+require 'fileutils'
+require 'tempfile'
+
+include FileUtils
+
+require File.dirname(__FILE__) + '/plugin/rails_environment' 
+require File.dirname(__FILE__) + '/plugin/plugin' 
+require File.dirname(__FILE__) + '/plugin/repositories' 
+require File.dirname(__FILE__) + '/plugin/repository' 
+require File.dirname(__FILE__) + '/plugin/commands' 
+require File.dirname(__FILE__) + '/plugin/recursive_http_fetcher' 
+
+
+

data/lib/commands/plugin/commands.rb

@@ -0,0 +1,486 @@
+
+# Load default environment and parse arguments
+require 'optparse'
+module Commands
+
+  class Plugin
+    attr_reader :environment, :script_name, :sources
+    def initialize
+      @environment = RailsEnvironment.default
+      @rails_root = RailsEnvironment.default.root
+      @script_name = File.basename($0) 
+      @sources = []
+    end
+    
+    def environment=(value)
+      @environment = value
+      RailsEnvironment.default = value
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@script_name} [OPTIONS] command"
+        o.define_head "Rails plugin manager."
+        
+        o.separator ""        
+        o.separator "GENERAL OPTIONS"
+        
+        o.on("-r", "--root=DIR", String,
+             "Set an explicit rails app directory.",
+             "Default: #{@rails_root}") { |@rails_root| self.environment = RailsEnvironment.new(@rails_root) }
+        o.on("-s", "--source=URL1,URL2", Array,
+             "Use the specified plugin repositories instead of the defaults.") { |@sources|}
+        
+        o.on("-v", "--verbose", "Turn on verbose output.") { |$verbose| }
+        o.on("-h", "--help", "Show this help message.") { puts o; exit }
+        
+        o.separator ""
+        o.separator "COMMANDS"
+        
+        o.separator "  discover   Discover plugin repositories."
+        o.separator "  list       List available plugins."
+        o.separator "  about      Show basic info about a plugin."
+        o.separator "  install    Install plugin(s) from known repositories or URLs."
+        o.separator "  update     Update installed plugins."
+        o.separator "  remove     Uninstall plugins."
+        o.separator "  source     Add a plugin source repository."
+        o.separator "  unsource   Remove a plugin repository."
+        o.separator "  sources    List currently configured plugin repositories."
+        
+        o.separator ""
+        o.separator "EXAMPLES"
+        o.separator "  Install a plugin:"
+        o.separator "    #{@script_name} install continuous_builder\n"
+        o.separator "  Install a plugin from a subversion URL:"
+        o.separator "    #{@script_name} install http://dev.rubyonrails.com/svn/rails/plugins/continuous_builder\n"
+        o.separator "  Install a plugin and add a svn:externals entry to vendor/plugins"
+        o.separator "    #{@script_name} install -x continuous_builder\n"
+        o.separator "  Show information about the acts_as_chunky_bacon plugin:"
+        o.separator "    #{@script_name} about acts_as_chunky_bacon\n"
+        o.separator "  List all available plugins:"
+        o.separator "    #{@script_name} list\n"
+        o.separator "  List plugins in the specified repository:"
+        o.separator "    #{@script_name} list --source=http://dev.rubyonrails.com/svn/rails/plugins/\n"
+        o.separator "  Discover and prompt to add new repositories:"
+        o.separator "    #{@script_name} discover\n"
+        o.separator "  Discover new repositories but just list them, don't add anything:"
+        o.separator "    #{@script_name} discover -l\n"
+        o.separator "  Add a new repository to the source list:"
+        o.separator "    #{@script_name} source http://dev.rubyonrails.com/svn/rails/plugins/\n"
+        o.separator "  Remove a repository from the source list:"
+        o.separator "    #{@script_name} unsource http://dev.rubyonrails.com/svn/rails/plugins/\n"
+        o.separator "  Show currently configured repositories:"
+        o.separator "    #{@script_name} sources\n"        
+        o.separator "  Show the options for the list command:"
+        o.separator "    #{@script_name} list -h\n"
+      end
+    end
+    
+    def parse!(args=ARGV)
+      general, sub = split_args(args)
+      options.parse!(general)
+      
+      command = general.shift
+      if command =~ /^(list|discover|install|source|unsource|sources|remove|update|about)$/
+        command = Commands.const_get(command.capitalize).new(self)
+        command.parse!(sub)
+      else
+        puts "Unknown command: #{command}"
+        puts options
+        exit 1
+      end
+    end
+    
+    def split_args(args)
+      left = []
+      left << args.shift while args[0] and args[0] =~ /^-/
+      left << args.shift if args[0]
+      return [left, args]
+    end
+    
+    def self.parse!(args=ARGV)
+      Plugin.new.parse!(args)
+    end
+  end
+  
+  
+  class List
+    def initialize(base_command)
+      @base_command = base_command
+      @sources = []
+      @local = false
+      @remote = false
+      @cached = true
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} list [OPTIONS] [PATTERN]"
+        o.define_head "List available plugins."
+        o.separator   ""        
+        o.separator   "Options:"
+        o.separator   ""
+        o.on(         "-s", "--source=URL1,URL2", Array,
+                      "Use the specified plugin repositories.") {|@sources| @remote = true; @cached = false }
+        o.on(         "--local", 
+                      "List locally installed plugins.") {|@local| @cached = false }
+        o.on(         "--cached",
+                      "List the known plugins in the local sources cache. This is the default behavior.") {|@cached|}
+        o.on(         "--remote",
+                      "List remotely available plugins.",
+                      "unless --local is provided.") {|@remote| @cached = false }
+      end
+    end
+    
+    def parse!(args)
+      options.order!(args)
+      unless @sources.empty?
+        @sources.map!{ |uri| Repository.new(uri) }
+      else
+        @sources = Repositories.instance.all
+      end
+      if @remote
+        @sources.map{|r| r.plugins}.flatten.each do |plugin| 
+          if @local or !plugin.installed?
+            puts plugin.to_s
+          end
+        end
+      elsif @cached
+        Repositories.instance.cached_plugins.each { |plugin| puts plugin.to_s }
+        puts "\nThere are #{Repositories.instance.plugin_count} plugins in the source cache.\n\n"
+      else
+        cd "#{@base_command.environment.root}/vendor/plugins"
+        Dir["*"].select{|p| File.directory?(p)}.each do |name| 
+          puts name
+        end
+      end
+    end
+  end
+  
+  
+  class Sources
+    def initialize(base_command)
+      @base_command = base_command
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} sources [OPTIONS] [PATTERN]"
+        o.define_head "List configured plugin repositories."
+        o.separator   ""        
+        o.separator   "Options:"
+        o.separator   ""
+        o.on(         "-c", "--check", 
+                      "Report status of repository.") { |@sources| } # TODO Implement
+        o.on(         "-r", "--refresh", 
+                      "Refresh the source cache with the list of plugins available in each repository.") { refresh }
+      end
+    end
+    
+    def parse!(args)
+      options.parse!(args)
+      Repositories.each do |repo|
+        puts repo.uri
+      end
+    end
+    
+    def refresh
+      puts "Refreshing source cache (may take a few minutes)..."
+      repositories = Repositories.instance
+      repositories.refresh!
+      repositories.save
+    end
+  end
+  
+  
+  class Source
+    def initialize(base_command)
+      @base_command = base_command
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} source REPOSITORY"
+        o.define_head "Add a new repository."
+      end
+    end
+    
+    def parse!(args)
+      options.parse!(args)
+      count = 0
+      args.each do |uri|
+        if Repositories.instance.add(uri)
+          puts "added: #{uri.ljust(50)}" if $verbose
+          count += 1
+        else
+          puts "failed: #{uri.ljust(50)}"
+        end
+      end
+      Repositories.instance.save
+      puts "Added #{count} repositories."
+    end
+  end
+  
+  
+  class Unsource
+    def initialize(base_command)
+      @base_command = base_command
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} source URI [URI [URI]...]"
+        o.define_head "Remove repositories from the default search list."
+        o.separator ""
+        o.on_tail("-h", "--help", "Show this help message.") { puts o; exit }
+      end
+    end
+    
+    def parse!(args)
+      options.parse!(args)
+      count = 0
+      args.each do |uri|
+        if Repositories.instance.remove(uri)
+          count += 1
+          puts "removed: #{uri.ljust(50)}"
+        else
+          puts "failed: #{uri.ljust(50)}"
+        end
+      end
+      Repositories.instance.save
+      puts "Removed #{count} repositories."
+    end
+  end
+
+  
+  class Discover
+    def initialize(base_command)
+      @base_command = base_command
+      @list = false
+      @prompt = true
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} discover URI [URI [URI]...]"
+        o.define_head "Discover repositories referenced on a page."
+        o.separator   ""        
+        o.separator   "Options:"
+        o.separator   ""
+        o.on(         "-l", "--list", 
+                      "List but don't prompt or add discovered repositories.") { |@list| @prompt = !@list }
+        o.on(         "-n", "--no-prompt", 
+                      "Add all new repositories without prompting.") { |v| @prompt = false }
+      end
+    end
+
+    def parse!(args)
+      options.parse!(args)
+      args = ['http://wiki.rubyonrails.org/rails/pages/Plugins', 'http://agilewebdevelopment.com/plugins/scrape'] if args.empty?
+      args.each do |uri|
+        scrape(uri) do |repo_uri|
+          catch(:next_uri) do
+            if @prompt
+              begin
+                $stdout.print "Add #{repo_uri}? [Y/n] "
+                throw :next_uri if $stdin.gets !~ /^y?$/i
+              rescue Interrupt
+                $stdout.puts
+                exit 1
+              end
+            elsif @list
+              puts repo_uri
+              throw :next_uri
+            end
+            Repositories.instance.add(repo_uri)
+            puts "discovered: #{repo_uri}" if $verbose or !@prompt
+          end
+        end
+      end
+      Repositories.instance.save
+    end
+    
+    def scrape(uri)
+      require 'open-uri'
+      puts "Scraping #{uri}" if $verbose
+      dupes = []
+      content = open(uri).each do |line|
+        begin
+          if line =~ /<a[^>]*href=['"]([^'"]*)['"]/ || line =~ /(svn:\/\/[^<|\n]*)/
+            uri = $1
+            if uri =~ /^\w+:\/\// && uri =~ /\/plugins\// && uri !~ /\/browser\// && uri !~ /^http:\/\/wiki\.rubyonrails/ && uri !~ /http:\/\/instiki/
+              uri = extract_repository_uri(uri)
+              yield uri unless dupes.include?(uri) || Repositories.instance.exist?(uri)
+              dupes << uri
+            end
+          end
+        rescue
+          puts "Problems scraping '#{uri}': #{$!.to_s}"
+        end
+      end
+    end
+    
+    def extract_repository_uri(uri)
+      uri.match(/(svn|https?):.*\/plugins\//i)[0]
+    end 
+  end
+  
+  class Install
+    def initialize(base_command)
+      @base_command = base_command
+      @method = :http
+      @options = { :quiet => false, :revision => nil, :force => false }
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} install PLUGIN [PLUGIN [PLUGIN] ...]"
+        o.define_head "Install one or more plugins."
+        o.separator   ""
+        o.separator   "Options:"
+        o.on(         "-x", "--externals", 
+                      "Use svn:externals to grab the plugin.", 
+                      "Enables plugin updates and plugin versioning.") { |v| @method = :externals }
+        o.on(         "-o", "--checkout",
+                      "Use svn checkout to grab the plugin.",
+                      "Enables updating but does not add a svn:externals entry.") { |v| @method = :checkout }
+        o.on(         "-q", "--quiet",
+                      "Suppresses the output from installation.",
+                      "Ignored if -v is passed (./script/plugin -v install ...)") { |v| @options[:quiet] = true }
+        o.on(         "-r REVISION", "--revision REVISION",
+                      "Checks out the given revision from subversion.",
+                      "Ignored if subversion is not used.") { |v| @options[:revision] = v }
+        o.on(         "-f", "--force",
+                      "Reinstalls a plugin if it's already installed.") { |v| @options[:force] = true }
+        o.separator   ""
+        o.separator   "You can specify plugin names as given in 'plugin list' output or absolute URLs to "
+        o.separator   "a plugin repository."
+      end
+    end
+    
+    def determine_install_method
+      best = @base_command.environment.best_install_method?
+      @method = :http if best == :http and @method == :export
+      case
+      when (best == :http and @method != :http)
+        msg = "Cannot install using subversion because `svn' cannot be found in your PATH"
+      when (best == :export and (@method != :export and @method != :http))
+        msg = "Cannot install using #{@method} because this project is not under subversion."
+      when (best != :externals and @method == :externals)
+        msg = "Cannot install using externals because vendor/plugins is not under subversion."
+      end
+      if msg
+        puts msg
+        exit 1
+      end
+      @method
+    end
+    
+    def parse!(args)
+      options.parse!(args)
+      environment = @base_command.environment
+      install_method = determine_install_method
+      puts "Plugins will be installed using #{install_method}" if $verbose
+      args.each do |name|
+        ::Plugin.find(name).install(install_method, @options)
+      end
+    rescue
+      puts "Plugin not found: #{args.inspect}"
+      exit 1
+    end
+  end
+
+  class Update
+    def initialize(base_command)
+      @base_command = base_command
+    end
+   
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} update [name [name]...]"
+        o.on(         "-r REVISION", "--revision REVISION",
+                      "Checks out the given revision from subversion.",
+                      "Ignored if subversion is not used.") { |v| @revision = v }
+        o.define_head "Update plugins."
+      end
+    end
+   
+    def parse!(args)
+      options.parse!(args)
+      root = @base_command.environment.root
+      cd root
+      args = Dir["vendor/plugins/*"].map do |f|
+        File.directory?("#{f}/.svn") ? File.basename(f) : nil
+      end.compact if args.empty?
+      cd "vendor/plugins"
+      args.each do |name|
+        if File.directory?(name)
+          puts "Updating plugin: #{name}"
+          system("svn #{$verbose ? '' : '-q'} up \"#{name}\" #{@revision ? "-r #{@revision}" : ''}")
+        else
+          puts "Plugin doesn't exist: #{name}"
+        end
+      end
+    end
+  end
+
+  class Remove
+    def initialize(base_command)
+      @base_command = base_command
+    end
+    
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} remove name [name]..."
+        o.define_head "Remove plugins."
+      end
+    end
+    
+    def parse!(args)
+      options.parse!(args)
+      root = @base_command.environment.root
+      args.each do |name|
+        ::Plugin.new(name).uninstall
+      end
+    end
+  end
+
+  class About
+    def initialize(base_command)
+      @base_command = base_command
+    end
+
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} about name [name]..."
+        o.define_head "Shows plugin info at {url}/about.yml."
+      end
+    end
+
+    def parse!(args)
+      options.parse!(args)
+      args.each do |name|
+        if plugin = ::Plugin.find(name)
+          if about_hash = plugin.about
+            puts about_hash.to_yaml + "\n"
+            next
+          end
+        end
+        
+        puts "Plugin #{name} could not be found in the known repositories."
+        puts
+      end
+    end
+  end
+end
+