vclog 1.8.2 → 1.9.0

data/lib/vclog/report.rb

@@ -0,0 +1,187 @@
+require 'ostruct'
+#require 'ansi'
+require 'erb'
+
+module VCLog
+
+  # The Report class acts a controller for outputing 
+  # change log / release history.
+  #
+  class Report
+
+    #
+    # Directory of this file, so as to locate templates.
+    #
+    DIR = File.dirname(__FILE__)
+
+    #
+    # Instance of VCLog::Repo.
+    #
+    attr :repo
+
+    #
+    # OpenStruct of report options.
+    #
+    attr :options
+
+    #
+    # Setup new Reporter instance.
+    #
+    # @param [Repo] repo
+    #   An instance of VCLog::Repo.
+    #
+    def initialize(repo, options)
+      @repo    = repo
+      @options = case options 
+                 when Hash
+                   OpenStruct.new(options)
+                 else
+                   options
+                 end
+
+      @options.level ||= 0
+    end
+
+    #
+    # Returns a Changelog object.
+    #
+    def changelog
+      changes = options.point ? repo.changes : repo.change_points
+      ChangeLog.new(changes).above(options.level)
+    end
+
+    #
+    # Compute and return set of releases for +changelog+ changes.
+    #
+    def releases
+      repo.releases(changelog.changes)
+    end
+
+    #
+    # User as given by the command line or from the repo.
+    #
+    def user
+      options.user || repo.user
+    end
+
+    #
+    # Email address as given on the command line or from the repo.
+    #
+    def email
+      options.email || repo.email
+    end
+
+    #
+    # Repo repository URL.
+    #
+    def repository
+      repo.repository
+    end
+
+    #
+    # Repository URL.
+    #
+    # @todo Ensure this is being provided.
+    #
+    def url
+      options.url || repo.repository
+    end
+
+    # TODO
+    def homepage
+      options.homepage
+    end
+
+    # TODO: Let the title be nil and the template can set a default if it needs to.
+
+    #
+    # Report title.
+    #
+    def title
+      return options.title if options.title
+      case options.type
+      when :history
+        "RELEASE HISTORY"
+      else
+        "CHANGELOG"
+      end
+    end
+
+    # NOTE: ERBs trim_mode is broken --it removes an extra space. 
+    # So we can't use it for plain text templates.
+
+    #
+    # Print report.
+    #
+    def print
+      options.type   ||= 'changelog'
+      options.format ||= 'ansi'
+
+      require_formatter(options.format)
+
+      tmp_file = Dir[File.join(DIR, 'templates', "#{options.type}.#{options.format}.{erb,rb}")].first
+
+      tmp = File.read(tmp_file)
+
+      case File.extname(tmp_file)
+      when '.rb'
+        eval(tmp, binding, tmp_file)
+      when '.erb'
+        erb = ERB.new(tmp, nil, '<>')
+        erb.result(binding)
+      else
+        raise "unrecognized template - #{tmp_file}"
+      end
+    end
+
+   private
+
+    #
+    # Depending on the format special libraries may by required.
+    #
+    def require_formatter(format)
+      case format.to_s
+      when 'yaml'
+        require 'yaml'
+      when 'json'
+        require 'json'
+      end
+    end
+
+    #
+    # HTML escape.
+    #
+    def h(input)
+       result = input.to_s.dup
+       result.gsub!("&", "&amp;")
+       result.gsub!("<", "&lt;")
+       result.gsub!(">", "&gt;")
+       result.gsub!("'", "&apos;")
+       #result.gsub!("@", "&at;")
+       result.gsub!("\"", "&quot;")
+       return result
+    end
+
+    #
+    # Convert from RDoc to HTML.
+    #
+    def r(input)
+      rdoc.convert(input)
+    end
+
+    #
+    # RDoc converter.
+    #
+    # @return [RDoc::Markup::ToHtml] rdoc markup HTML converter.
+    #
+    def rdoc
+      @_rdoc ||= (
+        gem 'rdoc' rescue nil  # to ensure latest version
+        require 'rdoc'
+        RDoc::Markup::ToHtml.new
+      )
+    end
+
+  end
+
+end

data/lib/vclog/tag.rb

@@ -1,27 +1,68 @@
 module VCLog
 
+  #
   class Tag
+
+    #
+    # Tag's commit id.
+    #
+    attr_accessor :id
+
+    #
+    # Tag name, which in this case is typically a version stamp.
+    #
     attr_accessor :name
+
+    #
+    # Date tag was made.
+    #
     attr_accessor :date
+
+    #
+    # Creator to the tag.
+    #
     attr_accessor :author
+
+    #
+    # Tag message.
+    #
     attr_accessor :message
 
+    #
+    # Last commit before Tag.
+    #
     attr_accessor :commit
 
+    #
+    # @todo Hg is using this at the moment but it really shouldn't be here,
+    #   since it is take care of by `commit.files`.
+    #
+    attr_accessor :files
+
+    #
+    # Setup new Tag intsance.
+    #
+    # If `:commit` is not provided, it is assume that the underlying SCM
+    # simply creates tags as references to a commit. That is to say the tag
+    # information and the commit information are one and the same. This is
+    # the case for Hg, but not for Git, for instance.
     #
     def initialize(data={})
-      @commit = Change.new
+      @commit = data.delete(:commit) || Change.new(data)
+
       data.each do |k,v|
         __send__("#{k}=", v)
       end
     end
 
+    #
+    #  Set the tag name.
     #
     def name=(name)
       @name = (name || 'HEAD').strip
     end
 
-    #
+    # Alias for +name+ attribute.
     alias_method :label,  :name
     alias_method :label=, :name=
 
@@ -29,87 +70,73 @@ module VCLog
     alias_method :tag,  :name
     alias_method :tag=, :name=
 
-    #
+    # Set author name, stripping white space.
     def author=(author)
       @author = author.to_s.strip
     end
 
+    # Alias for +author+ attribute.
     alias_method :tagger,  :author
     alias_method :tagger=, :author=
 
+    # Alias for +author+ attribute.
     alias_method :who,  :author
     alias_method :who=, :author=
 
+    #
+    # Set the tag date, converting +date+ to a Time object.
     #
     def date=(date)
       @date = parse_date(date)
     end
 
+    #
+    # Set the tag message.
     #
     def message=(msg)
       @message = msg.strip
     end
 
-    alias_method :msg,  :message
-    alias_method :msg=, :message=
-
-
-    #
-    def commit_id
-      @commit.id
-    end
-
     #
-    def commit_id=(id)
-      @commit.id = id
-    end
-
-    #
-    alias_method :id,  :commit_id
-    alias_method :id=, :commit_id=
-
+    # Alias for +message+.
     #
-    alias_method :revision,  :commit_id
-    alias_method :revision=, :commit_id=
-
-    #
-    def commit_date
-      @commit.date ||= date
-    end
-
-    #
-    def commit_date=(date)
-      @commit.date = date
-    end
+    alias_method :msg,  :message
+    alias_method :msg=, :message=
 
     #
-    def to_json
-      to_h.to_json
-    end
-
+    # Convert to Hash.
     #
     def to_h
       {
         'name'    => name,
         'date'    => date,
         'author'  => author,
-        'message' => message
+        'message' => message,
+        'commit'  => commit.to_h
       }
     end
 
+    #
+    # Inspection string for Tag.
     #
     def inspect
-      "<Tag #{name} #{date.strftime('%Y-%m-%d %H:%M:%S')}>"
+      dstr = date ? date.strftime('%Y-%m-%d %H:%M:%S') : '(date?)'
+      "<Tag #{name} #{dstr}>"
     end
 
+    #
     # Normal tag order is the reverse typical sorts.
+    #
     def <=>(other)
       return -1 if name == 'HEAD'
       other.name <=> name
     end
 
-    private
+  private
 
+    #
+    #
+    #
     def parse_date(date)
       case date
       when Time

data/lib/vclog/templates/changelog.ansi.rb

@@ -13,34 +13,17 @@ changelog.by_date.each do |date, date_changes|
     author_changes.sort!{|a,b| b.level <=> a.level}
 
     author_changes.each do |entry|
+      msg = entry.to_s(:summary=>!options.detail)
 
-      line = "#{entry.message.strip}"
-
-      if options.extra && entry.type
-        line << " <#{ entry.type }>"
-      end
-
-      if options.revision
-        line << " (##{entry.revision})"
-      end
-
-      case entry.level
-      when 1
-        line = line.ansi(:yellow)
-      when 0
-        line = line.ansi(:green)
-      when -1
-        line = line.ansi(:cyan)
-      else
-        if entry.level > 1
-          line = line.ansi(:red) 
-        else
-          line = line.ansi(:blue)
-        end
-      end
-
-      out << "  * " + line
+      #if !options.summary && entry.type
+      #  msg << " [#{ entry.type }]"
+      #end
 
+      msg = msg.ansi(*entry.color) unless entry.color.empty?
+
+      msg << "\n(##{entry.id})" if options.reference
+
+      out << msg.tabto(4).sub('    ','  * ')
     end
 
     out << ""

data/lib/vclog/templates/changelog.atom.erb

@@ -8,7 +8,7 @@
 
   <% if homepage %><link href="<%= homepage %>" /><% end %>
 
-  <id><% if vcs.uuid %>urn:uuid:<%= vcs.uuid %><% else %><%= vcs.repository %><% end %></id>
+  <id><% if repo.uuid %>urn:uuid:<%= repo.uuid %><% else %><%= repo.repository %><% end %></id>
 
   <updated><%= Time.now.xmlschema %></updated>
 
@@ -24,9 +24,9 @@
 
   <entry>
 
-    <title><%= h entry.message.lines.first.rstrip %></title>
+    <title><%= h entry.summary %></title>
 
-    <id><%= url %>#<%= entry.revision %></id>
+    <id><%= url %>#<%= entry.id %></id>
 
     <author><%= entry.author %></author>
 

data/lib/vclog/templates/changelog.gnu.rb

@@ -5,25 +5,18 @@ out << "#{title}\n" if title
 changelog.by_date.each do |date, date_changes|
 
   date_changes.by_author.each do |author, author_changes|
-
     out << "#{ date }  #{ author }\n"
 
     author_changes.each do |entry|
+      msg = entry.to_s(:summary=>!options.detail)
 
-      out << "        * #{entry.message.strip}"
- 
-      if options.extra && entry.type
-        out.last << " <#{ entry.type }>"
-      end
-
-      if options.revision
-        out.last << "(##{entry.revision})"
-      end
+      #msg << " [#{entry.type}]" if entry.type && !options.summary
+      msg << "\n(##{entry.id})" if options.reference
 
+      out << msg.tabto(8).sub('        ','      * ')
     end
 
     out << ""
-
   end
 
 end