vclog 1.0.0

data/lib/vclog/core_ext.rb

@@ -0,0 +1,106 @@
+require 'facets/string/indent'
+require 'facets/string/tabto'
+require 'facets/string/margin'
+require 'facets/enumerable/group_by'
+
+=begin
+
+module VCLog
+
+  # Extensions for String class.
+  # Taken from Facets.
+  module String
+
+    # Provides a margin controlled string.
+    #
+    #   x = %Q{
+    #         | This
+    #         |   is
+    #         |     margin controlled!
+    #         }.margin
+    #
+    #
+    #   NOTE: This may still need a bit of tweaking.
+    #
+    #  CREDIT: Trans
+
+    def margin(n=0)
+      #d = /\A.*\n\s*(.)/.match( self )[1]
+      #d = /\A\s*(.)/.match( self)[1] unless d
+      d = ((/\A.*\n\s*(.)/.match(self)) ||
+          (/\A\s*(.)/.match(self)))[1]
+      return '' unless d
+      if n == 0
+        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, '')
+      else
+        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, ' ' * n)
+      end
+    end
+
+    # Preserves relative tabbing.
+    # The first non-empty line ends up with n spaces before nonspace.
+    #
+    #  CREDIT: Gavin Sinclair
+
+    def tabto(n)
+      if self =~ /^( *)\S/
+        indent(n - $1.length)
+      else
+        self
+      end
+    end
+
+    # Indent left or right by n spaces.
+    # (This used to be called #tab and aliased as #indent.)
+    #
+    #  CREDIT: Gavin Sinclair
+    #  CREDIT: Trans
+
+    def indent(n)
+      if n >= 0
+        gsub(/^/, ' ' * n)
+      else
+        gsub(/^ {0,#{-n}}/, "")
+      end
+    end
+
+  end
+
+end
+
+class String #:nodoc:
+  include VCLog::String
+end
+
+
+# Core extension
+
+module Enumerable
+
+  unless defined?(group_by) or defined?(::ActiveSupport)  # 1.9 or ActiveSupport
+
+    # #group_by is used to group items in a collection by something they
+    # have in common.  The common factor is the key in the resulting hash, the
+    # array of like elements is the value.
+    #
+    #   (1..5).group_by { |n| n % 3 }
+    #        #=> { 0 => [3], 1 => [1, 4], 2 => [2,5] }
+    #
+    #   ["I had", 1, "dollar and", 50, "cents"].group_by { |e| e.class }
+    #        #=> { String => ["I had","dollar and","cents"], Fixnum => [1,50] }
+    #
+    # CREDIT: Erik Veenstra
+
+    def group_by #:yield:
+      #h = k = e = nil
+      r = Hash.new
+      each{ |e| (r[yield(e)] ||= []) << e }
+      r
+    end
+
+  end
+
+end
+
+=end
+

data/lib/vclog/vcs/darcs.rb

@@ -0,0 +1,83 @@
+module VCLog
+
+  class VCS
+
+    # = DARCS
+    #
+    # Provide Darcs SCM revision tools.
+    #
+    # TODO: This needs to be fixed.
+    #
+    class DARCS
+
+      ### Is a darcs repository?
+      def repository?
+        File.directory?('_darcs')
+      end
+
+      ### This is also a module function.
+      module_function :repository?
+
+      ### Cached Changelog.
+      def changelog
+        @changelog ||= generate_changelog
+      end
+
+      ### Generate Changelog object.
+      def generate_changelog
+        raise "not a darcs repository" unless repository?
+
+        log = Changelog.new
+
+        txt = `darcs changes` #--repo=#{@repository}`
+
+        txt.each_line do |line|
+          case line
+          when /^\s*$/
+          when /^(Mon|Tue|Wed|Thu|Fri|Sat|Sun)/
+          when /^\s*tagged/
+            log << $'
+            log << "\n"
+          else
+            log << line
+            log << "\n"
+          end
+        end
+
+        return log
+      end
+
+      ### Retrieve the "revision number" from the darcs tree.
+      def calculate_version
+        raise "not a darcs repository" unless repository?
+
+        status = info.status
+
+        changes = `darcs changes`
+        count   = 0
+        tag     = "0.0"
+
+        changes.each("\n\n") do |change|
+          head, title, desc = change.split("\n", 3)
+          if title =~ /^  \*/
+            # Normal change.
+            count += 1
+          elsif title =~ /tagged (.*)/
+            # Tag.  We look for these.
+            tag = $1
+            break
+          else
+            warn "Unparsable change: #{change}"
+          end
+        end
+        ver = "#{tag}.#{count.to_s}"
+
+        return ver
+        #format_version_stamp(ver, status) # ,released)
+      end
+
+    end
+
+  end
+end
+

data/lib/vclog/vcs/git.rb

@@ -0,0 +1,54 @@
+module VCLog
+
+  class VCS
+
+    ### = GIT 
+    ###
+    class GIT
+
+      def initialize
+
+      end
+
+      #
+      def changelog
+        @changelog ||= generate_changelog
+      end
+
+      # 
+      def generate_changelog
+        log = Changelog.new
+
+        changelog ||= `git-log`.strip
+
+        changes = changelog.split(/^commit/m)
+
+        changes.shift # throw the first (empty) entry away
+
+        changes.each do |text|
+          date, who, rev, msg = nil, nil, nil, []
+          text.each_line do |line|
+            unless rev
+              rev = line.strip
+              next
+            end
+            if md = /^Author:(.*?)$/.match(line)
+              who = md[1]
+            elsif md = /^Date:(.*?)$/m.match(line)
+              date = Time.parse(md[1])
+            else
+              msg << line.strip
+            end
+          end
+          log.change(date, who, rev, msg.join("\n"))
+        end
+
+        @changelog = log
+      end
+
+    end
+
+  end
+
+end
+

data/lib/vclog/vcs/svn.rb

@@ -0,0 +1,58 @@
+module VCLog
+
+  class VCS
+
+    # = SVN
+    #
+    # Raw SVN format:
+    #
+    #   ------------------------------------------------------------------------
+    #   r34 | transami | 2006-08-02 22:10:11 -0400 (Wed, 02 Aug 2006) | 2 lines
+    #
+    #   change foo to work better
+    #
+    class SVN
+
+      def initialize
+      end
+
+      ###
+      def changelog
+        @changelog ||= generate_changelog
+      end
+
+      ###
+      def generate_changelog
+        log = Changelog.new
+
+        txt = `svn log`.strip
+
+        com = txt.split(/^[-]+$/)
+
+        com.each do |msg|
+          msg = msg.strip
+
+          next if msg.empty?
+
+          idx = msg.index("\n")
+          head = msg.slice!(0...idx)
+          rev, who, date, cnt = *head.split('|')
+
+          rev  = rev.strip
+          who  = who.strip
+          msg  = msg.strip
+
+          date = Time.parse(date)
+
+          log.change(date, who, rev, msg)
+        end
+
+        @changelog = log
+      end
+
+    end
+
+  end
+
+end
+

data/lib/vclog/vcs.rb

@@ -0,0 +1,82 @@
+module VCLog
+
+  require 'time'
+  require 'vclog/changelog'
+  require 'vclog/vcs/svn'
+  require 'vclog/vcs/git'
+  #require 'vclog/vcs/hg'
+  #require 'vclog/vcs/darcs'
+
+  # TODO: Might we have a NO-VCS changelog based on
+  #       LOG: entries in source files?
+
+  # = Version Control System
+  class VCS
+
+    attr :type
+
+    def initialize(root=nil)
+      @root = root || Dir.pwd
+      @type = read_type
+      raise ArgumentError, "Not a recognized version control system." unless @type
+    end
+
+    def read_type
+      dir = nil
+      Dir.chdir(@root) do
+        dir = Dir.glob("{.svn,.git,.hg,_darcs}").first
+      end
+      dir[1..-1] if dir
+    end
+
+    def delegate
+      @delegate ||= VCS.const_get(type.upcase).new
+    end
+
+    #
+    def method_missing(s, *a, &b)
+      delegate.send(s, *a, &b)
+    end
+
+=begin
+    # Write the ChangeLog to file.
+
+    def write_changelog( log, file )
+      if File.directory?(file)
+        file = File.join( file, DEFAULT_CHANGELOG_FILE )
+      end
+      File.open(file,'w+'){ |f| f << log }
+      puts "Change log written to #{file}."
+    end
+
+    # Write version stamp to file.
+
+    def write_version( stamp, file )
+      if File.directory?(file)
+        file = File.join( file, DEFAULT_VERSION_FILE )
+      end
+      File.open(file,'w'){ |f| f << stamp }
+      puts "#{file} saved."
+    end
+
+    # Format the version stamp.
+
+    def format_version_stamp( version, status=nil, date=nil )
+      if date.respond_to?(:strftime)
+        date = date.strftime("%Y-%m-%d")
+      else
+        date = Time.now.strftime("%Y-%m-%d")
+      end
+      status = nil if status.to_s.strip.empty?
+      stamp = []
+      stamp << version
+      stamp << status if status
+      stamp << "(#{date})"
+      stamp.join(' ')
+    end
+=end
+
+  end
+
+end
+

data/meta/authors

@@ -0,0 +1 @@
+Trans <transfire@gmail.com>

data/meta/created

@@ -0,0 +1 @@
+2006-05-09

data/meta/description

@@ -0,0 +1 @@
+VCLog is a cross-VCS/SCM ChangeLog generator.

data/meta/homepage

@@ -0,0 +1 @@
+http://proutils.rubyforge.org/vclog

data/meta/license

@@ -0,0 +1 @@
+GPL

data/meta/mailinglist

@@ -0,0 +1 @@
+tigerops-community@rubyforge.org

data/meta/package

@@ -0,0 +1 @@
+vclog

data/meta/project

@@ -0,0 +1 @@
+proutils

data/meta/repository

@@ -0,0 +1,2 @@
+git://rubyforge.org/proutils.git
+gitosis@rubyforge.org:proutils.git

data/meta/requires

@@ -0,0 +1 @@
+facets > 2.4

data/meta/sitemap

@@ -0,0 +1 @@
+doc/rdoc: vclog

data/meta/summary

@@ -0,0 +1 @@
+Cross-VCS/SCM ChangeLog Generator

data/meta/title

@@ -0,0 +1 @@
+VCLog

data/meta/version

@@ -0,0 +1 @@
+1.0.0

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: vclog
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Trans <transfire@gmail.com>
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: VCLog is a cross-VCS/SCM ChangeLog generator.
+email: transfire@gmail.com
+executables: 
+- vclog
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MANIFEST
+- RELEASE
+- HISTORY
+- COPYING
+files: 
+- RELEASE
+- README
+- HISTORY
+- meta/created
+- meta/repository
+- meta/homepage
+- meta/summary
+- meta/package
+- meta/title
+- meta/version
+- meta/license
+- meta/sitemap
+- meta/mailinglist
+- meta/authors
+- meta/requires
+- meta/project
+- meta/description
+- lib/vclog/changelog.rb
+- lib/vclog/core_ext.rb
+- lib/vclog/vcs/darcs.rb
+- lib/vclog/vcs/git.rb
+- lib/vclog/vcs/svn.rb
+- lib/vclog/vcs/hg.rb
+- lib/vclog/vcs.rb
+- bin/vclog
+- COPYING
+- MANIFEST
+has_rdoc: true
+homepage: http://proutils.rubyforge.org/vclog
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --title
+- vclog api
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: proutils
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: VCLog is a cross-VCS/SCM ChangeLog generator.
+test_files: []
+