capistrano-changelog 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e9bfe6dc308fc927af68f6242733ae2024bb0b0
+  data.tar.gz: d9ec16816df93500be675e00816ca8f12278aa29
+SHA512:
+  metadata.gz: d5f7c87c3c499d56755288df88e9db883defe07df54e290483eca93f5f417ef1e7a8c58db2d24662b856ade729e44187835bb71118f67cbf654b13f8757bb03d
+  data.tar.gz: 169536f050e9bc9529d34919aa7946dc6c601fa48d9e7348d5dbe4e25603b147d783a6ec02181432ca401ad044f51ae4777516af050313a464b19885fc4f3a5c

data/.rspec

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

data/Gemfile

@@ -3,10 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'rspec'
-gem 'vcr', '~> 2.7'
+gem 'rspec', '~> 3.0'
 gem 'webmock'
+gem 'nokogiri'
 
 gem 'git'
-gem 'faraday', '~> 0.8'
-gem 'faraday-middleware', '~> 0.9'
+gem 'faraday', '~> 0.9'
+gem 'faraday_middleware', '~> 0.9'
+gem 'faraday-http-cache'

data/README.md

@@ -20,15 +20,20 @@ Or install it yourself as:
 
     $ gem install capistrano-changelog
 
+Put into deploy.rb
+
+    require 'capistrano/changelog'
+
+
 
 ## Usage
 
-Capistrano tasks
+Use following settings at deploy.rb
+
+    role :changelog, %w{ host.name }, cache: true, version: true
 
-    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
+    set :changelog,         File.join(current_path, 'public', 'changelog.html')
+    set :changelog_version, File.join(current_path, 'public', 'version.json')
 
 Hooks
 

data/capistrano-changelog.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'capistrano-changelog/version'
+require 'changelog/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-changelog"
-  spec.version       = CapistranoChangelog::VERSION
+  spec.version       = "0.4.0"
   spec.authors       = ["Dmitry Larkin"]
   spec.email         = ["dmitry.larkin@gmail.com"]
   spec.description   = %q{Uses git commits to recognize tracker stories and generates ChangeLog.}
@@ -18,12 +18,11 @@ Gem::Specification.new do |spec|
   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_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"
+  spec.add_runtime_dependency     'oj'
+  spec.add_runtime_dependency     'capistrano', '< 3.0'
+  spec.add_runtime_dependency     'faraday', '~> 0.9'
+  spec.add_runtime_dependency     'faraday-http-cache', '~> 0.4'
 end

data/lib/capistrano-changelog.rb

@@ -1,29 +1,21 @@
-require "capistrano-changelog/version"
-require "git"
-
-
 module CapistranoChangelog
   class GeneralError < StandardError; end
 
-  module Pivotal
-    class NetworkError < StandardError; end
+  module Trackers
+    class Trackers::NetworkError < StandardError; end
+    class Trackers::ConfigError < StandardError; end
+    class Trackers::AccessDenied < StandardError; end
+    class Trackers::BatchError < StandardError; end
 
-    autoload :Story, "capistrano-changelog/pivotal/story"
-    autoload :API, "capistrano-changelog/pivotal/api"
+    autoload :Pivotal,        "changelog/trackers/pivotal"
   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"
+  autoload :Version,          "changelog/version"
+  autoload :Release,          "changelog/release"
+  autoload :Story,            "changelog/story"
+  autoload :History,          "changelog/history"
+  autoload :Git,              "changelog/git"
+  autoload :StoriesTracker,   "changelog/stories_tracker"
 
   def self.root
     File.expand_path '../..', __FILE__
@@ -32,6 +24,8 @@ module CapistranoChangelog
   def self.templates
     File.join root, 'templates'
   end
-end
 
-Git::Lib.send :include, CapistranoChangelog::Git::Lib
+  def self.pivotal_tracker
+    ENV['PIVOTAL_TOKEN'] or raise CapistranoChangelog::GeneralError, "Pivotal Tracker access token missed. Run $ export PIVOTAL_TOKEN='you-access-token'."
+  end
+end

data/lib/capistrano/changelog.rb

@@ -0,0 +1,7 @@
+require 'capistrano/version'
+
+if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
+  load File.expand_path("../tasks/changelog.rake", __FILE__)
+else
+  require 'capistrano/v2/hooks'
+end

data/lib/capistrano/v2/hooks.rb

@@ -0,0 +1,12 @@
+require "capistrano/v2/recipes"
+
+Capistrano::Configuration.instance(:must_exist).load do
+  # Generate ChangeLog file
+  after "deploy:create_symlink", "deploy:changelog"
+
+  # Generage version.json file
+  after "deploy:create_symlink", "deploy:changelog:version"
+
+  before "deploy:changelog", "deploy:changelog:download_cache"
+  after  "deploy:changelog", "deploy:changelog:upload_cache"
+end

data/lib/capistrano/v2/recipes.rb

@@ -0,0 +1,47 @@
+require 'capistrano-changelog'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  # CapistranoChangelog.load_into(self)
+
+  _cset(:changelog_tracker)           { :pivotal }
+  _cset(:changelog_cache_local_file)  { 'tmp/changelog.json' }
+  _cset(:changelog_cache_remote_file) { File.join(shared_path, 'changelog.json') }
+  _cset(:changelog)                   { File.join(shared_path, 'changelog.html') }
+  _cset(:changelog_version)           { File.join(shared_path, 'version.json') }
+  _cset(:changelog_date_format)       { '%I:%M%P %D UTC' }
+
+  namespace :deploy do
+    namespace :changelog do
+      task :download_cache, roles: :changelog, only: {cache: true}, on_no_matching_servers: :continue do
+        begin
+          get fetch(:changelog_cache_remote_file), fetch(:changelog_cache_local_file)
+        rescue Capistrano::TransferError => e
+          logger.info "Changelog cache file does not exists."
+        end
+      end
+
+      task :upload_cache, roles: :changelog, only: {cache: true}, on_no_matching_servers: :continue do
+        put IO.read(fetch(:changelog_cache_local_file)), fetch(:changelog_cache_remote_file)
+      end
+
+      desc "Generates changelog"
+      task :default, roles: :changelog do
+        begin
+          history = CapistranoChangelog::History.new({
+                      changelog_cache_local_file: fetch(:changelog_cache_local_file),
+                      logger: logger
+                    })
+        rescue CapistranoChangelog::GeneralError => e
+          logger.error e.message
+        end
+
+        put history.generate, fetch(:changelog)
+      end
+
+      desc "Generates version file. RESTART=(true|false) option could be specified (by default is true)"
+      task :version, roles: :changelog, only: {version: true}, on_no_matching_servers: :continue do
+        put CapistranoChangelog::Version.generate, fetch(:changelog_version), mkdir: true
+      end
+    end
+  end
+end

data/lib/capistrano/v3/tasks/changelog.rake

@@ -0,0 +1,22 @@
+namespace :deploy do
+  desc "Generates changelog"
+  task :changelog do
+    raise 'Capistrano 3.x does not supported yet'
+  end
+
+  desc "Generates version file. RESTART=(true|false) option could be specified (by default is true)"
+  task :version do
+    raise 'Capistrano 3.x does not supported yet'
+  end
+
+  before "deploy:finalize_update", "deploy:changelog"
+  before "deploy:finalize_update", "deploy:version"
+end
+
+namespace :load do
+  task :defaults do
+    set(:changelog_tracker)         ->{ :pivotal }
+    set(:changelog_cache)           ->{ false }
+    set(:changelog)                 ->{ File.join(release_path, 'public', 'changelog.html') }
+  end
+end

data/lib/changelog/git.rb

@@ -0,0 +1,72 @@
+require 'csv'
+
+module CapistranoChangelog
+  module Git
+    extend self
+
+    class Commit < OpenStruct
+      def date
+        Time.parse(self.datetime).utc
+      rescue TypeError => e
+        nil
+      end
+
+      def <=> (other)
+        self.date <=> other.date
+      end
+
+      def short
+        self.commit.slice(0,7)
+      end
+
+      def to_s
+        self.comment
+      end
+    end
+
+    CMD_VERSION       = "describe --always"
+    CMD_FIRST_COMMIT  = "rev-list --max-parents=0 HEAD"
+
+    CMD_TAGS          = "for-each-ref --sort='*authordate' --format='%(objectname)%09%(*authordate:iso8601)%09%(tag)' refs/tags"
+    CMD_TAGS_HEADERS  = [ :commit, :datetime, :comment ]
+
+    CMD_LOG           = "log --date=iso8601 --pretty=format:'%H%x09%cd%x09%s' --no-merges "
+    CMD_LOG_HEADERS   = [ :commit, :datetime, :comment ]
+
+    def describe
+      run(CMD_VERSION)
+    end
+
+    def first_commit
+      csv_to_commits(run(CMD_LOG + run(CMD_FIRST_COMMIT)), CMD_LOG_HEADERS).first
+    end
+
+    def last_commit
+      csv_to_commits(run(CMD_LOG + 'HEAD^..HEAD'), CMD_LOG_HEADERS).first.tap{ |c| c.comment = 'HEAD' }
+    end
+
+    def releases
+      csv_to_commits(run(CMD_TAGS), CMD_TAGS_HEADERS)
+    end
+
+    def tags
+      releases.push(last_commit)
+    end
+
+    def commits(predecessor, successor)
+      return Array.new if (successor <=> predecessor) < 1
+
+      csv_to_commits run(CMD_LOG + " %s..%s" % [predecessor.commit, successor.commit]), CMD_LOG_HEADERS
+    end
+
+    def run(cmd)
+      (`git #{cmd}`).strip
+    end
+
+    def csv_to_commits(csv, headers)
+      CSV.parse(csv.gsub(/\"/, ''), col_sep: "\t").to_a.map do |a|
+        Commit.new Hash[ headers.zip(a) ]
+      end
+    end
+  end
+end

data/lib/changelog/history.rb

@@ -0,0 +1,86 @@
+require 'erb'
+require 'ostruct'
+require 'oj'
+require 'fileutils'
+
+module CapistranoChangelog
+  class Context < OpenStruct
+    def format(dt)
+      dt.strftime('%I:%M%P %D UTC') if dt.kind_of?(Time)
+    end
+  end
+
+  class History
+    attr_reader :releases, :cache, :options
+
+    def initialize(params = {})
+      @first_commit = CapistranoChangelog::Git.first_commit
+      @last_commit  = CapistranoChangelog::Git.last_commit
+      @releases     = CapistranoChangelog::Release.all
+      @tracker      = CapistranoChangelog::StoriesTracker.new
+      @cache        = {}
+      @options = {
+        changelog_cache_local_file: nil,
+        changelog_cache: false,
+        logger: false
+      }.merge(params)
+    end
+
+    def store_cache(filename)
+      return unless filename
+
+      dir = File.dirname(filename)
+      FileUtils.mkdir_p(dir) unless File.exists?(dir)
+      File.open(filename, 'w+') do |f|
+        f << Oj.dump(cache)
+      end
+    end
+
+    def read_cache(filename)
+      return unless filename and File.exists?(filename)
+
+      @cache = ( Oj.load(IO.read(filename)) || {} ) if File.exists?(filename)
+    rescue Oj::ParseError => e
+      File.unlink(filename) if File.exists?(filename)
+
+      return {}
+    end
+
+    def udpate_cache
+      read_cache options.fetch(:changelog_cache_local_file)
+
+      @tracker.fetch CapistranoChangelog::Git.commits(@first_commit, @last_commit), cache, options
+
+      store_cache options.fetch(:changelog_cache_local_file)
+    end
+
+    def next_to(release)
+      if idx = releases.index(release) and releases[idx + 1]
+        releases[idx + 1]
+      else
+        @last_commit
+      end
+    end
+
+    def prev_to(release)
+      if idx = releases.index(release) and idx > 0 and releases[idx - 1]
+        releases[idx - 1]
+      else
+        @first_commit
+      end
+    end
+
+    def generate
+      udpate_cache
+
+      context = Context.new({
+        date: Time.new.utc,
+        history: self,
+        releases: releases.reverse
+      })
+
+      template = ERB.new IO.read(File.join(CapistranoChangelog.templates, 'changelog.erb'))
+      template.result context.instance_eval { binding }
+    end
+  end
+end

data/lib/changelog/release.rb

@@ -0,0 +1,47 @@
+require 'time'
+
+module CapistranoChangelog
+  class Release
+    attr_reader :tag
+
+    def initialize(tag)
+      @tag = tag
+    end
+
+    def <=> (other)
+      self.date <=> other.date
+    end
+
+    def method_missing(meth, *args)
+      if tag.respond_to?(meth)
+        tag.send(meth, *args)
+      else
+        super
+      end
+    end
+
+    def stories(history)
+      commits = CapistranoChangelog::Git.commits history.prev_to(self), self
+
+      CapistranoChangelog::StoriesTracker.new.ids(commits).map do |uid|
+        CapistranoChangelog::Story.new(uid, history, commits)
+      end
+    end
+
+    def unreconized(history)
+      CapistranoChangelog::Git.commits(history.prev_to(self), self).select do |commit|
+        commit.comment !~ Trackers::Pivotal::MATCHER
+      end
+    end
+
+    def unreconized?(history)
+      unreconized(history).size > 0
+    end
+
+    def self.all
+      CapistranoChangelog::Git.tags.map do |tag|
+        CapistranoChangelog::Release.new(tag)
+      end
+    end
+  end
+end