rubycut-vclog 1.9.4

data/lib/vclog/templates/history.json.rb

@@ -0,0 +1 @@
+releases.map{ |r| r.to_h }.to_json

data/lib/vclog/templates/history.markdown.rb

@@ -0,0 +1,38 @@
+out = []
+
+out << "# #{title || 'RELEASE HISTORY'}"
+
+releases.sort.each do |release|
+
+  tag = release.tag
+
+  out << "\n## #{tag.name} / #{tag.date.strftime('%Y-%m-%d')}"
+
+  out << "\n#{tag.message.strip} (#{tag.author})"
+
+  if !(options.summary or release.changes.empty?)
+
+    out << "\nChanges:"
+
+    release.groups.each do |number, changes|
+
+      out << "\n* #{changes.size} #{changes[0].label }\n"
+
+      changes.sort{|a,b| b.date <=> a.date}.each do |entry|
+        msg = entry.to_s(:summary=>!options.detail)
+
+        msg << "\n(##{entry.id})" if options.reference
+
+        out << msg.tabto(6).sub('      ','    * ')
+      end
+
+    end
+
+  end 
+
+  out << ""
+
+end
+
+out.join("\n") + "\n"
+

data/lib/vclog/templates/history.rdoc.rb

@@ -0,0 +1,36 @@
+out = []
+
+out << "= #{title || 'Release History'}"
+
+releases.sort.each do |release|
+  tag = release.tag
+
+  out << "\n== #{tag.name} / #{tag.date.strftime('%Y-%m-%d')}"
+
+  out << "\n#{tag.message.strip} (#{tag.author})"
+
+  if !(options.summary or release.changes.empty?)
+
+    out << "\nChanges:"
+
+    release.groups.each do |type, changes|
+
+      out << "\n* #{changes.size} #{changes[0].label }\n"
+
+      changes.sort{|a,b| b.date <=> a.date}.each do |entry|
+        msg = entry.to_s(:summary=>!options.detail)
+
+        msg << "\n(##{entry.id})" if options.reference
+
+        out << msg.tabto(6).sub('      ','    * ')
+      end
+
+    end
+
+  end 
+
+  out << ""
+end
+
+out.join("\n") + "\n"
+

data/lib/vclog/templates/history.rss.erb

@@ -0,0 +1,84 @@
+<?xml version="1.0"?>
+
+<rss version="2.0">
+
+  <channel>
+
+    <title><%= title %></title>
+
+    <% if url %><link><%= url %></link><% end %>
+
+    <% if homepage %><link><%= homepage %></link><% end %>
+
+    <description>Release History</description>
+
+    <language>en-us</language>
+
+    <pubDate><%= Time.now.rfc822 %></pubDate>
+
+    <lastBuildDate><%= Time.now.rfc822 %></lastBuildDate>
+
+    <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+
+    <generator>VCLog</generator>
+
+    <managingEditor><%= email %> (<%= user %>)</managingEditor>
+
+    <webMaster><%= email %> (<%= user %>)</webMaster>
+
+<% releases.sort.each do |release| %>
+
+<% tag = release.tag %>
+
+    <item>
+
+      <title><%= tag.name %></title>
+
+      <author><%= tag.author %></author>
+
+      <link><%= url %>#<%= tag.id %></link>
+
+      <pubDate><%= tag.date.rfc822 %></pubDate>
+
+      <guid isPermaLink="false"><%= url %>#<%= tag.id %></guid>
+
+      <description><![CDATA[
+
+        <p><%= tag.message %></p>
+
+<% if !options.summary %>
+
+<% release.groups.each do |number, changes| %>
+
+        <h2><%= changes.size %> <%= changes[0].label %></h2>
+
+        <ul class="log">
+
+<% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+
+          <li class="entry">
+            <%= entry.message.rstrip %><br/>
+
+            <%= entry.author %> <%= entry.date.strftime('%Y-%m-%d %H:%M:%S') %>
+
+            <% if options.reference %>(#<%= h entry.id %>)<% end %>           
+          </li>
+
+<% end %>
+
+        </ul>
+
+<% end %>
+
+<% end %>
+
+      ]]></description>
+
+    </item>
+
+<% end %>
+
+  </channel>
+
+</rss>
+

data/lib/vclog/templates/history.xml.erb

@@ -0,0 +1,43 @@
+<?xml version="1.0"?>
+<% if options.stylesheet %>
+<?xml-stylesheet href="#{options.stylesheet}" type="text/xsl" ?>
+<% end %>
+<history>
+  <title><%= title %></title>
+  <% releases.sort.each do |release| %>
+  <tag>
+    <% tag = release.tag %>
+    <name><%= h tag.name %></name>
+    <date><%= tag.date.strftime('%Y-%m-%d') %></date>
+    <author><%= h tag.author %></author>
+    <message><%= h tag.message %></message>
+
+    <% release.groups.each do |number, changes| %>
+    <commit-group type="<%= changes[0].type %>" label="<%= changes[0].label %>">
+      <% changes.sort{|a,b| b.date <=> a.date}.each do |entry| %>
+      <commit>
+        <id><%= h entry.id %></id>
+        <date><%= entry.date %></date>
+        <author><%= h entry.author %></author>
+        <type><%= h entry.type %></type>
+        <message>
+          <summary><%= h entry.summary %></summary>
+<% if entry.details.empty? %>
+          <details></details>
+<% else %>
+          <details>
+<![CDATA[
+<%= h entry.details %>
+
+]]>
+          </details>
+<% end %>
+        </message>
+      </commit>
+      <% end %>
+    </commit-group>
+    <% end %>
+  </tag>
+  <% end %>
+</history>
+

data/lib/vclog/templates/history.yaml.rb

@@ -0,0 +1 @@
+releases.map{ |r| r.to_h }.to_yaml

data/man/man1/index.txt

@@ -0,0 +1,9 @@
+# manuals
+vclog(1)             vclog.1.ronn
+vclog-changelog(1)   vclog-changelog.1.ronn
+vclog-history(1)     vclog-history.1.ronn
+vclog-version(1)     vclog-version.1.ronn
+vclog-news(1)        vclog-news.1.ronn
+vclog-bump(1)        vclog-bump.1.ronn
+vclog-autotag(1)     vclog-autotag.1.ronn
+

data/man/man1/vclog-autotag.1.ronn

@@ -0,0 +1,29 @@
+vclog-autotag(1) - tag history entries
+======================================
+
+## SYNOPSIS
+
+`vclog-autotag`
+
+## DESCRIPTION
+
+Ensure all HISTORY file entries have corresponding commit tags in
+the version control system.
+
+## OPTIONS
+
+  * `--force`, `-y`
+    Create tags without asking for confirmation.
+
+  * `--prefix`, `-p PREFIX`
+    Specify a prefix to add to version tags. Typically
+    this will be the letter 'v'.
+
+  * `--file`, `-f FILE`
+    Specify a specific history file to use. This is useful
+    is the history file does not conform to the usual naming
+    convention of `HISTORY.*`.
+
+## SEE ALSO
+
+vclog(1)

data/man/man1/vclog-bump.1.ronn

@@ -0,0 +1,21 @@
+vclog-bump(1) - suggest next version
+====================================
+
+## SYNOPSIS
+
+`vclog-bump`
+
+## DESCRIPTION
+
+Display the next most suitable version number, based on the current
+version number. The bump command considers the commit levels in
+determining if the next version should be a major or minor bump.
+
+## OPTIONS
+
+  * `--version`, `-v NUM`
+    Assume this version number is current.
+
+## SEE ALSO
+
+vclog(1)

data/man/man1/vclog-news.1.ronn

@@ -0,0 +1,25 @@
+vclog-news(1) - output latest release notice
+============================================
+
+## SYNOPSIS
+
+`vclog-news`
+
+## DESCRIPTION
+
+Display the most recent entry in a project's history file. This command
+does NOT show the latest tag message, rather it is useful for making
+a new tag. For instnace:
+
+  `vclog-news | git tag -a -F - v1.0.0`
+
+This command will create a new git tag using the most recent message in
+the history file.
+
+## OPTIONS
+
+No options yet.
+
+## SEE ALSO
+
+vclog(1)

data/man/man1/vclog-version.1.ronn

@@ -0,0 +1,14 @@
+vclog-version(1) - display current version
+==========================================
+
+## SYNOPSIS
+
+`vclog-version`
+
+## DESCRIPTION
+
+Display current version number according to source control system.
+
+## SEE ALSO
+
+vclog(1)

data/man/man1/vclog.1.ronn

@@ -0,0 +1,49 @@
+vclog(1) - version control logs
+===============================
+
+## SYNOPSIS
+
+`vclog [options]`
+
+## DESCRIPTION
+
+VCLog is a versitle cross-VCS/SCM changelog and release history generator.
+It currently supports Git, Hg and (limited) Subversion.
+
+## OPTIONS
+
+Note that not all formats support all options, and some formats use them
+in variant manners.
+
+  * `-f`, `--format <FORMAT>`
+    Output format (ansi, rdoc, html, etc.)
+
+  * `--style <URI>`
+    Provide a stylesheet URI, either css or xsl, for HTML or XML formats.
+
+  * `-d`, `--detail`
+    Include commit message details.
+
+  * `-p`, `--point`
+    Divide commit messages into commit points.
+
+  * `-v`, `--version <VERSION>`
+    Use as current version number.
+
+  * `-t`, `--title TITLE`
+    Document title (for format that supports it).
+
+  * `-s`, `--summary
+    Omit change points. (Applies only to release history report.)
+
+  * `i`, `--id`
+    Include revision/reference ids. (Does not apply to xml/html formats.)
+
+  * `-l`, `--level <NUMBER>`
+    Lowest level of commit to display, default is `0`.
+
+Both changelog and release history can be produced in a variety of formats.
+
+## SEE ALSO
+
+vclog-version(1), vclog-bump(1), vclog-autotag(1)

data/spec/feature_git_changes.rb

@@ -0,0 +1,58 @@
+#require_relative 'featurettes/repo_creation'
+#require_relative 'featurettes/shellout'
+
+Feature "Git Change Log Support" do
+  As "Git users"
+  We "want to generate nicely formatted change logs"
+
+  Scenario "Git Changelog" do
+    Given "a suitable Git repository"
+    When  "I run `vclog`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in RDoc" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f rdoc`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in Markdown" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f markdown`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in HTML" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f html`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in XML" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f xml`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in Atom" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f atom`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in YAML" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f yaml`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Changelog in JSON" do
+    Given "a suitable Git repository"
+    When  "I run `vclog -f json`"
+    Then  "the exit status should be 0"
+  end
+
+  include RepoCreation
+  include Shellout
+end

data/spec/feature_git_history.rb

@@ -0,0 +1,58 @@
+#require_relative 'featurettes/repo_creation'
+#require_relative 'featurettes/shellout'
+
+Feature "Git Release History Support" do
+  As "Git users"
+  We "want to generate nicely formatted release histories"
+
+  Scenario "Git Release History" do
+    Given "a suitable Git repository"
+    When  "I run `vclog r`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in RDoc" do
+    Given "a suitable Git repository"
+    When  "I run `vclog r -f rdoc`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in Markdown" do
+    Given "a suitable Git repository"
+    When  "I run `vclog rel -f markdown`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in HTML" do
+    Given "a suitable Git repository"
+    When  "I run `vclog rel -f html`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in XML" do
+    Given "a suitable Git repository"
+    When  "I run `vclog rel -f xml`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in Atom" do
+    Given "a suitable Git repository"
+    When  "I run `vclog rel -f atom`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in YAML" do
+    Given "a suitable Git repository"
+    When  "I run `vclog rel -f yaml`"
+    Then  "the exit status should be 0"
+  end
+
+  Scenario "Git Release History in JSON" do
+    Given "a suitable Git repository"
+    When  "I run `vclog rel -f json`"
+    Then  "the exit status should be 0"
+  end
+
+  include RepoCreation
+  include Shellout
+end