pvn 0.0.1

data/lib/pvn/io/element.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+require 'pvn/base/util'
+
+require 'svnx/log/command'
+require 'svnx/log/entries'
+
+require 'svnx/status/command'
+require 'svnx/status/entries'
+
+require 'svnx/info/command'
+require 'svnx/info/entries'
+
+require 'pvn/io/fselement'
+
+module PVN; module IO; end; end
+
+module PVN::IO
+  # An element unites an svn element and a file/directory (at least one of
+  # which should exist).
+
+  class Element
+    include Loggable
+
+    attr_reader :svn
+    attr_reader :local
+    
+    def initialize args = Hash.new
+      info "args: #{args}"
+      
+      svnurl = args[:svnurl]
+      fname  = args[:filename] || args[:file] # legacy
+      # $$$ todo: map svnurl to SVNElement, and fname to FSElement
+
+      @svn   = args[:svn] || (args[:file] && SVNElement.new(:filename => args[:file]))
+      @local = PVN::FSElement.new args[:local] || args[:file]
+      
+      info "local: #{@local}"
+    end
+
+    def exist?
+      @local && @local.exist?
+    end
+
+    def directory?
+      if exist?
+        @local.directory?
+      else
+        # look it up with svn info
+        false
+      end
+    end
+
+    def file?
+      if exist?
+        @local.file?
+      else
+        raise "need this"
+      end
+    end
+
+    def svninfo
+    end
+
+    # returns log entries
+    def log cmdargs = SVNx::LogCommandArgs.new
+      # $$$ todo: this should be either @local if set, otherwise @svn (url)
+      # cmdargs.path = @local
+      cmd = SVNx::LogCommand.new cmdargs
+      SVNx::Log::Entries.new :xmllines => cmd.execute
+    end
+
+    # returns :added, :deleted, "modified"
+    def status
+      cmdargs = SVNx::StatusCommandArgs.new :path => @local
+      cmd = SVNx::StatusCommand.new :cmdargs => cmdargs
+      xml = cmd.execute.join ''
+      entries = SVNx::Status::Entries.new :xml => SVNx::Status::XMLEntries.new(xml)
+      entry = entries[0]
+      entry.status
+    end
+
+    # def to_command subcmd, revcl, *args
+    #   cmd = "svn #{subcmd}"
+    #   info "cmd: #{cmd}".on_blue
+    #   info "args: #{args}".on_blue
+    #   args = args.flatten
+
+    #   # revcl is [ -r, 3484 ]
+    #   if revcl
+    #     cmd << " " << revcl.join(" ")
+    #   end
+    #   cmd << " " << Util::quote_list(args)
+    #   info "cmd: #{cmd}".on_blue
+    #   cmd
+    # end
+    
+    # def line_counts
+    #   [ @svnelement && @svnelement.line_count, @fselement && @fselement.line_count ]
+    # end
+
+    def <=> other
+      @svn <=> other.svn
+    end
+
+    def to_s
+      "svn => " + @svn.to_s + "; local => " + @local.to_s
+    end
+  end
+end

data/lib/pvn/io/fselement.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+
+module PVN
+  # A filesystem element (directory or file).
+  class FSElement < Pathname
+    include Loggable
+    attr_reader :name
+    
+    def initialize name
+      @name = name
+      super
+    end
+    
+    def line_count
+      readlines.size
+    end
+  end
+end

data/lib/pvn/log/formatter/color_formatter.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel/log'
+
+module PVN
+  class ColorFormatter
+    include Loggable
+
+    def pad what, field
+      nspaces = [ width(field) - what.length, 1 ].max
+      " " * nspaces
+    end
+
+    def colorize what, field
+      colors = colors field
+      return what if colors.nil? || colors.empty?
+      colors.each do |col|
+        what = what.send col
+      end
+      what
+    end
+
+    def add_field value, field
+      colorize(value, field) + pad(value, field)
+    end
+  end
+end

data/lib/pvn/log/formatter/entries_formatter.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pvn/log/formatter/log_formatter'
+require 'pvn/log/formatter/entry_formatter'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  class EntriesFormatter < Formatter
+    attr_reader :from_head
+    attr_reader :from_tail
+
+    def initialize use_color, entries, from_head, from_tail
+      super use_color
+      @entries = entries
+      @from_head = from_head
+      @from_tail = from_tail
+    end
+
+    def format
+      lines = Array.new
+      total = @entries.size
+      @entries.each_with_index do |entry, idx|
+        ef = EntryFormatter.new use_colors, entry, idx, from_head, from_tail, total
+        lines.concat ef.format
+        
+        lines << '-' * 55
+      end
+      lines
+    end
+  end
+end

data/lib/pvn/log/formatter/entry_formatter.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pvn/log/formatter/log_formatter'
+require 'pvn/log/formatter/summary_formatter'
+require 'pvn/log/formatter/message_formatter'
+require 'pvn/log/formatter/path_formatter'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  class EntryFormatter < Formatter
+    attr_reader :entry
+    attr_reader :idx
+    attr_reader :from_head
+    attr_reader :from_tail
+    attr_reader :total
+
+    def initialize use_colors, entry, idx, from_head, from_tail, total
+      super use_colors
+      @entry = entry
+      @idx = idx
+      @from_head = from_head
+      @from_tail = from_tail
+      @total = total
+    end
+    
+    def format
+      if false
+        info "@entry.revision: #{@entry.revision}"
+        info "@entry.author  : #{@entry.author}"
+        info "@entry.date    : #{@entry.date}"
+        info "@entry.message : #{@entry.message}"
+        @entry.paths.each do |path|
+          info "    path.kind  : #{path.kind}"
+          info "    path.action: #{path.action}"
+          info "    path.name  : #{path.name}"
+        end
+      end
+      
+      lines = Array.new
+      
+      sf = SummaryFormatter.new use_colors, entry, idx, from_head, from_tail, total
+      lines << sf.format
+      lines << ""
+      
+      mf = MessageFormatter.new use_colors, entry.message
+      lines << mf.format
+      lines << ""
+
+      pf = PathFormatter.new use_colors, entry.paths
+      lines.concat pf.format
+      
+      lines
+    end
+  end
+end

data/lib/pvn/log/formatter/log_formatter.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'svnx/log/entry'
+require 'pvn/log/formatter/color_formatter'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  # a format for log entries
+  class Formatter < PVN::ColorFormatter
+
+    WIDTHS = { 
+      :revision     => 10, 
+      :neg_revision => 5,
+      :pos_revision => 5,
+      :author       => 25
+    }
+
+    COLORS = {
+      :revision     => [ :bold ],
+      :neg_revision => [ :bold ],
+      :pos_revision => [ :bold ],
+      :author       => [ :bold, :cyan ],
+      :date         => [ :bold, :magenta ],
+
+      :added        => [ :green ],
+      :modified     => [ :yellow ],
+      :deleted      => [ :red ],
+      :renamed      => [ :magenta ],
+
+      :dir          => [ :bold ],
+    }
+
+    attr_reader :use_colors
+
+    def initialize use_colors
+      @use_colors = use_colors
+      # should also turn this off if not on a terminal that supports colors ...
+    end
+
+    def write_entries entries, out = $stdout
+      entries.each_with_index do |entry, idx|
+        fmtlines = format entry, idx, entries.size
+        
+        out.puts fmtlines
+        out.puts '-' * 55
+      end
+    end
+
+    def width field
+      WIDTHS[field]
+    end
+
+    def colors field
+      use_colors ? COLORS[field] : nil
+    end
+  end
+end

data/lib/pvn/log/formatter/message_formatter.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pvn/log/formatter/log_formatter'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  class MessageFormatter < Formatter
+    def initialize use_colors, msg
+      super use_colors
+      @msg = msg
+    end
+
+    def format
+      use_colors ? @msg.white : @msg
+    end
+  end
+end

data/lib/pvn/log/formatter/path_formatter.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pvn/log/formatter/log_formatter'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  class PathFormatter < Formatter
+    PATH_ACTIONS = {
+      'M' => :modified,
+      'A' => :added,
+      'D' => :deleted,
+      'R' => :renamed
+    }
+
+    def initialize use_colors, paths
+      super use_colors
+      @paths = paths
+    end
+
+    def format
+      lines = Array.new
+      @paths.sort_by { |path| path.name }.each do |path|
+        pstr = "    "
+        if field = PATH_ACTIONS[path.action]
+          pstr << colorize(path.name, field)
+        else
+          raise "wtf?: #{path.action}"
+        end
+
+        if path.kind == 'dir'
+          pstr = colorize(pstr, :dir)
+        end
+
+        lines << pstr
+      end
+      lines
+    end
+  end
+end

data/lib/pvn/log/formatter/summary_formatter.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'pvn/log/formatter/log_formatter'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  class SummaryFormatter < Formatter
+    attr_reader :entry
+    attr_reader :idx
+    attr_reader :from_head
+    attr_reader :from_tail
+    attr_reader :total
+
+    def initialize use_colors, entry, idx, from_head, from_tail, total
+      super use_colors
+      @entry = entry
+      @idx = idx
+      @from_head = from_head
+      @from_tail = from_tail
+      @total = total
+    end
+
+    def format
+      lines = add_field(entry.revision, :revision)
+      negidx  = (-1 - idx).to_s
+
+      if from_head
+        lines << add_field(negidx, :neg_revision)
+      else
+        lines << pad("", :neg_revision)
+      end
+
+      # info "@total: #{total}"
+
+      if from_tail
+        posidx = "+#{total - idx - 1}"
+        lines << add_field(posidx, :pos_revision)
+      else
+        lines << pad("", :pos_revision)
+      end
+      
+      lines << add_field(entry.author, :author)
+      lines << colorize(entry.date, :date)
+      lines
+    end
+  end
+end

data/lib/pvn/log/logcmd.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'system/command'
+require 'system/cachecmd'
+require 'pvn/svn/command/svncmd'
+require 'pvn/log/logfactory'
+require 'pvn/log/logoptions'
+
+module PVN
+  class LogCommand < SVNCommand
+    COMMAND = "log"
+    REVISION_ARG = '-r'
+
+    attr_reader :options
+
+    self.doc do |doc|
+      doc.subcommands = [ COMMAND, 'l' ]
+      doc.description = "Print log messages for the given files."
+      doc.usage       = "[OPTIONS] FILE..."
+      doc.summary     = [ "Prints the log entries for the given files, with colorized",
+                          "output. Unlike 'svn log', which prints all log entries, ",
+                          "'pvn log' prints #{DEFAULT_LIMIT} entries by default.",
+                          "As with other pvn commands, 'pvn log' accepts relative ",
+                          "revisions."
+                        ]
+      doc.options.concat LogOptionSet.new.options
+      doc.examples   << [ "pvn log foo.rb",       "Prints the latest #{DEFAULT_LIMIT} log entries for foo.rb." ]
+      doc.examples   << [ "pvn log -l 25 foo.rb", "Prints 25 log entries for the file." ]
+      doc.examples   << [ "pvn log -3 foo.rb",    "Prints the log entry for revision (HEAD - 3)." ]
+      doc.examples   << [ "pvn log +3 foo.rb",    "Prints the 3rd log entry." ]
+      doc.examples   << [ "pvn log -l 10 -F",     "Prints the latest 10 entries, unformatted." ]
+      doc.examples   << [ "pvn log -r 122 -v",    "Prints log entry for revision 122, with the files in that change." ]
+    end
+    
+    def initialize args = Hash.new
+      @options = LogOptionSet.new
+      
+      debug "args: #{args.inspect}"
+      
+      @options.revision.fromdate = args[:fromdate]
+      @options.revision.todate = args[:todate]
+
+      @options.options.each do |opt|
+        info "opt: #{opt}".blue
+      end
+
+      @entries = nil
+
+      super
+    end
+
+    def has_entries?
+      true
+    end
+
+    def use_cache?
+      # use cache unless log is to head.
+      super && !@options.revision.head?
+    end
+
+    def entries
+      @entries ||= begin
+                     # of course this assumes that output is in plain text (non-XML)
+                     factory = PVN::Log::TextFactory.new output
+                     factory.entries
+                   end
+    end
+
+    def revision_of_nth_entry num
+      entry = nth_entry num
+      entry && entry.revision.to_i
+    end
+
+    def nth_entry n
+      entries[-1 * n]
+    end
+
+    def write_entries
+      info "@options: #{@options.inspect}"
+      info "@options.format: #{@options.format.inspect}".yellow
+
+      entries.each do |entry|
+        info "@options.format.value: #{@options.format.value}"
+        entry.write @options.format.value
+      end
+      unless @options.format
+        puts PVN::Log::Entry::BANNER
+      end
+    end
+
+    # this may be faster than get_nth_entry
+    def read_from_log_output n_matches
+      loglines = output.reverse
+
+      entries = entries
+      entry = entries[-1 * n_matches]
+      
+      if true
+        return entry && entry.revision.to_i
+      end
+
+      loglines.each do |line|
+        next unless md = SVN_LOG_SUMMARY_LINE_RE.match(line)
+        
+        info "md: #{md}".yellow
+        
+        n_matches -= 1
+        if n_matches == 0
+          return md[1].to_i
+        end
+      end
+      nil
+    end
+  end
+end
+
+module PVN::Log
+  class Command < CachableCommand
+    def initialize args
+      command = %w{ svn log }
+
+      # todo: handle revision conversion:
+      fromrev = args[:fromrev]
+      torev   = args[:torev]
+
+      if fromrev && torev
+        command << "-r" << "#{fromrev}:#{torev}"
+      elsif args[:fromdate] && args[:todate]
+        command << "-r" << "\{#{fromdate}\}:\{#{todate}\}"
+      end
+      debug "command: #{command}".on_red
+    end
+  end
+end
+end

data/lib/pvn/log/logentry.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel'
+require 'pvn/config'
+
+module PVN; module Log; end; end
+
+module PVN::Log
+  class Entry
+    include Loggable
+
+    FIELDS = [ :revision,
+               :user,
+               :date,
+               :time,
+               :tz,
+               :dtg,
+               :nlines,
+               :files,
+               :comment ]
+
+    FIELDS.each do |field|
+      attr_reader field
+    end
+
+    WRITE_FORMAT_DEFAULT = ('#{revision.yellow}\t#{user.green}\t#{date} #{time}\n' +
+                            '#{list(comment)}#{cr(files)}' +
+                            '#{list(files, :blue, :on_yellow)}\n')
+    
+    WRITE_SUMMARY_LINE = 'r#{revision} | #{user} | #{date} #{time} #{tz} (#{dtg}) | #{nlines} #{nlines.to_i == 1 ? "line" : "lines"}\n'
+    
+    WRITE_UNFORMATTED_VERBOSE = (WRITE_SUMMARY_LINE + 
+                                 'Changed Paths:\n' +
+                                 '#{list(files)}\n' +
+                                 '#{plainlist(comment)}')
+    
+    WRITE_UNFORMATTED_TERSE = (WRITE_SUMMARY_LINE + '\n' +
+                               '#{plainlist(comment)}')
+
+    BANNER = '-' * 72
+    
+    def set_from_args name, args
+      self.instance_variable_set '@' + name.to_s, args[name]
+    end
+
+    # Reads a log entry from the text, starting at the first line at or after
+    # lidx, matching the svn log separator line. Returns [ entry, new_index ],
+    # where new_index is the updated index into the lines. Returns nil if the
+    # text does not match the expected plain text format.
+    def self.create_from_text lines, lidx = 0
+      return TextOutputReader.create_from_text lines, lidx
+    end
+
+    def initialize args = Hash.new
+      FIELDS.each do |field|
+        set_from_args field, args
+      end
+    end
+
+    def cr ary
+      ary && !ary.empty? ? "\n" : ''
+    end
+
+    def list lines, *colors
+      return '' unless lines
+      
+      lines.collect do |line|
+        ln = line.chomp
+        colors.each do |color|
+          ln = ln.send(color)
+        end
+        "    " + ln + "\n"
+      end.join('')
+    end
+
+    def plainlist lines
+      return '' unless lines
+      
+      # ensure that each has a newline
+      lines.collect do |line|
+        line.chomp + "\n"
+      end.join('')
+    end
+
+    def write formatted
+      # ------------------------------------------------------------------------
+      # r1907 | hielke.hoeve@gmail.com | 2011-11-14 05:50:38 -0500 (Mon, 14 Nov 2011) | 1 line
+      #
+      # back to dev
+
+      if formatted
+        cfg = PVN::Configuration.read
+        
+        logcfg = cfg.section "log"
+        info "logcfg: #{logcfg}"
+        format = logcfg && logcfg.assoc('format') && logcfg.assoc('format')[1]
+        info "format: #{format}"
+
+        format ||= WRITE_FORMAT_DEFAULT
+
+        # @todo allow reformatting of date and time
+        # format = WRITE_FORMAT_DEFAULT
+        msg = eval('"' + format + '"')
+        print msg
+      else
+        puts BANNER
+
+        fmt = files ? WRITE_UNFORMATTED_VERBOSE : WRITE_UNFORMATTED_TERSE
+        
+        puts eval('"' + fmt + '"')
+      end
+    end
+  end
+end