vimget 0.1.0

data/bin/vim-get

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby 
+#
+# vim-get: a vim script manager
+#
+# $Id: vim-get 8 2008-03-26 17:32:26Z eddyxu $
+
+begin
+  $: << "#{File.dirname(__FILE__)}/../lib"
+  require 'vimget'
+rescue LoadError
+  require 'rubygems'
+  require 'vimget'
+end
+
+VimGet::application.run

data/lib/vimget/command.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+#
+# @file   command.rb
+#
+# @breif  parser and manager commands
+#
+# @author Eddy Xu <eddyxu@gmail.com>
+#
+# Copyright 2008 by xulei.org
+#
+# $Id: command.rb 5 2008-04-11 18:33:39Z eddyxu $
+#
+
+require 'optparse'
+require "vimget/configure"
+
+module VimGet
+  
+  # base class for all commands
+  class BaseCommand
+    PROGRAM = "vim-get"
+    # the name of command
+    attr_reader :command
+    
+    # the options for this command
+    attr_reader :options
+    
+    attr_reader :options_group
+    
+    # the default options for the command
+    attr_accessor :defaults
+    
+    # the name of the command for command-line invocation
+    attr_accessor :program_name
+    
+    # A short description of the command
+    attr_accessor :summary
+    
+    def initialize(command, summary = nil, defaults = {})
+      @command, @summary, @defaults = command, summary, defaults
+      @program_name = "#{PROGRAM} #{command}"
+      @options = defaults.dup
+      @parser = nil
+      @option_groups = Hash.new { |h,k| h[k] = [] }
+    end
+    
+    def usage
+      @program_name
+    end
+    
+    def show_help
+      parser.program_name = usage
+      puts @parser
+    end
+    
+    def arguments
+      ""
+    end
+    
+    def invoke(*args)
+      handle_options(args)
+      if @options[:help]
+        show_help
+      else
+        execute
+      end
+    end
+    
+    def execute
+      raise 'Command without define execute function'
+    end
+  
+    protected
+    
+    def add_option(*opts, &handler)
+      group_name = Symbol === opts.first ? opts.shift : :options                                                         
+      @option_groups[group_name] << [opts, handler]
+    end
+    
+    def remove_option(name)                                                                                            
+      @option_groups.each do |_, option_list|                                                                         
+        option_list.reject! { |args, _| args.any? { |x| x =~ /^#{name}/ } }                                             
+      end                                                                   
+    end
+    
+    def pop_one_argument
+      return nil if @rest.empty?
+      return @rest.shift
+    end
+    
+    private
+    
+    def handle_options(args)
+      @rest = parser.parse(*args)
+      @options[:args] = args
+    end
+    
+    def parser
+      create_parser if @parser.nil?
+      @parser
+    end
+  
+    def create_parser
+      @parser = OptionParser.new
+
+      if @summary
+        @parser.separator ""
+        @parser.separator "  Summary:"
+        wrap(@summary, 80-4).split("\n").each do |l|
+          @parser.separator "  #{l.strip}"
+        end
+        @parser.separator ""
+      end
+   
+      unless arguments.empty?
+        @parser.separator("  Arguments:")                                                                                  
+        arguments.split(/\n/).each do |arg_desc|                                                                         
+          @parser.separator("    #{arg_desc}")                                                                        
+        end                                                                                              
+        @parser.separator("")
+      end
+      
+      add_option(:common, '-h', '--help', 'display this help') {|v, opts| @options[:help] = true }
+      add_option(:common, '--debug', 'print debug informations') {|v, opts| VimGet.configure.debug = true }
+      add_option(:common, '--verbose', 'set verbose mode') {|v, opts| @options[:verbose] = true }
+      
+      @option_groups.each do |grp, opts|
+       configure_options(grp, opts)
+      end
+      
+      @parser.separator "  Further information"
+      @parser.separator "    http://vimget.rubyforge.org"
+    end
+  
+    def configure_options(header, option_list)
+      return if option_list.nil? or option_list.empty?
+
+      header = header.to_s.empty? ? '' : "#{header} "
+      @parser.separator "  #{header.capitalize}options:"
+
+      option_list.each do |args, handler|
+        dashes = args.select { |arg| arg =~ /^-/ }
+        @parser.on(*args) do |value|
+          handler.call(value, @options)
+        end
+      end
+
+      @parser.separator ''
+    end
+    
+    def wrap(text, width)
+      text.gsub(/(.{1,#{width}})( +|$\n?)|(.{1,#{width}})/, "\\1\\3\n")
+    end
+    
+  end
+  
+end

data/lib/vimget/command_manager.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+# 
+# Command Manager
+#
+# Eddy Xu <eddyxu@gmail.com>
+#
+# 2008 (c) Quarkware.com
+#
+# $Id: command_manager.rb 5 2008-04-11 18:33:39Z eddyxu $
+
+require "vimget/exceptions"
+require "vimget/configure"
+
+module VimGet
+  
+  class CommandManager
+    def self.instance
+      @command_manager ||= CommandManager.new
+    end
+    
+    def initialize
+    end
+    
+    def run(args)
+      process_args(args)
+    rescue StandardError => ex
+      puts "While execute vim-get...(#{ex.class})\n   #{ex.to_s}"
+      puts ex.backtrace if VimGet.configure.debug
+    rescue Interrupt
+      puts "Interrupt"
+      exit 1
+    end
+    
+    
+    def process_args(args)
+      if ARGV.empty?
+        usage
+        exit 1
+      end
+      
+      case ARGV[0]
+      when '-h', '--help'
+        usage
+        exit 1
+      when '-v', '--version', 'version'
+        version
+      when 'help'
+        ARGV[1] ? help(ARGV[1]) : help
+      end
+      
+      cmd_obj = find_command(ARGV[0])
+      cmd_obj.invoke(ARGV.dup)
+    end
+    
+    
+    def usage
+      puts <<-USAGE 
+      vim-get: the vim script management tool
+
+      Usage: 
+        vim-get -h/--help    
+        vim-get -v/--version 
+        vim-get command [options] [arg1 argu2 ...]
+
+      Common options:
+        --debug         display debug infomation
+        --verbose       set verbose
+
+      Supported commands:
+        help            provide help for special commands
+        version         display version and runtime informations
+
+        install         install a script
+        uninstall       uninstall a script
+        upgrade         upgrade outdated script
+        sync            sync local script version database
+        clean           clean all distributed files
+
+        list            list local scripts
+        outdated        list all outdated scripts
+        installed       list all installed scripts
+    
+      Further Infomation:
+        https://rubyforge.org/projects/vimget/
+
+      USAGE
+    end
+      
+    def help(cmd="")
+      if cmd.empty? 
+        usage
+      elsif cmd == "help"
+        nil
+      else
+        command_obj = find_command(cmd)
+        command_obj.show_help
+      end
+      
+      exit 1
+    end
+    
+    def version
+      puts "vim-get: vim script management tool #{VIMGET_VERSION}"
+      puts
+      puts "Runtime:"
+      puts "  vim-get base dir: #{VimGet.configure.base_dir}"
+      puts "  vim dir: #{VimGet.configure.vim_dir}"
+      exit 1
+    end
+    
+    private
+
+    def find_command(cmd_str)
+      cmd_str = cmd_str.to_s
+
+      begin
+        const_name = cmd_str.capitalize.gsub(/_(.)/) {$1.upcase}
+        require "vimget/commands/#{cmd_str}_command"
+        VimGet::Commands.const_get("#{const_name}Command").new
+      rescue LoadError => ex
+        raise VimGet::CommandLineError, "Unknown command #{cmd_str}"
+      end
+
+    end
+  end
+end

data/lib/vimget/commands/clean_command.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+#
+# File:         clean_command.rb
+#
+# Brief:        clean command
+#
+# Author:       Eddy Xu <eddyxu@gmail.com>
+# 
+# Copyright:    2008 (c) Quarkware.com
+#
+# $Id: clean_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+#
+
+require "vimget/command"
+require "vimget/configure"
+
+module VimGet
+  module Commands
+    
+    class CleanCommand < BaseCommand
+      def initialize
+        super('clean', 'clean all distributed files')
+        
+      end
+      
+      def execute
+        dir = VimGet.configure.distfiles_dir
+        puts "Cleaing..."
+        
+        abs_dir = File.expand_path(dir)
+        Dir.glob(File.join(abs_dir,"*")).each { |f| File.delete(f) }
+      end
+    end
+  end
+end

data/lib/vimget/commands/install_command.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+#
+# File:         install_command.rb
+#
+# Brief:        install command
+#
+# Author:       Eddy Xu <eddyxu@gmail.com>
+# 
+# Copyright:    2008 (c) Quarkware.com
+#
+# $Id: install_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+#
+
+require "vimget/command"
+require "vimget/db"
+require "vimget/exceptions"
+require "vimget/webparser"
+require "vimget/installer"
+
+
+module VimGet
+  module Commands
+    
+    class InstallCommand < BaseCommand
+      def initialize
+        super('install', "Install a script")
+        
+        custom_options
+      end
+      
+      def usage
+        "#{@program_name} [NAME]"
+      end
+      
+      def arguments
+        "NAME    name of script to install"
+      end
+      
+      def execute
+        if @options[:install_id]
+          script = VimGet.db.find_with_id @options[:install_id]
+          
+          if script.nil?
+            script = VimGet.parse_script_page(@options[:install_id])
+            VimGet.db.add(script)
+          end
+        else
+          @rest.shift if @rest.first == "install"
+          if @rest.empty?
+            raise CommandLineError, "Missing arguments"
+          end
+          
+          name = @rest.first
+          
+          script = VimGet.db.find(name)
+          
+          raise UnknownScriptError, "Unknow script!" if script.nil?
+        end
+        
+        installer = Installer.new(@options)
+        installer.install(script)
+      end
+      
+      private
+      
+      def custom_options
+        add_option(:install, '-i', '--id ID', Integer, "Install a script with script id") do |v, opts|
+          opts[:install_id] = v
+        end
+        add_option(:install, '--dry-run', "Do not modify anything") { |v, opts| opts[:dryrun] = v }
+      end
+    end
+    
+  end
+end

data/lib/vimget/commands/installed_command.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+#
+# File:         installed_command.rb
+#
+# Brief:        installed command
+#
+# Author:       Eddy Xu <eddyxu@gmail.com>
+# 
+# Copyright:    2008 (c) Quarkware.com
+#
+# $Id: installed_command.rb 6 2008-04-11 19:01:26Z eddyxu $
+#
+
+require "vimget/commands/list_command"
+
+module VimGet
+  
+  module Commands
+    
+    class InstalledCommand < ListCommand
+      def initialize
+        super("installed", "Display all installed scripts")
+        options[:installed] = true
+        remove_option('--outdated')
+        remove_option('--installed')
+      end
+      
+      def usage
+        @program_name
+      end
+    end
+  end
+  
+end

data/lib/vimget/commands/list_command.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby -wKU
+#
+# list command
+#
+# $Id: list_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+
+require "vimget/command"
+require "vimget/db.rb"
+
+module VimGet
+  module Commands
+  
+    class ListCommand < BaseCommand
+      def initialize(name = 'list', summary = 'Display all script in local')
+        super(name,
+          summary,
+          :format => "plain")
+        
+        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"
+        elsif @options[:installed]
+          puts "List installed scripts"
+        else
+          puts "List scripts"
+        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}"
+            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
+      end
+      
+      private
+      
+      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}
+      end
+    end
+    
+  end
+end

data/lib/vimget/commands/outdated_command.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+#
+# File:         outdated_command.rb
+#
+# Brief:        outdated command
+#
+# Author:       Eddy Xu <eddyxu@gmail.com>
+# 
+# Copyright:    2008 (c) Quarkware.com
+#
+# $Id: outdated_command.rb 6 2008-04-11 19:01:26Z eddyxu $
+#
+
+require "vimget/commands/list_command"
+
+module VimGet
+  
+  module Commands
+    
+    class OutdatedCommand < ListCommand
+      def initialize
+        super("outdated", "Display all outdated scripts")
+        options[:outdated] = true
+        remove_option('--outdated')
+        remove_option('--installed')
+      end
+      
+      def usage
+        @program_name
+      end
+    end
+  end
+  
+end

data/lib/vimget/commands/sync_command.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+# File:         sync_command.rb
+#
+# Brief:        do sync command
+#
+# Author:       Eddy Xu <eddyxu@gmail.com>
+# 
+# Copyright:    2008 (c) Quarkware.com
+#
+# $Id: sync_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+#
+
+require "vimget/command"
+require "vimget/db"
+require "vimget/webparser"
+
+module VimGet
+  module Commands
+    
+    class SyncCommand < BaseCommand
+      def initialize
+        super('sync', 'Sync with vim site')
+      end
+      
+      def execute
+        puts "Syncing..."
+        
+        db = VimGet.db
+        db.search().each do |s|
+          puts "-> sync #{s.name}.."
+          new_script = VimGet::parse_script_page(s.sid)
+          new_script.installed = s.installed
+          db.update(new_script)
+        end
+      end
+    end
+  end
+end

data/lib/vimget/commands/uninstall_command.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby 
+#
+# File    uninstall.rb
+#
+# Brief   act the uninstall operations
+#
+# Author  Eddy Xu <eddyxu@gmail.com>
+#
+# Copyright   2008 (c) Quarkware.com
+#
+# $Id: uninstall_command.rb 5 2008-04-11 18:33:39Z eddyxu $
+
+require "vimget/command"
+require "vimget/db"
+require "vimget/installer"
+
+
+module VimGet
+  
+  module Commands
+    
+    class UninstallCommand < BaseCommand
+      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 }
+            
+        add_option('--dry-run', 
+            'Do not motify any files') { |v,opts| opts[:dry_run] = v }
+      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
+        
+        installer = Installer.new(@options)
+        installer.uninstall(script)
+      end
+    end
+  end
+  
+end

data/lib/vimget/commands/upgrade_command.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+#
+# File:         upgrade_command.rb
+#
+# Brief:        perform upgrading operation
+#
+# Author:       Eddy Xu <eddyxu@gmail.com>
+#
+# Copyright:    2008 (c) Quarkware.com
+#
+# $Id: upgrade_command.rb 6 2008-04-11 19:01:26Z eddyxu $
+#
+
+require "vimget/command"
+require "vimget/installer"
+require "vimget/db"
+
+module VimGet
+  module Commands
+    
+    class UpgradeCommand < BaseCommand
+      def initialize
+        super('upgrade', 'upgrade outdated script(s)')
+      end
+      
+      def execute
+        outdated_scripts = VimGet.db.get_outdated_scripts
+        
+        if outdated_scripts.empty? 
+          puts "There is no script outdated."
+          return
+        end
+        
+        installer = Installer.new(@options)
+        outdated_scripts.each do |s|
+          installer.upgrade(s)
+        end
+      end
+    end
+  end
+end