flash_flow 1.4.6 → 1.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b4faf52faa0345d39f5a6b125d897a33ef97dc6
-  data.tar.gz: 96e3e0f1160587d5bbd972a4357f82c92807704d
+  metadata.gz: 15f833dbdf036b8b927f9aa237a16eeb7517dddd
+  data.tar.gz: 23a4cfc9d4c72be08b0d62033135761ad2b1b312
 SHA512:
-  metadata.gz: d513f6f38ac8bd6e8e44e2e380975f7fafd9c1f28c60999b1d91d33312daff171fd97e855a3d9fdcfa5f1190dad7ae4f3caab9b5336d7531d1dd96b13a0b372d
-  data.tar.gz: 5767d8b4b74060742e2a50b50aaa7b782c7858fec8badbfc4d6c2e05402052b3f285c0ca13029a4f6920b28a82b1ac194571e93f7d4c924f0bd67bdaab52bbb4
+  metadata.gz: 7c13b101fa30de5b08f047f5f595505b183d0e93a2ec79ffdef3537d751d0aa0503552c18533c07a3b5b15c63ca1f35e7464192eaec2e5fd193b439d9e51b82e
+  data.tar.gz: 9eff4cf8331cb77cc4c29db326f08e793c8ce2db05d3e2f5aa3b09502cff9bbde14e16ddb963986bf5f4bfb6889c7ea8489cc74d86d74968ef8eee57cecad947

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    flash_flow (1.4.6)
+    flash_flow (1.4.7)
       hipchat (~> 1.5)
       mail
       octokit (~> 4.1)
       percy-client
       pivotal-tracker (~> 0.5)
+      prawn
       ruby-graphviz (> 0)
 
 GEM
@@ -33,11 +34,13 @@ GEM
       domain_name (~> 0.5)
     httparty (0.14.0)
       multi_xml (>= 0.5.2)
-    httpclient (2.8.0)
-    mail (2.6.3)
-      mime-types (>= 1.16, < 3)
-    mime-types (2.99.2)
-    mimemagic (0.3.1)
+    httpclient (2.8.2)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mimemagic (0.3.2)
     mini_portile2 (2.1.0)
     minitest (5.3.5)
     minitest-stub_any_instance (1.0.1)
@@ -51,6 +54,7 @@ GEM
       nokogiri (~> 1.5)
     octokit (4.3.0)
       sawyer (~> 0.7.0, >= 0.5.3)
+    pdf-core (0.6.1)
     percy-client (1.6.0)
       faraday (>= 0.9)
       httpclient (>= 2.6)
@@ -61,6 +65,9 @@ GEM
       nokogiri-happymapper (>= 0.5.4)
       rest-client (>= 1.8.0)
     pkg-config (1.1.7)
+    prawn (2.1.0)
+      pdf-core (~> 0.6.1)
+      ttfunk (~> 1.4.0)
     rake (10.4.2)
     rest-client (2.0.0)
       http-cookie (>= 1.0.2, < 2.0)
@@ -72,6 +79,7 @@ GEM
       addressable (>= 2.3.5, < 2.5)
       faraday (~> 0.8, < 0.10)
     slop (3.6.0)
+    ttfunk (1.4.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.2)

data/bin/flash_flow

@@ -32,6 +32,10 @@ case
     FlashFlow::Merge::Status.new(FlashFlow::Config.configuration.issue_tracker, FlashFlow::Config.configuration.branches, FlashFlow::Config.configuration.branch_info_file, FlashFlow::Config.configuration.git, logger: FlashFlow::Config.configuration.logger).status_html
   when options[:release_branches]
     FlashFlow::Merge::Release.new(options).run
+  when options[:gen_pdf_diffs]
+    FlashFlow::Release::Base.new(FlashFlow::Config.configuration.release).gen_pdf_diffs(*options[:gen_pdf_diffs])
+  when options[:merge_release]
+    FlashFlow::Merge::Master.new(options).run
   else
     FlashFlow::Merge::Acceptance.new(options).run
     FlashFlow::IssueTracker::Base.new(FlashFlow::Config.configuration.issue_tracker).stories_pushed

data/flash_flow.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ruby-graphviz', "> 0"
   spec.add_dependency 'percy-client'
   spec.add_dependency 'mail'
+  spec.add_dependency 'prawn'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "> 0"

data/lib/flash_flow/git.rb

@@ -60,12 +60,12 @@ module FlashFlow
     end
 
     def branch_contains?(branch, ref)
-      run("branch --contains #{ref}", log: CmdRunner::LOG_CMD)
+      run("branch -a --contains #{ref}", log: CmdRunner::LOG_CMD)
       last_stdout.split("\n").detect { |str| str[2..-1] == branch }
     end
 
-    def master_branch_contains?(ref)
-      branch_contains?(master_branch, ref)
+    def master_branch_contains?(sha)
+      branch_contains?("remotes/#{remote}/#{master_branch}", sha)
     end
 
     def in_original_merge_branch
@@ -175,13 +175,12 @@ module FlashFlow
       run("push #{'-f' if force} #{remote} #{branch}")
     end
 
-    def   copy_temp_to_branch(branch, squash_message = nil)
+    def copy_temp_to_branch(branch, squash_message = nil)
       run("checkout #{temp_merge_branch}")
       run("merge --strategy=ours --no-edit #{branch}")
       run("checkout #{branch}")
       run("merge #{temp_merge_branch}")
 
-
       squash_commits(branch, squash_message) if squash_message
     end
 

data/lib/flash_flow/merge.rb

@@ -4,5 +4,6 @@ module FlashFlow
 end
 
 require 'flash_flow/merge/acceptance'
+require 'flash_flow/merge/master'
 require 'flash_flow/merge/release'
 require 'flash_flow/merge/status'

data/lib/flash_flow/merge/base.rb

@@ -15,6 +15,7 @@ module FlashFlow
       class VersionError < RuntimeError; end
       class OutOfSyncWithRemote < RuntimeError; end
       class UnmergeableBranch < RuntimeError; end
+      class NothingToMergeError < RuntimeError; end
 
       def initialize(opts={})
         @local_git = Git.new(Config.configuration.git, logger)
@@ -70,6 +71,30 @@ module FlashFlow
         branch.ref == @git.working_branch
       end
 
+      def pending_release
+        @data.releases.detect { |r| r['status'] == 'Pending' }
+      end
+
+      def release_ahead_of_master
+        @git.branch_exists?("#{@git.remote}/#{@git.release_branch}") &&
+            !@git.master_branch_contains?(@git.get_sha("#{@git.remote}/#{@git.release_branch}"))
+      end
+
+      def write_data(commit_msg)
+        @git.in_temp_merge_branch do
+          @git.run("reset --hard #{@git.remote}/#{@git.merge_branch}")
+        end
+        @git.in_merge_branch do
+          @git.run("reset --hard #{@git.remote}/#{@git.merge_branch}")
+        end
+
+        @data.save!
+
+        @git.copy_temp_to_branch(@git.merge_branch, commit_msg)
+        @git.delete_temp_merge_branch
+        @git.push(@git.merge_branch, false)
+      end
+
     end
   end
 end

data/lib/flash_flow/merge/master.rb

@@ -0,0 +1,75 @@
+require 'flash_flow/merge/base'
+
+module FlashFlow
+  module Merge
+    class Master < Base
+
+      class GitPushFailure < RuntimeError; end
+
+      def initialize(opts={})
+        super(opts)
+
+        @data = Data::Base.new({}, Config.configuration.branch_info_file, @git, logger: logger)
+      end
+
+      def run
+        begin
+          check_version
+          puts "Merging #{@git.release_branch} into #{@git.master_branch}"
+          logger.info "\n\n### Beginning merge of #{@git.release_branch} into #{@git.master_branch} ###\n\n"
+
+          mergers, errors = [], []
+
+          @lock.with_lock do
+            release = pending_release
+            if !release
+              raise NothingToMergeError.new("There is no pending release.")
+            elsif !release_ahead_of_master
+              raise NothingToMergeError.new("The release branch '#{@git.release_branch}' has no commits that are not in master")
+            end
+
+            @git.in_original_merge_branch do
+              @git.initialize_rerere
+            end
+
+            @git.in_branch(@git.master_branch) do
+              @git.run("reset --hard origin/master")
+              merge_branches([Data::Branch.new(@git.release_branch)]) do |branch, merger|
+                mergers << [branch, merger]
+              end
+            end
+
+            errors = mergers.select { |m| m.last.result != :success }
+
+            if errors.empty?
+              unless @git.push("#{@git.master_branch}:#{@git.master_branch}", true)
+                raise GitPushFailure.new("Unable to push to #{@git.master_branch}. See log for details.")
+              end
+
+              released_sha = @git.get_sha(@git.master_branch)
+
+              release['status'] = 'Success'
+              release['released_sha'] = released_sha
+
+              write_data('Release merged [ci skip]')
+            end
+          end
+
+          if errors.empty?
+            puts 'Success!'
+          else
+            raise UnmergeableBranch.new("#{@git.release_branch} didn't merge successfully to #{@git.master_branch}:\n  #{errors.map { |e| e.first.ref }.join("\n  ")}")
+          end
+
+          logger.info "### Finished merge of #{@git.release_branch} into #{@git.master_branch} ###"
+        rescue Lock::Error, OutOfSyncWithRemote, UnmergeableBranch, GitPushFailure, NothingToMergeError, VersionError => e
+          puts 'Failure!'
+          puts e.message
+        ensure
+          @local_git.run("checkout #{@local_git.working_branch}")
+        end
+      end
+
+    end
+  end
+end

data/lib/flash_flow/merge/release.rb

@@ -5,7 +5,6 @@ module FlashFlow
     class Release < Base
 
       class PendingReleaseError < RuntimeError; end
-      class NothingToMergeError < RuntimeError; end
       class GitPushFailure < RuntimeError; end
 
       def initialize(opts={})
@@ -26,11 +25,10 @@ module FlashFlow
           mergers, errors = [], []
 
           @lock.with_lock do
-            release = @data.releases.detect { |r| r['status'] == 'Pending' }
+            release = pending_release
             if release
               raise PendingReleaseError.new("There is already a pending release: #{release}")
-            elsif @git.branch_exists?("#{@git.remote}/#{@git.release_branch}") &&
-                !@git.branch_contains?(@git.master_branch, @git.get_sha("#{@git.remote}/#{@git.release_branch}"))
+            elsif release_ahead_of_master
               raise PendingReleaseError.new("The release branch '#{@git.release_branch}' has commits that are not in master")
             end
 
@@ -56,18 +54,7 @@ module FlashFlow
 
               @data.releases.unshift({ created_at: Time.now, sha: release_sha, status: 'Pending' })
 
-              @git.in_temp_merge_branch do
-                @git.run("reset --hard #{@git.remote}/#{@git.merge_branch}")
-              end
-              @git.in_merge_branch do
-                @git.run("reset --hard #{@git.remote}/#{@git.merge_branch}")
-              end
-
-              @data.save!
-
-              @git.copy_temp_to_branch(@git.merge_branch, 'Release data updated [ci skip]')
-              @git.delete_temp_merge_branch
-              @git.push(@git.merge_branch, false)
+              write_data('Release branch created [ci skip]')
             end
           end
 

data/lib/flash_flow/options.rb

@@ -5,8 +5,8 @@ module FlashFlow
     def self.parse
       options = {}
       opt_parser = OptionParser.new do |opts|
-        opts.banner = "Usage: flash_flow [options]"
-        opts.separator ""
+        opts.banner = 'Usage: flash_flow [options]'
+        opts.separator ''
 
         opts.on('--install', 'Copy flash_flow.yml.erb to your repo and exit') { |v| options[:install] = true }
         opts.on('-v', '--version', 'Print the current version of flash flow and exit') { |v| options[:version] = true }
@@ -25,8 +25,10 @@ module FlashFlow
         opts.on('--merge-status', 'Show status of all branches and their stories and exit') { |v| options[:merge_status] = true }
         opts.on('--merge-status-html', 'Show status of all branches and their stories in html format and exit') { |v| options[:merge_status_html] = true }
         opts.on('--make-release branch1,branch2', 'Comma-delimited list of branches to merge to the release branch. Run "--merge-release ready" to merge all ready to ship branches') { |v| options[:release_branches] = v.split(',') }
+        opts.on('--gen-pdf-diffs output_file,build_id,threshold', 'Generate a pdf file with screenshot differences for the specified (latest) build. output_file is required. build_id defaults to the latest build. threshold defaults to 0') { |v| options[:gen_pdf_diffs] = v.split(',') }
+        opts.on('--merge-release', 'Merge the release branch into the master branch and push') { |v| options[:merge_release] = true }
 
-        opts.on_tail("-h", "--help", "Show this message") do
+        opts.on_tail('-h', '--help', 'Show this message') do
           puts opts
           exit
         end

data/lib/flash_flow/release.rb

@@ -19,6 +19,10 @@ module FlashFlow
         @release.send_release_email if @release.respond_to?(:send_release_email)
       end
 
+      def gen_pdf_diffs(output_file, threshold=0.0)
+        @release.gen_pdf_diffs(output_file, threshold) if @release.respond_to?(:gen_pdf_diffs)
+      end
+
     end
   end
 end

data/lib/flash_flow/release/pdf_diff_generator.rb

@@ -0,0 +1,159 @@
+require 'prawn'
+require 'open-uri'
+
+module FlashFlow
+  module Release
+    class PdfDiffGenerator
+
+      NUM_COLUMNS = 3
+      SPACE_BETWEEN = 10
+
+      def generate(compare_data, filename, threshold, verbose=true)
+        info = collect_comparison_info(compare_data, threshold)
+        @orientation = :portrait
+        Prawn::Document.generate(filename, page_layout: @orientation, margin: [10, 10, 10, 10]) do |pdf|
+          set_dimensions(*pdf.bounds.top_right)
+          generate_title_page(pdf)
+          info.each do |comparison|
+            add_comparison_to_pdf(pdf, comparison)
+          end
+          pdf.number_pages('<page> of <total>', { start_count_at: 1, align: :right, size: 12 })
+          @num_pages = pdf.page_count
+        end
+        puts "Wrote #{@num_pages} pages to: #{filename}" if verbose
+        filename
+      end
+
+      private
+
+      ##########################
+      #                        #
+      # PDF Generation methods #
+      #                        #
+      ##########################
+
+      def set_dimensions(width, height)
+        @page_width = width
+        @page_height = height
+        @column_landscape = compute_column_width([width, height].max)
+        @column_portrait = compute_column_width([width, height].min)
+      end
+
+      def compute_column_width(page_width)
+        (page_width / NUM_COLUMNS) - (SPACE_BETWEEN * (NUM_COLUMNS - 1))
+      end
+
+      def generate_title_page(pdf)
+        pdf.text("Compliance Diffs Generated At: #{Time.now.to_s}")
+      end
+
+      def compute_scale_factor(column_width, page_height, info)
+        x_scale_factor = column_width / info[:width]
+        y_scale_factor = page_height / info[:height]
+        [x_scale_factor, y_scale_factor].min
+      end
+
+      def compute_scale_and_orientation(info)
+        scale_portrait = compute_scale_factor(@column_portrait, [@page_width, @page_height].max, info)
+        scale_landscape = compute_scale_factor(@column_landscape, [@page_width, @page_height].min, info)
+        if scale_portrait > scale_landscape
+          @orientation = :portrait
+          @column_width = @column_portrait
+          scale_portrait
+        else
+          @orientation = :landscape
+          @column_width = @column_landscape
+          scale_landscape
+        end
+      end
+
+      def add_comparison_to_pdf(pdf, comparison)
+        scale_factor = compute_scale_and_orientation(comparison['head-screenshot'])
+        options = { vposition: :top, scale: scale_factor }
+
+        pdf.start_new_page(layout: @orientation)
+
+        place_image(pdf, comparison.dig('head-screenshot', :url), options, 1)
+        place_image(pdf, comparison.dig('base-screenshot', :url), options, 2)
+        place_image(pdf, comparison.dig('base-screenshot', :url), options, 3)
+        place_image(pdf, comparison.dig('pdiff', :url), options, 3)
+      end
+
+      def place_image(pdf, url, options, column)
+        pdf.float do
+          options[:position] = (column - 1) * (@column_width + SPACE_BETWEEN)
+          pdf.image(open(url), options)
+        end
+      end
+
+      ####################################
+      #                                  #
+      # Methods to traverse Percy output #
+      #                                  #
+      ####################################
+
+      def collect_comparison_info(compare_info, threshold=0.0)
+        [].tap do |result|
+          compare_info['data'].each do |record|
+            if record['type'] == 'comparisons'
+              comparison_urls = get_comparison_info(record, compare_info)
+              result << comparison_urls if comparison_urls&.dig('diff-ratio').to_f > threshold
+            end
+          end
+        end
+      end
+
+      def get_comparison_info(record, data)
+        { id: record['id'] }.tap do |h|
+          %w(head-screenshot base-screenshot pdiff).each do |attr|
+            info = record.dig('relationships', attr, 'data')
+            unless info.nil?
+              attr_record = lookup_record(info['id'], info['type'], 'included', data)
+              h[attr] = lookup_image_url(lookup_image_id(attr_record, attr), data)
+              h['diff-ratio'] = attr_record.dig('attributes', 'diff-ratio') if attr == 'pdiff'
+            end
+          end
+        end
+      end
+
+      def lookup_image_id(record, attr)
+        if attr == 'pdiff'
+          record.dig('relationships', 'diff-image', 'data', 'id')
+        else
+          record.dig('relationships', 'image', 'data', 'id')
+        end
+      end
+
+      def lookup_image_url(id, data)
+        record = lookup_image(id, data)
+        unless record.nil?
+          { url: record.dig('attributes', 'url'),
+            width: record.dig('attributes', 'width'),
+            height: record.dig('attributes', 'height') }
+        end
+      end
+
+      def lookup_comparison(id, data)
+        lookup_record(id, 'comparisons', 'data', data)
+      end
+
+      def lookup_image(id, data)
+        lookup_record(id, 'images', 'included', data)
+      end
+
+      def lookup_screenshot(id, data)
+        lookup_record(id, 'screenshots', 'data', data)
+      end
+
+      def lookup_snapshot(id, data)
+        lookup_record(id, 'snapshots', 'data', data)
+      end
+
+      def lookup_record(id, kind, where, data)
+        data[where].detect { |item| item['type'] == kind && item['id'] == id }
+      end
+
+    end
+  end
+end
+