vclog 1.8.2 → 1.9.0

data/lib/vclog/adapters.rb

@@ -1,10 +1,11 @@
 require 'vclog/adapters/svn'
 require 'vclog/adapters/git'
 require 'vclog/adapters/hg'
-#require 'vclog/vcs/darcs'
+#require 'vclog/adapters/darcs'
 
 module VCLog
 
+  # Namespace for all VCS/SCM adapters.
   module Adapters
   end
 

data/lib/vclog/adapters/abstract.rb

@@ -1,276 +1,131 @@
 module VCLog
-module Adapters
 
-  require 'time'
-  require 'pathname'
-  require 'tempfile'
+  module Adapters
 
-  require 'vclog/formatter'
-  require 'vclog/changelog'
-  require 'vclog/history'
-  require 'vclog/change'
-  require 'vclog/tag'
+    require 'time'
+    require 'pathname'
+    require 'tempfile'
 
-  # TODO: Might we have a NO-VCS changelog based on
-  #       LOG: entries in source files?
+    require 'vclog/changelog'
+    require 'vclog/change'
+    require 'vclog/tag'
 
-  # = Version Control System
-  class Abstract
+    # TODO: Could we support a "no scm" changelog based on `LOG:` entries in source files?
 
-    #
-    attr :config
-
-    # Root location.
-    attr :root
-
-    # Heuristics object.
-    attr :heuristics
-
-    # Minimum change level.
-    attr :level
+    # TODO: Possibly use Amp or SCM gem for future version.
 
+    # Abstract base class for all version control system adapters.
     #
-    def initialize(repo)
-      @repo = repo
+    class Abstract
 
-      @root       = repo.root  
-      @heuristics = repo.heuristics
-      @level      = repo.level
+      #
+      attr :config
 
-      initialize_framework
-    end
+      # Root location.
+      attr :root
 
-    # This is used if the adapter is using an external library
-    # to interface with the repository.
-    def initialize_framework
-    end
+      # Heuristics object.
+      attr :heuristics
 
-    #
-    def extract_tags
-      raise "Not Implemented"
-    end
+      #
+      def initialize(repo)
+        @repo       = repo
+        @root       = repo.root  
+        @heuristics = repo.heuristics
 
-    #
-    def extract_changes
-      raise "Not Implemented"
-    end
-
-    #
-    def tags
-      @tags ||= extract_tags
-    end  
-
-    #
-    # TODO: possbile to move heuristics lookup into Change class?
-    def changes
-      @changes ||= all_changes.select do |c|
-        c.level >= self.level
+        initialize_framework
       end
-    end
 
-    #
-    def all_changes
-      @all_changes ||= (
-        changes = []
-        extract_changes.each do |change|
-          #raise "how did this happen?" if Change == c
-          #rev, date, who, msg = *c
-          #type, level, label, nmsg = *heuristics.lookup(msg)
-          #Change.new(rev, date, who, nmsg||msg, type, level, label)
-          change.apply_heuristics(heuristics)
-          changes << change 
-        end
-        changes
-      )     
-    end
-
-    #
-    def tag?(name)
-      tags.find{ |t| t.name == name }
-    end
-
-    #
-    def changelog
-      ChangeLog.new(changes)
-    end
-
-    #
-    def history
-      @history ||= History.new(self)
-    end
-
-    #
-    def display(type, format, options)
-      @options = options
-      formatter = Formatter.new(self)
-      formatter.display(type, format, options)
-    end
-
-    # TODO: allow config of these levels thresholds ?
-    def bump
-      max = history.releases[0].changes.map{ |c| c.level }.max
-      if max > 1
-        bump_part('major')
-      elsif max >= 0
-        bump_part('minor')
-      else
-        bump_part('patch')
+      # This is used if the adapter is using an external library
+      # to interface with the repository.
+      def initialize_framework
       end
-    end
 
-    # Provides a bumped version number.
-    def bump_part(part=nil)
-      raise "bad version part - #{part}" unless ['major', 'minor', 'patch', 'build', ''].include?(part.to_s)
+      #
+      def extract_tags
+        raise "Not Implemented"
+      end
 
-      if tags.last
-        v = tags[-1].name # TODO: ensure the latest version
-        v = tags[-2].name if v == 'HEAD'
-      else
-        v = '0.0.0'
+      #
+      def extract_changes
+        raise "Not Implemented"
       end
 
-      v = v.split(/\W/)    # TODO: preserve split chars
+      #
+      def tags
+        @tags ||= extract_tags
+      end  
 
-      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('.')
+      #
+      def changes
+        @changes ||= extract_changes
       end
-    end
 
-    # Returns the current verion string.
-    def version
-      if tags.last
-        v = tags[-1].name # TODO: ensure the latest version
-        v = tags[-2].name if v == 'HEAD'
-      else
-        v = '0.0.0'
+      #
+      def change_points
+        @change_points ||= (
+          changes.inject([]){ |list, change| list.concat(change.points); list }
+        )
       end
-      return v
-    end
-
-    # Return the latest commit as of a given date.
-    def change_by_date(date)
-      list = all_changes.select{ |c| c.date <= date }
-      list.sort_by{ |c| c.date }.last
-    end
-
-  private
-
-    #
-    def version_tag?(tag_name)
-      /(v|\d)/i =~ tag_name
-    end
 
-    #
-    def tempfile(name, content)
-      mfile = Tempfile.new(name)
-      File.open(mfile.path, 'w'){ |f| f << content }
-      mfile.path
-    end
-
-=begin
-    # Looks for a "[type]" indicator at the end of the commit message.
-    # If that is not found, it looks at front of message for
-    # "[type]" or "[type]:". Failing that it tries just "type:".
-    #
-    def split_type(note)
-      note = note.strip
-      if md = /\[(.*?)\]\Z/.match(note)
-        t = md[1].strip.downcase
-        n = note[0...(md.begin(0))]
-      elsif md = /\A\[(.*?)\]\:?/.match(note)
-        t = md[1].strip.downcase
-        n = note[md.end(0)..-1]
-      elsif md = /\A(\w+?)\:/.match(note)
-        t = md[1].strip.downcase
-        n = note[md.end(0)..-1]
-      else
-        n, t = note, nil
+      #
+      def tag?(name)
+        tags.find{ |t| t.name == name }
       end
-      n.gsub!(/^\s*?\n/m,'') # remove blank lines
-      return n, t
-    end
-=end
-
-=begin
-    # Write the ChangeLog to file.
 
-    def write_changelog( log, file )
-      if File.directory?(file)
-        file = File.join( file, DEFAULT_CHANGELOG_FILE )
+      # Returns the current verion string.
+      def version
+        if tags.last
+          v = tags[-1].name # TODO: ensure the latest version
+          v = tags[-2].name if v == 'HEAD'
+        else
+          v = '0.0.0'
+        end
+        return v
       end
-      File.open(file,'w+'){ |f| f << log }
-      puts "Change log written to #{file}."
-    end
 
-    # Write version stamp to file.
+      # Return the latest commit as of a given date.
+      def change_by_date(date)
+        list = changes.select{ |c| c.date <= date }
+        list.sort_by{ |c| c.date }.last
+      end
 
-    def write_version( stamp, file )
-      if File.directory?(file)
-        file = File.join( file, DEFAULT_VERSION_FILE )
+      # Fallback for user is `ENV['USER']`.
+      def user
+        ENV['USER']
       end
-      File.open(file,'w'){ |f| f << stamp }
-      puts "#{file} saved."
-    end
 
-    # Format the version stamp.
+      # Fallback for email address is `ENV['EMAIL']`.
+      def email
+        ENV['EMAIL']
+      end
 
-    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")
+      #
+      def repository
+        nil
       end
-      status = nil if status.to_s.strip.empty?
-      stamp = []
-      stamp << version
-      stamp << status if status
-      stamp << "(#{date})"
-      stamp.join(' ')
-    end
-=end
 
-  public
+      #
+      def uuid
+        nil
+      end
 
-    #
-    def user
-      ENV['USER']
-    end
+    private
 
-    #
-    def email
-      ENV['EMAIL']
-    end
+      #
+      def version_tag?(tag_name)
+        /(v|\d)/i =~ tag_name
+      end
 
-    #
-    def repository
-      nil
-    end
+      #
+      def tempfile(name, content)
+        mfile = Tempfile.new(name)
+        File.open(mfile.path, 'w'){ |f| f << content }
+        mfile.path
+      end
 
-    #
-    def uuid
-      nil
     end
 
   end
 
 end
-end
-

data/lib/vclog/adapters/darcs.rb

@@ -1,88 +1,93 @@
 require 'vclog/adapters/abstract'
 
 module VCLog
-module Adapters
-
-  # = Darcs
-  #
-  # Provide Darcs SCM revision tools.
-  #
-  # TODO: This needs to be fixed!!!!!!!
-  #
-  class Darcs < Abstract
-
-    # Is a darcs repository?
-    def repository?
-      File.directory?('_darcs')
-    end
 
-    # This is also a module function.
-    module_function :repository?
+  module Adapters
 
-    # Cached Changelog.
-    def changelog
-      @changelog ||= generate_changelog
-    end
+    # Darcs SCM adapter.
+    #
+    # FIXME: This needs to be fixed!!!!!!!
+    #
+    class Darcs < Abstract
 
-    # Generate Changelog object.
-    def generate_changelog
-      raise "not a darcs repository" unless repository?
+      #
+      def initialize(*)
+        raise "Darcs is not yet supported. Please help us fix that!"
+      end
 
-      log = Changelog.new
+      # Is a darcs repository?
+      def repository?
+        File.directory?('_darcs')
+      end
 
-      txt = `darcs changes` #--repo=#{@repository}`
+      # This is also a module function.
+      module_function :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
+      # Cached Changelog.
+      def changelog
+        @changelog ||= generate_changelog
       end
 
-      return log
-    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
 
-    # 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}"
+        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
-      ver = "#{tag}.#{count.to_s}"
 
-      return ver
-      #format_version_stamp(ver, status) # ,released)
-    end
+      # TODO
+      def tag(ref, label, msg)
+        `darcs tag #{label}`
+      end
 
-    # TODO
-    def tag(ref, label, msg)
-      `darcs tag #{label}`
     end
 
   end
 
 end
-end