anchorman 0.6.0 → 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa7a2944aa87ac44844b8227cc2c3e051cd7b8f2
+  data.tar.gz: 4da009463c5442576a6f9763ca72cb10b89f4014
+SHA512:
+  metadata.gz: d53ccbef5b04c9f828b2eb59dd069d94c3aebd7d965a05f0281a286412ca9b3d7cd828fab8ac2437ea78886c546298c964a49951ea19d889135adf37e3f93cbc
+  data.tar.gz: 4efb402b5a36f0d25e995733ec6424a8464cf87ec52e85620db5bad19b00aeb747fd0bd9214ff80471f1009b387ec8f0f2c663ea12459cdff33a20083a92e090

data/README.md

@@ -5,7 +5,7 @@ _When you need trusted news, you turn to an anchorman._
 
 Simply put, Anchorman scans your commit log and builds release notes for your project.
 
-These notes are build in [Markdown][md] and live in a `release_notes` directory off of your project root. When viewed locally they will be readable. When viewed on Github they will be rendered as nice HTML.
+These notes are build in [Markdown][md] and live in a `release_notes` directory off of your project root. The expected usage is to have one file per release, named appropriately,  in this directory. When viewed locally they will be readable. When viewed on Github they will be rendered as nice HTML.
 
 There is also an option to generate HTML versions of these files using [Github Flavored Markdown][gfm] for posting/hosting elsewhere.
 
@@ -29,19 +29,19 @@ Or install it yourself as:
 
 ## Usage
 
-Anchorman is fairly simple-minded. It generates files with a little bit of formatting, but not much. The resulting files are meant as good starting points for more human-readable release notes.
+Anchorman is fairly simple-minded. It generates files with a little bit of formatting, but not much.  The resulting files are meant as good starting points for more human-readable release notes.
 
     $ anchorman notes
 
-Generates a `release_notes/release_notes.md` off of the root of your project. Has a simple header and will have a bullet list of commit information from your entire repo.
+Generates a `release_notes/release_notes.md` off of the root of your project.  Has a simple header and will have a bullet list of commit information from your entire repo.
 
     $ anchorman notes --from=<ref> --to=<ref>
 
-Builds notes only for commits between two git refs. If not supplied, `to` defaults to `HEAD`. Can be combined with other options.
+Builds notes only for commits between two git refs. If not supplied, `to` defaults to `HEAD`.  Can be combined with other options.
 
     $ anchorman notes --name=<filename>
 
-Writes out notes to `release_notes/<filename>.md`.Can be combined with other options.
+Writes out notes to `release_notes/<filename>.md`.  Can be combined with other options.
 
     $ anchorman html
 

data/lib/anchorman.rb

@@ -1,8 +1,8 @@
 require "thor"
 require "git"
 require "github/markdown"
+require "octokit"
 
-require "anchorman/repo"
 require "anchorman/commit_formatter"
 require "anchorman/version"
 require "anchorman/cli"

data/lib/anchorman/cli.rb

@@ -1,6 +1,6 @@
 module Anchorman
   NOTES_HEADER = "# Release Notes\n\n## Summary\n\n## Changes\n\n"
-  NOTES_FOOTER = "\n\n\------\n\n_Release Notes generated with [Anchorman](http://github.com/infews/anchorman)_"
+  NOTES_FOOTER = "\n\n------\n\n_Release Notes generated with _[Anchorman](http://github.com/infews/anchorman)_"
 
   class CLI < Thor
 
@@ -13,9 +13,9 @@ module Anchorman
       git = open_repo
 
       commits = if options[:from]
-                  git.log.between options[:from], options[:to]
+                  git.log(nil).between options[:from], options[:to]
                 else
-                  git.log
+                  git.log(nil)
                 end
 
       return unless commits.size
@@ -24,7 +24,7 @@ module Anchorman
 
       empty_directory 'release_notes'
 
-      formatter = CommitFormatter.new(Repo.new(git))
+      formatter = CommitFormatter.new
       notes = commits.collect { |c| formatter.format(c) }.join("\n\n")
 
       create_file "release_notes/#{options[:name]}.md" do
@@ -73,4 +73,4 @@ module Anchorman
 
     end
   end
-end
+end

data/lib/anchorman/commit_formatter.rb

@@ -1,9 +1,9 @@
 module Anchorman
-  class CommitFormatter < Struct.new(:repo)
+  class CommitFormatter
 
     def format(commit)
-      note = "* SHA: #{repo.commit_url(commit.sha)}\n"
-      note << "    * #{format_message(commit.message)}\n"
+      note = "* #{format_message(commit.message)}\n"
+      note << "    * SHA: #{commit.sha}\n"
       note << "    * #{commit.author.name}, #{commit.author.email}\n"
       note
     end

data/lib/anchorman/version.rb

@@ -1,3 +1,3 @@
 module Anchorman
-  VERSION = "0.6.0"
+  VERSION = "0.9.1"
 end

data/release_notes/{release_notes.md → v.0.6.0.md}

@@ -19,4 +19,4 @@ First Release. A real MVP.
 
 ------
 
-Release Notes generated with [Anchorman](http://github.com/infews/anchorman)_
+Release Notes generated with _[Anchorman](http://github.com/infews/anchorman)_

data/release_notes/v0.9.1.md

@@ -0,0 +1,26 @@
+# Release Notes Anchorman v0.9.1
+
+## Summary
+
+This is mostly a clean-up release. There was a glitch with v0.9.0. So ignore that one.
+
+## Breaking Changes
+
+Anchorman is still pre-1.0, so we're in flux.
+
+This release removes the HTML linking of SHAs back to GitHub. The code to support it was annoyingly complex and by using the right code (coming soon) at GitHub for rendering to HTML, there will be even better linking. This was part of the response to #[2](https://github.com/infews/anchorman/pull/2).
+
+## Other Changes, Pull Requests and Bugs
+
+* When generating notes, the description now comes first. This will make it easier to collapse to read and edit the Markdown file as you work through the notes. See [this Tracker story](http://www.pivotaltracker.com/story/54124569)
+* Thanks to #[4](https://github.com/infews/anchorman/pull/4), git repos with more than 30 commits are handled. The current code does not iterate along the commits well yet. So large repos are probably going to break without a lot of memory.
+* Fixed a bug that didn't close an underscore in the footer
+
+## Coming Soon
+
+* HTML rendering is up next. Good news - Anchorman will use the GitHub API for rendering Markdown to HTML, giving auto-linking and other awesome formatting. Bad news - you will need an internet connection to release.
+
+
+------
+
+_Release Notes generated with _[Anchorman](http://github.com/infews/anchorman)_

metadata

@@ -1,126 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: anchorman
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.9.1
 platform: ruby
 authors:
 - infews
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-17 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: github-markdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Extract release notes from your git log
@@ -134,42 +147,35 @@ files:
 - bin/anchorman
 - lib/anchorman/cli.rb
 - lib/anchorman/commit_formatter.rb
-- lib/anchorman/repo.rb
 - lib/anchorman/version.rb
 - lib/anchorman.rb
-- release_notes/release_notes.md
 - release_notes/sample.md
+- release_notes/v.0.6.0.md
+- release_notes/v0.9.1.md
 - LICENSE.md
 - README.md
 homepage: http://github.com/infews/anchorman
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -802147756992914157
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -802147756992914157
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Executable that scans your git log for specific release tags and builds a
   directory of nicely formatted set of Markdown files ready for detailed editing into
   release notes.

data/lib/anchorman/repo.rb

@@ -1,27 +0,0 @@
-module Anchorman
-  class Repo < Struct.new(:git_repo)
-
-    def remote
-      git_repo.remote
-    end
-
-    def is_github?
-      remote &&
-          remote.name == "origin" &&
-          remote.url &&
-          remote.url.match(/github\.com/)
-    end
-
-    def commit_url(sha)
-      return sha unless is_github?
-
-      "[#{sha}](#{github_url_for 'commit', sha})"
-    end
-
-    private
-
-    def github_url_for(*components)
-      [remote.url[0..-5], *components].join('/')
-    end
-  end
-end