vclog 1.1 → 1.2

data/lib/vclog/release.rb

@@ -0,0 +1,23 @@
+module VCLog
+
+  #
+  class Release
+    attr :tag
+    attr :changes
+    #
+    def initialize(tag, changes)
+      @tag = tag
+      @changes = changes
+    end
+
+    def to_h
+      { :tag => tag.to_h, :changes => changes }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+  end
+
+end
+

data/lib/vclog/tag.rb

@@ -0,0 +1,54 @@
+module VCLog
+
+  class Tag
+    attr_accessor :name
+    attr_accessor :date
+    attr_accessor :author
+    attr_accessor :message
+
+    def initialize(name, date, author, message)
+      self.name    = name
+      self.date    = date
+      self.author  = author
+      self.message = message
+    end
+
+    def name=(name)
+      @name = name.strip
+    end
+
+    def author=(author)
+      @author = author.strip
+    end
+
+    def date=(date)
+      case date
+      when Time
+        @date = date
+      else
+        @date = Time.parse(date.to_s)
+      end
+    end
+
+    def message=(msg)
+      @message = msg.strip
+    end
+
+    alias_method :tagger, :author
+    alias_method :tagger=, :author=
+
+    def to_json
+      to_h.to_json
+    end
+
+    def to_h
+      {
+        :name => name,
+        :date => date,
+        :author => author,
+        :message => message
+      }
+    end
+  end
+
+end

data/lib/vclog/vcs.rb

@@ -2,10 +2,9 @@ module VCLog
 
   require 'time'
   require 'vclog/changelog'
-  require 'vclog/vcs/svn'
-  require 'vclog/vcs/git'
-  #require 'vclog/vcs/hg'
-  #require 'vclog/vcs/darcs'
+  require 'vclog/history'
+  require 'vclog/change'
+  require 'vclog/tag'
 
   # TODO: Might we have a NO-VCS changelog based on
   #       LOG: entries in source files?
@@ -13,29 +12,102 @@ module VCLog
   # = 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
+    def self.factory(root=nil)
+      root = root || Dir.pwd
+      type = read_type(root)
+      raise ArgumentError, "Not a recognized version control system." unless type
+      VCS.const_get(type.upcase).new(root)
     end
 
-    def read_type
+    def self.read_type(root)
       dir = nil
-      Dir.chdir(@root) do
+      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
+    attr :root
+
+    #
+    def initialize(root)
+      @root = File.expand_path(root)
+    end
+
+    def tags
+      @tags ||= extract_tags.map{ |t| Tag===t ? t : Tag.new(*t) }
+    end
+
+    def changes
+      @changes ||= extract_changes.map{ |c| Change===c ? c : Change.new(*c) }
     end
 
     #
-    def method_missing(s, *a, &b)
-      delegate.send(s, *a, &b)
+    def extract_tags
+      raise "Not Implemented"
+    end
+
+    #
+    def extract_changes
+      raise "Not Implemented"
+    end
+
+    #
+    def changelog
+      ChangeLog.new(changes)
+    end
+
+    #
+    def history(opts={})
+      @history ||= History.new(self, opts)
+    end
+
+    # Provides a bumped version number.
+    def bump(part=nil)
+      return part unless ['major', 'minor', 'patch', ''].include?(part.to_s)
+
+      if tags.last
+        v = tags.last.name   # TODO: ensure the latest version
+      else
+        v = '0.0.0'
+      end
+      v = v.split(/\W/)    # TODO: preserve split chars
+      case part.to_s
+      when 'major'
+        v[0] = v[0].succ
+        (1..(v.size-1)).each{ |i| v[i] = '0' }
+        v.join('.')
+      when 'minor'
+        v[1] = '0' unless v[1]
+        v[1] = v[1].succ
+        (2..(v.size-1)).each{ |i| v[i] = '0' }
+        v.join('.')
+      when 'patch'
+        v[1] = '0' unless v[1]
+        v[2] = '0' unless v[2]
+        v[2] = v[2].succ
+        (3..(v.size-1)).each{ |i| v[i] = '0' }
+        v.join('.')
+      else
+        v[-1] = '0' unless v[-1]
+        v[-1] = v[-1].succ
+        v.join('.')
+      end
+    end
+
+  private
+
+    # Looks for a "[type]" indicator at the end of the message.
+    def split_type(note)
+      note = note.strip
+      if md = /\A.*?\[(.*?)\]\s*$/.match(note)
+        t = md[1].strip.downcase
+        n = note.sub(/\[#{md[1]}\]\s*$/, "")
+      else
+        n, t = note, nil
+      end
+      n.gsub!(/^\s*?\n/m,'') # remove blank lines
+      return n, t
     end
 
 =begin
@@ -78,5 +150,10 @@ module VCLog
 
   end
 
+  require 'vclog/vcs/svn'
+  require 'vclog/vcs/git'
+  #require 'vclog/vcs/hg'
+  #require 'vclog/vcs/darcs'
+
 end
 

data/lib/vclog/vcs/git.rb

@@ -1,30 +1,33 @@
 module VCLog
 
-  class VCS
+  require 'vclog/vcs'
 
-    ### = GIT 
-    ###
-    class GIT
+  class VCS
 
-      def initialize
+    # = GIT Adapter
+    #
+    class GIT < VCS
 
-      end
+      #def initialize
+      #end
 
       #
-      def changelog
-        @changelog ||= generate_changelog
-      end
+      #def changelog
+      #  @changelog ||= ChangeLog.new(changes)
+      #end
 
-      # 
-      def generate_changelog
-        log = Changelog.new
-
-        changelog ||= `git-log`.strip
+      #
+      #def history(opts={})
+      #  @history ||= History.new(self, opts)
+      #end
 
+      # Collect changes.
+      #
+      def extract_changes
+        list = []
+        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|
@@ -40,15 +43,43 @@ module VCLog
               msg << line.strip
             end
           end
-          log.change(date, who, rev, msg.join("\n"))
+          msg = msg.join("\n")
+          msg, type = *split_type(msg)
+          list << [rev, date, who, msg, type]
         end
+        list
+      end
 
-        @changelog = log
+      # Collect tags.
+      #
+      # `git show 1.0` produces:
+      #
+      #   tag 1.0
+      #   Tagger: 7rans <transfire@gmail.com>
+      #   Date:   Sun Oct 25 09:27:58 2009 -0400
+      #
+      #   version 1.0
+      #   commit
+      #   ...
+      #
+      def extract_tags
+        list = []
+        tags = `git tag -l`
+        tags.split(/\s+/).each do |tag|
+          info = `git show #{tag}`
+          md = /\Atag(.*?)\n(.*?)^commit/m.match(info)
+          who, date, *msg = *md[2].split(/\n/)
+          who  = who.split(':')[1].strip
+          date = date[date.index(':')+1..-1].strip
+          msg  = msg.join("\n")
+          list << [tag, date, who, msg]
+        end
+        list
       end
 
-    end
+    end#class GIT
 
-  end
+  end#class VCS
 
-end
+end#module VCLog
 

data/lib/vclog/vcs/svn.rb

@@ -4,26 +4,18 @@ module VCLog
 
     # = SVN
     #
-    # Raw SVN format:
+    # SVN's raw log format:
     #
     #   ------------------------------------------------------------------------
     #   r34 | transami | 2006-08-02 22:10:11 -0400 (Wed, 02 Aug 2006) | 2 lines
     #
     #   change foo to work better
     #
-    class SVN
+    class SVN < VCS
 
-      def initialize
-      end
-
-      ###
-      def changelog
-        @changelog ||= generate_changelog
-      end
-
-      ###
-      def generate_changelog
-        log = Changelog.new
+      #
+      def extract_changes
+        log = []
 
         txt = `svn log`.strip
 
@@ -44,15 +36,71 @@ module VCLog
 
           date = Time.parse(date)
 
-          log.change(date, who, rev, msg)
+          msg, type = *split_type(msg)
+
+          log << [rev, date, who, msg, type]
         end
 
-        @changelog = log
+        log
+      end
+
+      #
+      def extract_tags
+        list = []
+        tagdir = tag_directory
+
+        if tagdir
+          tags = Dir.entries(tagdir).select{ |e| e.index('.') != 0 && e =~ /\d(.*)$/ }
+        else
+          tags = []
+        end
+
+        tags.each do |path|
+          dir = File.join(tagdir, path)
+
+          info = `svn info #{dir}`
+          info = YAML.load(info)
+          md = /(\d.*)$/.match(info['Path'])
+          name = md ? md[1] : path
+          date = info['Last Changed Date']
+          who  = info['Last Changed Author']
+          rev  = info['Revision']
+
+          commit = `svn log -r BASE #{dir}`
+          msg  = commit.lines.to_a[2..-2].join("\n").strip
+
+          list << [name, date, who, msg]
+        end
+        list
+      end
+
+      # This isn't perfect, but is there really anyway for it to be?
+      # It ascends up the current directory tree looking for the 
+      # best candidate for a tags directory.
+      def tag_directory
+        fnd = nil
+        dir = root
+        while dir != '/' do
+          entries = Dir.entries(dir)
+          if entries.include?('.svn')
+            if entries.include?('tags')
+              break(fnd = File.join(dir, 'tags'))
+            else
+              entries = entries.reject{ |e| e.index('.') == 0 }
+              entries = entries.reject{ |e| e !~ /\d$/ }
+              break(fnd = dir) unless entries.empty?
+            end
+          else
+            break(fnd=nil)
+          end
+          dir = File.dirname(dir)
+        end
+        fnd
       end
 
-    end
+    end#class SVN
 
-  end
+  end#class VCS
 
-end
+end#module VCLog
 

data/meta/version

@@ -1 +1 @@
-1.1
+1.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vclog
 version: !ruby/object:Gem::Version 
-  version: "1.1"
+  version: "1.2"
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 -04:00
+date: 2009-10-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,9 +41,13 @@ files:
 - README
 - TODO
 - bin/vclog
+- lib/vclog/change.rb
 - lib/vclog/changelog.rb
-- lib/vclog/command.rb
+- lib/vclog/cli.rb
 - lib/vclog/facets.rb
+- lib/vclog/history.rb
+- lib/vclog/release.rb
+- lib/vclog/tag.rb
 - lib/vclog/vcs.rb
 - lib/vclog/vcs/darcs.rb
 - lib/vclog/vcs/git.rb