rubycut-vclog 1.9.4

data/lib/vclog/report.rb

@@ -0,0 +1,200 @@
+require 'ostruct'
+require 'erb'
+#require 'ansi'
+
+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[:type]   ||= 'changelog'
+      options[:format] ||= 'ansi'
+
+      @options = OpenStruct.new(options)
+
+      @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
+
+    #
+    # Report type.
+    #
+    def type
+      options.type
+    end
+
+    #
+    # Report format.
+    #
+    def format
+      options.format
+    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 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
+      require_formatter(format)
+
+      tmpl_glob = File.join(DIR, 'templates', "#{type}.#{format}.{erb,rb}")
+      tmpl_file = Dir[tmpl_glob].first
+
+      raise "could not find template -- #{type}.#{format}" unless tmpl_file
+
+      tmpl = File.read(tmpl_file)
+
+      case File.extname(tmpl_file)
+      when '.rb'
+        eval(tmpl, binding, tmpl_file)
+      when '.erb'
+        erb = ERB.new(tmpl, nil, '<>')
+        erb.result(binding)
+      else
+        raise "unrecognized template type -- #{tmpl_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

@@ -0,0 +1,151 @@
+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 = 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=
+
+    #
+    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 for +message+.
+    #
+    alias_method :msg,  :message
+    alias_method :msg=, :message=
+
+    #
+    # Convert to Hash.
+    #
+    def to_h
+      {
+        'name'    => name,
+        'date'    => date,
+        'author'  => author,
+        'message' => message,
+        'commit'  => commit.to_h
+      }
+    end
+
+    #
+    # Inspection string for Tag.
+    #
+    def inspect
+      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
+
+    #
+    #
+    #
+    def parse_date(date)
+      case date
+      when Time
+        date
+      else
+        Time.parse(date.to_s)
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,35 @@
+require 'ansi'
+
+out = []
+
+out << "#{title}\n".ansi(:bold) if title
+
+changelog.by_date.each do |date, date_changes|
+
+  date_changes.by_author.each do |author, author_changes|
+
+    out << "#{ date }  #{ author }\n".ansi(:bold)
+
+    author_changes.sort!{|a,b| b.level <=> a.level}
+
+    author_changes.each do |entry|
+      msg = entry.to_s(:summary=>!options.detail)
+
+      #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 << ""
+
+  end
+
+end
+
+out.join("\n") + "\n"

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

@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+
+<feed xmlns="http://www.w3.org/2005/Atom">
+
+  <title><%= title %></title>
+
+  <% if url %><link href="<%= url %>" /><% end %>
+
+  <% if homepage %><link href="<%= homepage %>" /><% end %>
+
+  <id><% if repo.uuid %>urn:uuid:<%= repo.uuid %><% else %><%= repo.repository %><% end %></id>
+
+  <updated><%= Time.now.xmlschema %></updated>
+
+  <author>
+
+    <name><%= user %></name>
+
+    <email><%= email %></email>
+
+  </author>
+
+<% changelog.changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+
+  <entry>
+
+    <title><%= h entry.summary %></title>
+
+    <id><%= url %>#<%= entry.id %></id>
+
+    <author><%= entry.author %></author>
+
+    <updated><%= entry.date.xmlschema %></updated>
+
+    <content type="xhtml">
+
+      <div xmlns="http://www.w3.org/1999/xhtml">
+
+        <%= entry.message %><br/>
+
+        <%= entry.author %> <%= entry.date.strftime('%Y-%m-%d %H:%M:%S') %>
+
+      </div>
+
+    </content>
+
+  </entry>
+
+<% end %>
+
+</feed>
+

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

@@ -0,0 +1,24 @@
+out = []
+
+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)
+
+      #msg << " [#{entry.type}]" if entry.type && !options.summary
+      msg << "\n(##{entry.id})" if options.reference
+
+      out << msg.tabto(8).sub('        ','      * ')
+    end
+
+    out << ""
+  end
+
+end
+
+out.join("\n") + "\n"