vclog 1.8.2 → 1.9.0

data/lib/vclog/cli/changelog.rb

@@ -1,33 +0,0 @@
-require 'vclog/cli/abstract'
-
-module VCLog
-module CLI
-
-  class Changelog < Abstract
-
-    #
-    def self.terms
-      ['log', 'changelog']
-    end
-
-    #
-    def parser
-      super do |opt|
-        opt.banner = "Usage: vclog [changelog | log] [options]"
-        opt.separator(" ")
-        opt.separator("Print a Change Log.")
-        template_options(opt)
-      end
-    end
-
-    #
-    def execute
-      format = options[:format] || 'ansi'
-      output = repo.display(:changelog, format, options)
-      puts output
-    end
-
-  end
-
-end
-end

data/lib/vclog/cli/help.rb

@@ -1,42 +0,0 @@
-require 'vclog/cli/abstract'
-
-module VCLog
-module CLI
-
-  class Help < Abstract
-
-    #
-    def self.terms
-      ['help']
-    end
-
-    #
-    def parser
-      super do |opt|
-        opt.banner = "Usage: vclog help"
-      end
-    end
-
-    #
-    def execute
-      if cmd = arguments.first
-        VCLog::CLI.cli(cmd, '--help')
-      else
-        puts "Usage: vclog [command] [options]"
-        puts
-        puts "COMMANDS:"
-        puts "  changelog      produce a Change Log"
-        puts "  history        produce a Release History"
-        puts "  formats        list available formats"
-        puts "  version        display the current version"
-        puts "  bump           display next reasonable version"
-        puts "  autotag        create tags for history file entries"
-        puts "  help           show help information"
-        puts
-      end
-    end
-
-  end
-
-end
-end

data/lib/vclog/cli/history.rb

@@ -1,39 +0,0 @@
-require 'vclog/cli/abstract'
-
-module VCLog
-module CLI
-
-  class History < Abstract
-
-    #
-    def self.terms
-      ['history', 'release']
-    end
-
-    #
-    def parser
-      super do |opt|
-        opt.banner = "Usage: vclog history [options]\n" +
-                     "       vclog release [options]"
-        opt.separator " "
-        opt.separator("Print a Release History.")
-        opt.separator(" ")
-        opt.separator "SPECIAL OPTIONS:"
-        opt.on('--version', '-v NUM', "use as if current version number") do |num|
-          options[:version] = num
-        end
-        template_options(opt)
-      end
-    end
-
-    #
-    def execute
-      format = options[:format] || 'ansi'
-      output = repo.display(:history, format, options)
-      puts output
-    end
-
-  end
-
-end
-end

data/lib/vclog/formatter.rb

@@ -1,123 +0,0 @@
-require 'ostruct'
-#require 'ansi'
-
-module VCLog
-
-  #
-  class Formatter
-
-    DIR = File.dirname(__FILE__)
-
-    #
-    attr :vcs
-
-    # New Formmater.
-    #
-    # vcs - an instance of a subclass of VCS::Abstract
-    #
-    def initialize(vcs)
-      @vcs = vcs
-    end
-
-    # Returns a Changelog object taken from the VCS.
-    def changelog
-      @vcs.changelog
-    end
-
-    # Returns a History object garnered form the VCS.
-    def history
-      @vcs.history
-    end
-
-    #
-    def user
-      @options.user || @vcs.user
-    end
-
-    #
-    def email
-      @options.email || @vcs.email
-    end
-
-    #
-    def repository
-      @vcs.repository
-    end
-
-    # TODO
-    def url
-      @options.url || @vcs.repository
-    end
-
-    # TODO
-    def homepage
-      @options.homepage
-    end
-
-    # TODO: let be nil and let template make a default if wanted
-    def title
-      return @options.title if @options.title
-      case @doctype
-      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.
-    #++
-    def display(doctype, format, options)
-      options = OpenStruct.new(options) if Hash === options
-
-      @doctype = doctype
-      @format  = format
-      @options = options
-
-      require_formatter(format)
-
-      tmp_file = Dir[File.join(DIR, 'templates', "#{@doctype}.#{@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
-
-      #
-      def require_formatter(format)
-        case format.to_s
-        when 'yaml'
-          require 'yaml'
-        when 'json'
-          require 'json'
-        end
-      end
-
-      #
-      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
-
-  end
-
-end

data/lib/vclog/history.rb

@@ -1,131 +0,0 @@
-module VCLog
-
-  require 'vclog/facets'
-  require 'vclog/changelog'
-  require 'vclog/tag'
-  require 'vclog/release'
-  require 'erb'
-
-  # = Release History Class
-  #
-  # A Release History is very similar to a ChangeLog.
-  # It differs in that it is divided into releases with
-  # version, release date and release note.
-  #
-  # The release version, date and release note can be
-  # descerened from the underlying SCM by identifying
-  # the hard tag commits.
-  #
-  # TODO: Extract output formating from delta parser. Later---Huh?
-  #
-  class History
-
-    # Location of this file in the file system.
-    DIR = File.dirname(__FILE__)
-
-    #
-    attr :vcs
-
-    # Alternate title.
-    attr_accessor :title
-
-    # Current working version.
-    attr_accessor :version
-
-    # Provide extra information.
-    attr_accessor :extra
-
-    #
-    def initialize(vcs)
-      @vcs     = vcs
-
-      #opts = OpenStruct.new(opts) if Hash === opts
-
-      #@title   = opts.title || "RELEASE HISTORY"
-      #@extra   = opts.extra
-      #@version = opts.version
-      #@level =  opts.level || 0
-    end
-
-    # Tag list from version control system.
-    def tags
-      @tags ||= vcs.tags
-    end
-
-    # Changelog object
-    def changelog
-      @changlog ||= vcs.changelog #ChangeLog.new(changes)
-    end
-
-    # Change list from version control system filter for level setting.
-    def changes
-      @changes ||= vcs.changes
-    end
-
-    #
-    def releases
-      @releases ||= (
-        rel = []
-
-        tags = self.tags
-
-        #ver  = vcs.bump(version)
-        user = vcs.user
-        time = ::Time.now + (3600 * 24) # one day ahead
-
-        tags << Tag.new(:name=>'HEAD', :id=>'HEAD', :date=>time, :who=>user, :msg=>"Current Development")
-
-        # TODO: Do we need to add a Time.now tag?
-        # add current verion to release list (if given)
-        #previous_version = tags[0].name
-        #if current_version < previous_version  # TODO: need to use natural comparision
-        #  raise ArgumentError, "Release version is less than previous version (#{previous_version})."
-        #end
-        #rels << [current_version, current_release || Time.now]
-        #rels = rels.uniq      # only uniq releases
-
-        # sort by release date
-        tags = tags.sort{ |a,b| a.date <=> b.date }
-
-        # organize into deltas
-        delta = []
-        last  = nil
-        tags.each do |tag|
-          delta << [tag, [last, tag.commit_date]]
-          last = tag.commit_date
-        end
-        # gather changes for each delta
-        delta.each do |tag, (started, ended)|
-          if started
-            set = changes.select{ |c| c.date >= started && c.date < ended  }
-            #gt_vers, gt_date = gt.name, gt.date
-            #lt_vers, lt_date = lt.name, lt.date
-            #gt_date = Time.parse(gt_date) unless Time===gt_date
-            #lt_date = Time.parse(lt_date) unless Time===lt_date
-            #log = changelog.after(gt).before(lt)
-          else
-            #lt_vers, lt_date = lt.name, lt.date
-            #lt_date = Time.parse(lt_date) unless Time===lt_date
-            #log = changelog.before(lt_date)
-            set = changes.select{ |c| c.date < ended }
-          end
-
-          rel << Release.new(tag, set)
-        end
-        rel
-      )
-    end
-
-    # Group +changes+ by tag type.
-    def groups(changes)
-      @groups ||= changes.group_by{ |e| e.type }
-    end
-
-    #
-    def to_h
-      releases.map{ |rel| rel.to_h }
-    end
-
-  end
-
-end

data/lib/vclog/kernel.rb

@@ -1,12 +0,0 @@
-module VCLog
-
-  module Kernel
-
-    #
-    def heuristics
-      @heuristics ||= Heuristics.new()
-    end
-
-  end
-
-end

data/man/man1/vclog-changelog.1

@@ -1,47 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "VCLOG\-CHANGELOG" "1" "November 2010" "RubyWorks" "VCLog"
-.
-.SH "NAME"
-\fBvclog\-changelog\fR \- change log
-.
-.SH "SYNOPSIS"
-\fBvclog\fR
-.
-.br
-\fBvclog log\fR
-.
-.br
-\fBvclog changelog\fR
-.
-.SH "DESCRIPTION"
-Produce a Change Log\.
-.
-.SH "OPTIONS"
-.
-.IP "\(bu" 4
-\fB\-\-version\fR, \fB\-v <VERSION>\fR Set current version number\.
-.
-.IP "\(bu" 4
-\fB\-f\fR, \fB\-\-format <FORMAT>\fR Output format\.
-.
-.IP "\(bu" 4
-\fB\-\-style <URI>\fR Provide a stylesheet URI (css or xsl) for HTML or XML format\.
-.
-.IP "\(bu" 4
-\fB\-t\fR, \fB\-\-title TITLE\fR Document title\.
-.
-.IP "\(bu" 4
-\fB\-s\fR, \fB\-\-summarize\fR Produce summary output\.
-.
-.IP "\(bu" 4
-\fB\-\-id\fR Include revision id in output\.
-.
-.IP "\(bu" 4
-\fB\-l\fR, \fB\-\-level <NUMBER>\fR Lowest level of commit to display [0]\.
-.
-.IP "" 0
-.
-.SH "SEE ALSO"
-vclog(1), vclog\-history(1)

data/man/man1/vclog-changelog.1.html

@@ -1,123 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta http-equiv='content-type' value='text/html;charset=utf8'>
-  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
-  <title>vclog-changelog(1) - change log</title>
-  <style type='text/css' media='all'>
-  /* style: man */
-  body#manpage {margin:0}
-  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
-  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
-  .mp h2 {margin:10px 0 0 0}
-  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
-  .mp h3 {margin:0 0 0 4ex}
-  .mp dt {margin:0;clear:left}
-  .mp dt.flush {float:left;width:8ex}
-  .mp dd {margin:0 0 0 9ex}
-  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
-  .mp pre {margin-bottom:20px}
-  .mp pre+h2,.mp pre+h3 {margin-top:22px}
-  .mp h2+pre,.mp h3+pre {margin-top:5px}
-  .mp img {display:block;margin:auto}
-  .mp h1.man-title {display:none}
-  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
-  .mp h2 {font-size:16px;line-height:1.25}
-  .mp h1 {font-size:20px;line-height:2}
-  .mp {text-align:justify;background:#fff}
-  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
-  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
-  .mp u {text-decoration:underline}
-  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
-  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
-  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
-  .mp b.man-ref {font-weight:normal;color:#434241}
-  .mp pre {padding:0 4ex}
-  .mp pre code {font-weight:normal;color:#434241}
-  .mp h2+pre,h3+pre {padding-left:0}
-  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
-  ol.man-decor {width:100%}
-  ol.man-decor li.tl {text-align:left}
-  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
-  ol.man-decor li.tr {text-align:right;float:right}
-  </style>
-  <style type='text/css' media='all'>
-  /* style: toc */
-  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
-  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
-  .man-navigation a:hover {color:#111;text-decoration:underline}
-  </style>
-</head>
-<!--
-  The following styles are deprecated and will be removed at some point:
-  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
-
-  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
-  .man-navigation should be used instead.
--->
-<body id='manpage'>
-  <div class='mp' id='man'>
-
-  <div class='man-navigation' style='display:none'>
-    <a href="#NAME">NAME</a>
-    <a href="#SYNOPSIS">SYNOPSIS</a>
-    <a href="#DESCRIPTION">DESCRIPTION</a>
-    <a href="#OPTIONS">OPTIONS</a>
-    <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
-
-  <ol class='man-decor man-head man head'>
-    <li class='tl'>vclog-changelog(1)</li>
-    <li class='tc'>VCLog</li>
-    <li class='tr'>vclog-changelog(1)</li>
-  </ol>
-
-  <h2 id="NAME">NAME</h2>
-<p class="man-name">
-  <code>vclog-changelog</code> - <span class="man-whatis">change log</span>
-</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<p><code>vclog</code><br />
-<code>vclog log</code><br />
-<code>vclog changelog</code></p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
-<p>Produce a Change Log.</p>
-
-<h2 id="OPTIONS">OPTIONS</h2>
-
-<ul>
-<li><p><code>--version</code>, <code>-v &lt;VERSION></code>
-Set current version number.</p></li>
-<li><p><code>-f</code>, <code>--format &lt;FORMAT></code>
-Output format.</p></li>
-<li><p><code>--style &lt;URI></code>
-Provide a stylesheet URI (css or xsl) for HTML or XML format.</p></li>
-<li><p><code>-t</code>, <code>--title TITLE</code>
-Document title.</p></li>
-<li><p><code>-s</code>, <code>--summarize</code>
-Produce summary output.</p></li>
-<li><p><code>--id</code>
-Include revision id in output.</p></li>
-<li><p><code>-l</code>, <code>--level &lt;NUMBER></code>
-Lowest level of commit to display [0].</p></li>
-</ul>
-
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<p><a href="vclog.1.html" class="man-ref">vclog<span class="s">(1)</span></a>, <a href="vclog-history.1.html" class="man-ref">vclog-history<span class="s">(1)</span></a></p>
-
-
-  <ol class='man-decor man-foot man foot'>
-    <li class='tl'>RubyWorks</li>
-    <li class='tc'>November 2010</li>
-    <li class='tr'>vclog-changelog(1)</li>
-  </ol>
-
-  </div>
-</body>
-</html>