vimget 0.1.0 → 0.1.1

data/README

@@ -0,0 +1,6 @@
+= VimGet
+== A vim script management tool
+
+
+
+Author::  Eddy Xu (mailto:eddyxu@gmail.com)

data/lib/vimget/command.rb

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 #
-# @file   command.rb
+# =Base class for command object.
+# Parse options and invoke inherited execute function
 #
-# @breif  parser and manager commands
+# Author:: Eddy Xu (mailto:eddyxu@gmail.com)
+# License:: Distributed under BSD License
+# Copyright:: Copyright 2008 (c) Quarkare.com (http://www.quarkware.com)
 #
-# @author Eddy Xu <eddyxu@gmail.com>
-#
-# Copyright 2008 by xulei.org
-#
-# $Id: command.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: command.rb 8 2008-04-12 12:47:35Z eddyxu $
 #
 
 require 'optparse'
@@ -16,7 +15,7 @@ require "vimget/configure"
 
 module VimGet
   
-  # base class for all commands
+  # base class for all commands, providing fundamental functions for command
   class BaseCommand
     PROGRAM = "vim-get"
     # the name of command
@@ -25,6 +24,7 @@ module VimGet
     # the options for this command
     attr_reader :options
     
+    # divide options into named groups
     attr_reader :options_group
     
     # the default options for the command
@@ -53,6 +53,7 @@ module VimGet
       puts @parser
     end
     
+    # return a argument string 
     def arguments
       ""
     end
@@ -66,6 +67,7 @@ module VimGet
       end
     end
     
+    # interface for all sub class, must implement this function!
     def execute
       raise 'Command without define execute function'
     end
@@ -83,9 +85,9 @@ module VimGet
       end                                                                   
     end
     
-    def pop_one_argument
-      return nil if @rest.empty?
-      return @rest.shift
+    # fetch one argument from argument list
+    def fetch_one_argu
+      @rest.shift
     end
     
     private
@@ -93,8 +95,12 @@ module VimGet
     def handle_options(args)
       @rest = parser.parse(*args)
       @options[:args] = args
+      
+      # remove the operation name
+      @rest.shift if @rest.first == @program_name
     end
     
+    # singleton entry for OptionParser
     def parser
       create_parser if @parser.nil?
       @parser

data/lib/vimget/command_manager.rb

@@ -2,25 +2,26 @@
 # 
 # Command Manager
 #
-# Eddy Xu <eddyxu@gmail.com>
+# Author::  Eddy Xu (mailto:eddyxu@gmail.com)
+# Licence:: Distributed under BSD Licences
+# Copyright:: Copyright (c) 2008 Quarkware.com
 #
-# 2008 (c) Quarkware.com
-#
-# $Id: command_manager.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: command_manager.rb 8 2008-04-12 12:47:35Z eddyxu $
 
 require "vimget/exceptions"
 require "vimget/configure"
 
 module VimGet
   
+  # This class will find property command and invoke it
   class CommandManager
+    # singleton entry
     def self.instance
       @command_manager ||= CommandManager.new
     end
     
-    def initialize
-    end
-    
+    # run the command manager with args
+    # * args is a argument array
     def run(args)
       process_args(args)
     rescue StandardError => ex
@@ -31,7 +32,7 @@ module VimGet
       exit 1
     end
     
-    
+    # handle arguments for special command
     def process_args(args)
       if ARGV.empty?
         usage
@@ -52,7 +53,7 @@ module VimGet
       cmd_obj.invoke(ARGV.dup)
     end
     
-    
+    # display general usage 
     def usage
       puts <<-USAGE 
       vim-get: the vim script management tool
@@ -86,6 +87,7 @@ module VimGet
       USAGE
     end
       
+    # display special help informations for command
     def help(cmd="")
       if cmd.empty? 
         usage
@@ -99,6 +101,7 @@ module VimGet
       exit 1
     end
     
+    # puts version and runtime info
     def version
       puts "vim-get: vim script management tool #{VIMGET_VERSION}"
       puts

data/lib/vimget/commands/list_command.rb

@@ -2,7 +2,7 @@
 #
 # list command
 #
-# $Id: list_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: list_command.rb 7 2008-04-11 22:48:50Z eddyxu $
 
 require "vimget/command"
 require "vimget/db.rb"
@@ -28,22 +28,16 @@ module VimGet
           
         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 = VimGet.db.search()
-        
-        # Todo: decouple it to output module
+       
         scripts.each do |s|
-          if @options[:outdated] && !s.outdated?
-            next
-          elsif @options[:installed] && !s.installed?
-            next
-          end
-          
           if @options[:format] == "plain"
             puts "[#{s.name}]"
             puts "id: #{s.sid}"
@@ -63,7 +57,7 @@ module VimGet
       def add_customer_options
         #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}
+        add_option(:list, '-i', '--installed', 'List all installed scripts') {|v,opts| opts[:installed] = v}
       end
     end
     

data/lib/vimget/commands/upgrade_command.rb

@@ -8,7 +8,7 @@
 #
 # Copyright:    2008 (c) Quarkware.com
 #
-# $Id: upgrade_command.rb 6 2008-04-11 19:01:26Z eddyxu $
+# $Id: upgrade_command.rb 7 2008-04-11 22:48:50Z eddyxu $
 #
 
 require "vimget/command"
@@ -24,7 +24,7 @@ module VimGet
       end
       
       def execute
-        outdated_scripts = VimGet.db.get_outdated_scripts
+        outdated_scripts = VimGet.db.outdated_scripts
         
         if outdated_scripts.empty? 
           puts "There is no script outdated."

data/lib/vimget/db.rb

@@ -2,7 +2,7 @@
 #
 # manage local script index database
 #
-# $Id: db.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: db.rb 7 2008-04-11 22:48:50Z eddyxu $
 
 require "vimget/configure"
 require "vimget/script"
@@ -27,8 +27,7 @@ module VimGet
     end
 
     def add(script)
-      file_path = File.join(@db_path, script.name + @@EXT)
-      file_path = File.expand_path(file_path)
+      file_path = db_file(script)
       File.open(file_path, 'w') do |f|
         f.truncate(0)
         
@@ -53,7 +52,7 @@ manifest {
     
     def update(script)
       if script.manifest.empty?
-        filepath = File.join(@db_path, script.name + @@EXT)
+        filepath = db_file(script)
         s = parse_script(filepath)
         script.manifest = s.manifest if s
       end
@@ -62,8 +61,7 @@ manifest {
     end
     
     def remove(script)
-      file_path = File.join(@db_path, script.name + @@EXT)
-      file_path = File.expand_path(file_path)
+      file_path = db_file(script)
       File.delete(file_path)
     end
     
@@ -75,30 +73,35 @@ manifest {
       file_list = Dir.glob(glob_pattern)
      
       ret = Array.new
-      closure = ""
+      
       file_list.each do |f|
-        ret << parse_script(f)
+        script = parse_script(f)
+        
+        if block_given?
+          ret << script if yield(script)
+        else
+          ret << script
+        end
       end
+
       ret
     end
 
     def find_with_id(sid)
-      search.each { |s| return s if s.sid == sid }
-      return nil
+      s = search { |script| script.sid == sid }
+      s.first
     end
   
     def find(name)
-      # find a script by using name, if not one finded, return nil
-      search.each { |s| return s if s.name == name }
-      return nil
+      search(name).first
     end
     
-    def get_outdated_scripts
-      scripts = search()
-      
-      ret_array = Array.new
-      scripts.each { |s| ret_array << s if s.outdated? }
-      return ret_array
+    def outdated_scripts
+      search { |s| s.outdated? }
+    end
+    
+    def installed_scripts
+      search { |s| !s.installed.empty? }
     end
     
     private
@@ -134,6 +137,10 @@ manifest {
       s.author = ctn["author"]
       return s
     end
+    
+    def db_file(script)
+      File.expand_path(File.join(@db_path, script.name + @@EXT))
+    end
   end
 
 end

data/lib/vimget/installer.rb

@@ -22,7 +22,8 @@ module VimGet
     # Manage the installing progress and uninstall/upgrading etc
     def initialize(opts = {})
       @options = opts
-      #@dist_path = VimGet.configure.distfiles_dir
+      @dist_path = File.expand_path(VimGet.configure.distfiles_dir)
+      FileUtils.mkdir_p(@dist_path) if not File.exist? @dist_path
     end
 
     def install(script)

data/lib/vimget.rb

@@ -1,18 +1,22 @@
-#!/usr/bin/env ruby -wKU
+#!/usr/bin/env ruby
 #
 # Main file for vim-get application
 #
-# Copyright  GPLv2
+# Author::    Eddy Xu (mailto:eddyxu@gmail.com)
+# License::   Distributed under BSD License
+# Copyright:: Copyright (c) 2008 Quarkware.com
 #
-# $Id: vimget.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: vimget.rb 8 2008-04-12 12:47:35Z eddyxu $
 
+require 'fileutils'
 require "vimget/command_manager"
+require "vimget/configure"
 
-VIMGET_VERSION = "0.1.0"
+VIMGET_VERSION = "0.1.1"
 
 module VimGet
   
-  # Singleton access point
+  # Singleton access point for main application
   class << self
     def application 
       @application ||= VimGet::Application.new
@@ -27,11 +31,12 @@ module VimGet
   # VimGet application class
   class Application
     def initialize
-      
+      vimget_path = File.expand_path(VimGet.configure.base_dir)
+      FileUtils.mkdir_p vimget_path if not File.exist? vimget_path
     end
     
     def run
       CommandManager.instance.run(ARGV)
     end
   end
-end
+end

data/test/tc_command.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby 
+#
+# test case for command.rb
+#
+# author: Eddy Xu <eddyxu@gmail.com>
+#
+# $Id: tc_command.rb 8 2008-04-12 12:47:35Z eddyxu $
+
+require 'test/unit'
+require 'vimget/command'
+
+class CommandTest < Test::Unit::TestCase
+  def setup
+  end
+  
+  def teardown
+    
+  end
+  
+  def test_parse_option
+  end
+end

data/test/tc_db.rb

@@ -2,7 +2,7 @@
 #
 # test case for db.rb
 #
-# $Id: tc_db.rb 4 2008-04-07 19:16:34Z eddyxu $
+# $Id: tc_db.rb 7 2008-04-11 22:48:50Z eddyxu $
 
 require 'test/unit'
 require "vimget/db"
@@ -12,10 +12,20 @@ require "tmpdir"
 class TestDB < Test::Unit::TestCase
   def setup
     @basedir = Dir.tmpdir
+    
+    @s1 = VimGet::Script.new("123", "test_1", "Eddy Xu", "4.23", "4.23", 
+      "download?from=somewhere", 
+    ["plugin/taglist.vim", "doc/taglist.txt"])
+  
+    # outdated one
+    @s2 = VimGet::Script.new("321", "test_outdated", "EdX", "3.24", "3.23",
+    "download str", [])
+  
+    @db = VimGet::PathDB.new(@basedir)
   end
   
   def teardown
-    nil
+    Dir.glob(db_file("*")) { |filename| File.delete(filename)  }
   end
   
   def test_find
@@ -23,23 +33,57 @@ class TestDB < Test::Unit::TestCase
   end
   
   def test_add
-    s = VimGet::Script.new("123", "test")
+    s = VimGet::Script.new(123, "test")
     s.author = "Eddy Xu"
     s.installed = "4.23"
     s.version = "5.23"
     s.download = "download?from=somewhere"
     s.manifest = ["plugin/taglist.vim", "doc/taglist.txt"]
     
-    db = VimGet::PathDB.new(@basedir)
-    
-    db.add(s)
+    @db.add(s)
     
     expected_filepath = File.join(@basedir, "db", "test.manifest")
     assert(File.exist?(expected_filepath), "Failed to create script manifest.")
     
+    s1 = @db.find("test")
+    assert_not_nil(s1, "VimGet::db find nothing")
+    assert_equal(s.sid, s1.sid)
+    assert_equal("4.23", s1.installed, "Wrong installed version")
+    assert_equal(s.manifest, s1.manifest)
+    assert_equal(s.outdated?, s1.outdated?)
+    
   end
 
   def test_update
-    s = VimGet::Script.new("123", "test")
+    db = db_file(@s1.name)
+    assert_equal(false, File.exist?(db))
+    @db.add(@s1)
+    assert_equal(true, File.exist?(db), "Failed to create script manifest.")
+    @s1.author = "Meg Ryan"
+    @s1.installed = "23.2"
+    @s1.version = "2.32"
+    @s1.manifest << "ftplugin/taglist.a"
+    
+    @db.update(@s1)
+    
+    s = @db.find(@s1.name)
+    assert_equal("Meg Ryan", s.author)
+    assert_equal(@s1.manifest, s.manifest)
+    
+    # Todo: is it right to ignore the manifest empty?
+    empty_s = VimGet::Script.new(@s1.sid, @s1.name)
+    empty_s.author, empty_s.installed, empty_s.version = @s1.author, @s1.installed, @s1.version
+    empty_s.manifest = []
+    
+    @db.update(empty_s)
+    
+    s = @db.find(empty_s.name)
+    assert_equal(@s1.manifest, s.manifest)
+  end
+  
+  private
+  
+  def db_file(name)
+    File.join(@basedir, "db", name + ".manifest")
   end
 end

data/test/ts_vimget.rb

@@ -2,10 +2,11 @@
 #
 # Test suite for vimget
 #
-# $Id: ts_vimget.rb 5 2008-04-11 18:33:39Z eddyxu $
+# $Id: ts_vimget.rb 8 2008-04-12 12:47:35Z eddyxu $
 
 $: << "#{File.dirname(__FILE__)}/../lib"
 
 require 'tc_db'
+require 'tc_command'
 require 'tc_installer'
 require 'tc_script'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vimget
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Eddy Xu
@@ -28,10 +28,11 @@ executables:
 - vim-get
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - bin/vim-get
+- test/tc_command.rb
 - test/tc_db.rb
 - test/tc_installer.rb
 - test/tc_script.rb
@@ -55,6 +56,7 @@ files:
 - lib/vimget/script.rb
 - lib/vimget/webparser.rb
 - lib/vimget.rb
+- README
 has_rdoc: true
 homepage: http://www.xulei.org/projects/vimget
 post_install_message: