capistrano-fiesta 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0523e553bc6d687b7a7b9a1c712c5d6f9cc5ad6d
-  data.tar.gz: 00c27fe98e2f058a7ae9ee2711c5c96078e56526
+  metadata.gz: 0d2c67bd3f3a7967e8c0d2e21ac1cad88572c1c4
+  data.tar.gz: bff17d6f9c990d1196cea630f61acdb4861d6764
 SHA512:
-  metadata.gz: d950d568707047a06c9c03971d81ee2d6fc619d2602f7417e929c61a69bc4c2b3447df1991c7c66693013757bac09c7c327e5f77cf661946593c65bde8d00674
-  data.tar.gz: 7243ef680c5fca0955ff5b81959f85ae8b75c1f5e67dacc0b7e0b802a90ce3015837535ce37bf42ec4418b518d3381313919e472e37858a3f9ab495c94f92ee8
+  metadata.gz: 1ef2d2eef7c9c4dcc79e9c1906394b6bbd0eaac76d3f9d9e2a24b2047892e88b473d65dfadae9abce0e4d787f24057b62b0a2c2afb01f441cf5ab9e4b85e70a2
+  data.tar.gz: 7c106e2d4245732539088c88f5425228401c8b453e32804de58942d6b7a48fe3113fbafe43ce17a1403f03876cc1750a2dcfd297ea963fc37593a99132731045

data/capistrano-fiesta.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "attr_extras", "~> 5.2"
   spec.add_dependency "capistrano", "~> 3.1"
   spec.add_dependency "octokit", "~> 4.1"
 

data/lib/capistrano/fiesta/announcement.rb

@@ -0,0 +1,32 @@
+require "attr_extras/explicit"
+require "capistrano/fiesta/slack_dummy"
+
+module Capistrano
+  module Fiesta
+    class Announcement
+      extend AttrExtras.mixin
+      pattr_initialize :text, :config
+
+      def post
+        client.post(options)
+        text
+      end
+
+      private
+
+        def options
+          config.merge(payload: payload)
+        end
+
+        def payload
+          config.fetch(:payload, {}).merge(text: text)
+        end
+
+        def client
+          Slackistrano
+        rescue NameError
+          SlackDummy.new
+        end
+    end
+  end
+end

data/lib/capistrano/fiesta/auto_composed_story.rb

@@ -0,0 +1,15 @@
+module Capistrano
+  module Fiesta
+    class AutoComposedStory < Story
+      SCREENSHOT_TAG = "#"
+
+      def release_note
+        release_note_in_body
+      end
+
+      def images
+        pr.body.to_s.scan(/https?:\/\/\S*\.(?:png|jpg|gif)#{SCREENSHOT_TAG}/i)
+      end
+    end
+  end
+end

data/lib/capistrano/fiesta/editor.rb

@@ -1,11 +1,11 @@
+require "attr_extras/explicit"
 require "tempfile"
 
 module Capistrano
   module Fiesta
     class Editor
-      def initialize(content)
-        @content = content
-      end
+      extend AttrExtras.mixin
+      pattr_initialize :content, [:comment]
 
       def compose
         create_temp_file
@@ -16,7 +16,8 @@ module Capistrano
       private
 
         def create_temp_file
-          file << @content
+          file << content
+          file << "# #{comment}\n\n" if comment
           file.close
         end
 
@@ -37,7 +38,7 @@ module Capistrano
         end
 
         def file
-          @file ||= Tempfile.new(['fiesta', '.md'])
+          @_file ||= Tempfile.new(["fiesta", ".md"])
         end
     end
   end

data/lib/capistrano/fiesta/github.rb

@@ -4,6 +4,11 @@ require "yaml"
 module Capistrano
   module Fiesta
     class Github
+
+      def self.client
+        new.client
+      end
+
       def client
         Octokit::Client.new(config)
       end

data/lib/capistrano/fiesta/release.rb

@@ -0,0 +1,32 @@
+require "attr_extras/explicit"
+
+module Capistrano
+  module Fiesta
+    class Release
+      extend AttrExtras.mixin
+      pattr_initialize [:repo, :name, :stories]
+
+      def post
+        github.create_release(repo, tag, name: name, body: body)
+      end
+
+      private
+
+        def name
+          @name ||= Time.now.to_i.to_s
+        end
+
+        def tag
+          "release-#{name}"
+        end
+
+        def body
+          stories.map(&:to_markdown).join("\n")
+        end
+
+        def github
+          @_github ||= Github.client
+        end
+    end
+  end
+end

data/lib/capistrano/fiesta/report.rb

@@ -1,44 +1,72 @@
-Encoding.default_internal = Encoding.default_external = 'utf-8'
+Encoding.default_internal = Encoding.default_external = "utf-8"
 
+require "attr_extras/explicit"
+require "capistrano/fiesta/announcement"
 require "capistrano/fiesta/github"
-require "capistrano/fiesta/draft"
+require "capistrano/fiesta/template"
 require "capistrano/fiesta/editor"
 require "capistrano/fiesta/logger"
-require "capistrano/fiesta/slack_dummy"
 require "capistrano/fiesta/story"
+require "capistrano/fiesta/auto_composed_story"
+require "capistrano/fiesta/release"
 
 module Capistrano
   module Fiesta
     class Report
-      attr_reader :stories
+      extend AttrExtras.mixin
+      pattr_initialize :github_url, [:last_release, :comment, :auto_compose]
+      attr_query :auto_compose?
 
-      def initialize(github_url, last_release: nil, comment: nil)
-        @github_url, @last_release, @comment = github_url, last_release, comment
-        @stories = merged_pull_requests.map { |pr| Story.new(pr) }
+      def announce(config = {})
+        return Logger.warn("Announcement blank, nothing posted to Slack") if nothing_to_announce?
+        Announcement.new(text, config).post
       end
 
-      def announce(options = {})
-        text = editor.compose if stories.any?
-        return Logger.warn('Announcement blank, nothing posted to Slack') if text.nil? || text.empty?
-        options[:payload] = options.fetch(:payload, {}).merge(text: text)
-        chat.post(options)
-        text
+      def create_release(name = nil)
+        return Logger.warn "No new stories, skipping GitHub release" if stories.none?
+        Release.new(repo: repo, name: name, stories: stories).post
       end
 
-      def create_release(name = nil)
-        return Logger.warn 'No new stories, skipping GitHub release' if stories.none?
-        name ||= Time.now.to_i.to_s
-        github.create_release(repo, "release-#{name}", name: name, body: stories.map(&:to_markdown).join("\n"))
+      def stories
+        @_stories ||= fetch_stories
       end
 
       private
 
+        def fetch_stories
+          if auto_compose?
+            merged_pull_requests.map { |pr| AutoComposedStory.new(pr) }
+          else
+            merged_pull_requests.map { |pr| Story.new(pr) }
+          end
+        end
+
+        def nothing_to_announce?
+          stories.none? || text.nil? || text.empty?
+        end
+
+        def text
+          @_text ||= render_text
+        end
+
+        def render_text
+          if auto_compose?
+            template
+          else
+            editor.compose
+          end
+        end
+
         def editor
-          Editor.new(draft.render)
+          Editor.new(template, comment: comment)
         end
 
-        def draft
-          Draft.new(comment: @comment, stories: stories)
+        def template
+          Template.new(stories_with_release_notes).render
+        end
+
+        def stories_with_release_notes
+          stories.find_all(&:release_note)
         end
 
         def merged_pull_requests
@@ -49,21 +77,17 @@ module Capistrano
         end
 
         def repo
-          @github_url.match(/github.com[:\/](\S+\/\S+)\.git/)[1]
+          github_url.match(/github.com[:\/](\S+\/\S+)\.git/)[1]
         end
 
         def last_released_at
-          Time.parse(@last_release + 'Z00:00').iso8601 if @last_release
+          if last_release
+            Time.parse(last_release + "Z00:00").iso8601
+          end
         end
 
         def github
-          @github ||= Github.new.client
-        end
-
-        def chat
-          Slackistrano
-        rescue NameError
-          SlackDummy.new
+          @_github ||= Github.client
         end
     end
   end

data/lib/capistrano/fiesta/story.rb

@@ -1,20 +1,21 @@
+require "attr_extras/explicit"
+
 module Capistrano
   module Fiesta
     class Story
-      def initialize(pr)
-        @pr = pr
-      end
+      extend AttrExtras.mixin
+      pattr_initialize :pr
 
       def release_note
         (release_note_in_body || title).strip
       end
 
       def images
-        @pr.body.to_s.scan(/https?:\/\/\S*\.(?:png|jpg|gif)/i)
+        pr.body.to_s.scan(/https?:\/\/\S*\.(?:png|jpg|gif)/i)
       end
 
       def url
-        @pr.html_url
+        pr.html_url
       end
 
       def to_markdown
@@ -24,11 +25,11 @@ module Capistrano
       private
 
         def title
-          @pr.title.to_s.sub(/\[Delivers #\S+\]\z/, '')
+          @_title ||= pr.title.to_s.sub(/\[Delivers #\S+\]\z/, "")
         end
 
         def release_note_in_body
-          @pr.body.to_s[/_Release\snote\:(.+)_/m, 1]
+          @_release_note_in_body ||= pr.body.to_s[/_Release\snote\:?\s(.+)_/m, 1]
         end
     end
   end

data/lib/capistrano/fiesta/template.rb

@@ -0,0 +1,21 @@
+require "attr_extras/explicit"
+require "erb"
+
+module Capistrano
+  module Fiesta
+    class Template
+      extend AttrExtras.mixin
+      pattr_initialize :stories
+
+      def render
+        ERB.new(File.read(erb), nil, "-").result(binding)
+      end
+
+      private
+
+        def erb
+          File.join(File.expand_path("../../templates", __FILE__), "draft.erb")
+        end
+    end
+  end
+end

data/lib/capistrano/fiesta/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Fiesta
-    VERSION = "1.4.1"
+    VERSION = "1.5.1"
   end
 end

data/lib/capistrano/tasks/fiesta.rake

@@ -1,40 +1,61 @@
 namespace :fiesta do
-  desc 'Run a fiesta report and announce it'
+  desc "Generate a fiesta report and announce it"
   task :run do
-    invoke 'fiesta:generate'
-    invoke 'fiesta:announce'
+    if master_branch?
+      invoke "fiesta:generate"
+      invoke "fiesta:announce"
+    end
   end
 
-  desc 'Generate a fiesta report'
+  desc "Generate a fiesta report"
   task :generate do
     run_locally do
-      set :fiesta_report, Capistrano::Fiesta::Report.new(repo_url, last_release: last_release, comment: fetch(:fiesta_comment))
-      info "Deploying #{report.stories.size} new story(ies)"
+      set :fiesta_report, build_report
     end
   end
 
-  desc 'Announce a fiesta report'
+  desc "Announce a fiesta report"
   task :announce do
     run_locally do
       report.announce(slack_params)
-      report.create_release fetch(:release_timestamp) if fetch(:branch) == 'master'
+      report.create_release(timestamp)
       Capistrano::Fiesta::Logger.logs.each { |log| warn log }
     end
   end
 
+  def build_report
+    Capistrano::Fiesta::Report.new(repo_url, report_options)
+  end
+
   def report
     fetch(:fiesta_report)
   end
 
+  def report_options
+    {
+      last_release: last_release,
+      comment: fetch(:fiesta_comment),
+      auto_compose: fetch(:fiesta_auto_compose)
+    }
+  end
+
   def last_release
     last_release = nil
     on roles(:web).first do
       last_release_path = capture("readlink #{current_path}")
-      last_release = last_release_path.split('/').last
+      last_release = last_release_path.split("/").last
     end
     last_release
   end
 
+  def master_branch?
+    fetch(:branch) == "master"
+  end
+
+  def timestamp
+    fetch(:release_timestamp)
+  end
+
   def slack_params
     {
       team: fetch(:slack_team),
@@ -42,13 +63,13 @@ namespace :fiesta do
       webhook: fetch(:slack_webhook),
       via_slackbot: fetch(:slack_via_slackbot),
       payload: {
-        channel: fetch(:fiesta_slack_channel) || 'releases',
-        username: fetch(:fiesta_slack_username) || 'New Releases',
-        icon_emoji: ':tada:'
+        channel: fetch(:fiesta_slack_channel) || "releases",
+        username: fetch(:fiesta_slack_username) || "New Releases",
+        icon_emoji: ":tada:"
       }
     }
   end
 end
 
-before 'deploy:starting', 'fiesta:generate'
-after 'deploy:finished', 'fiesta:announce'
+before "deploy:starting", "fiesta:generate"
+after "deploy:finished", "fiesta:announce"

data/lib/capistrano/templates/draft.erb

@@ -1,7 +1,3 @@
-<% if comment -%>
-# <%= comment %>
-
-<% end -%>
 <% stories.each do |story| -%>
 • <%= story.release_note %>
 <% story.images.each do |image| -%>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-fiesta
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
@@ -169,13 +183,16 @@ files:
 - capistrano-fiesta.gemspec
 - lib/capistrano-fiesta.rb
 - lib/capistrano/fiesta.rb
-- lib/capistrano/fiesta/draft.rb
+- lib/capistrano/fiesta/announcement.rb
+- lib/capistrano/fiesta/auto_composed_story.rb
 - lib/capistrano/fiesta/editor.rb
 - lib/capistrano/fiesta/github.rb
 - lib/capistrano/fiesta/logger.rb
+- lib/capistrano/fiesta/release.rb
 - lib/capistrano/fiesta/report.rb
 - lib/capistrano/fiesta/slack_dummy.rb
 - lib/capistrano/fiesta/story.rb
+- lib/capistrano/fiesta/template.rb
 - lib/capistrano/fiesta/version.rb
 - lib/capistrano/tasks/fiesta.rake
 - lib/capistrano/templates/draft.erb

data/lib/capistrano/fiesta/draft.rb

@@ -1,23 +0,0 @@
-require "erb"
-
-module Capistrano
-  module Fiesta
-    class Draft
-      attr_reader :comment, :stories
-
-      def initialize(comment:, stories: [])
-        @comment, @stories = comment, stories
-      end
-
-      def render
-        ERB.new(File.read(template), nil, '-').result(binding)
-      end
-
-      private
-
-        def template
-          File.join(File.expand_path('../../templates', __FILE__), 'draft.erb')
-        end
-    end
-  end
-end