vcs 0.2.148 → 0.3.0

data/AUTHORS

@@ -0,0 +1,6 @@
+---
+Vcs was written by and with the assistance of:
+
+  - Nicolas Pouillard <ertai@lrde.epita.fr>:
+      - Initial Design
+      - Maintenance

data/NEWS

@@ -0,0 +1,9 @@
+New in 0.3 2005-09-16:
+
+  * The help command now show all commands including vcs ones.
+  * New system to fill values like the subject, the title... of your
+    changelog, mails and news which belong to your patches.
+  * No more put the subject as an argument of vcs.
+  * Improve the command running handling, vcs calls are now full stream based.
+  * Add two commands `url' and `script'.
+  * Improve the error handling.

data/README

@@ -0,0 +1,82 @@
+---
+
+- Intro: >
+    C'est  un  wrapper  pour  les  syst�mes  de  versions comme Svn, Cvs, Prcs,
+    Arch...  Il  permet  donc  au  minimum  de  faire  tout  ce  que le syst�me
+    sous-jacent propose, mais l'avantage est de pouvoir l'�tendre facilement.
+
+- HOWTO: Reportez vous au fichier HOWTO pour configurer et installer Vcs.
+    
+- Description:
+
+  - Les commandes de base peuvent �tre surcharg�es: >
+      par exemple `svn commit' a un comportement non interactif par d�faut.
+
+      Mais l'on peut tout de m�me appeler le v�ritable `svn commit'.
+
+      Pour cela il y a une convention: toutes les m�thodes terminant par `_'
+      sont directement celles du syst�me.
+
+      Avec cela on peut v�rifier que l'outil est bien devant le vrai svn:
+      svn status_
+
+  - Quelques fonctionnalit�s:
+
+      - Un des principaux avantages est la gestion des erreurs: >
+
+          Par exemple on utilise une commande qui commit puis poste une news.
+          Si le commit r�ussit et que la news ne passe pas, il suffit de
+          relancer l'envoi de la news: svn news
+
+          En effet chaque m�thode peut conserver des fichiers, ces fichiers
+          commencent par `,'.
+
+      - Les alias de m�thodes: >
+
+          Tout comme svn et cvs il existe des raccourcis pour certaines m�thodes
+          et bien s�r lorsque l'on surcharge une m�thode, le raccourci pointe
+          vers la nouvelle m�thode.
+
+      - Quelques nouvelles m�thodes:
+
+          - svn revision: Renvoie le num�ro de r�vision courante
+            alias: rev
+
+          - svn mkchangelog: G�n�re une entr�e de ChangeLog � partir de `status'
+            alias: mkcl
+
+          - svn changelog: Concat�ne la nouvelle entr�e au v�ritable ChangeLog
+            alias: cl
+
+          - svn message: Cr�e le contenu du message du mail ou de la news
+            alias: msg
+
+          - svn mail: Envoie un mail.
+
+          - svn news: Poste une news.
+
+      - Plus facile d'�crire des scripts: >
+
+          Lorsque l'on veut automatiser un traitement fait avec un Rcs,
+          il est g�n�ralement plus simple de le faire en script shell
+          lorsque cela n'exc�de pas une dixaine de lignes. Apr�s cela certains
+          avantages des langages de script �volu�s nous manquent.
+          Pourtant certaines choses tr�s faciles peuvent devenir plus lourdes:
+            svn commit => system("svn commit")
+
+          Heureusement avec le mod�le objet d�j� pos� cela devient plus
+          raisonnable, comparez par exemple:
+
+            svn commit => svn.commit
+
+            svn info | grep '^Revision' | sed s/^Revision: //
+
+              =>
+
+            svn.info.readlines.grep(/^Revision/)[0].sub(/^Revision: /, '').to_i
+
+  - Exemple final: commit complet pour les lrde tools.
+
+    commande: svn lrdetools_commit 'votre sujet pour la news'
+
+    ensuite: laissez vous guider.

data/Rakefile

@@ -1,73 +1,8 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-
-PKG_VERSION = "0.2.#{`vcs-svn rev`.chomp}"
-
-PKG_FILES = FileList[*%w"
-  src/**/*.rb
-  ruby_ex/**/*.rb
-  bin/**/*
-  doc/**/*
-  [A-Z]*
-"].exclude(/\b\.svn\b|\..*\.sw[op]$|~$|README/)
-
-desc 'Default Task'
-task :default => :package
-
-desc 'Publish to RubyForge'
-task :rubyforge do
-  Rake::RubyForgePublisher.new('vcs', 'ertai').upload
-end
-
-
-Rake::RDocTask.new('doc') do |rdoc|
-  rdoc.title = 'Vcs -- A wrapper over any version control system'
-  rdoc.template = 'kilmer'
-  #rdoc.template = 'doc/jamis'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  #rdoc.rdoc_files.add('src/vcs.rb', 'src/**/*.rb')
-  rdoc.rdoc_files.add('src/**/*.rb')
-  #rdoc.main = 
-end
-
-
-# The Gem specification
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = 'vcs'
-  s.version = PKG_VERSION
-  s.summary = 'A wrapper over any version control system'
-  s.description = '
-    Version control systems (Subversion, CVS, PRCS...), however useful,
-    are not very extensible: adding new features can be cumbersome, especially
-    if you want them for different such systems at once.
-    Vcs provide a simple dynamic hierarchy for Version Control Systems.
-  '
-  
-  s.bindir = 'bin'
-  s.executables = %w[ vcs vcs-svn vcs-cvs vcs-prcs ]
-  s.default_executable = 'vcs'
-  s.files = PKG_FILES.to_a
-  s.require_path = 'src'
-  s.autorequire = 'vcs'
-
-  s.has_rdoc = true
-  s.author = 'Nicolas Pouillard'
-  s.email = 'ertai@lrde.epita.fr'
-  s.homepage = 'https://svn.lrde.epita.fr/svn/lrdetools/trunk/vcs/'
-  s.rubyforge_project = s.name
-end
-  
-# Create compressed packages
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  # p.need_tar = true
-  # p.need_zip = true
-end
-
+# Author::    The TTK Team.                                        -*- ruby -*-
+# Copyright:: Copyright (c) 2005 TTK team. All rights reserved.
+# License::   Ruby License
+# Revision::  $Id$
 
+require 'rubygems'
+require_gem 'core_ex'
+load 'core_ex/rakefile_base.rf'

data/SPEC.dyn.yml

@@ -0,0 +1,10 @@
+--- !ruby/object:OpenStruct 
+table: 
+  :version_id: ''
+  :url: https://svn.lrde.epita.fr/svn/lrdetools/trunk/vcs
+  :version: !ruby/object:Version 
+    build: 0
+    major: 0
+    minor: 3
+    revision: 227
+  :date: "Fri, 16 Sep 2005"

data/SPEC.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = %q{vcs}
+  s.version = "0.3.0"
+  s.date = %q{2005-09-16}
+  s.summary = %q{A wrapper over any version control system}
+  s.email = ["ertai@lrde.epita.fr"]
+  s.homepage = %q{http://rubyforge.org/projects/vcs}
+  s.rubyforge_project = %q{vcs}
+  s.description = %q{Version  control  systems (Subversion, CVS, PRCS...), however useful, are not very  extensible:  adding  new  features can be cumbersome, especially if you want  them  for  different such systems at once. Vcs provide a simple dynamic hierarchy for Version Control Systems.}
+  s.authors = ["Nicolas Pouillard"]
+  s.files = ["lib/vcs/changelog.rb", "lib/vcs/conflict.rb", "lib/vcs/cvs.rb", "lib/vcs/diff.rb", "lib/vcs/diffstat.rb", "lib/vcs/edit.rb", "lib/vcs/last_changed_date.rb", "lib/vcs/mail.rb", "lib/vcs/message.rb", "lib/vcs/mycommit.rb", "lib/vcs/news.rb", "lib/vcs/prcs.rb", "lib/vcs/revision.rb", "lib/vcs/script.rb", "lib/vcs/status.rb", "lib/vcs/svn.rb", "lib/vcs/url.rb", "lib/vcs/vcs.rb", "bin/vcs", "bin/vcs-cvs", "bin/vcs-prcs", "bin/vcs-svn", "AUTHORS", "HOWTO", "NEWS", "Rakefile", "README", "SPEC.dyn.yml", "SPEC.gemspec", "SPEC.yml"]
+  s.executables = ["vcs", "vcs-cvs", "vcs-prcs", "vcs-svn"]
+  s.add_dependency(%q<ruby_ex>, ["~> 0.2.0"])
+end

data/SPEC.yml

@@ -0,0 +1,39 @@
+---
+Author: Nicolas Pouillard
+License: GNU General Public License (GPL)
+Revision: '$Id$'
+
+name: vcs
+
+title: Vcs -- A wrapper over any version control system
+summary: A wrapper over any version control system
+description: |
+  Version  control  systems (Subversion, CVS, PRCS...), however useful, are not
+  very  extensible:  adding  new  features can be cumbersome, especially if you
+  want  them  for  different such systems at once. Vcs provide a simple dynamic
+  hierarchy for Version Control Systems.
+homepage: http://rubyforge.org/projects/vcs
+
+rdoc_dir: doc/html
+tags_url: https://svn.lrde.epita.fr/svn/lrdetools/tags
+
+commit_command: ltci
+commit_dir: ..
+
+rdoc_files: !filelist
+  - README
+  - AUTHORS
+  - lib/vcs/**/*.rb
+
+pkg_files: !filelist
+  - lib/vcs/**/*.rb
+  - bin/**/*
+  - '[A-Z]*'
+
+executables: [ vcs, vcs-svn, vcs-cvs, vcs-prcs ]
+
+dependencies:
+  ruby_ex: [~> 0.2.0, 6087/ruby_ex-0.2.0.tar.gz]
+
+root_test_suite: test/vcs-check.yml
+ttk_version: ~> 0.3.0

data/bin/vcs

@@ -16,13 +16,11 @@ require 'logger'
 require 'optparse'
 require 'set'
 
-VCS_VERSION = '0.2.148'
+VCS_VERSION = '0.3.0'
 VCS_PATH = Pathname.new(__FILE__).expand_path
 VCS_DIR, VCS = VCS_PATH.split
-SRC = VCS_DIR + '..' + 'src'
-RUBY_EX = VCS_DIR + '..' + 'ruby_ex'
-$: << SRC.to_s
-$: << RUBY_EX.to_s
+LIB = VCS_DIR + '..' + 'lib'
+$: << LIB.to_s
 
 dir = Pathname.pwd
 while not dir.root? and not (vcs_dir = dir + 'vcs').exist?
@@ -41,14 +39,14 @@ def LOG.format_message(severity, timestamp, msg, progname)
   "#{VCS}: #{progname}#{severity.downcase}: #{msg}\n"
 end
 
-Pathname.glob("{#{SRC}/**,#{vcs_dir}}/*.rb") do |file|
+Pathname.glob("{#{LIB}/**,#{vcs_dir}}/*.rb") do |file|
   LOG.debug { file.basename.to_s }
   begin
-    require file.basename.to_s
-  rescue LoadError => ex
+    require "vcs/#{file.basename}"
+  rescue LoadError
     begin
       require file.to_s
-    rescue
+    rescue LoadError => ex
       raise ex
     end
   end
@@ -81,13 +79,13 @@ OPTS = OptionParser.new do |opts|
     exit
   end
 
-  opts.on('--mk-alias', 'Use this command like that `vcs --mk-alias`') do
+  opts.on('--mk-alias', 'Put the result of this command in your .zshrc or .bashrc') do
     ALL_VCS_NAMES.each do |n|
       n = n.to_s.downcase
       if VCS_PATH.executable?
-        puts "alias #{n}=#{VCS_PATH}-#{n}"
+        puts "alias #{n}=#{VCS_PATH}-#{n} ;"
       else
-        puts "alias #{n}=vcs-#{n}"
+        puts "alias #{n}=vcs-#{n} ;"
       end
     end
     exit
@@ -95,17 +93,18 @@ OPTS = OptionParser.new do |opts|
 
   opts.on('-C', '--[no-]check', 'Check your vcs configuration') do |check|
     if check
-      Vcs.new('').call_conf_checkers 
+      Vcs.new('vcs').call_conf_checkers 
       exit
     end
   end
 
-  opts.on('-d', '--debug LEVEL', Integer, 'Set debug level') do |anInteger|
-    $debug = anInteger
+  opts.on('-d', '--debug LEVEL', 'Set debug level') do |severity|
+    LOG.level = Logger.const_get(severity.upcase)
   end
 
   opts.on_tail('-h', '--help', 'Show this message') do |test|
     STDERR.puts OPTS
+    STDERR.puts "\n\nReport bugs to <ertai@lrde.epita.fr>."
     exit
   end
 
@@ -116,6 +115,7 @@ OPTS = OptionParser.new do |opts|
 
 end
 
+ENV['LC_ALL'] = 'C'
 if ENV.has_key? 'FULLNAME'
   FULLNAME = ENV['FULLNAME']
 else
@@ -125,7 +125,9 @@ else
 end
 env = %w[ EMAIL FULLNAME EDITOR PAGER ]
 if env.all? { |s| ENV[s] }
-  env.each { |s| Kernel.const_set(s, ENV[s]) }
+  EDITOR = ENV['EDITOR'].to_cmd
+  PAGER = ENV['PAGER'].to_cmd
+  EMAIL = ENV['EMAIL']
 else
   env.each { |s| LOG.error "Need #{s} in the environement" unless ENV[s] }
   exit

data/lib/vcs/changelog.rb

@@ -0,0 +1,164 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2004 LRDE. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: header 98 2004-09-29 12:07:43Z ertai $
+
+require 'vcs/vcs'
+require 'vcs/svn'
+
+class Svn
+
+  @@file_st =
+  {
+    'A' => 'New',
+    'D' => 'Remove',
+  }
+  @@file_st.default = ''
+
+  @@prop_st =
+  {
+    'M' => 'Changed property'
+  }
+
+  def mkchangelog_from_status ( *args )
+    result = []
+    from_status(*args) do |line, file_st, prop_st, copy_st, file|
+      next if file_st =~ /[?X]/
+      next if file == 'ChangeLog'
+      ls = []
+      ls << @@file_st[file_st] if @@file_st.has_key? file_st
+      ls << @@prop_st[prop_st].downcase if @@prop_st.has_key? prop_st
+      result << [file, ls.join(', ')]
+    end
+    raise Failure, 'No changes, so no ChangeLog entry.' if result.empty?
+    result
+  end
+  private :mkchangelog_from_status
+
+end # class Svn
+
+
+class Vcs
+
+  class MustBeFilled < Exception
+    attr_reader :file
+    def initialize ( file )
+      @file = file
+      super("You must fill this file: `#{file.to_s}'")
+    end
+  end
+
+  @@subject_format = '<%= rev %>: <%= title %>'
+
+  def mkchangelog! ( *args )
+    error_handling :changelog_failed
+
+    unless CL.exist?
+      raise Failure, "No `#{CL}', you are probably not in a valid directory."
+    end
+
+    cl = ADD_CL
+
+    # Already filled if ,ChangeLog.add exists and not begin by ---
+    if cl.exist?
+      raise MustBeFilled, cl if cl.read =~ /\A---/
+      require 'erb'
+      ls = []
+      YAML.each_document("--- |\n" + cl.read) { |x| (ls.size == 2)? break : ls << x }
+      title_subject, input = ls
+      header = { 'title'   => title_subject[/^title: (.*)$/, 1],
+                 'subject' => title_subject[/^subject: (.*)$/, 1] }
+      rev = revision.read.to_i + 1
+      header.merge!('rev' => rev, 'revision' => rev)
+      raise "no title: reopen #{ADD_CL}" if header['title'].nil?
+      header['title'].sub!(/\.$/, '')
+      b = getBinding(header)
+      header = ERB.new(header.to_yaml, $SAFE, '<-%->', '$erbout_').result(b)
+      META.open('w') { |f| f.puts header }
+      output = ERB.new(input, $SAFE, '<-%->', '$erbout_').result(b)
+      return output
+    end
+
+    cl_add = mkchangelog_from_status(*args)
+    LOG.info "Creating a new `#{cl}' file"
+    cl.open('w') do |f|
+      head = Time.now.strftime("%Y-%m-%d  #{FULL_EMAIL}")
+      f.puts "
+|--- | ########## Fill this file correctly and remove this line ########## | ---
+|title: 
+|subject: #{@@subject_format}.
+|
+|--- | ###################### Your ChangeLog entrie ###################### | ---
+      |#{head}
+      |
+      |\t<%= title %>.
+      |
+      |".head_cut!
+
+      cl_add.each do |file, str|
+        f.puts "\t* #{file}: #{str}."
+      end
+
+      f.puts "|
+|--- | ########### This line, and those below, will be ignored ########### | ---
+      |Instructions:
+      |\t* The first line must be removed when this file is filled.
+      |\t* After you must specify a title, for the news/mail subject.
+      |\t* The line containing <%= title %> will be replaced by your title,
+      |\t  <%= subject %> by the subject line, <%= rev %> by the revision...
+      |\t* Everywhere in the document you can get/compute some values with
+      |\t  these tags <%= aRubyExpression %> even some vcs specific call.
+      |\t  For example <%= status.read %> will include the `svn status' output.
+      |
+      |".head_cut!
+      with(f).diff!(*args)
+    end
+
+    raise MustBeFilled, cl
+  end
+
+  def concat_changelog! ( *args )
+    error_handling :changelog_failed
+
+    if cl_entry = mkchangelog(*args)
+
+      unless TMP_CL.exist?
+	LOG.info "Moving `#{CL}' to `#{TMP_CL}' ..."
+	CL.rename(TMP_CL)
+      end
+
+      CL.open('w') do |file|
+	LOG.info "Prepending `#{ADD_CL}' to `#{CL}' ..."
+	file.print cl_entry
+	file.puts
+        file.print TMP_CL.read
+      end
+
+      return cl_entry
+
+    end
+  end
+
+  def changelog_failed
+    if TMP_CL.exist?
+      LOG.info "Restoring `#{CL}' from `#{TMP_CL}' ..."
+      TMP_CL.rename(CL)
+    end
+    LOG.info "#{ADD_CL}: Contains your ChangeLog entry" if ADD_CL.exist?
+  end
+
+  def getBinding ( header )
+    code = []
+    header.each do |k, v|
+      code << "#{k} = #{v.inspect}"
+    end
+    code << 'binding'
+    eval(code.join('; '))
+  end
+  protected :getBinding
+
+  alias_command :mkcl, :mkchangelog
+  alias_command :ctcl, :concat_changelog
+
+end # class Vcs
+