capistrano-changelog 0.3.0 → 0.4.0

data/lib/changelog/stories_tracker.rb

@@ -0,0 +1,39 @@
+module CapistranoChangelog
+  class StoriesTracker
+    attr_reader :stories
+
+    def fetch(commits, cache, options)
+      ids_to_fetch = ids(commits) - cache.keys
+
+      return if ids_to_fetch.empty?
+
+      log = ->(msg){ options[:logger].send(:info, msg) if options[:logger] }
+
+      chunks = ids_to_fetch.each_slice(100).to_a.map do |chunk|
+        begin
+          log.call("Changelog: fetching chunk of stories: #{chunk.size}")
+          source.export(chunk)
+        rescue Trackers::BatchError => e
+          log.call("Changelog: got an export error")
+          log.call(e.message)
+
+          chunk.map do |uid|
+            log.call("Changelog: Fetching single story: #{uid}")
+            source.get(uid)
+          end
+        end
+      end
+
+      cache.merge! Hash[chunks.inject(:+)]
+    end
+
+    def source
+      @source ||= Trackers::Pivotal.new
+    end
+
+    def ids(commits)
+      @ids ||= commits.map{ |commit| commit.comment.scan(Trackers::Pivotal::MATCHER) }.flatten.compact.map(&:to_i).uniq
+    end
+
+  end
+end

data/lib/changelog/story.rb

@@ -0,0 +1,29 @@
+module CapistranoChangelog
+  Story = Struct.new(:uid, :history, :commits_collection) do
+    def title
+      history.cache.fetch(uid, nil) || history.cache.fetch(uid.to_s, nil)
+    end
+
+    def error
+      'Story has no description'
+    end
+
+    def valid?
+      history.cache.has_key?(uid) || history.cache.has_key?(uid.to_s)
+    end
+
+    def commits
+      commits_collection.select do |commit|
+        commit.comment =~ (/\##{uid}/)
+      end
+    end
+
+    def url
+      "https://www.pivotaltracker.com/story/show/#{uid}"
+    end
+
+    def to_s
+      "#{uid}: #{title}"
+    end
+  end
+end

data/lib/changelog/trackers/pivotal.rb

@@ -0,0 +1,54 @@
+require 'oj'
+require 'faraday'
+require 'faraday_middleware'
+
+module CapistranoChangelog
+  module Trackers
+    class Pivotal
+
+      MATCHER = /\#(\d+)/
+
+      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'] = CapistranoChangelog.pivotal_tracker
+          faraday.options[:timeout] = 30
+          faraday.options[:open_timeout] = 30
+        end
+      end
+
+      def export(ids)
+        response = connection.post do |opts|
+          opts.url 'stories/export'
+          opts.headers['Content-Type'] = 'application/json'
+          opts.body = Oj.dump({"ids" => ids})
+        end
+
+        unless response.status == 200
+          raise Trackers::BatchError, response.body.inspect
+        else
+          CSV.parse(response.body, headers: :first_row, skip_blanks: true).map do |row|
+            row.values_at(0, 1)
+          end
+        end
+      end
+
+      def get(uid)
+        response = connection.get("stories/#{uid}")
+
+        unless response.status == 200
+          raise Trackers::AccessDenied
+        else
+          response.body.values_at(*%w{ id name })
+        end
+      rescue Trackers::AccessDenied => e
+        [ uid, false ]
+      rescue Faraday::TimeoutError => e
+        sleep(1) and retry
+      end
+
+    end
+  end
+end

data/lib/{capistrano-changelog/release.rb → changelog/version.rb}

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

data/spec/lib/capistrano-changelog/git_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+RSpec.describe CapistranoChangelog::Git do
+
+  describe ".describe" do
+    let(:release) { "v1.2.3-4-g55443322" }
+
+    it "returns last release string" do
+      allow(described_class).to receive(:run).with(described_class::CMD_VERSION).and_return(release)
+      expect(described_class.describe).to eq(release)
+    end
+  end
+
+  describe ".first_commit" do
+    let(:first_commit) { 'e5eed9f975008ea59ec5d3b47047088949f6fb41' }
+    let(:git_log) do
+      output =<<OUTPUT
+e5eed9f975008ea59ec5d3b47047088949f6fb41\t2013-11-22 13:11:48 +0200\tinitial commit
+OUTPUT
+    end
+
+    it "returns first commit object" do
+      allow(described_class).to receive(:run).with(described_class::CMD_FIRST_COMMIT).and_return(first_commit)
+      allow(described_class).to receive(:run).with(described_class::CMD_LOG + first_commit).and_return(git_log)
+      expect(described_class.first_commit.commit).to eq(first_commit)
+    end
+  end
+
+  describe ".last_commit" do
+    let(:last_commit) { '8bbeaac2b114228d27f8464fe2cd2df15adeb8ce' }
+    let(:git_log) do
+      output =<<OUTPUT
+8bbeaac2b114228d27f8464fe2cd2df15adeb8ce\t2013-11-22 13:11:48 +0200\tinitial commit
+OUTPUT
+    end
+
+    it "returns first commit object" do
+      allow(described_class).to receive(:run).with(described_class::CMD_LOG + 'HEAD^..HEAD').and_return(git_log)
+
+      expect(described_class.last_commit.commit).to eq(last_commit)
+    end
+  end
+
+  describe ".releases" do
+    let(:full_output) do
+      output =<<OUTPUT
+029bb8a07f62d4579b8265cb10e5ab01b8bed880\t2013-11-20 10:10:26 +0200\tv0.0.1
+bbc430a085ebff05bf41878336aa688303415f60\t2013-11-20 11:04:37 +0200\tv0.0.2
+9c909837862ca121189003a7eec6817a646b2163\t2013-11-20 11:07:47 +0200\tv0.1.0
+8bbeaac2b114228d27f8464fe2cd2df15adeb8ce\t2013-11-20 12:11:21 +0200\tv0.1.1
+3904d563f7df1332d84606e9b2bf9071ca5552fa\t2013-11-21 14:46:33 +0200\tv0.2.0
+5efb66c1f863cb0726e013be4f0d015dafdaa4e1\t2013-11-21 15:59:36 +0200\tv0.2.1
+fb5bffcad9d5809d9675687c1c608173db9a1589\t2013-11-22 13:11:48 +0200\tv0.2.2
+25fafb66002aef1ba1b3a18015cd3880c1e36694\t2013-11-25 15:35:21 +0200\tv0.3.0
+OUTPUT
+    end
+
+    let(:first_tag) { described_class.releases.first }
+
+    it "returns array of Commit objects" do
+      allow(described_class).to receive(:run).with(described_class::CMD_TAGS).and_return(full_output)
+
+      expect(first_tag).to be_a(CapistranoChangelog::Git::Commit)
+      expect(first_tag.commit).to eq('029bb8a07f62d4579b8265cb10e5ab01b8bed880')
+      expect(first_tag.comment).to eq('v0.0.1')
+    end
+
+    it "returns empty array if no tags were created" do
+      allow(described_class).to receive(:run).with(described_class::CMD_TAGS).and_return("")
+      expect(described_class.releases).to be_empty
+    end
+  end
+
+  describe ".commits" do
+    let(:git_log) do
+      output =<<OUTPUT
+e5eed9f975008ea59ec5d3b47047088949f6fb41\t2013-11-22 13:11:48 +0200\tupdated html formatting
+d4c120c3ecc6abe259489b6ea6a027234422babf\t2013-11-21 15:59:36 +0200\ttime for tags
+af94b7cac32054f55d041db3359acb23ccb920aa\t2013-11-21 14:46:33 +0200\tchangelog
+OUTPUT
+    end
+
+    let(:initial_commit) {  }
+    let(:head) {  }
+
+    let(:first_tag)  { CapistranoChangelog::Git::Commit.new({
+      commit: '8bbeaac2b114228d27f8464fe2cd2df15adeb8ce',
+      datetime: '2013-11-20 12:11:21 +0200',
+      title: 'v0.1.1'
+    }) }
+
+    let(:second_tag) { CapistranoChangelog::Git::Commit.new({
+      commit: 'fb5bffcad9d5809d9675687c1c608173db9a1589',
+      datetime: '2013-11-22 13:11:48 +0200',
+      title: 'v0.2.2'
+    }) }
+
+    let(:predecessor) { CapistranoChangelog::Release.new(first_tag) }
+    let(:successor)   { CapistranoChangelog::Release.new(second_tag) }
+
+    it "retrieves list between two commits" do
+      allow(described_class).to receive(:run).and_return(git_log)
+      expect(described_class.commits(predecessor, successor)).to satisfy { |collection| collection.size == 3 }
+    end
+
+    it "retrieves empty list between the same commit" do
+      expect(described_class).to_not receive(:run)
+      expect(described_class.commits(predecessor, predecessor)).to be_empty
+    end
+
+    it "retrieves empty list between wrong sequenve of commits" do
+      expect(described_class).to_not receive(:run)
+      expect(described_class.commits(successor, predecessor)).to be_empty
+    end
+  end
+
+end

data/spec/lib/capistrano-changelog/history_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe CapistranoChangelog::History do
+
+  let(:initial) { CapistranoChangelog::Git::Commit.new(commit: 'theveryfirstcommit', datetime: (Time.now - 30).to_s, comment: '1') }
+  let(:first)   { CapistranoChangelog::Git::Commit.new(commit: 'firstcommit123',     datetime: (Time.now - 10).to_s, comment: '2') }
+  let(:second)  { CapistranoChangelog::Git::Commit.new(commit: 'secondcommit231',    datetime: (Time.now     ).to_s, comment: '3') }
+  let(:third)   { CapistranoChangelog::Git::Commit.new(commit: 'thirdcommit321',     datetime: (Time.now + 10).to_s, comment: '4') }
+  let(:head)    { CapistranoChangelog::Git::Commit.new(commit: 'theverylastcommit',  datetime: (Time.now + 30).to_s, comment: '5') }
+  let(:collection) { [first, second, third] }
+
+  before do
+    allow(CapistranoChangelog::Git).to receive(:last_commit).and_return(head)
+    allow(CapistranoChangelog::Git).to receive(:first_commit).and_return(initial)
+  end
+
+  subject { described_class.new }
+
+  describe ".next_to" do
+    it "have to return next release from history if exists" do
+      allow(CapistranoChangelog::Release).to receive(:all).and_return(collection)
+      expect(subject.next_to(first)).to eq(second)
+    end
+
+    it "have to return HEAD if next release does not exists" do
+      allow(CapistranoChangelog::Release).to receive(:all).and_return(collection)
+      expect(subject.next_to(third).commit).to eq('theverylastcommit')
+    end
+  end
+
+  describe ".prev_to" do
+    it "have to return prev release from history if exists" do
+      allow(CapistranoChangelog::Release).to receive(:all).and_return(collection)
+      expect(subject.prev_to(second)).to eq(first)
+    end
+
+    it "have to return FIRST if prev release does not exists" do
+      allow(CapistranoChangelog::Release).to receive(:all).and_return(collection)
+      expect(subject.prev_to(first).commit).to eq(initial.commit)
+    end
+  end
+
+  describe ".generate", skip: true do
+    it "generates HTML formated changelog" do
+      expect{ Nokogiri::HTML(described_class.new.generate) }.not_to raise_error
+    end
+  end
+
+end

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

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+RSpec.describe CapistranoChangelog::Release do
+
+  let(:first_tag)  { CapistranoChangelog::Git::Commit.new commit: 'aabbcczz1', title: 'v0.0.1', datetime: '2013-11-21 10:10:10 +0200' }
+  let(:second_tag) { CapistranoChangelog::Git::Commit.new commit: 'aabbcczz2', title: 'v0.0.2', datetime: '2013-11-22 10:10:10 +0200' }
+  let(:last_tag)   { CapistranoChangelog::Git::Commit.new commit: 'aabbcczz3', title: 'v0.0.3', datetime: '2013-11-23 10:10:10 +0200' }
+
+  context "object properties" do
+
+    let(:tag) { first_tag }
+
+    subject { described_class.new(tag) }
+
+    it "has commit object" do
+      expect(subject.commit).to eq('aabbcczz1')
+    end
+
+    it "uses tag name" do
+      expect(subject.title).to eq('v0.0.1')
+    end
+
+    it "uses hash value as value" do
+      expect(subject.date).to eq(Time.utc(2013,11,21,8,10,10))
+    end
+
+  end
+
+
+  context "comparable" do
+
+    let(:one)   { described_class.new(first_tag) }
+    let(:two)   { described_class.new(second_tag) }
+    let(:three) { described_class.new(last_tag) }
+
+    it "have to be equal" do
+      expect(one <=> one).to eq(0)
+    end
+
+    it "have to be lower" do
+      expect(one <=> two).to eq(-1)
+    end
+
+    it "have to be greater" do
+      expect(three <=> two).to eq(1)
+    end
+
+    it "have to be sortable" do
+      expect([one, three, two].sort).to eq([one, two, three])
+    end
+
+    it "have to be reversable" do
+      expect([one, two, three].reverse).to eq([three, two, one])
+    end
+
+  end
+
+
+  describe ".stories" do
+
+
+
+  end
+
+end

data/spec/lib/capistrano-changelog/version_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe CapistranoChangelog::Version do
+
+  let(:version) { 'x.y.z-andsomehash' }
+
+  describe ".generate" do
+    it "generates JSON string" do
+      expect{ JSON.parse(described_class.generate) }.not_to raise_error
+    end
+
+    context "JSON content" do
+      let(:time) { Time.mktime(2014,01,01) }
+
+      before do
+        allow(CapistranoChangelog::Git).to receive(:describe).and_return(version)
+        allow(Time).to receive(:now).and_return(time)
+      end
+
+      subject { JSON.parse(described_class.generate) }
+
+      it "contains version string" do
+        expect(subject).to include({'version' => version})
+      end
+
+      it "contains UNIX timestamp" do
+        expect(subject).to include({'ts' => time.to_i})
+      end
+
+      context "restart flag" do
+        it "returns true by default" do
+          allow(ENV).to receive(:fetch).with('RESTART', 'true').and_return('true')
+          expect(subject).to include({'restart' => true})
+        end
+
+        it "returns false if environment variable exists" do
+          allow(ENV).to receive(:fetch).with('RESTART', 'true').and_return('any value or false')
+          expect(subject).to include({'restart' => false})
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rspec'
+require 'nokogiri'
 require 'capistrano-changelog'
-require 'vcr'
 
 RSpec.configure do |c|
   c.mock_with :rspec

data/templates/changelog.erb

@@ -106,35 +106,51 @@
 
   <body>
     <div class="content">
-      <h1>Change Log @ <%= @changelog.date %></h1>
+      <h1>Change Log @ <%= format date %></h1>
       <div class="content-inner">
 
-        <% for @release in @changelog.releases %>
-        <h2><%= @release.title %> <span class="date">(<%= @release.date %>)</span></h2>
+        <% for release in releases %>
+        <h2><%= release.comment %> <span class="date">(<%= format release.date %>)</span></h2>
 
-          <% for @story in @release.stories %>
+          <% for story in release.stories(history) %>
           <div class="story">
 
-            <% if @story.valid? %>
+            <% if story.valid? %>
             <h3>
-              <a href="<%= @story.url %>"><span class="num"><%= @story.num %></span></a>
-              <span class="name"><%= @story.name %></span>
+              <a href="<%= story.url %>"><span class="num"><%= story.uid %></span></a>
+              <span class="name"><%= story.title %></span>
             </h3>
             <% else %>
             <h3>
-              <span class="num"><%= @story.num %></span>
-              <span class="name"><%= @story.error %></span>
+              <span class="num"><%= story.uid %></span>
+              <span class="name"><%= story.error %></span>
             </h3>
             <% end %>
 
             <ul class="commits">
-              <% for @commit in @release.commits(@story.num) %>
-              <li><%= @commit.message %></li>
+              <% for commit in story.commits %>
+              <li><%= commit %></li>
               <% end %>
             </ul>
           </div>
           <% end %>
 
+          <% if release.unreconized?(history) %>
+          <div class="story">
+
+            <h3>
+              <span class="name">Unreconized</span>
+            </h3>
+
+            <ul class="commits">
+              <% for commit in release.unreconized(history) %>
+              <li><%= commit.short %> <%= commit %></li>
+              <% end %>
+            </ul>
+
+          </div>
+          <% end %>
+
         <% end %>
       </div>
     </div>