portvcs 0.0.1

data/README.rdoc

@@ -0,0 +1,104 @@
+=Name
+
+portvcs--FreeBSD ports commits history viewer that doesn't require
+neither local ports tree nor CVS checkouts.
+
+
+==Synopsis
+
+ portvcs [options] category/port
+
+
+==Description
+
+The portvcs utility connects to a remote VCS (Version Control System)
+server and grabs the history of commits.
+
+At the time of writing FreeBSD uses CVS (jeez) for its ports collection,
+so portvcs (with default configuration) connects to well-known French
+CVS server via TCP port 2401 and reads the logs of a particular port.
+By default the utility constrains the history to 1 year but that's easy
+changeable via +-d+ CL (command line) option.
+
+portvcs isn't restricted to FreeBSD ports--it can read logs from
+(probably) any CVS server but in that case its usefulness is very
+doubtful.
+
+The options are as follows:
+
+--ports-tree-local DIR::    Set this if you have the ports tree
+                            directory in an unusual place.
+
+--config-dirs::             List all possible locations for the
+                            configuration file. The first found wins.
+
+--config NAME::             The name of the configuration file. If
+                            it contains +/+ in it, the list from
+                            <tt>\--config-dirs</tt> is ignored.
+
+-d EXP::                     Passes the EXP to VCS server to set limits
+                             for the logs. Usually it's something like
+                             '2 months ago<'. For all possible values,
+                             read the help for the option +-d+ in cvs
+                             help for its log command, e.g, type:
+
+                              % info -n '(cvs)log options'
+
+--host STR::                A hostname of a remote server.
+
+--port N::                  A port number (default is 2401) of the
+                            remote server.
+
+--user STR::                A user name on the remote server. 
+
+--pass STR::                A password for the user on the remote
+                            server.
+
+--cvsroot DIR::             CVSROOT on a remote server.
+
+--ports-tree DIR::          A directory that follows CVSROOT and serves
+                            as a ports tree. For example, CVSROOT can
+                            be +/home/ncvs+ and the ports directory can
+                            be +ports+ or may be empty at all.
+
+--vcs-version::             Just get version of a remote VCS server and
+                            exit.
+
+--cvs-pass-scramble STR::   A handy option for encrypting...
+--cvs-pass-descramble STR:: ... and decrypting CVS passwords.
+
+-V::                         Show portvcs version and exit.
+
+-v::                         Be more verbose. You can supply it several
+                             times, viz. +-vv+ dumps even more debug info.
+
+==Configuration
+
+portvcs looks for its configuration at 3 places at start up.
+
+1. At <tt>PORTVCS_CONF</tt> env variable. (Its format is exactly similar
+   to CL options.)
+
+2. At configuration file. Its default name is <tt>portvcs.yaml</tt> and
+   it can be stored in several system directories which are observable
+   by <tt>--config--dirs</tt> CL option.
+
+3. At command line.
+
+Higher number levels overrides the values from lower number levels.
+
+The configuration file must be in YAML format. Look into <tt>`gem env
+gemdir`/gems/portvcs-x.y.z/etc/</tt> directory for samples.
+
+
+==Examples
+
+ % portvcs www/firefox
+ % portvcs /usr/ports/www/firefox
+ % portvcs www/firefox/files/patch-configure.in
+
+ % pwd
+ /usr/ports/x11-toolkits/gtk20
+ % portvcs Makefile
+ % portvcs files/patch-gtk_gtksignal.h
+ % portvcs -d '3 month ago<' .

data/Rakefile

@@ -0,0 +1,43 @@
+# -*-ruby-*-
+
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new() {|i|
+  i.name = "portvcs"
+  i.version = `bin/#{i.name} -V`
+  i.summary = "FreeBSD ports commits history viewer that doesn't require neither local ports tree nor CVS checkouts."
+  i.author = 'Alexander Gromnitsky'
+  i.email = 'alexander.gromnitsky@gmail.com'
+  i.homepage = "http://github.com/gromnitsky/#{i.name}"
+  i.platform = Gem::Platform::RUBY
+  i.required_ruby_version = '>= 1.9.2'
+  i.files = FileList['lib/**/*', 'bin/*', 'doc/*', 'etc/*', '[A-Z]*', 'test/**/*']
+
+  i.executables = FileList['bin/*'].gsub(/^bin\//, '')
+  i.default_executable = i.name
+  
+  i.test_files = FileList['test/test_*.rb']
+  
+  i.rdoc_options << '-m' << 'doc/README.rdoc'
+  i.extra_rdoc_files = FileList['doc/*']
+  
+  i.add_development_dependency('open4', '>=  1.0.1')
+}
+
+Rake::GemPackageTask.new(spec).define()
+
+task(default: %(repackage))
+
+Rake::RDocTask.new('doc') {|i|
+  i.main = 'doc/README.rdoc'
+  i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
+  i.rdoc_files.exclude("lib/**/plugins")
+}
+
+Rake::TestTask.new() {|i|
+  i.test_files = FileList['test/test_*.rb']
+}

data/bin/portvcs

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+
+require 'date'
+require 'optparse'
+require 'yaml'
+require 'shellwords.rb'
+
+require_relative '../lib/portvcs/portvcs.rb'
+require_relative '../lib/portvcs/utils.rb'
+
+include PortVCS
+
+$conf = {
+  verbose: 0,
+  banner: "Usage: #{File.basename($0)} [options] category/port",
+
+  vcs: 'cvs',
+  vcs_legal: ['cvs'], # TODO: get this array automatically
+  host: '',
+  port: 2401,
+  user: '',
+  cvsroot: '',
+  pass: '',
+  ports_tree: '',
+
+  date_cond: "#{(DateTime.now - 366).strftime('%d %b %Y')}<",
+
+  config: 'portvcs.yaml',
+  config_dirs: [File.absolute_path("#{File.dirname(File.expand_path($0))}/../etc"),
+                '/etc', '/usr/etc', '/usr/local/etc',
+               "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/etc"],
+
+  mode: 'log',
+  ports_tree_local: '/usr/ports'
+}
+
+def veputs(level, t)
+  puts(t) if $conf[:verbose] >= level
+end
+
+def errx(ec, t)
+  STDERR.puts File.basename($0) + ' error: ' + t.to_s
+  exit ec if ec > 0
+end
+
+def cl_parse(myargs, times = 1)
+  o = OptionParser.new()
+  o.banner = $conf[:banner]
+  o.on('-V', 'Show the program version') {
+    puts Meta::VERSION
+    exit 0
+  }
+  o.on('--cvs-pass-scramble STR', 'Handy encoding of CVS passwords') { |v|
+    puts CVSDumb.pass_scramble(v)
+    exit 0
+  }
+  o.on('--cvs-pass-descramble STR') { |v|
+    puts CVSDumb.pass_descramble(v)
+    exit 0
+  }
+  o.on('--config NAME', "Set a config name (default is #{$conf[:config]})") {|v|
+    $conf[:config] = v
+  }
+  o.on('--config-dirs', 'Show possible config locations') {
+    $conf[:config_dirs].each { |i|
+      f = i + '/' + $conf[:config]
+      puts (File.readable?(f) ? '* ' : '  ') +  f
+    }
+    exit 0
+  }
+  o.on('--ports-tree-local DIR', "(Default is #{$conf[:ports_tree_local]})") { |v| $conf[:ports_tree_local] = v }
+  o.on('-v', 'Be more verbose') {
+    # protect variable from incrementing in a second parse round
+    $conf[:verbose] += 1 if times <= 1
+  }
+  o.on('--host STR') { |v| $conf[:host] = v }
+  o.on('--port N', Integer, "(default is #{$conf[:port]})") { |v| $conf[:port] = v }
+  o.on('--user STR') { |v| $conf[:user] = v }
+  o.on('--pass STR') { |v| $conf[:pass] = v }
+  o.on('--ports-tree DIR') { |v| $conf[:ports_tree] = v }
+  o.on('--cvsroot DIR') { |v| $conf[:cvsroot] = v }
+  o.on('-d EXP', "Date condition, for example '1 Jan 2010<'") { |v| $conf[:date_cond] = v }
+  o.on('--vcs TYPE', $conf[:vcs_legal], "Select version control system (#{$conf[:vcs_legal].join(', ')})") { |v| $conf[:vcs] = v }
+  o.on('--vcs-version', 'Get version of a remote VCS server') { $conf[:mode] = 'version' }
+
+  begin
+    o.parse!(myargs)
+  rescue
+    errx(1, $!)
+  end
+end
+
+def pager_setup
+  [ENV['PAGER'], 'less', 'more'].compact.uniq.each {|i|
+    next unless Utils.in_path?(i.split.first)
+    io = IO.popen(i, "w") rescue next
+    next if $? and $?.exited? # pager didn't work
+    veputs(2, "Pager: #{i}")
+    return io
+  }
+  return nil
+end
+
+
+# --[ main ]------------------------------------------------------------
+
+# 1. parse env var
+if ENV.key?(Meta::NAME.upcase + '_CONF')
+  cl_parse ENV[Meta::NAME.upcase + '_CONF'].shellsplit
+end
+
+# 2. parse CL in case of --config option
+argv1 = ARGV.dup
+cl_parse argv1
+
+# 3. load config & final CL parse
+begin
+  r = Utils.config_load($conf, $conf[:config], $conf[:config_dirs])
+rescue
+  errx(1, "cannot load config: #{$!}")
+end
+veputs(1, "Loaded config: #{r}")
+cl_parse ARGV, 2
+
+abort($conf[:banner]) if (ARGV.size == 0 || ARGV[0] =~ /^\s*$/) && $conf[:mode] == 'log'
+
+# print our env
+if $conf[:verbose] >= 1
+  puts 'Libs dir: '+Utils.gem_libdir
+  pp $conf
+end
+
+# 4. connect to remote VCS
+v = VCS.new($conf[:vcs])
+begin
+  v.open(debug: ($conf[:verbose] >= 2 ? true : false), host: $conf[:host], cvsroot: $conf[:cvsroot],
+         port: $conf[:port], user: $conf[:user], pass: $conf[:pass],
+         ports_tree: $conf[:ports_tree]) { |vp|
+  
+    case $conf[:mode]
+    when 'version'
+      puts vp.version
+    else
+      if !(p = Utils.port_extract_name(ARGV[0].dup.strip, $conf[:ports_tree_local]))
+        errx(1, "invalid port name")
+      end
+      p[1] = 'Makefile' if !p[1]
+
+      out = pager_setup() || STDOUT # get output stream
+      vp.log(p[0], p[1], $conf[:date_cond]) {|i|
+        begin
+          out.puts i
+        rescue Errno::EPIPE
+          out = STDOUT
+          retry
+        end
+      }
+      out.close unless out == STDOUT
+    end
+  }
+rescue
+  errx(1, $!)
+end

data/doc/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Alexander Gromnitsky.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/doc/README.rdoc

@@ -0,0 +1,104 @@
+=Name
+
+portvcs--FreeBSD ports commits history viewer that doesn't require
+neither local ports tree nor CVS checkouts.
+
+
+==Synopsis
+
+ portvcs [options] category/port
+
+
+==Description
+
+The portvcs utility connects to a remote VCS (Version Control System)
+server and grabs the history of commits.
+
+At the time of writing FreeBSD uses CVS (jeez) for its ports collection,
+so portvcs (with default configuration) connects to well-known French
+CVS server via TCP port 2401 and reads the logs of a particular port.
+By default the utility constrains the history to 1 year but that's easy
+changeable via +-d+ CL (command line) option.
+
+portvcs isn't restricted to FreeBSD ports--it can read logs from
+(probably) any CVS server but in that case its usefulness is very
+doubtful.
+
+The options are as follows:
+
+--ports-tree-local DIR::    Set this if you have the ports tree
+                            directory in an unusual place.
+
+--config-dirs::             List all possible locations for the
+                            configuration file. The first found wins.
+
+--config NAME::             The name of the configuration file. If
+                            it contains +/+ in it, the list from
+                            <tt>\--config-dirs</tt> is ignored.
+
+-d EXP::                     Passes the EXP to VCS server to set limits
+                             for the logs. Usually it's something like
+                             '2 months ago<'. For all possible values,
+                             read the help for the option +-d+ in cvs
+                             help for its log command, e.g, type:
+
+                              % info -n '(cvs)log options'
+
+--host STR::                A hostname of a remote server.
+
+--port N::                  A port number (default is 2401) of the
+                            remote server.
+
+--user STR::                A user name on the remote server. 
+
+--pass STR::                A password for the user on the remote
+                            server.
+
+--cvsroot DIR::             CVSROOT on a remote server.
+
+--ports-tree DIR::          A directory that follows CVSROOT and serves
+                            as a ports tree. For example, CVSROOT can
+                            be +/home/ncvs+ and the ports directory can
+                            be +ports+ or may be empty at all.
+
+--vcs-version::             Just get version of a remote VCS server and
+                            exit.
+
+--cvs-pass-scramble STR::   A handy option for encrypting...
+--cvs-pass-descramble STR:: ... and decrypting CVS passwords.
+
+-V::                         Show portvcs version and exit.
+
+-v::                         Be more verbose. You can supply it several
+                             times, viz. +-vv+ dumps even more debug info.
+
+==Configuration
+
+portvcs looks for its configuration at 3 places at start up.
+
+1. At <tt>PORTVCS_CONF</tt> env variable. (Its format is exactly similar
+   to CL options.)
+
+2. At configuration file. Its default name is <tt>portvcs.yaml</tt> and
+   it can be stored in several system directories which are observable
+   by <tt>--config--dirs</tt> CL option.
+
+3. At command line.
+
+Higher number levels overrides the values from lower number levels.
+
+The configuration file must be in YAML format. Look into <tt>`gem env
+gemdir`/gems/portvcs-x.y.z/etc/</tt> directory for samples.
+
+
+==Examples
+
+ % portvcs www/firefox
+ % portvcs /usr/ports/www/firefox
+ % portvcs www/firefox/files/patch-configure.in
+
+ % pwd
+ /usr/ports/x11-toolkits/gtk20
+ % portvcs Makefile
+ % portvcs files/patch-gtk_gtksignal.h
+ % portvcs -d '3 month ago<' .

data/doc/TODO

@@ -0,0 +1,2 @@
++ pager
+- turn on gzip in cvs protocol

data/etc/fr.FreeBSD.org.yaml

@@ -0,0 +1,7 @@
+--- 
+:host: anoncvs.fr.FreeBSD.org
+:port: 2401
+:user: anoncvs
+:pass: anoncvs
+:cvsroot: /home/ncvs
+:ports_tree: ports

data/etc/portvcs.yaml

@@ -0,0 +1,7 @@
+--- 
+:host: anoncvs.fr.FreeBSD.org
+:port: 2401
+:user: anoncvs
+:pass: anoncvs
+:cvsroot: /home/ncvs
+:ports_tree: ports

data/lib/portvcs/meta.rb

@@ -0,0 +1,6 @@
+module PortVCS
+  module Meta
+    NAME = 'portvcs'
+    VERSION = '0.0.1'
+  end
+end

data/lib/portvcs/portvcs.rb

@@ -0,0 +1,180 @@
+require 'socket'
+
+# :include: ../../README.rdoc
+module PortVCS
+  
+  # A wrapper for *Dumb classes
+  class VCS
+    
+    def self.select(type)
+      case type
+      when 'cvs'
+        return CVSDumb
+      else
+        fail "unknown VCS '#{type}'"
+      end
+    end
+    
+    # sys -- a class like CVSDumb
+    def initialize(sys)
+      @sys = VCS.select(sys)
+    end
+
+    attr_accessor :sys
+
+    def open(p)
+      s1 = s2 = @sys.new(p)
+      if block_given?
+        begin
+          s1 = yield(s2)
+        rescue
+          fail $!
+        ensure
+          s2.close
+        end
+      end
+      
+      return s1
+    end
+    
+  end # VCS
+
+  class CVSDumb
+    # debug print prefixes
+    CLIENT = 'C: '
+    SERVER = 'S: '
+
+    PASSPAIR = {
+      ?! => 120, ?" => 53, ?% => 109, ?& => 72, ?' => 108, ?( => 70, ?) => 64,
+      ?* => 76, ?+ => 67, ?, => 116, ?- => 74, ?. => 68, ?/ => 87, ?0 => 111,
+      ?1 => 52, ?2 => 75, ?3 => 119, ?4 => 49, ?5 => 34, ?6 => 82, ?7 => 81,
+      ?8 => 95, ?9 => 65, ?: => 112, ?; => 86, ?< => 118, ?= => 110, ?> => 122,
+      ?? => 105, ?A => 57, ?B => 83, ?C => 43, ?D => 46, ?E => 102, ?F => 40,
+      ?G => 89, ?H => 38, ?I => 103, ?J => 45, ?K => 50, ?L => 42, ?M => 123,
+      ?N => 91, ?O => 35, ?P => 125, ?Q => 55, ?R => 54, ?S => 66, ?T => 124,
+      ?U => 126, ?V => 59, ?W => 47, ?X => 92, ?Y => 71, ?Z => 115, ?_ => 56,
+      ?a => 121, ?b => 117, ?c => 104, ?d => 101, ?e => 100, ?f => 69, ?g => 73,
+      ?f => 69, ?h => 99, ?i => 63, ?j => 94, ?k => 93, ?l => 39, ?m => 37,
+      ?n => 61, ?o => 48, ?p => 58, ?q => 113, ?r => 32, ?s => 90, ?t => 44,
+      ?u => 98, ?v => 60, ?w => 51, ?x => 33, ?y => 97, ?z => 62
+    }
+
+    def self.pass_scramble(t)
+      r = ?A
+      t.each_char {|i|
+        fail "invalid char in pass: #{i}" if ! PASSPAIR.key? i
+        r << PASSPAIR[i].chr
+      }
+      return r
+    end
+
+    # the algorithm is symmetric
+    def self.pass_descramble(t)
+      pass_scramble(t)[2..-1]
+    end
+
+    # p is a hash
+    def initialize(p)
+      @host = p[:host]
+      @port = p[:port]
+      @user = p[:user]
+      @pass = p[:pass]
+      @cvsroot = p[:cvsroot].strip
+      @debug = p[:debug]
+      @ports_tree = p[:ports_tree].strip
+
+      @client = TCPSocket.open(@host, @port)
+      request("BEGIN AUTH REQUEST")
+      request(@cvsroot)
+      request(@user)
+      request(CVSDumb.pass_scramble(@pass))
+      request("END AUTH REQUEST")
+      fail "cannot auth to #{@user}@#{@host}" if getline != 'I LOVE YOU'
+    end
+
+    attr_accessor :debug
+
+    def version
+      request('version')
+      request('noop')
+      r = getline_text
+      getline # for 'noop'
+      return r
+    end
+
+    def log(dir, file = nil, date_cond = nil)
+      request("Root #{@cvsroot}")
+      request("Directory .")
+      request("#{@cvsroot}/#{@ports_tree.to_s == '' ? '' : @ports_tree + '/'}#{dir}")
+      request("Argument -N")
+      if date_cond
+        request("Argument -d")
+        request("Argument #{date_cond}")
+      end
+      request("Argument #{file}") if file != nil
+      request('log')
+
+      getmultilines_text {|i| yield i }
+    end
+    
+    def close
+      @client.close
+    end
+
+    
+    protected
+    
+    # debug print
+    def dputs(type, t)
+      puts "#{type}#{t}" if debug
+    end
+
+    def getline
+      r = @client.gets.strip
+      dputs(SERVER, r)
+      return r
+    end
+
+    def getline_text
+      @client
+      r = getline
+      if r.match(/^M (.+)/)
+        getline # read final 'ok\n'
+        return $1
+      else
+        fail "protocol error (unexpected string): #{r}"
+      end
+    end
+
+    def getmultilines_text
+      is_error = false
+      e = []
+      while line = @client.gets.strip
+        break if line == 'ok'
+        if line == 'error'
+          is_error = true
+          break
+        end
+
+        if (line =~ /^(M|E) ?(.*)/)
+          if $1 == 'E'
+            e << $2
+          else
+            yield $2
+          end
+        else
+          fail "protocol error (unexpected string): #{line}"
+        end
+      end
+
+      fail "protocol error: " + e.join(', ') if is_error
+    end
+
+    def request(t)
+      @client.send("#{t}\n", 0)
+      dputs(CLIENT, t)
+    end
+    
+  end # CVSDumb
+
+end # module

data/lib/portvcs/utils.rb

@@ -0,0 +1,88 @@
+require 'pp'
+require_relative 'meta'
+
+module PortVCS
+
+  class Utils
+    
+    # load config file immediately if it contains '/' in its name,
+    # otherwise search through several dirs for it.
+    #
+    # conf -- a hash to merge result with
+    #
+    # return a loaded filename or nil on error
+    def self.config_load(conf, file, dirs)
+      p = ->(f) {
+        if File.readable?(f)
+          begin
+            myconf = YAML.load_file(f)
+          rescue
+            abort("cannot parse #{f}: #{$!}")
+          end
+          %w(host port user pass cvsroot ports_tree).each { |i|
+            fail "missing or nil '#{i}' in #{f}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
+          }
+          conf.merge!(myconf)
+          return file
+        end
+        return nil
+      }
+
+      if file.index('/')
+        return p.call(file)
+      else
+        dirs.each {|dir| return dir+'/'+file if p.call(dir + '/' + file) }
+      end
+
+      return nil
+    end
+
+    # p -- a string to examine
+    # ptree -- a directory name with a local port tree, for example "/usr/ports"
+    def self.port_extract_name(t, ptree)
+      return nil if t.to_s == '' || (! t.index('/') && Dir.pwd !~ /^#{ptree}/)
+
+      t.sub!(/#{ptree}(\/*)?/, '') if t =~ /^#{ptree}/
+      return nil if t[0] == '/'
+
+      # idempotent lambda
+      inptree = ->() {
+        if Dir.pwd =~ /^#{ptree}/
+          l = (d = Dir.pwd.sub(/#{ptree}(\/*)?/, '')).split('/').length
+          return File.split(d + '/' + t) if l >= 2 && l <= 3
+        end
+      }
+      
+      case t.split('/').length
+      when 1
+        return inptree.call
+      when 2
+        # assuming files/patch-aa in /usr/ports/www/firefox/files/
+        return inptree.call if inptree.call
+        # assuming www/firefox
+        return [t]
+      when 3..4
+        # assuming www/firefox/Makefile
+        return File.split(t)
+      end
+
+      return nil
+    end
+
+    def self.gem_libdir
+      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{PortVCS::Meta::NAME}",
+           "#{Gem.dir}/gems/#{PortVCS::Meta::NAME}-#{PortVCS::Meta::VERSION}/lib/#{PortVCS::Meta::NAME}"]
+      t.each {|i| return i if File.readable?(i) }
+      fail "both paths are invalid: #{t}"
+    end
+
+    def self.in_path?(file)
+      return true if file =~ %r%\A/% and File.exist? file
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
+        File.exist? File.join(path, file)
+      end
+    end
+    
+  end # Utils
+end

data/test/helper.rb

@@ -0,0 +1,45 @@
+# various staff for minitest
+
+require 'fileutils'
+require 'open4'
+
+include FileUtils
+
+require_relative '../lib/portvcs/utils'
+include PortVCS
+
+# don't run tests automatically if they were invoked as 'gem check -t ...'
+if $0 =~ /gem/
+  require 'minitest/unit'
+else
+  require 'minitest/autorun'
+end
+
+def cmd_run(cmd)
+  so = sr = ''
+  status = Open4::popen4(cmd) { |pid, stdin, stdout, stderr|
+    so = stdout.read
+    sr = stderr.read
+  }
+  [status.exitstatus, sr, so]
+end
+
+# return the right directory for (probably executable) _c_
+def cmd(c)
+  case File.basename(Dir.pwd)
+  when Meta::NAME.downcase
+    # test probably is executed from the Rakefile
+    Dir.chdir('test')
+  when 'test'
+    # we are in the test directory, there is nothing special to do
+  else
+    # tests were invoked by 'gem check -t bwkfanboy'
+    begin
+      Dir.chdir(Utils.gem_libdir + '/../../test')
+    rescue
+      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
+    end
+  end
+
+  '../bin/' + c
+end

data/test/semis/cvstest/portvcs/Makefile

@@ -0,0 +1,2 @@
+# "There is no way to do CVS right."
+#   -- Linus Torvalds.

data/test/semis/localhost_cvs.yaml

@@ -0,0 +1,7 @@
+--- 
+:host: 127.0.0.1
+:port: 2401
+:user: anonymous
+:pass: anoncvs
+:cvsroot: /usr/local/cvsroot
+:ports_tree: ''

data/test/semis/localhost_cvs_incomplete.yaml

@@ -0,0 +1,7 @@
+--- 
+:host: 127.0.0.1
+:port: 
+:user: anonymous
+:pass: anoncvs
+:cvsroot: /usr/local/cvsroot
+:ports_tree: ''

data/test/test_cvsdumb.rb

@@ -0,0 +1,39 @@
+require_relative 'helper'
+
+class TestCVSDumb < MiniTest::Unit::TestCase
+  CMD = 'portvcs'
+  CONFIG = 'semis/localhost_cvs.yaml'
+  MSG = 'This test requires a running CVS server on localhost with auth credentials
+listed in semis/localhost_cvs.yaml file'
+  
+  def setup
+    cmd 'foobar' # cd to tests directory
+
+    @skip_log_of_the_something = true
+    # this probably won't work on your machine
+    if ENV.key?('CVSROOT').to_s !~ /^\s*$/
+      cd 'semis/cvstest'
+      cmd_run("rm -rf '" + ENV['CVSROOT']+'/test/portvcs' + "'")
+      r = cmd_run("cvs import -m 'Huh?' test foo bar")
+      if r[0] != 0
+        warn("cannot import a test file into #{ENV['CVSROOT']}: "+r[1..-1].join('; '))
+      else
+        @skip_log_of_the_something = false
+      end
+      cd '../..'
+    end
+  end
+
+  def test_version
+    r = cmd_run("#{cmd CMD} --config #{CONFIG} --vcs-version")
+    assert_equal(0, r[0], MSG)
+    assert_match(/Concurrent Versions System \(CVS\) 1.11/, r[2])
+  end
+
+  def test_log_of_the_something
+    skip('cvsroot on localhost is not ready') if @skip_log_of_the_something
+    r = cmd_run("#{cmd CMD} --config #{CONFIG} test/portvcs")
+    assert_equal(0, r[0], MSG)
+    refute_equal(0, r[2].size)
+  end
+end

data/test/test_utils.rb

@@ -0,0 +1,68 @@
+require_relative 'helper'
+
+class TestUtils < MiniTest::Unit::TestCase
+  def setup
+    cmd 'foobar' # cd to tests directory
+    @ptree = Dir.pwd + '/' + 'ports'
+  end
+
+  def test_name_resolution
+    save = Dir.pwd
+    
+    assert_equal(nil, Utils.port_extract_name(nil, @ptree))
+    assert_equal(nil, Utils.port_extract_name('', nil))
+    assert_equal(nil, Utils.port_extract_name('    ', nil))
+    assert_equal(nil, Utils.port_extract_name('foo    ', nil))
+    assert_equal(nil, Utils.port_extract_name('/', nil))
+    assert_equal(nil, Utils.port_extract_name('////////// //////', nil))
+    assert_equal(nil, Utils.port_extract_name('//////////', nil))
+    assert_equal(nil, Utils.port_extract_name('/foo', nil))
+    assert_equal(nil, Utils.port_extract_name('foo/', nil))
+    
+    assert_equal(['foo/bar'], Utils.port_extract_name('/foo/bar', nil))
+    assert_equal(['q/w', 'e'], Utils.port_extract_name('/q/w/e', nil))
+    assert_equal(['q/w/e', 'r'], Utils.port_extract_name('/q/w/e/r', nil))
+    assert_equal(nil, Utils.port_extract_name('/q/w/e/r/t', nil))
+    assert_equal(nil, Utils.port_extract_name('/q/w/e/r/t/y/u/i/o', nil))
+
+    Dir.chdir @ptree
+    assert_equal(nil, Utils.port_extract_name('program', @ptree))
+    assert_equal(['category/program'],
+                 Utils.port_extract_name('category/program', @ptree))
+    assert_equal(['category/program', 'Makefile'],
+                 Utils.port_extract_name('category/program/Makefile', @ptree))
+
+    Dir.chdir 'category'
+    assert_equal(nil, Utils.port_extract_name('program', @ptree))
+
+    Dir.chdir 'program'
+    assert_equal(["category/program", "pkg-descr"],
+                 Utils.port_extract_name('pkg-descr', @ptree))
+
+    assert_equal(["category/program/files", "patch-aa"],
+                 Utils.port_extract_name('files/patch-aa', @ptree))
+    
+    Dir.chdir 'files'
+    assert_equal(["category/program/files", "patch-aa"],
+                 Utils.port_extract_name('patch-aa', @ptree))
+
+    Dir.chdir save
+  end
+
+  def test_config
+    t = { foo: 'bar' }
+    t_exp = {
+      foo: 'bar', host: '127.0.0.1', port: 2401, user: 'anonymous',
+      pass: 'anoncvs', cvsroot: '/usr/local/cvsroot', ports_tree: ''
+    }
+
+    assert_equal('semis/localhost_cvs.yaml',
+                 Utils.config_load(t, 'semis/localhost_cvs.yaml', nil))
+    assert_equal(t_exp, t)
+
+    assert_raises(RuntimeError) {
+      Utils.config_load(t, 'semis/localhost_cvs_incomplete.yaml', nil)
+    }
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: portvcs
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexander Gromnitsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-13 00:00:00 +02:00
+default_executable: portvcs
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :development
+  version_requirements: *id001
+description: 
+email: alexander.gromnitsky@gmail.com
+executables: 
+- portvcs
+extensions: []
+
+extra_rdoc_files: 
+- doc/TODO
+- doc/README.rdoc
+- doc/LICENSE
+files: 
+- lib/portvcs/portvcs.rb
+- lib/portvcs/utils.rb
+- lib/portvcs/meta.rb
+- bin/portvcs
+- doc/TODO
+- doc/README.rdoc
+- doc/LICENSE
+- etc/portvcs.yaml
+- etc/fr.FreeBSD.org.yaml
+- README.rdoc
+- Rakefile
+- test/ports/category/program/files/patch-aa
+- test/ports/category/program/Makefile
+- test/ports/category/program/pkg-descr
+- test/helper.rb
+- test/semis/localhost_cvs.yaml
+- test/semis/localhost_cvs_incomplete.yaml
+- test/semis/cvstest/portvcs/Makefile
+- test/test_utils.rb
+- test/test_cvsdumb.rb
+has_rdoc: true
+homepage: http://github.com/gromnitsky/portvcs
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- -m
+- doc/README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: FreeBSD ports commits history viewer that doesn't require neither local ports tree nor CVS checkouts.
+test_files: 
+- test/test_utils.rb
+- test/test_cvsdumb.rb