vcs 0.3.0 → 0.4.0

data/lib/vcs/common_commit.rb

@@ -0,0 +1,110 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2004, 2005 LRDE. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: header 98 2004-09-29 12:07:43Z ertai $
+
+class Vcs
+
+  def common_commit! ( subject_format, files=[], opts={}, &block )
+
+    unless CL.exist?
+      raise Failure, "No `#{CL}', you are probably not in a valid directory."
+    end
+
+    @@subject_format = subject_format
+
+    update!
+
+    have_unrecognized_files = false
+    status(files) do |se|
+      if se.category == :unrecognize
+        have_unrecognized_files = true
+        se.colorize! if color?
+        puts se.line
+      end
+    end
+    if have_unrecognized_files
+      raise Failure, "
+        |You have unrecognized files in your working copy!
+        |This meant that these files won't be commited!
+        |You have some solutions to comply with the rule:
+        |- You must put these files in some categories.
+        |    For instance you can rename these files and put a `+' before
+        |    to make it `precious':
+        |      put `,' for `junk'
+        |      put `\\' for `unmask'
+        |      put `-' for `exclude'
+        |- You can also edit your configuration file (.vcs) to customize
+        |    these categories. For example add this:
+        |    ------------ .vcs ------------
+        |    precious:
+        |      - !re my_precious_file[0-9]*
+        |      - !re .*\.patch
+        |    ------------ .vcs ------------
+        |- You can also perform a partial commit and specify which files
+        |    and directories commit. For example this command:
+        |    #{@command} commit foo.c bar/
+        |
+        |Commit failed".head_cut!
+    end
+
+    Vcs.commited = edit_form!(files)
+
+    mk_message(files)
+    edit! Message
+
+    iform = nil
+
+    if commited?
+      iform ||= YAML.load(IForm.read)
+    else
+
+      unless @h.agree 'Committing, are you sure? (y/n)', true
+        commit_failed
+      end
+
+      concat_changelog!(files)
+
+      files << 'ChangeLog' unless files.empty?
+
+      begin
+        commit_!(files, opts.merge(:message => mk_log_entry(files).read))
+        iform = YAML.load(IForm.read).merge('commited' => true)
+        IForm.open('w') { |f| f.print iform.to_yaml }
+        TMP_CL.delete if TMP_CL.exist?
+      rescue Exception => ex
+        commit_failed ex
+      end
+
+      update!
+
+    end
+
+    block[iform['subject']] if block_given?
+
+    logger.info 'Deleting junk files...'
+    TMP_CL.delete if TMP_CL.exist?
+    destdir = '+commited'.to_path/iform['revision'].to_s
+    destdir.mkpath unless destdir.directory?
+    [LogEntry, Form, IForm, Message, MAIL, NEWS].each do |path|
+      next unless path.exist?
+      dest = destdir/path
+      logger.info "Moving `#{path}' to `#{dest}'..."
+      path.rename(dest)
+    end
+
+  end
+  protected :common_commit!
+
+  def commit_failed ( ex=nil )
+    logger.error "Aborting #{ex}"
+    logger.info 'You can rerun the same command to resume the commit'
+    raise 'Commit failed'
+  end
+
+  cattr_accessor :commited
+  def commited?
+    Vcs.commited
+  end
+
+end # class Vcs

data/lib/vcs/conflict.rb

@@ -1,16 +1,22 @@
+# Copyright:: Copyright (c) 2004, 2005  LRDE. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id$
+
 class Vcs
 
-  def mk_conflicts_list
+  def mk_conflicts_list ( files, options={} )
     ls = status.output.readlines.grep(/^C/).map! { |s| s[/^C\s+(.*)/, 1] }
     raise "no conflicts" if ls.empty?
     ls
   end
+  protected :mk_conflicts_list
 
-  def edit_conflicts!
+  def edit_conflicts! ( files, options={} )
     edit! mk_conflicts_list
   end
 
-  def resolve_conflicts!
+  def resolve_conflicts! ( files, options={} )
     conflicts = mk_conflicts_list
     question = "Resolve these conflicts?: \n  - #{conflicts.join("\n  - ")}\n(y/n)"
     if @h.agree question, true

data/lib/vcs/cvs.rb

@@ -1,9 +1,7 @@
-# Author:: Nicolas Pouillard  <ertai@lrde.epita.fr>.
-# Copyright:: Copyright (c) 2004 LRDE. All rights reserved.
-# License:: GNU General Public License (GPL).
-
-# $LastChangedBy: ertai $
-# $Id: header 98 2004-09-29 12:07:43Z ertai $
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2004, 2005 LRDE. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: header 98 2004-09-29 12:07:43Z ertai $
 
 require 'vcs/vcs'
 
@@ -18,4 +16,3 @@ class Cvs < Vcs
   end
 
 end # class Cvs
-

data/lib/vcs/delete.rb

@@ -0,0 +1,21 @@
+# Copyright:: Copyright (c) 2005  LRDE. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: delete.rb 265 2005-10-03 12:37:03Z pouill_n $
+
+class Vcs
+
+  specific_options << '--auto'
+
+  def delete! ( files=[], options={} )
+    if options[:auto]
+      options.delete(:auto)
+      list!(files, :missing => true) do |path_list|
+        delete_!(path_list.stringify, options) unless path_list.empty?
+      end
+    else
+      delete_!(files, options)
+    end
+  end
+
+end # class Vcs

data/lib/vcs/diff.rb

@@ -3,16 +3,36 @@
 # License::   GNU General Public License (GPL).
 # Revision::  $Id$
 
-class Svn
-
-  def diffw_from_status! ( *args )
-    files = Set.new
-    from_status(*args) do |line, file_st, prop_st, cpy, file|
-      next if file_st =~ /[?X]/
-      next if file == 'ChangeLog'
-      files << Pathname.new(file)
+class Vcs
+
+  def diffw! ( *args )
+    diff_!(*args)
+  end
+
+  def check_gnu_diff
+    unless `diff --version` =~ /GNU/
+      raise ArgumentError, 'diffw: Gnu diff is required'
+    end
+  end
+  add_conf_checker :check_gnu_diff
+
+end # class Vcs
+
+
+class Svn < Vcs
+
+  # A diff only for your eyes
+  def diffw! ( files_orig=[], options={} )
+    files = []
+    status(files_orig) do |se|
+      next if se.file_st.chr =~ /[?X\\,+D]/
+      next if se.file.to_s == 'ChangeLog'
+      next if se.file.directory?
+      files << se.file unless files.include? se.file
     end
-    diffw!(*files.delete_if { |f| f.directory? })
+    return if files.empty? and not files_orig.empty?
+    diff_! files,
+           options.merge(:diff_cmd => 'diff', :extensions => '-NPbuw')
   end
 
 end # class Svn

data/lib/vcs/diffstat.rb

@@ -1,5 +1,5 @@
 # Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
-# Copyright:: Copyright (c) 2004 LRDE. All rights reserved.
+# Copyright:: Copyright (c) 2004, 2005 LRDE. All rights reserved.
 # License::   GNU General Public License (GPL).
 # Revision::  $Id$
 
@@ -12,13 +12,13 @@ class Vcs
   # display statitics on your patch.
   def diffstat! ( *a )
     check_diffstat
-    (diff(*a) | @@diffstat).run(@runner)
+    (diffw(*a) | @@diffstat).run(@runner)
   end
   alias_command :ds, :diffstat
 
   def check_diffstat
     unless `diffstat -V` =~ /diffstat version/
-      raise ArgumentError, 'The `diffstat\' tool is needed by Vcs.diffstat' 
+      raise ArgumentError, 'diffstat: diffstat is required'
     end
   end
 

data/lib/vcs/edit.rb

@@ -1,15 +1,14 @@
 # Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
-# Copyright:: Copyright (c) 2004 LRDE. All rights reserved.
+# Copyright:: Copyright (c) 2004, 2005 LRDE. All rights reserved.
 # License::   GNU General Public License (GPL).
-# Revision::  $Id: edit.rb 225 2005-09-16 14:09:22Z pouill_n $
+# Revision::  $Id: edit.rb 244 2005-09-29 12:45:05Z pouill_n $
 
 require 'vcs/vcs'
 
 class Vcs
 
-  def edit! ( *files )
-    # stringify
-    cmd = EDITOR + files.flatten.map { |x| x.to_s } > [STDOUT, STDERR]
+  def edit! ( files=[], options={} )
+    cmd = Vcs.editor + files > [STDOUT, STDERR]
     cmd.run(@runner)
   end
 

data/lib/vcs/environment.rb

@@ -0,0 +1,59 @@
+# Copyright:: Copyright (c) 2005  LRDE. All rights reserved.
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# License::   Gnu General Public License.
+# Revision::  $Id: environment.rb 242 2005-09-28 14:19:47Z pouill_n $
+
+class Vcs
+
+  class << self
+
+    def fullname
+      env('FULLNAME') { Etc.getpwnam(user).gecos }
+    end
+
+    def editor
+      env('EDITOR').to_cmd
+    end
+
+    def pager
+      env('PAGER').to_cmd
+    end
+
+    def full_email
+      "#{fullname}  <#{email}>"
+    end
+
+    def method_missing ( meth )
+      env meth.to_s.upcase
+    end
+
+    @@vars ||= {}
+    @@env_status ||= true
+
+    def env ( name, &block )
+      return @@vars[name] if @@vars.has_key? name
+      @@vars[name] =
+        if var = ENV[name]
+          var
+        elsif block.nil?
+          logger.error "Need #{name} in the environement"
+          @@env_status = false
+          "!!! #{name} not set !!!"
+        else
+          default = block[]
+          logger.warn "Need #{name} in the environement (default: #{default})"
+          ENV[name] = default
+          default
+        end
+    end
+
+  end # class << self
+
+  def check_env
+    %w[ email fullname editor pager ].each { |m| Vcs.send(m) }
+  end
+
+  add_conf_checker :check_env
+
+end # class Vcs
+

data/lib/vcs/form.rb

@@ -0,0 +1,97 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005 LRDE. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: form.rb 266 2005-10-03 13:11:29Z pouill_n $
+
+class Vcs
+
+  def edit_form! ( *args )
+    mk_form(*args)
+    edit! Form if Form.read =~ /\A---/
+    if Form.read =~ /\A---/
+      raise Failure, "You must fill this file: `#{Form}' (and remove the first line)"
+    else
+      mk_iform(*args)
+      return YAML.load(IForm.read)['commited']
+    end
+  end
+
+
+  def mk_iform! ( *args )
+    with_cache! IForm, 'instanciated form (title, subject, ChangeLog entry, diff)' do
+      cl = mk_form(*args).read
+      ls = []
+      YAML.each_document("--- |\n" + cl) { |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!('revision' => rev, 'commited' => false)
+      if header['title'].nil? or header['title'].blank?
+        raise Failure, "No title found. Reopen `#{Form}' and add it"
+      end
+      header['title'] += '.' unless header['title'] =~ /[.?!]$/
+      b = getBinding(header.merge(:rev => rev))
+      input = ERB.new(input, nil, '<-%->', '$erbout_').result(b)
+      LogEntry.open('w') { |f| f.print input }
+      header.each_value do |v|
+        next unless v.is_a? String
+        v.replace(ERB.new(v, nil, '<-%->', '$erbout_').result(b))
+      end
+      puts header.to_yaml
+    end
+  end
+  IForm = ',iform'.to_path unless defined? Vcs::IForm
+
+
+  @@subject_format ||= '<%= rev %>: <%= title %>'
+
+  def mk_form! ( files=[], options={} )
+    with_cache! Form, 'complete form (title, subject, ChangeLog entry, diff)' do
+
+      puts "
+      |--- | ########## Fill this file correctly and remove this line ########## | ---
+      |title: 
+      |subject: #{@@subject_format}
+      |
+      |--- | ###################### Your ChangeLog entry ###############  80c| # | ---
+      |<%= title %>
+      |
+      |".head_cut!
+
+      mk_log_entry!(files)
+
+      puts "|
+      |--- | ########### This line, and those below, will be ignored #### 80c| # | ---
+      |Instructions:
+      |- The first line must be removed when this file is filled.
+      |- After you must specify a title, for the news/mail subject.
+      |  The line containing <%= title %> will be replaced by your title,
+      |  <%= subject %> by the subject line, <%= rev %> by the revision...
+      |- Everywhere in the document you can get/compute some values with
+      |  these tags <%= aRubyExpression %> even some vcs specific call.
+      |  For example <%= status.read %> will include the 'svn status' output.
+      |- Tabulations and stars ('*') will be added in the ChangeLog before each line.
+      |- The '80c|' on the fourth line is here to show you where will be the
+      |  limit. The '|' is the 79th char.
+      |
+      |".head_cut!
+
+      diffw!(files)
+    end
+  end
+  alias_command :mkf, :mk_form
+  Form = ',form'.to_path unless defined? Vcs::Form
+
+  def getBinding ( header )
+    code = []
+    header.each do |k, v|
+      code << "#{k} = #{v.inspect}"
+    end
+    code << 'binding'
+    eval(code.join('; '))
+  end
+  protected :getBinding
+
+end # class Vcs
+

data/lib/vcs/ignore.rb

@@ -0,0 +1,26 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005  LRDE. All rights reserved.
+# License::   Gnu General Public License.
+# Revision::  $Id: ignore.rb 260 2005-10-02 20:22:46Z pouill_n $
+
+
+class Svn
+
+  # Add an ignore entry in the given path. Automatically determine the rep 
+  # concerned with svn:ignore.
+  # Examples: 
+  #    $ svn ignore my_subdir/'*.tex'
+  #    $ svn ignore ./foo.generated my_subdir/another/a_wrong_file
+  def ignore! ( files=[], options={} )
+    files.each do |file|
+      dir, base = file.to_path.split
+      logger.info { "Add `#{base}' to svn:ignore of `#{dir}'"}
+      data = propget(['svn:ignore', dir], :strict => true)
+      data.output.open('a') { |f| f.puts base }
+      propset!(['svn:ignore', dir],
+               options.merge(:quiet => true, :file => data.output))
+      data.clean
+    end
+  end
+
+end # class Svn