pvn 0.0.1

data/README.markdown

@@ -0,0 +1,38 @@
+PVN
+===
+
+Pvn adds functionality stolen and inspired by Perforce and Git, as well as just
+things I conjured up.
+
+What it isn't: a replace for svn (the command). The intent here is not to do
+everything svn does, but better. Maybe some day that will happen.
+
+SUMMARY
+-------
+
+    svn [ options ] file ...
+
+FEATURES
+--------
+
+**Relative revisions**: Pvn supports revisions being specified as being relative
+to their "index" in the list of svn revision. "+n" means the nth revision in
+the list for a given path, and "-n" is the nth from the last revision, where
+-1 means the last revision.
+
+Thus for the following list of revisions for a path:
+
+    r1947 | easter.bunny | 2011-11-14 07:24:45 -0500 (Mon, 14 Nov 2011) | 1 line
+    r1714 | santa.claus | 2011-09-22 16:38:30 -0400 (Thu, 22 Sep 2011) | 1 line
+    r1192 | santa.claus | 2011-09-05 03:51:04 -0400 (Mon, 05 Sep 2011) | 1 line
+    r1145 | tooth.fairy | 2011-08-02 04:57:23 -0400 (Tue, 02 Aug 2011) | 1 line
+    r1143 | santa.claus | 2011-07-29 07:51:49 -0400 (Fri, 29 Jul 2011) | 1 line
+    r1049 | santa.claus | 2011-06-22 07:17:43 -0400 (Wed, 22 Jun 2011) | 1 line
+
+Relative revision +0 is r1049, -1 is r1947, +1 is r1143, and so on.
+
+**Colorized logging**. The "log" subcommand works in pvn as it does with svn,
+except that output is colorized, differing for the elements (file, directory) and
+the status of the element (added, deleted, changed). The logging output also
+shows the relative revision.
+

data/bin/pvn

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2011-11-9.
+#  Copyright (c) 2011. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/pvn")
+require "pvn/app"
+
+PVN::App::Runner.new STDOUT, ARGV
+
+# PVN::App.execute(STDOUT, ARGV)

data/bin/pvndiff

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2011-11-9.
+#  Copyright (c) 2011. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/pvn")
+require "pvn/diff/differ"
+
+PVN::Differ.new ARGV

data/lib/pvn/app.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+
+require 'pvn/io/element'
+
+require 'svnx/log/entries'
+
+require 'pvn/subcommands/log/command'
+
+# not yet supported:
+# require 'pvn/subcommands/pct/command'
+
+# the old ones:
+require 'pvn/diff/diffcmd'
+require 'pvn/pct/pctcmd'
+require 'pvn/describe'
+require 'pvn/upp/uppcmd'
+require 'pvn/wherecmd'
+
+module PVN; module App; end; end
+
+module PVN::App
+  class Runner
+    include Loggable
+
+    def initialize io, args
+      RIEL::Log.level = RIEL::Log::WARN
+      RIEL::Log.set_widths(-25, 5, -35)
+
+      if args.empty?
+        run_help args
+      end
+      
+      while args.size > 0
+        arg = args.shift
+        info "arg: #{arg}"
+
+        case arg
+        when "--verbose"
+          RIEL::Log.level = RIEL::Log::DEBUG
+        when "help", "--help", "-h"
+          run_help args
+        when "log"
+          run_command PVN::Subcommands::Log::Command, args
+        when "pct"
+          $stderr.puts "subcommand 'pct' is not yet supported"
+          exit(-1)
+        else
+          $stderr.puts "ERROR: subcommand not valid: #{arg}"
+          exit(-1)
+        end
+      end
+
+      run_help args
+    end
+
+    def run_command cmdcls, args
+      begin
+        cmdcls.new args
+        exit(0)
+      rescue => e
+        # puts e.backtrace
+        $stderr.puts e
+        exit(-1)
+      end
+    end
+
+    # below is the old implementation. yes, I should have branched this.
+    # =======================================================
+
+    def self.run_command_with_output cmd
+      RIEL::Log.info "cmd: #{cmd}".on_black
+      puts cmd.output
+      true
+    end
+    
+    def self.run_command_as_entries cmd
+      RIEL::Log.info "cmd: #{cmd}".on_black
+      cmd.write_entries
+      true
+    end
+
+    SUBCOMMANDS = [ PVN::Subcommands::Log::Command,
+#                    DiffCommand, 
+#                    DescribeCommand, 
+#                    PctCommand,
+#                    WhereCommand,
+#                    UndeleteCommand,
+                  ]
+    
+    def run_help args
+      forwhat = args[0]
+
+      cls = SUBCOMMANDS.find do |cls|
+        cls.getdoc.subcommands.include? forwhat
+      end
+
+      if cls
+        cls.to_doc
+      else
+        puts "usage: pvn [--verbose] <command> [<options>] [<args>]"
+        puts "PVN, version #{PVN::VERSION}"
+        puts
+        puts "PVN has the subcommands:"
+        SUBCOMMANDS.each do |sc|
+          printf "   %-10s %s\n", sc.getdoc.subcommands[0], sc.getdoc.description
+        end
+      end
+      exit(0)
+    end
+    
+    def self.execute stdout, args = Array.new
+      while args.size > 0
+        arg = args.shift
+        RIEL::Log.debug "arg: #{arg}"
+
+        if arg == "--verbose"
+          RIEL::Log.level = RIEL::Log::DEBUG
+          next
+        end
+
+        if arg == "help"
+          return run_help args
+        end
+
+        SUBCOMMANDS.each do |sc|
+          if sc.doc.subcommands.include?(arg)
+            cmd = sc.new :execute => true, :command_args => args
+            if cmd.has_entries?
+              return run_command_as_entries cmd
+            else
+              return run_command_with_output cmd
+            end
+          end
+        end
+        
+        $stderr.puts "ERROR: subcommand not valid: #{arg}"
+      end
+    end
+  end
+end

data/lib/pvn/base/textlines.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+
+module PVN
+  class TextLines
+    include Loggable
+
+    attr_reader :lines
+
+    def initialize lines
+      @lines = lines
+      @lidx = 0
+    end
+
+    def match_line re, offset = 0
+      re.match line(offset)
+    end
+
+    def line offset = 0
+      @lines[@lidx + offset]
+    end
+
+    def has_line?
+      @lidx < @lines.length
+    end
+
+    def advance_line offset = 1
+      @lidx += offset
+    end
+    
+  end
+end

data/lib/pvn/base/util.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module PVN
+  module Util
+    POS_NEG_NUMERIC_RE = Regexp.new('^[\-\+]?\d+$')
+
+    # Returns the list joined by spaces, with each element in the list in double
+    # quotes.
+    def self.quote_list args
+      args.collect { |a| "\"#{a}\"" }.join(' ') 
+    end
+  end
+end

data/lib/pvn/cmddoc.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+
+module PVN
+  class CommandDoc
+    attr_accessor :subcommands
+    attr_accessor :description
+    attr_accessor :usage
+    attr_accessor :summary
+    
+    attr_reader :examples
+    attr_reader :options
+
+    def initialize
+      @subcommands = nil
+      @description = nil
+      @usage = nil
+      @summary = nil
+      @options = Array.new
+      @examples = Array.new
+    end
+
+    def to_doc io = $stdout
+      doc = Array.new
+
+      subcmds = @subcommands
+
+      subcmdstr = subcmds[0].dup
+      if subcmds.size > 1
+        subcmdstr << " (" << subcmds[1 .. -1].join(" ") << ")"
+      end
+
+      io.puts subcmdstr + ": " + @description
+      io.puts "usage: " + subcmds[0] + " " + @usage
+      io.puts ""
+      io.puts @summary.collect { |line| "  " + line }
+
+      write_section "options", @options, io do |opt, io|
+        option_to_doc opt, io
+      end
+
+      write_section "examples", @examples, io do |ex, io|
+        example_to_doc ex, io
+      end
+    end
+
+    def write_section name, section, io
+      if section.length > 0
+        io.puts ""
+        io.puts "#{name.capitalize}:"
+        io.puts ""
+        
+        section.each do |opt|
+          yield opt, io
+        end
+      end
+    end
+
+    def example_to_doc ex, io
+      ex.each_with_index do |line, idx|
+        if idx == 0
+          io.puts "  % #{line}"
+        else
+          io.puts "    #{line}"
+        end
+      end
+      io.puts
+    end
+
+    def option_to_doc opt, io
+      opt.to_doc io
+    end
+  end
+end

data/lib/pvn/config.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+require 'singleton'
+
+module PVN
+  class Configuration
+    def initialize
+      @@instance = self
+      @values = Hash.new { |h, k| h[k] = Array.new }
+    end
+
+    def config &blk
+      blk.call self
+    end
+
+    def self.config &blk
+      @@instance.config(&blk)
+    end
+
+    def self.read
+      @@instance ||= begin
+        cfg = self.new
+        pvndir = ENV['HOME'] + '/.pvn'
+        cfgfile = pvndir + '/config'
+        
+        begin
+          require cfgfile
+        rescue LoadError => e
+          # no configuration
+        end
+        cfg
+      end
+    end
+
+    def value name, field
+      @values[name][field]
+    end
+
+    def section name
+      @values[name]
+    end
+
+    def method_missing meth, *args, &blk
+      eqre = Regexp.new('^(\w+)=')
+      # puts "method missing: #{meth}"
+      if md = eqre.match(meth.to_s)
+        name = md[1]
+        @values[@current] << [ name.to_s, *args ]
+        # puts "@values: #{@values}"
+      else
+        @current = meth.to_s
+        yield self
+        @current = nil
+      end
+    end
+  end
+end
+
+
+if __FILE__ == $0
+  cfg = PVN::Configuration.read
+end

data/lib/pvn/describe.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'system/command'
+# require 'pvn/diff'
+
+module PVN
+  class DescribeCommand < Command
+    COMMAND = "describe"
+
+    self.doc do |doc|
+      doc.subcommands = [ COMMAND, 'desc' ]
+      doc.description = "Describes the changes of one or more revisions."
+      doc.usage       =  "[OPTIONS] FILE..."
+      doc.summary     = [ "  Prints the log message and the files changed for the given",
+                          "  revisions." ]
+      doc.examples   << [ "pvn describe -1 foo.rb", "Prints the summary for the most recent revision of foo.rb." ]
+    end
+    
+    # has_option :limit, '-l', "the number of log entries", DEFAULT_LIMIT, :negate => [ %r{^--no-?limit} ]
+    has_revision_option :multiple => true
+
+    def initialize args = Hash.new
+      info "args: #{args}".on_blue
+      super
+    end
+
+    def run args
+      info "args: #{args}".on_yellow
+      revisions = find_option(:revision).value
+
+      info "revisions: #{revisions}".yellow
+
+      revisions.each do |rev|
+        info "svn log -r #{rev}"
+        info "svn diff --summarize -c #{rev}"
+      end
+    end
+  end
+end

data/lib/pvn/diff/diffcmd.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pvn/config'
+require 'pvn/svn/command/svncmd'
+require 'pvn/diff/diffopts'
+
+module PVN  
+  class DiffCommand < SVNCommand
+    COMMAND = "diff"
+
+    attr_reader :options
+    
+    self.doc do |doc|
+      doc.subcommands = [ COMMAND ]
+      doc.description = "Displays differences between revisions."
+      doc.usage       = "[OPTIONS] FILE..."
+      doc.summary     = [ "Compare two revisions, filtering through external programs.",
+                          "For each file compared, the file extension is used to find",
+                          "a diff program." ]
+      doc.options.concat DiffOptionSet.new.options
+      doc.examples   << [ "pvn diff foo.rb", "Compares foo.rb against the last updated version." ]
+      doc.examples   << [ "pvn diff -3 StringExt.java", "Compares StringExt.java at change (HEAD - 3), using a Java-specific program such as DiffJ." ]
+      doc.examples   << [ "pvn diff -r +4 -w", "Compares the 4th revision against the working copy, ignoring whitespace." ]
+    end
+    
+    def initialize args = Hash.new
+      @options = DiffOptionSet.new
+      debug "args: #{args.inspect}".yellow
+
+      super
+    end
+
+    def use_cache?
+      super && !against_head?
+    end
+
+    def against_head?
+      @options.change.value.nil? && @options.revision.head?
+    end
+    
+    # @todo implement
+    if true
+      self.options do |opts|
+        # opts.add :diffcmd
+      end
+    end
+  end
+end

data/lib/pvn/diff/differ.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pathname'
+require 'pvn/config'
+
+module PVN
+  # the app for svn --diff-cmd
+  class Differ
+    include Loggable
+    
+    def initialize args
+      fromlabel = args[2]
+      tolabel = args[4]
+
+      fromname, fromrev = fromlabel.split("\t")
+      toname, torev = tolabel.split("\t")
+
+      fromfile = args[-2]
+      tofile = args[-1]
+
+      diffcmd = diff_command_by_ext fromname
+      info "diffcmd: #{diffcmd}"
+
+      if diffcmd
+        workingcmd = diffcmd.dup
+
+        [ fromlabel, tolabel, fromfile, tofile ].each_with_index do |str, idx|
+          workingcmd.gsub! Regexp.new('\{' + idx.to_s + '\}'), str
+        end
+
+        run_command workingcmd
+      else
+        run_diff_default fromlabel, tolabel, fromfile, tofile
+      end
+    end
+
+    def diff_command_by_ext fname
+      extname = Pathname.new(fname).extname
+      return nil if extname.empty?
+
+      ext = extname[1 .. -1]
+
+      cfg = PVN::Configuration.read
+
+      diffcfg = cfg.section "diff"
+      return nil unless diffcfg
+
+      diff_for_ext = diffcfg.assoc(ext)
+      diff_for_ext && diff_for_ext[1]
+    end
+
+    def run_diff_default fromfname, tofname, fromfile, tofile
+      cmd = "diff -u --label \"#{fromfname}\" --label \"#{tofname}\" #{fromfile} #{tofile}"
+      run_command cmd
+    end
+
+    def run_command cmd
+      info "cmd: #{cmd}".red
+      IO.popen(cmd) do |io|
+        io.each do |line|
+          puts line
+        end
+      end        
+    end
+  end
+end

data/lib/pvn/diff/diffopts.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'synoption/set'
+require 'pvn/subcommands/revision/revision_option'
+
+module PVN
+  thisfile = Pathname.new __FILE__
+  PVNDIFF_CMD = (thisfile.parent.parent.parent.parent + "bin/pvndiff").expand_path
+
+  POS_NEG_NUMERIC_RE = Regexp.new('^[\-\+]?\d+$')
+  
+  # "pvn diff -3" == "pvn diff -c -3", not "pvn diff -r -3", because
+  # we diff for the change, not from that revision to head.
+
+  class DiffRevisionOption < RevisionOption
+    def head?
+      value.nil? || value == 'HEAD'
+    end
+  end
+  
+  class DiffChangeOption < Option
+    def initialize chgargs = Hash.new
+      chgargs[:setter] = :revision_from_args
+      chgargs[:regexp] = POS_NEG_NUMERIC_RE
+      
+      super :change, '-c', "change", chgargs
+    end
+  end
+
+  class DiffWhitespaceOption < Option
+    def initialize wsargs = Hash.new
+      super :whitespace, '-W', "ignore all whitespace", wsargs
+    end
+
+    def to_command_line
+      if value
+        %w{ -x -w -x -b -x --ignore-eol-style }
+      end
+    end
+  end
+
+  class DiffOptionSet < OptionSet
+    attr_reader :change
+    attr_reader :revision
+    
+    def initialize
+      super
+      
+      # diffcmd is old/new option style (non-subclass of Option)
+      diffcmd = PVNDIFF_CMD.exist? && PVNDIFF_CMD
+      @diffcmdopt = add Option.new :diffcmd, "--diff-cmd", "the program to run diff through", diffcmd, :negate => [ %r{^--no-?diff-?cmd} ]
+      @change     = add DiffChangeOption.new
+      @revision   = add DiffRevisionOption.new
+      @whitespace = add DiffWhitespaceOption.new
+    end
+  end
+end

data/lib/pvn/doc.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+require 'pvn/documenter'
+
+# Log.level = Log::DEBUG
+
+module PVN
+  module Doc
+    include Loggable
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      [ :subcommands, :description, :usage, :summary, :examples ].each do |name|
+        define_method name do |val|
+          self.instance_eval do 
+            @doc ||= Documenter.new
+            meth = (name.to_s + '=').to_sym
+            @doc.send meth, val
+          end
+        end
+      end
+      
+      def to_doc io = $stdout
+        self.instance_eval { @doc.to_doc io }
+      end
+    end
+  end
+end