sashimi 0.1.0

data/CHANGELOG

@@ -0,0 +1,57 @@
+* *v0.1.0*
+
+* Print on the stdout the plugin name on each command execution
+
+* Fixed shell help output in commands.rb: make clear each command accepts multiple params. Deleted duplicated Update class from commands.rb.
+
+* Fixed sashimi.gemspec: sashimi executable is now available after gem setup
+
+* Made AbstractRepository#remove_hidden_folders platform independent
+
+* Fixed loading in sashimi
+
+* Fixed lib loading in sashimi.rb
+
+* Added setup.rb
+
+* Added PluginNotFound to improve OOP in exceptions handling
+
+* Added version.rb
+
+* Added installation instructions, examples and copyright to README [#9 state:resolved]
+
+* Created gemspec file [#8 state:resolved]
+
+* Added MIT-LICENSE [#10 state:resolved]
+
+* Add an installed plugin to a Rails app [#7 state:resolved]
+
+* Show plugin summary in list command [#6 state:resolved]
+
+* Improved tests for Plugin#about
+
+* Cache summary stored in plugin about.yml [#5 state:resolved]
+
+* Plugin serialization [#4 state:resolved]
+
+* List all installed plugins [#3 state:resolved]
+
+* Update an installed plugin [#1 state:resolved]
+
+* Refactored Plugin and AbstractRepository to separate class responsabilities
+
+* Remove a plugin from cache when uninstalled
+
+* Created a plugins cache to store the repository type (svn or git)
+
+* Improved shell commands help
+
+* Basic plugin uninstall process
+
+* Basic plugin install process
+
+* Introducing Plugin, AbstractRepository, SvnRepository and GitRepository
+
+* Adding Rakefile
+
+* Adding CHANGELOG

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Luca Guidi
+
+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,73 @@
+Sashimi
+=======
+
+Sashimi is a Rails plugins manager.
+It allows to install your favourite plugins in a local repository and add them to your Rails apps.
+The main goal is to allow the plugins offline installation.
+
+
+
+Installation
+============
+
+$ (sudo) gem install jodosha-sashimi --source=http://gems.github.com
+
+
+
+Usage
+=====
+
+Install a plugin from a subversion URL:
+$ sashimi install http://dev.rubyonrails.com/svn/rails/plugins/continuous_builder
+
+Install a plugin from a git URL:
+$ sashimi install git://github.com/jodosha/click-to-globalize.git
+
+Uninstall a plugin:
+$ sashimi uninstall continuous_builder
+
+Update a plugin:
+$ sashimi update click-to-globalize
+
+List all installed plugins:
+$ sashimi list
+
+Add installed plugin(s) to a Rails app:
+$ sashimi add click-to-globalize
+
+
+
+Known And Common Issues
+=======================
+
+* When add a plugin to an app, make sure your current directory is the rails root.
+
+* Only Subversion and Git repositories are currently supported.
+
+
+Contribute
+==========
+
+* Check out the code and test it:
+  $ git clone git://github.com/jodosha/sashimi.git
+  $ rake
+
+* Create a ticket to: http://sushistar.lighthouseapp.com
+
+* Create a patch and add as attachement to the ticket.
+
+
+Credits
+=======
+
+Partially inspired to RaPT[http://rapt.rubyforge.org/].
+
+
+
+Home Page
+=========
+http://lucaguidi.com/pages/sashimi
+
+
+
+Copyright (c) 2008 Luca Guidi - http://lucaguidi.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sashimi gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the sashimi gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sashimi'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/sashimi

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'sashimi'
+require 'sashimi/commands'
+
+$rails_app = Dir.pwd
+
+Sashimi::Commands::Command.parse!

data/lib/sashimi/commands.rb

@@ -0,0 +1,183 @@
+require 'optparse'
+
+module Sashimi
+  module Commands
+    class Command
+      attr_reader :script_name
+      
+      def initialize
+        @script_name = File.basename($0)
+      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("-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 "  install        Install plugin(s) from known URL(s)."
+          o.separator "  uninstall      Uninstall plugin(s) from local repository."
+          o.separator "  update         Update installed plugin(s)."
+          o.separator "  list           List all installed plugins."
+          o.separator "  add            Add installed plugin(s) to a Rails app."
+
+          o.separator ""
+          o.separator "EXAMPLES"
+          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 from a git URL:"
+          o.separator "    #{@script_name} install git://github.com/jodosha/click-to-globalize.git\n"
+          o.separator "  Uninstall a plugin:"
+          o.separator "    #{@script_name} uninstall continuous_builder\n"
+          o.separator "  Update a plugin:"
+          o.separator "    #{@script_name} update click-to-globalize\n"
+          o.separator "  List all installed plugins:"
+          o.separator "    #{@script_name} list\n"
+          o.separator "  Add installed plugin(s) to a Rails app:"
+          o.separator "    #{@script_name} add click-to-globalize\n"
+        end
+      end
+
+      def parse!(args=ARGV)
+        general, sub = split_args(args)
+        options.parse!(general)
+
+        command = general.shift
+        if command =~ /^(install|uninstall|update|list|add)$/
+          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)
+        Command.new.parse!(args)
+      rescue Exception => e
+        puts e.message
+        exit 1
+      end
+    end
+    
+    class Install
+      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} install URL [URL2, URL3]"
+          o.define_head "Install plugin(s) from known URL(s)."
+        end
+      end
+      
+      def parse!(args)
+        options.parse!(args)
+        args.each do |url|
+          Plugin.new(nil, url).install
+        end
+      end
+    end
+  
+    class Uninstall
+      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} uninstall PLUGIN [PLUGIN2, PLUGIN3]"
+          o.define_head "Uninstall plugin(s) from local repository."
+        end
+      end
+      
+      def parse!(args)
+        options.parse!(args)
+        args.each do |name|
+          Plugin.new(name).uninstall
+        end
+      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 PLUGIN [PLUGIN2, PLUGIN3]"
+          o.define_head "Update installed plugin(s)."
+        end
+      end
+      
+      def parse!(args)
+        options.parse!(args)
+        args.each do |name|
+          Plugin.new(name).update
+        end
+      end
+    end
+    
+    class List
+      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} list"
+          o.define_head "List all installed plugins."
+        end
+      end
+      
+      def parse!(args)
+        options.parse!(args)
+        puts Plugin.list
+      end
+    end
+
+    class Add
+      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} add PLUGIN"
+          o.define_head "Add installed plugin(s) to a Rails app."
+        end
+      end
+      
+      def parse!(args)
+        options.parse!(args)
+        args.each do |name|
+          Plugin.new(name).add
+        end
+      end
+    end
+  end
+end

data/lib/sashimi/plugin.rb

@@ -0,0 +1,76 @@
+module Sashimi
+  class Plugin
+    attr_reader :url, :name
+    
+    def initialize(name, url = '')
+      @url = URI::parse(url).to_s
+      @name = name
+    end
+    
+    # Install the plugin
+    def install
+      repository.install
+    end
+    
+    # Uninstall the plugin
+    def uninstall
+      repository.uninstall
+    end
+    
+    # Update the plugin
+    def update
+      repository.update
+    end
+
+    # Add to a Rails app
+    def add
+      repository.add
+    end
+
+    def repository #:nodoc:
+      @repository ||= instantiate_repository
+    end
+    
+    # Read the content of the <tt>about.yml</tt>.
+    # New feature of Rails 2.1.x http:://dev.rubyonrails.org/changeset/9098
+    def about
+      @about ||= repository.about
+    end
+    
+    # Return the plugin summary.
+    def summary
+      about['summary']
+    end
+    
+    # Try to guess the plugin name.
+    def guess_name
+      name = File.basename(@url)
+      if name == 'trunk' || name.empty?
+        name = File.basename(File.dirname(@url))
+      end
+      name.gsub!(/\.git$/, '') if name =~ /\.git$/
+      name
+    end
+    
+    # Serialize the plugin to Hash format.
+    def to_hash
+      { self.guess_name => 
+        { 'type' => repository.scm_type,
+          'summary' => self.summary } }
+    end
+    
+    class << self
+      # List all installed plugins.
+      def list
+        AbstractRepository.list
+      end
+    end
+        
+  private
+    # Instantiate the repository.
+    # Look at <tt>AbstractRepository#instantiate_repository</tt> documentation.
+    def instantiate_repository
+      AbstractRepository.instantiate_repository(self)
+    end      
+  end
+end

data/lib/sashimi/repositories/abstract_repository.rb

@@ -0,0 +1,231 @@
+module Sashimi
+  class PluginNotFound < StandardError #:nodoc:
+    def initialize(plugin_name, message = nil)
+      @plugin_name = plugin_name
+      @message     = message
+    end
+
+    def to_s
+      @message || @plugin_name + " isn't in the local repository."
+    end
+  end
+  
+  class AbstractRepository
+    @@local_repository_sub_path = File.join('.rails', 'plugins')
+    @@cache_file = '.plugins'
+    attr_accessor :plugin
+    
+    def initialize(plugin)
+      self.plugin = plugin
+    end
+    
+    # Remove the repository
+    def uninstall
+      change_dir_to_local_repository
+      raise PluginNotFound.new(plugin.name) unless File.exists?(plugin.name)
+      FileUtils.rm_rf(plugin.name)
+      remove_from_cache
+    end
+    
+    # Add to a Rails app.
+    def add
+      puts plugin.name.titleize + "\n"
+      copy_plugin_to_rails_app
+      remove_hidden_folders
+      run_install_hook
+    end
+       
+    class << self
+      def instantiate_repository(plugin)
+        unless plugin.name.nil?
+          instantiate_repository_by_cache(plugin)
+        else
+          instantiate_repository_by_url(plugin)
+        end.new(plugin)
+      end
+
+      # Return all installed plugin names
+      def list
+        cache_content.sort.collect do |plugin, contents|
+          "#{plugin}\t\t#{contents['summary']}"
+        end.join("\n")
+      end
+
+      def local_repository_path #:nodoc:
+        @local_repository_path ||= File.join(find_home, @@local_repository_sub_path) 
+      end
+
+      def cache_file #:nodoc:
+        @@cache_file
+      end
+
+      # Return the path to the Rails app where the user launched sashimi command.
+      def path_to_rails_app
+        $rails_app
+      end
+
+      # Read the cache file and return the content as an <tt>Hash</tt>.
+      def cache_content
+        change_dir_to_local_repository
+        @@cache_content ||= (YAML::load_file(cache_file) || {}).to_hash
+      end
+
+      def instantiate_repository_by_url(plugin)
+        git_url?(plugin.url) ? GitRepository : SvnRepository
+      end
+
+      def instantiate_repository_by_cache(plugin)
+        cached_plugin = cache_content[plugin.name]
+        raise PluginNotFound.new(plugin.name) if cached_plugin.nil?
+        cached_plugin['type'] == 'git' ? GitRepository : SvnRepository
+      end
+
+      # Changes the current directory with the given one
+      def change_dir(dir)
+        FileUtils.cd(dir)
+      end
+      
+      # Change the current directory with local_repository_path
+      def change_dir_to_local_repository
+        change_dir(local_repository_path)
+      end
+      
+      # Rails app plugins dir
+      def plugins_dir
+        @@plugins_dir ||= File.join('vendor', 'plugins')
+      end
+      
+      # Find the user home directory
+      def find_home
+        ['HOME', 'USERPROFILE'].each do |homekey|
+          return ENV[homekey] if ENV[homekey]
+        end
+        if ENV['HOMEDRIVE'] && ENV['HOMEPATH']
+          return "#{ENV['HOMEDRIVE']}:#{ENV['HOMEPATH']}"
+        end
+        begin
+          File.expand_path("~")
+        rescue StandardError => ex
+          if File::ALT_SEPARATOR
+            "C:/"
+          else
+            "/"
+          end
+        end
+      end
+      
+      # Try to guess if it's a Git url.
+      def git_url?(url)
+        url =~ /^git:\/\// || url =~ /\.git$/
+      end
+    end
+
+    # Return the SCM type
+    #
+    #   Subversion   # => svn
+    #   Git          # => git
+    def scm_type
+      self.class.name.demodulize.gsub(/Repository$/, '').downcase
+    end
+    
+    # Read the content of the <tt>about.yml</tt>.
+    # New feature of Rails 2.1.x http:://dev.rubyonrails.org/changeset/9098
+    def about
+      change_dir_to_plugin_path
+      return {} unless File.exists?('about.yml')
+      (YAML::load_file('about.yml') || {}).to_hash
+    end
+    
+  private
+    # Proxy for <tt>AbstractRepository#change_dir</tt>
+    def change_dir(dir)
+      self.class.change_dir(dir)
+    end
+    
+    # Proxy for <tt>AbstractRepository#change_dir_to_local_repository</tt>
+    def change_dir_to_local_repository
+      self.class.change_dir_to_local_repository
+    end
+    
+    # Change the current directory with the plugin one
+    def change_dir_to_plugin_path
+      change_dir(File.join(local_repository_path, plugin.name || plugin.guess_name))
+    end
+
+    # Proxy for <tt>AbstractRepository#local_repository_path</tt>
+    def local_repository_path
+      self.class.local_repository_path
+    end
+    
+    # Proxy for <tt>AbstractRepository#cache_file</tt>
+    def cache_file
+      self.class.cache_file
+    end
+    
+    # Proxy for <tt>AbstractRepository#cache_content</tt>
+    def cache_content
+      self.class.cache_content
+    end
+    
+    # Proxy for <tt>AbstractRepository#plugins_dir</tt>
+    def plugins_dir
+      self.class.plugins_dir
+    end
+    
+    # Proxy for <tt>AbstractRepository#path_to_rails_app</tt>
+    def path_to_rails_app
+      self.class.path_to_rails_app
+    end
+    
+    # Prepare the plugin installation
+    def prepare_installation
+      FileUtils.mkdir_p(local_repository_path)
+      change_dir_to_local_repository
+      FileUtils.touch(cache_file)
+    end
+    
+    # Add a plugin into the cache
+    def add_to_cache(plugin)
+      write_to_cache cache_content.to_hash.merge!(plugin)
+    end
+
+    # Remove a plugin from the cache
+    def remove_from_cache
+      cache_content.delete(plugin.name)
+      write_to_cache cache_content
+    end
+
+    # Write all the plugins into the cache
+    def write_to_cache(plugins)
+      change_dir_to_local_repository
+      FileUtils.mv(cache_file, "#{cache_file}-backup")
+      File.open(cache_file, 'w'){|f| f.write(plugins.to_yaml)}
+      FileUtils.rm("#{cache_file}-backup")
+    end
+    
+    # Copy a plugin to a Rails app.
+    def copy_plugin_to_rails_app
+      change_dir(path_to_rails_app)
+      FileUtils.mkdir_p(plugins_dir)
+      FileUtils.cp_r(File.join(local_repository_path, plugin.name), File.join(plugins_dir, plugin.name))
+    end
+    
+    # Remove SCM hidden folders.
+    def remove_hidden_folders
+      require 'find'
+      change_dir(File.join(path_to_rails_app, plugins_dir, plugin.name))
+      Find.find('./') do |path|
+        if File.basename(path) == '.'+scm_type
+          FileUtils.remove_dir(path, true)
+          Find.prune
+        end
+      end
+    end
+    
+    # Run the plugin install hook.
+    def run_install_hook
+      install_hook_file = File.join(plugins_dir, plugin.name, 'install.rb')
+      load install_hook_file if File.exist? install_hook_file
+    end
+  end
+end

data/lib/sashimi/repositories/git_repository.rb

@@ -0,0 +1,16 @@
+module Sashimi
+  class GitRepository < AbstractRepository
+    def install
+      prepare_installation
+      puts plugin.guess_name.titleize + "\n\n"
+      system("git clone #{plugin.url}")
+      add_to_cache(plugin.to_hash)
+    end
+    
+    def update
+      puts plugin.name.titleize + "\n\n"
+      change_dir_to_plugin_path
+      system('git pull')
+    end
+  end
+end

data/lib/sashimi/repositories/svn_repository.rb

@@ -0,0 +1,16 @@
+module Sashimi
+  class SvnRepository < AbstractRepository
+    def install
+      prepare_installation
+      puts plugin.guess_name.titleize + "\n\n"
+      system("svn co #{plugin.url} #{plugin.guess_name}")
+      add_to_cache(plugin.to_hash)
+    end
+    
+    def update
+      puts plugin.name.titleize + "\n\n"
+      change_dir_to_plugin_path
+      system("svn up")
+    end
+  end
+end