jodosha-sashimi 0.1.0 → 0.1.5

data/CHANGELOG

@@ -1,3 +1,25 @@
+* Prepare for v0.1.5
+
+* Raise a PluginNotFound exception if try to update a not existent plugin for the current Rails app
+
+* Updated command line syntax reference in README
+
+* Automatically schedule for SCM add and remove on plugin update, for Rails apps versioned with Svn and Git
+
+* Added --rails option to the Update command in order to update plugins already added to a Rails app [#12 state:resolved]
+
+* Added --rails option to the Install command as alias for the Add command [#11 state:resolved]
+
+* Added --all option to the Update command in order to update all installed plugins with one command [#2 state:resolved]
+
+
+
+* *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

data/README

@@ -29,11 +29,17 @@ $ sashimi uninstall continuous_builder
 Update a plugin:
 $ sashimi update click-to-globalize
 
+Update a plugin of a Rails app:
+$ sashimi update --rails click-to-globalize
+
+NOTE: If your application is versioned with Svn or Git, Sashimi will automatically schedules for add/remove the added/removed files.
+
 List all installed plugins:
 $ sashimi list
 
 Add installed plugin(s) to a Rails app:
 $ sashimi add click-to-globalize
+$ sashimi install --rails click-to-globalize
 
 
 

data/lib/sashimi/commands.rb

@@ -24,9 +24,9 @@ module Sashimi
           o.separator ""
           o.separator "COMMANDS"
 
-          o.separator "  install        Install plugin from known URL."
-          o.separator "  uninstall      Uninstall plugin from local repository."
-          o.separator "  update         Update an installed plugin."
+          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."
 
@@ -40,10 +40,16 @@ module Sashimi
           o.separator "    #{@script_name} uninstall continuous_builder\n"
           o.separator "  Update a plugin:"
           o.separator "    #{@script_name} update click-to-globalize\n"
+          o.separator "  Update all installed plugins:"
+          o.separator "    #{@script_name} update --all\n"
+          o.separator "  Update plugin(s) already added to a Rails app:"
+          o.separator "    #{@script_name} update --rails 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"
+          o.separator "  Add installed plugin(s) to a Rails app:"
+          o.separator "    #{@script_name} install --rails click-to-globalize\n"
         end
       end
 
@@ -79,35 +85,40 @@ module Sashimi
     
     class Install
       def initialize(base_command)
-        @base_command = 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"
-          o.define_head "Install a plugin."
+          o.banner =    "Usage: #{@base_command.script_name} install [OPTIONS] URL [URL2, URL3]"
+          o.define_head "Install plugin(s) from known URL(s)."
+          o.on("-r", "--rails", "Install the plugin(s) in a Rails app.") { |@rails| }
         end
       end
       
       def parse!(args)
         options.parse!(args)
-        args.each do |url|
-          Plugin.new(nil, url).install
+        args.each do |url_or_name|
+          if @rails
+            Plugin.new(url_or_name).add
+          else
+            Plugin.new(nil, url_or_name).install
+          end
         end
       end
     end
   
     class Uninstall
       def initialize(base_command)
-        @base_command = 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"
-          o.define_head "Remove an installed plugin."
+          o.banner =    "Usage: #{@base_command.script_name} uninstall PLUGIN [PLUGIN2, PLUGIN3]"
+          o.define_head "Uninstall plugin(s) from local repository."
         end
       end
       
@@ -121,42 +132,34 @@ module Sashimi
     
     class Update
       def initialize(base_command)
-        @base_command = 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"
-          o.define_head "Update an installed plugin."
+          o.banner =    "Usage: #{@base_command.script_name} update [OPTIONS] PLUGIN [PLUGIN2, PLUGIN3]"
+          o.define_head "Update installed plugin(s)."
+          o.on("-a", "--all", "Update all installed plugins.") { |@all| }
+          o.on("-r", "--rails", "Install the plugin(s) in a Rails app.") { |@rails| }
         end
       end
       
       def parse!(args)
         options.parse!(args)
-        args.each do |name|
-          Plugin.new(name).update
-        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"
-          o.define_head "Remove an installed plugin."
+        raise "Can't use both --all and --rails arguments." if @all and @rails
+        if @all
+          update_plugins(AbstractRepository.plugins_names)
+        elsif @rails
+          AbstractRepository.update_rails_plugins(args)
+        else
+          update_plugins(args)
         end
       end
       
-      def parse!(args)
-        options.parse!(args)
-        args.each do |name|
-          Plugin.new(name).uninstall
+      def update_plugins(plugins)
+        plugins.each do |plugin|
+          Plugin.new(plugin).update
         end
       end
     end

data/lib/sashimi/repositories/abstract_repository.rb

@@ -29,11 +29,18 @@ module Sashimi
     
     # Add to a Rails app.
     def add
-      copy_plugin_to_rails_app
-      remove_hidden_folders
+      puts plugin.name.titleize + "\n"
+      copy_plugin_and_remove_hidden_folders
+      rename_temp_folder
       run_install_hook
     end
-       
+
+    # Copy a plugin to a Rails app and remove SCM hidden folders
+    def copy_plugin_and_remove_hidden_folders
+      copy_plugin_to_rails_app
+      remove_hidden_folders      
+    end
+
     class << self
       def instantiate_repository(plugin)
         unless plugin.name.nil?
@@ -43,13 +50,69 @@ module Sashimi
         end.new(plugin)
       end
 
-      # Return all installed plugin names
+      # Return all installed plugin names and summary, formatted for stdout.
       def list
         cache_content.sort.collect do |plugin, contents|
           "#{plugin}\t\t#{contents['summary']}"
         end.join("\n")
       end
 
+      # Return all installed plugins names.
+      def plugins_names
+        cache_content.keys.sort
+      end
+
+      # Update the plugins installed in a rails app.
+      def update_rails_plugins(plugins_names)
+        change_dir(path_to_rails_app)
+        if under_version_control?
+          update_versioned_rails_plugins(plugins_names)
+        else
+          update_unversioned_rails_plugins(plugins_names)
+        end
+      end
+
+      # Update the plugins installed in a non versioned rails app.
+      def update_unversioned_rails_plugins(plugins_names)
+        change_dir(plugins_dir)
+        plugins_names.each do |plugin_name|
+          FileUtils.rm_rf(plugin_name)
+          Plugin.new(plugin_name).add
+        end
+      end
+
+      # Update the plugins installed in a versioned rails app.
+      def update_versioned_rails_plugins(plugins_names)
+        change_dir(plugins_dir)
+        plugins_names.each do |plugin_name|
+          raise PluginNotFound.new(plugin_name) unless File.exists?(plugin_name)
+          repository = Plugin.new(plugin_name).repository
+          repository.copy_plugin_and_remove_hidden_folders
+          files_scheduled_for_remove = repository.files_scheduled_for_remove
+          files_scheduled_for_add    = repository.files_scheduled_for_add
+          FileUtils.cp_r(plugin_name+'-tmp/.', plugin_name)
+          repository.remove_temp_folder
+          change_dir(plugin_name)
+          files_scheduled_for_remove.each {|file| scm_remove file}
+          files_scheduled_for_add.each {|file| scm_add file}
+        end
+      end
+
+      # Schedules an add for the given file on the current SCM system used by the Rails app.
+      def scm_add(file)
+        scm_command(:add, file)
+      end
+
+      def scm_remove(file)
+        scm_command(:rm, file)
+      end
+
+      # Execute the given command for the current SCM system used by the Rails app.
+      def scm_command(command, file)
+        scm = guess_version_control_system
+        system("#{scm} #{command} #{file}")
+      end
+
       def local_repository_path #:nodoc:
         @local_repository_path ||= File.join(find_home, @@local_repository_sub_path) 
       end
@@ -89,11 +152,27 @@ module Sashimi
         change_dir(local_repository_path)
       end
       
+      # Change the current directory with the fully qualified
+      # path to Rails app and plugins_dir.
+      def change_dir_to_absolute_plugins_dir
+        change_dir(File.join(File.expand_path(path_to_rails_app), plugins_dir))
+      end
+      
       # Rails app plugins dir
       def plugins_dir
         @@plugins_dir ||= File.join('vendor', 'plugins')
       end
       
+      # Check if the current working directory is under version control
+      def under_version_control?
+        !Dir.glob(".{git,svn}").empty?
+      end
+      
+      # Guess the version control system for the current working directory.
+      def guess_version_control_system
+        File.exists?('.git') ? :git : :svn
+      end
+      
       # Find the user home directory
       def find_home
         ['HOME', 'USERPROFILE'].each do |homekey|
@@ -134,6 +213,26 @@ module Sashimi
       return {} unless File.exists?('about.yml')
       (YAML::load_file('about.yml') || {}).to_hash
     end
+
+    # Returns a list of files that should be scheduled for SCM add.
+    def files_scheduled_for_add
+      change_dir_to_absolute_plugins_dir
+      Dir[plugin.name+"-tmp/**/*"].collect {|fn| fn.gsub(plugin.name+'-tmp', '.')} -
+        Dir[plugin.name+"/**/*"].collect{|fn| fn.gsub(plugin.name, '.')}
+    end
+    
+    # Returns a list of files that should be scheduled for SCM remove.
+    def files_scheduled_for_remove
+      change_dir_to_absolute_plugins_dir
+      Dir[plugin.name+"/**/*"].collect {|fn| fn.gsub(plugin.name, '.')} -
+        Dir[plugin.name+"-tmp/**/*"].collect {|fn| fn.gsub(plugin.name+"-tmp", '.')}
+    end
+    
+    # Remove the temp folder, used by update process.
+    def remove_temp_folder
+      change_dir_to_absolute_plugins_dir
+      FileUtils.rm_rf(plugin.name+'-tmp')
+    end
     
   private
     # Proxy for <tt>AbstractRepository#change_dir</tt>
@@ -146,6 +245,11 @@ module Sashimi
       self.class.change_dir_to_local_repository
     end
     
+    # Proxy for <tt>AbstractRepository#change_dir_to_absolute_plugins_dir</tt>
+    def change_dir_to_absolute_plugins_dir
+      self.class.change_dir_to_absolute_plugins_dir
+    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))
@@ -206,13 +310,22 @@ module Sashimi
     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))
+      FileUtils.cp_r(File.join(local_repository_path, plugin.name), File.join(plugins_dir, plugin.name+'-tmp'))
+    end
+    
+    # Rename the *-tmp folder used by the installation process.
+    #
+    # Example:
+    #   click-to-globalize-tmp # => click-to-globalize
+    def rename_temp_folder
+      change_dir(path_to_rails_app)
+      FileUtils.mv(File.join(plugins_dir, plugin.name+'-tmp'), 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))
+      change_dir(File.join(path_to_rails_app, plugins_dir, plugin.name+'-tmp'))
       Find.find('./') do |path|
         if File.basename(path) == '.'+scm_type
           FileUtils.remove_dir(path, true)

data/lib/sashimi/repositories/git_repository.rb

@@ -2,11 +2,13 @@ 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

data/lib/sashimi/repositories/svn_repository.rb

@@ -2,11 +2,13 @@ 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

data/sashimi.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name               = "sashimi"
-  s.version            = "0.1.0"
-  s.date               = "2008-05-19"
+  s.version            = "0.1.5"
+  s.date               = "2008-05-20"
   s.summary            = "Rails plugins manager"
   s.author             = "Luca Guidi"
   s.email              = "guidi.luca@gmail.com"

data/test/unit/repositories/abstract_repository_test.rb

@@ -44,6 +44,12 @@ class AbstractRepositoryTest < Test::Unit::TestCase
     end
   end
   
+  def test_should_return_all_installed_plugins_names
+    initialize_repository_for_test do
+      assert_equal(['plug-in', 'plugin'], AbstractRepository.plugins_names)
+    end
+  end
+  
   # DIRECTORIES
   def test_should_change_current_dir
     repository.change_dir(repository.class.find_home)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jodosha-sashimi
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors: 
 - Luca Guidi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-19 00:00:00 -07:00
+date: 2008-05-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency