vimget 0.1.1 → 0.1.3

data/README

@@ -1,6 +1,21 @@
 = VimGet
 == A vim script management tool
 
+=== Basic Usage
 
+After you first time installing the vimget, there is not any script information 
+in your local cache. So you need install a new script by its id. 
+
+For example, if you need install taglist (for the first time), you need enter:
+
+<i>$ vim-get install --id 273</i>
+
+To remove one script:
+
+<i>$ vim-get uninstall taglist.vim</i>
+
+Sync local script version database with vim site:
+
+<i>$ vim-get sync</i>
 
 Author::  Eddy Xu (mailto:eddyxu@gmail.com)

data/doc/vim-get.1

@@ -0,0 +1,16 @@
+.TH vim-get 1 "20 April 2008"
+.SH NAME
+vim\-get \- Vim Script Manager
+.SH SYNOPSIS
+.B vim\-get [options] 
+.I command 
+.B [args]
+.SH DESCRITPION
+vim-get is a vim script manager. It can automatically track the newest version of vim plugin scripts, 
+install and upgrade them.
+
+For more informations, use "vim-get help".
+.SH ALSO
+vim(1)
+.SH AUTHOR
+Eddy Xu <eddyxu@gmail.com>

data/lib/vimget/command.rb

@@ -7,7 +7,7 @@
 # License:: Distributed under BSD License
 # Copyright:: Copyright 2008 (c) Quarkare.com (http://www.quarkware.com)
 #
-# $Id: command.rb 8 2008-04-12 12:47:35Z eddyxu $
+# $Id: command.rb 10 2008-04-20 18:04:04Z eddyxu $
 #
 
 require 'optparse'
@@ -90,14 +90,20 @@ module VimGet
       @rest.shift
     end
     
+    # return a array of arguments anc clean the @rest
+    def fetch_arguments
+      ret = @rest.dup
+      @rest.clear
+      ret
+    end
+    
     private
     
     def handle_options(args)
       @rest = parser.parse(*args)
       @options[:args] = args
-      
       # remove the operation name
-      @rest.shift if @rest.first == @program_name
+      @rest.shift if @rest.first == @command
     end
     
     # singleton entry for OptionParser

data/lib/vimget/commands/clean_command.rb

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 #
-# File:         clean_command.rb
+# =Clean Command
+# This clean command will delete all distributed files
 #
-# Brief:        clean command
+# Author::  Eddy Xu  (mailto:eddyxu@gmail.com)
+# License::  Distributed under BSD License
+# Copyright:: 2008 (c) Quarkware.com (http://www.quarkware.com)
 #
-# Author:       Eddy Xu <eddyxu@gmail.com>
-# 
-# Copyright:    2008 (c) Quarkware.com
-#
-# $Id: clean_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: clean_command.rb 11 2008-05-17 17:47:35Z eddyxu $
 #
 
 require "vimget/command"

data/lib/vimget/commands/install_command.rb

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 #
-# File:         install_command.rb
+# =Install Command
+#  Command to install a script or scripts
 #
-# Brief:        install command
+# Author::  Eddy Xu (mailto:eddyxu@gmail.com)
+# License::  Distributed under BSD License
+# Copyright::   2008 (c) Quarkware.com (http://www.quarkware.com)
 #
-# Author:       Eddy Xu <eddyxu@gmail.com>
-# 
-# Copyright:    2008 (c) Quarkware.com
-#
-# $Id: install_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: install_command.rb 11 2008-05-17 17:47:35Z eddyxu $
 #
 
 require "vimget/command"
@@ -45,16 +44,13 @@ module VimGet
             VimGet.db.add(script)
           end
         else
-          @rest.shift if @rest.first == "install"
-          if @rest.empty?
-            raise CommandLineError, "Missing arguments"
+          script_name = fetch_one_argu
+          if script_name.nil?
+            raise CommandLineError, "You must indicate one script to install."
           end
+          script = VimGet.db.find(script_name)
           
-          name = @rest.first
-          
-          script = VimGet.db.find(name)
-          
-          raise UnknownScriptError, "Unknow script!" if script.nil?
+          raise UnknownScriptError, "Unknow script! (Perhaps you need install it by indicate its id)" if script.nil?
         end
         
         installer = Installer.new(@options)

data/lib/vimget/commands/installed_command.rb

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 #
-# File:         installed_command.rb
+# =Installed Command
+#  List out all installed commands
 #
-# Brief:        installed command
+# Author::  Eddy Xu (mailto:eddyxu@gmail.com)
+# License::  Distributed under BSD License
+# Copyright::  2008 (c) Quarkware.com (http://www.quarkware.com)
 #
-# Author:       Eddy Xu <eddyxu@gmail.com>
-# 
-# Copyright:    2008 (c) Quarkware.com
-#
-# $Id: installed_command.rb 6 2008-04-11 19:01:26Z eddyxu $
+# $Id: installed_command.rb 11 2008-05-17 17:47:35Z eddyxu $
 #
 
 require "vimget/commands/list_command"

data/lib/vimget/commands/list_command.rb

@@ -2,10 +2,11 @@
 #
 # list command
 #
-# $Id: list_command.rb 7 2008-04-11 22:48:50Z eddyxu $
+# $Id: list_command.rb 10 2008-04-20 18:04:04Z eddyxu $
 
 require "vimget/command"
-require "vimget/db.rb"
+require "vimget/db"
+require 'vimget/output'
 
 module VimGet
   module Commands
@@ -19,43 +20,25 @@ module VimGet
         add_customer_options
       end
       
-      def usage
-        "#{program_name} [STRING]"
-      end
-      
       def execute
         raise CommandLineError, "Ambiguous command!" if @options[:outdated] && @options[:installed]
           
         if @options[:outdated]
-          puts "List outdated scripts"
           scripts = VimGet.db.outdated_scripts
         elsif @options[:installed]
-          puts "List installed scripts"
           scripts = VimGet.db.installed_scripts
         else
-          puts "List scripts"
           scripts = VimGet.db.search
         end
        
-        scripts.each do |s|
-          if @options[:format] == "plain"
-            puts "[#{s.name}]"
-            puts "id: #{s.sid}"
-            puts "author: #{s.author}"
-            puts "installed: #{s.installed}"
-            puts "version: #{s.version}"
-            puts
-          #elsif @options[:format] == "xml"
-          #  puts "<script name=\"#{s.name}\" id=\"#{s.sid}\">"
-          #  puts "</script>"
-          end
-        end
+        outputer = Output.new(@options[:format])
+        outputer.short(scripts)
       end
       
       private
       
       def add_customer_options
-        #add_option(:list, '--xml', 'Display in XML Format') { |v,opts| opts[:format] = "xml" }
+        add_option(:list, '--xml', 'Display in XML Format') { |v,opts| opts[:format] = "xml" }
         add_option(:list, '-o', '--outdated', 'List all outdated scripts') {|v,opts| opts[:outdated] = v}
         add_option(:list, '-i', '--installed', 'List all installed scripts') {|v,opts| opts[:installed] = v}
       end

data/lib/vimget/commands/outdated_command.rb

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 #
-# File:         outdated_command.rb
+# =Outdated Command
+# list out all outdated scripts
 #
-# Brief:        outdated command
+# Author::  Eddy Xu (mailto:eddyxu@gmail.com)
+# License::  Distributed under BSD License
+# Copyright::  2008 (c) Quarkware.com (http://www.quarkware.com)
 #
-# Author:       Eddy Xu <eddyxu@gmail.com>
-# 
-# Copyright:    2008 (c) Quarkware.com
-#
-# $Id: outdated_command.rb 6 2008-04-11 19:01:26Z eddyxu $
+# $Id: outdated_command.rb 11 2008-05-17 17:47:35Z eddyxu $
 #
 
 require "vimget/commands/list_command"
@@ -17,6 +16,7 @@ module VimGet
   
   module Commands
     
+    # List all outdated command
     class OutdatedCommand < ListCommand
       def initialize
         super("outdated", "Display all outdated scripts")

data/lib/vimget/commands/uninstall_command.rb

@@ -8,7 +8,7 @@
 #
 # Copyright   2008 (c) Quarkware.com
 #
-# $Id: uninstall_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: uninstall_command.rb 10 2008-04-20 18:04:04Z eddyxu $
 
 require "vimget/command"
 require "vimget/db"
@@ -23,11 +23,6 @@ module VimGet
       def initialize
         super("uninstall", "Uninstall a script")
         
-        add_option("-i", 
-              "--id ID", 
-              Integer, 
-              "Indicated the id of script to uninstall")  { |v,opts| opts[:uninstall_id] = v }
-        
         add_option('--purge', 
             'Remove all associated files, including vim-get manifest') { |v,opts| opts[:purge] = v }
             
@@ -35,23 +30,25 @@ module VimGet
             'Do not motify any files') { |v,opts| opts[:dry_run] = v }
       end
       
+      def usage
+        "#{@program_name} SCRIPT [SCRIPT ...] "
+      end
+      
+      def arguments
+        "SCRIPT\t\tname of script to uninstall"
+      end
+      
       def execute
-        if @options[:uninstall_id]
-          script = VimGet.db.find_with_id(@options[:uninstall_id])
-        else
-          @rest.shift if @rest.first == "uninstall"
-          raise CommandLineError, "Missing arguments" if @rest.empty?
-          
-          name = @rest.first
-          script = VimGet.db.find(name)
-        end
-        
-        if script.nil?
-          raise UnknownScriptError, "This script is not installed yet." 
-        end
+        args = fetch_arguments
+        raise CommandLineError, "You must indicate one script at least to uninstall." if args.empty?
         
         installer = Installer.new(@options)
-        installer.uninstall(script)
+        args.each do |name|
+          script = VimGet.db.find(name)
+          raise UnknownScriptError, "This script is not installed yet." if script.nil?
+          
+          installer.uninstall(script)
+        end
       end
     end
   end

data/lib/vimget/commands/upgrade_command.rb

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 #
-# File:         upgrade_command.rb
+# =Upgrade Command
+#  Perform upgrading operation
 #
-# Brief:        perform upgrading operation
+# Author::  Eddy Xu (mailto:eddyxu@gmail.com)
+# License::  Distributed under BSD License
+# Copyright:: 2008 (c) Quarkware.com (http://www.quarkware.com)
 #
-# Author:       Eddy Xu <eddyxu@gmail.com>
-#
-# Copyright:    2008 (c) Quarkware.com
-#
-# $Id: upgrade_command.rb 7 2008-04-11 22:48:50Z eddyxu $
+# $Id: upgrade_command.rb 11 2008-05-17 17:47:35Z eddyxu $
 #
 
 require "vimget/command"
@@ -23,7 +22,17 @@ module VimGet
         super('upgrade', 'upgrade outdated script(s)')
       end
       
+      def usage
+        "#{@program_name} [SCRIPT SCRIPT...]"
+      end
+      
+      def arguments
+        "SCRIPT  the name of script to upgrade"
+      end
+      
+      # do the upgrading action
       def execute
+        args = fetch_arguments
         outdated_scripts = VimGet.db.outdated_scripts
         
         if outdated_scripts.empty? 

data/lib/vimget/db.rb

@@ -2,7 +2,7 @@
 #
 # manage local script index database
 #
-# $Id: db.rb 7 2008-04-11 22:48:50Z eddyxu $
+# $Id: db.rb 10 2008-04-20 18:04:04Z eddyxu $
 
 require "vimget/configure"
 require "vimget/script"
@@ -93,7 +93,9 @@ manifest {
     end
   
     def find(name)
-      search(name).first
+      path = abs_file(name)
+      return parse_script(path) if File.exist? path
+      return nil
     end
     
     def outdated_scripts
@@ -141,6 +143,10 @@ manifest {
     def db_file(script)
       File.expand_path(File.join(@db_path, script.name + @@EXT))
     end
+    
+    def abs_file(name)
+      File.expand_path(File.join(@db_path, name + @@EXT))
+    end
   end
 
 end

data/lib/vimget/installer.rb

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby 
 #
-# File    installer.rb
+# Act the install operations
 #
-# Brief   act the install operations
+# Author::  Eddy Xu <eddyxu@gmail.com>
+# Copyright::   2008 (c) Quarkware.com
+# License:: Distributed under BSD License
 #
-# Author  Eddy Xu <eddyxu@gmail.com>
-#
-# Copyright   2008 (c) Quarkware.com
-#
-# $Id: installer.rb 6 2008-04-11 19:01:26Z eddyxu $
+# $Id: installer.rb 13 2008-08-14 08:31:49Z eddyxu $
 
 require 'fileutils'
 require 'open-uri'
@@ -26,6 +24,7 @@ module VimGet
       FileUtils.mkdir_p(@dist_path) if not File.exist? @dist_path
     end
 
+    # Install a script
     def install(script)
       filepath = fetch(script)
       script.manifest = extract(filepath)
@@ -34,6 +33,7 @@ module VimGet
       VimGet.db.update(script) unless @options[:dry_run]
     end
 
+    # Uninstall one script
     def uninstall(script)
       puts "#{script.name} is not installed yet.";return if !script.installed?
       
@@ -145,11 +145,16 @@ module VimGet
     def remove_manifest(script)
       script.manifest.each do |f|
         abs_path = absolute_vim_path(f)
-        print "  Deleting #{abs_path}..." if @options[:verbose]
+        print "  Deleting #{abs_path}..." if @options[:verbose] or @options[:debug]
         if not File.exist?(abs_path)
           puts "Missing!" if @options[:verbose]
           next
         end
+        
+        if File.directory?(abs_path) 
+          next
+        end
+        
         File.delete(abs_path) unless @options[:dry_run]
         puts "Ok" if @options[:verbose]
       end

data/lib/vimget/output.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby 
+# 
+# Generate output in customize format
+#
+# Author:: Eddy Xu (mailto:eddyxu@gmail.com)
+# License::  Distributed under BSD License
+# Copyright:: 2008 (c) Quarkware.com
+#
+# $Id: output.rb 10 2008-04-20 18:04:04Z eddyxu $
+
+module VimGet
+  
+  # Output information in special format
+  # Supported format: plain, xml, (rss)
+  class Output
+    attr_reader :format
+    def initialize(format = "plain")
+      @format = format
+    end
+    
+    def short(script_array)
+      if @format == "plain"
+        script_array.each do |s|
+          if s.installed?
+            ver = "#{s.version} (#{s.installed})"
+          else
+            ver = "#{s.version}"
+          end
+          printf("%-30s %-10s\n", s.name, ver)
+        end
+      elsif @format == "xml"
+        # simply implement
+        puts "<scripts>"
+        script_array.each do |s|
+          puts "  <script name='#{s.name}' version='#{s.version}' installed='#{s.installed}'/>"
+        end
+        puts "</scripts>"
+        
+      else
+        
+      end
+    end
+    
+    def long(script_array)
+      if @format == "plain"
+        script_array.each do |s|
+          puts "[#{s.name}]"
+          puts ""
+        end
+      end
+    end
+    
+    def detail(script)
+      
+    end
+  end
+end

data/lib/vimget.rb

@@ -6,13 +6,13 @@
 # License::   Distributed under BSD License
 # Copyright:: Copyright (c) 2008 Quarkware.com
 #
-# $Id: vimget.rb 8 2008-04-12 12:47:35Z eddyxu $
+# $Id: vimget.rb 13 2008-08-14 08:31:49Z eddyxu $
 
 require 'fileutils'
 require "vimget/command_manager"
 require "vimget/configure"
 
-VIMGET_VERSION = "0.1.1"
+VIMGET_VERSION = "0.1.3"
 
 module VimGet
   

data/test/tc_command.rb

@@ -2,21 +2,44 @@
 #
 # test case for command.rb
 #
-# author: Eddy Xu <eddyxu@gmail.com>
+# Author: Eddy Xu <eddyxu@gmail.com>
+# Copyright: 2008 (c) Quarkware.com
 #
-# $Id: tc_command.rb 8 2008-04-12 12:47:35Z eddyxu $
+# $Id: tc_command.rb 9 2008-04-15 21:29:01Z eddyxu $
 
 require 'test/unit'
 require 'vimget/command'
 
+class TestCommand < VimGet::BaseCommand
+  def initialize
+    super('test', 'a simulator command for test purpose')
+  end
+  
+  def execute
+  end
+end
+
 class CommandTest < Test::Unit::TestCase
+  
   def setup
+    @cmd = TestCommand.new
   end
   
   def teardown
     
+  end
+  
+  def test_common
+    base_command = VimGet::BaseCommand.new('base')
+    # call underfined execute in base class
+    assert_raise(RuntimeError) { 
+        base_command.execute
+       }
+       
+    
   end
   
   def test_parse_option
+    
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vimget
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Eddy Xu
@@ -9,7 +9,7 @@ autorequire: vimget
 bindir: bin
 cert_chain: []
 
-date: 2008-04-12 00:00:00 +08:00
+date: 2008-08-14 00:00:00 +08:00
 default_executable: 
 - vim-get
 dependencies: 
@@ -53,12 +53,14 @@ files:
 - lib/vimget/db.rb
 - lib/vimget/exceptions.rb
 - lib/vimget/installer.rb
+- lib/vimget/output.rb
 - lib/vimget/script.rb
 - lib/vimget/webparser.rb
 - lib/vimget.rb
+- doc/vim-get.1
 - README
 has_rdoc: true
-homepage: http://www.xulei.org/projects/vimget
+homepage: https://rubyforge.org/projects/vimget/
 post_install_message: 
 rdoc_options: []
 
@@ -78,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.1.1
+rubyforge_project: vimget
+rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: An vim script tool