capistrano-changelog 0.3.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--default_path spec
+--order rand
+--warnings
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'vcr', '~> 2.7'
+gem 'webmock'
+
+gem 'git'
+gem 'faraday', '~> 0.8'
+gem 'faraday-middleware', '~> 0.9'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dmitry Larkin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+
+# capistrano-changelog
+
+Uses git commits to recognize tracker stories and generates ChangeLog.
+
+Integration with Capostrano.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-changelog', require: false
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-changelog
+
+
+## Usage
+
+Capistrano tasks
+
+    set :changelog_tracker, :pivotal                # ticket tracking service, default: pivotal
+    set :changelog_pivotal_token, 'xxxx'
+    set :changelog_output, File.join(release_path, 'public', 'changelog.html')
+    set :changelog_cache, '/tmp/pivotal'            # does tickets caching if caching path specified, default: false
+
+Hooks
+
+    # Generates ChangeLog file
+    #
+    after 'deploy:finished', 'deploy:changelog'
+
+    # Generates version.json with last commit hash
+    #
+    after 'deploy:update_code', 'deploy:version'
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'bundler'
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-w]
+end
+
+task :default => [:spec]

data/capistrano-changelog.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-changelog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-changelog"
+  spec.version       = CapistranoChangelog::VERSION
+  spec.authors       = ["Dmitry Larkin"]
+  spec.email         = ["dmitry.larkin@gmail.com"]
+  spec.description   = %q{Uses git commits to recognize tracker stories and generates ChangeLog.}
+  spec.summary       = %q{Uses git commits to recognize tracker stories and generates ChangeLog.}
+  spec.homepage      = "https://github.com/dml/capistrano-changelog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency     "git", "~> 1.2.6"
+  spec.add_runtime_dependency     "capistrano", "~> 2.0"
+  spec.add_runtime_dependency     "faraday", "~> 0.8"
+  spec.add_runtime_dependency     "faraday_middleware", "~> 0.9"
+  spec.add_runtime_dependency     "capistrano", "< 3.0"
+end

data/lib/capistrano-changelog.rb

@@ -0,0 +1,37 @@
+require "capistrano-changelog/version"
+require "git"
+
+
+module CapistranoChangelog
+  class GeneralError < StandardError; end
+
+  module Pivotal
+    class NetworkError < StandardError; end
+
+    autoload :Story, "capistrano-changelog/pivotal/story"
+    autoload :API, "capistrano-changelog/pivotal/api"
+  end
+
+  module Git
+    autoload :Lib, "capistrano-changelog/git/lib"
+  end
+
+  module Wrappers
+    autoload :ChangeLog,  "capistrano-changelog/wrappers/changelog"
+    autoload :Release,    "capistrano-changelog/wrappers/release"
+  end
+
+  autoload :Release,    "capistrano-changelog/release"
+  autoload :ChangeLog,  "capistrano-changelog/change_log"
+  autoload :TagList,    "capistrano-changelog/git/tags_list"
+
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+  def self.templates
+    File.join root, 'templates'
+  end
+end
+
+Git::Lib.send :include, CapistranoChangelog::Git::Lib

data/lib/capistrano-changelog/capistrno.rb

@@ -0,0 +1,15 @@
+require 'capistrano-changelog'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    desc "Generates changelog"
+    task :changelog do
+      put CapistranoChangelog::ChangeLog.generate, "#{current_path}/public/changelog.html"
+    end
+
+    desc "Generates version file. RESTART=(true|false) option could be specified (by default is true)"
+    task :version do
+      put CapistranoChangelog::Release.generate, "#{release_path}/version.json"
+    end
+  end
+end

data/lib/capistrano-changelog/change_log.rb

@@ -0,0 +1,22 @@
+require 'erb'
+
+module CapistranoChangelog
+  class Controller
+    def initialize
+      @changelog = CapistranoChangelog::Wrappers::ChangeLog.new
+    end
+    def get_binding
+      binding
+    end
+  end
+
+  class ChangeLog
+    def self.generate
+      raise GeneralError, "You have to specify Pivotal token with export PIVOTAL_TOKEN=xyz" unless ENV.has_key?('PIVOTAL_TOKEN')
+
+      controller = CapistranoChangelog::Controller.new
+      template = ERB.new IO.read(File.join(CapistranoChangelog.templates, 'changelog.erb'))
+      template.result(controller.get_binding)
+    end
+  end
+end

data/lib/capistrano-changelog/git/lib.rb

@@ -0,0 +1,10 @@
+module CapistranoChangelog::Git
+  module Lib
+    def ordered_tags
+      command_lines("for-each-ref --sort='*authordate' --format='%(tag)' refs/tags")
+    end
+    def first_commit
+      command("rev-list --max-parents=0 HEAD")
+    end
+  end
+end

data/lib/capistrano-changelog/git/tags_list.rb

@@ -0,0 +1,29 @@
+module CapistranoChangelog
+  class TagList
+    include Enumerable
+
+    def initialize(git, since)
+      @list = git.lib.ordered_tags + ['HEAD']
+      @since = since
+      @first_commit = git.lib.first_commit
+    end
+
+    def each(options = {})
+      list_after_item = @list[@list.index(@since), @list.size]
+
+      if block_given?
+        list_after_item.reverse.each { |e| yield(e) }
+      else
+        Enumerator.new(list_after_item.reverse, :each)
+      end
+    end
+
+    def next_to(name)
+      @list[@list.index(name) + 1] || 'HEAD'
+    end
+
+    def prev_to(name)
+      0 < @list.index(name) && @list[@list.index(name) - 1] or @first_commit
+    end
+  end
+end

data/lib/capistrano-changelog/pivotal/api.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module CapistranoChangelog
+  module Pivotal
+    class API
+      class << self
+        def connection
+          @connection ||= Faraday.new 'https://www.pivotaltracker.com/services/v5' do |faraday|
+            faraday.request :json
+            faraday.response :json, :content_type => /\bjson$/
+            faraday.adapter Faraday.default_adapter
+            faraday.headers['X-TrackerToken'] = ENV['PIVOTAL_TOKEN']
+            faraday.options[:timeout] = 30
+            faraday.options[:open_timeout] = 30
+          end
+        end
+
+        def get(uri)
+          begin
+            response = connection.get(uri)
+
+            raise Pivotal::NetworkError unless response.status == 200
+
+            response.body
+          rescue Pivotal::NetworkError, Faraday::Error::TimeoutError => e
+            {
+              'kind' => 'error',
+              'error' => 'Unable to fetch data'
+            }
+          end
+        end
+
+        def story(id)
+          get("stories/#{id}")
+        end
+
+        def epic(id)
+          get("epics/#{id}")
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-changelog/pivotal/story.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+
+module CapistranoChangelog
+  module Pivotal
+    class Story
+      attr_reader :num
+
+      def initialize(story_id)
+        @num = story_id
+        @story = Pivotal::API.story(story_id)
+        @labels = @story['labels'].map { |label| label['name'] } if @story['labels'].is_a?(Array)
+      end
+
+      def invalid?
+        @story['kind'] == 'error'
+      end
+
+      def valid?
+        !invalid?
+      end
+
+      def method_missing(meth)
+        if @story.has_key?(meth.to_s)
+          @story[meth.to_s]
+        else
+          super
+        end
+      end
+
+      def self.get(id)
+        return @stories[id] if defined?(@stories) and @stories[id]
+        @stories ||= {}
+        @stories[id] = new(id)
+      end
+    end
+  end
+end

data/lib/capistrano-changelog/release.rb

@@ -0,0 +1,13 @@
+require 'git'
+
+module CapistranoChangelog
+  class Release
+    def self.generate
+      JSON.dump({
+        restart: ( ENV.fetch('RESTART', 'true') == 'true' ),
+        version: (`git describe --always`).strip,
+        ts: Time.now.to_i
+      })
+    end
+  end
+end

data/lib/capistrano-changelog/version.rb

@@ -0,0 +1,3 @@
+module CapistranoChangelog
+  VERSION = "0.3.0"
+end

data/lib/capistrano-changelog/wrappers/changelog.rb

@@ -0,0 +1,21 @@
+module CapistranoChangelog::Wrappers
+  class ChangeLog
+    attr_reader :git, :tags
+
+    def initialize
+      @git ||= ::Git.open(Dir.getwd)
+      @start = ENV['PTLOG_SINCE'] || git.lib.ordered_tags.first
+      @tags = CapistranoChangelog::TagList.new(@git, @start)
+    end
+
+    def date
+      Time.new.utc.strftime('%I:%M%P %D UTC')
+    end
+
+    def releases
+      @tags.map do |tag|
+        CapistranoChangelog::Wrappers::Release.new(tag, self)
+      end
+    end
+  end
+end

data/lib/capistrano-changelog/wrappers/release.rb

@@ -0,0 +1,35 @@
+module CapistranoChangelog::Wrappers
+  class Release
+    def initialize(tag, changelog)
+      @tag = tag
+      @initial_commit = changelog.tags.prev_to(tag)
+      @git = changelog.git
+      @commit = @git.gcommit(tag)
+    end
+
+    def title
+      @tag
+    end
+
+    def date
+      @commit.date.utc.strftime('%I:%M%P %D UTC')
+    end
+
+    def stories
+      ids = @git.log.between(@initial_commit, @tag).map do |commit|
+        commit.message.scan(/\#(\d+)/)
+      end
+      ids.flatten.uniq.map{ |num| CapistranoChangelog::Pivotal::Story.get(num) }
+    end
+
+    def commits(num)
+      @git.log.between(@initial_commit, @tag).select do |commit|
+        commit.message =~ (/\##{num}/)
+      end
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/spec/lib/capistrano-changelog/wrappers/changelog_rspec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe CapistranoChangelog::Wrappers::ChangeLog do
+
+  let(:git) { mock(:git) }
+  let(:tags) { mock(:tag_list) }
+
+  describe ".date" do
+
+  end
+
+  describe ".releases" do
+
+  end
+
+end

data/spec/lib/capistrano-changelog/wrappers/release_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe CapistranoChangelog::Wrappers::Release do
+
+  let(:tag) { mock(:tag) }
+
+  subject {  }
+
+  describe '.title' do
+
+  end
+
+  describe '.date' do
+
+  end
+
+  describe '.stories' do
+
+  end
+
+  describe '.commits' do
+
+  end
+
+  describe '.get_binding' do
+
+  end
+
+end

data/spec/lib/capistrano_changelog_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CapistranoChangelog do
+
+  describe ".root" do
+    subject { described_class.root }
+
+    it { should be_a String }
+  end
+
+  describe '.templates' do
+    subject { described_class.templates }
+
+    it { should be_a String }
+    it { should include described_class.root }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'capistrano-changelog'
+require 'vcr'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

data/templates/changelog.erb

@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ChangeLog</title>
+    <link href='http://fonts.googleapis.com/css?family=Abel' rel='stylesheet' type='text/css'>
+
+    <style type="text/css">
+
+      @font-face {
+        font-family: sans-serif;
+        font-weight: normal;
+        font-style: normal;
+      }
+
+      @font-face {
+        font-family: sans-serif;
+        font-weight: normal;
+        font-style: normal;
+      }
+
+      body {
+        background-color: #f4f3f0;
+        min-width: 450px;
+        padding: 0;
+        margin: 0;
+        color: #292C2F;
+        font-family: DINPro-Regular, Arial;
+        font-size: 13px;
+      }
+
+      .content {
+        width: 800px;
+        margin: 22px auto;
+      }
+
+      .content-inner {
+        -webkit-border-radius: 5px;
+        -moz-border-radius: 5px;
+        border-radius: 5px;
+        background: white;
+        padding: 1px 30px;
+        -webkit-box-shadow: 0 3px 5px #d4d5d5;
+        -moz-box-shadow: 0 3px 5px #d4d5d5;
+        -o-box-shadow: 0 3px 5px #d4d5d5;
+        box-shadow: 0 3px 5px #d4d5d5;
+      }
+
+      h1, h2 , h3 {
+        font-family: sans-serif;
+        color: #000;
+        line-height: 1.321em;
+        font-weight: normal;
+        margin: 0;
+      }
+
+      h1 {
+        margin-bottom: 10px;
+        font-size: 30px;
+      }
+
+      h2 {
+        margin: 25px 0 10px;
+        font-size: 18px;
+      }
+
+      h3 {
+        font-size: 13px;
+        font-weight: bold;
+        margin-bottom: 5px;
+        padding-left: 15px;
+      }
+
+      a, a:visited, a:link, .num {
+        color: #4781c6;
+        text-decoration: none;
+      }
+
+      a:hover {
+        color: #f2b500;
+        text-decoration: none;
+      }
+
+      ul, li {
+        list-style: none;
+      }
+
+      ul {
+        margin: 0;
+        margin-bottom: 10px;
+        padding-left: 30px;
+      }
+
+      .date {
+        font-size: 13px;
+        font-style: italic;
+      }
+
+      .story {
+        margin-bottom: 25px;
+      }
+
+    </style>
+
+    <link rel="shortcut icon" href="assets/favicon.ico" />
+  </head>
+
+  <body>
+    <div class="content">
+      <h1>Change Log @ <%= @changelog.date %></h1>
+      <div class="content-inner">
+
+        <% for @release in @changelog.releases %>
+        <h2><%= @release.title %> <span class="date">(<%= @release.date %>)</span></h2>
+
+          <% for @story in @release.stories %>
+          <div class="story">
+
+            <% if @story.valid? %>
+            <h3>
+              <a href="<%= @story.url %>"><span class="num"><%= @story.num %></span></a>
+              <span class="name"><%= @story.name %></span>
+            </h3>
+            <% else %>
+            <h3>
+              <span class="num"><%= @story.num %></span>
+              <span class="name"><%= @story.error %></span>
+            </h3>
+            <% end %>
+
+            <ul class="commits">
+              <% for @commit in @release.commits(@story.num) %>
+              <li><%= @commit.message %></li>
+              <% end %>
+            </ul>
+          </div>
+          <% end %>
+
+        <% end %>
+      </div>
+    </div>
+  </body>
+</html>

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-changelog
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Dmitry Larkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Uses git commits to recognize tracker stories and generates ChangeLog.
+email:
+- dmitry.larkin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-changelog.gemspec
+- lib/capistrano-changelog.rb
+- lib/capistrano-changelog/capistrno.rb
+- lib/capistrano-changelog/change_log.rb
+- lib/capistrano-changelog/git/lib.rb
+- lib/capistrano-changelog/git/tags_list.rb
+- lib/capistrano-changelog/pivotal/api.rb
+- lib/capistrano-changelog/pivotal/story.rb
+- lib/capistrano-changelog/release.rb
+- lib/capistrano-changelog/version.rb
+- lib/capistrano-changelog/wrappers/changelog.rb
+- lib/capistrano-changelog/wrappers/release.rb
+- spec/lib/capistrano-changelog/wrappers/changelog_rspec.rb
+- spec/lib/capistrano-changelog/wrappers/release_spec.rb
+- spec/lib/capistrano_changelog_spec.rb
+- spec/spec_helper.rb
+- templates/changelog.erb
+homepage: https://github.com/dml/capistrano-changelog
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Uses git commits to recognize tracker stories and generates ChangeLog.
+test_files:
+- spec/lib/capistrano-changelog/wrappers/changelog_rspec.rb
+- spec/lib/capistrano-changelog/wrappers/release_spec.rb
+- spec/lib/capistrano_changelog_spec.rb
+- spec/spec_helper.rb
+has_rdoc: