capistrano-measure 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8800ff49810b512b1a0fac4e8efa703f0cd2a3a4
-  data.tar.gz: fa54945a4235c958ec5c7a1df9ed58207ac76242
+  metadata.gz: 7985b11ba0b7a76c5839925a75d929a7991222ec
+  data.tar.gz: d9d5b4a4bb46921324ffe71b8b4769788bdd5d68
 SHA512:
-  metadata.gz: 342c4504f111003037d240c6c2e5c1473d3297c24c1b3f6c91e61db813a9f3d1c24871ce1083c7bc4edbd975b307f7afe5f825e1063af74ff6dcbc764f0b1232
-  data.tar.gz: 0a472eaae23502477d039e487fc03e12040e7102b556bdd6a314017f2c222b1cf85711215a63b247eb6780de4d13e115c8e4a4e8b7c57f76f15708a618fa4008
+  metadata.gz: 9afca2004487f749ba1863e190f7ec1716362e9fd9df5519293765533849a2a9e9287c72fa8c551240fafde5a0d8f6799739556004720f29e144aaa876c6216d
+  data.tar.gz: d9d7958f05359b27fdc8d54d943632572e81a73308d63126047be83b48ff00f169801160c6968efcdc11cf1302a7e7b7346071612d7c9423f0e7aeef11cb9d48

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "bundle exec rspec spec"
+rvm:
+  - 2.0.0
+  - 2.3.1
+sudo: false

data/README.md

@@ -1,4 +1,6 @@
 # Capistrano::Measure - deployment speed measure tool
+[![Gem Version](https://badge.fury.io/rb/capistrano-measure.svg)](https://badge.fury.io/rb/capistrano-measure)
+[![Build Status](https://travis-ci.org/AMekss/capistrano-measure.svg?branch=master)](https://travis-ci.org/AMekss/capistrano-measure)
 
 In order to improve something you have to measure it! This helps you measure performance of your Capistrano deployments by appending performance reports after each Capistrano execution
 
@@ -85,6 +87,15 @@ It will append every capistrano execution with similar report
     I, [2014-10-23T18:10:31.386225 #14352]  INFO -- : deploy 104s
     I, [2014-10-23T18:10:31.386246 #14352]  INFO -- : ==========================================================
 
+### Settings
+You could change threshold time to change the results duration's color.
+
+```ruby
+set :alert_threshold, 10              # default 60 sec
+set :warning_threshold, 5             # default 30 sec
+set :measure_error_handling, :raise   # default :silent
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/capistrano-measure/fork )

data/capistrano-measure.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "capistrano", ">= 2", "< 4"
-  spec.add_dependency "colored", "~> 1.2"
+  spec.add_dependency "colorize", '>= 0.8.1'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/capistrano/measure/adapter.rb

@@ -8,21 +8,53 @@ module Capistrano
         nil
       end
 
-      def initialize(logger=nil)
-        @timer = Capistrano::Measure::Timer.new
-        @log_reporter = Capistrano::Measure::LogReporter.new(logger)
+      def initialize(logger, config)
+        @logger = logger
+        @config = config
+        @valid = true
       end
 
       def before_task(task_name)
-        @timer.start(task_name)
+        with_error_handling { timer.start(task_name) }
       end
 
       def after_task(task_name)
-        @timer.stop(task_name)
+        with_error_handling { timer.stop(task_name) }
       end
 
       def print_report
-        @log_reporter.render(@timer.report_events)
+        if valid?
+          log_reporter.render(timer.report_events)
+        else
+          log_reporter.render_error("Capistrano::Measure plugin encountered an error during performance evaluation and is not able to present a performance report, in order to `raise` and troubleshoot this error add `set :measure_error_handling, :raise` into your capistrano config")
+        end
+      end
+
+      private
+
+      attr_reader :logger, :config
+
+      def log_reporter
+        @log_reporter ||= Capistrano::Measure::LogReporter.new(logger, config)
+      end
+
+      def timer
+        @timer ||= Capistrano::Measure::Timer.new
+      end
+
+      def debug?
+        config.fetch(:measure_error_handling, :silent) == :raise
+      end
+
+      def valid?
+        @valid
+      end
+
+      def with_error_handling
+        yield
+      rescue StandardError => e
+        @valid = false
+        raise e if debug?
       end
 
     end

data/lib/capistrano/measure/error.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Measure
+    class Error < StandardError; end
+  end
+end

data/lib/capistrano/measure/integration/capistrano_2.rb

@@ -1,5 +1,5 @@
 Capistrano::Configuration.instance(:must_exist).load do |config|
-  adapter = Capistrano::Measure::Adapter.new(logger)
+  adapter = Capistrano::Measure::Adapter.new(logger, config)
 
   on :before do
     adapter.before_task(current_task.fully_qualified_name)

data/lib/capistrano/measure/integration/capistrano_3.rb

@@ -3,7 +3,7 @@ module Capistrano
     module Integration
       module Capistrano3
         def measure_adapter
-          @measure_adapter ||= Capistrano::Measure::Adapter.new
+          @measure_adapter ||= Capistrano::Measure::Adapter.new(::Logger.new(STDOUT), ::Capistrano::Configuration.env)
         end
 
         def insert_measure_tasks

data/lib/capistrano/measure/log_reporter.rb

@@ -1,33 +1,49 @@
-require 'colored'
+require 'colorized_string'
 require 'logger'
 
 module Capistrano
   module Measure
     class LogReporter
-      ALERT_TRASHOLD = 60
-      WARNING_TRASHOLD = 30
 
-      def initialize(logger=nil)
-        @logger = logger || ::Logger.new(STDOUT)
+      attr_reader :alert_threshold, :warning_threshold
+
+      DEFALUT_ALERT_THRESHOLD = 60
+      DEFAULT_WARNING_THRESHOLD = 30
+
+      def initialize(logger, config)
+        @logger = logger
+        @alert_threshold = config.fetch(:alert_threshold, DEFALUT_ALERT_THRESHOLD)
+        @warning_threshold = config.fetch(:warning_threshold, DEFAULT_WARNING_THRESHOLD)
       end
 
       def render(events)
         return if events.to_a.empty?
 
-        log_sepertor
-        log "  Performance Report".green
-        log_sepertor
+        with_layout do
+          events.each do |event|
+            log "#{'..' * event.indent}#{event.name} #{colorize_time(event.elapsed_time)}"
+          end
+        end
+      end
 
-        events.each do |event|
-          log "#{'..' * event.indent}#{event.name} #{colorize_time(event.elapsed_time)}"
+      def render_error(message)
+        with_layout do
+          @logger.error message
         end
-        log_sepertor
       end
 
       private
 
+      def with_layout
+        log_sepertor
+        log ColorizedString["  Performance Report"].green
+        log_sepertor
+        yield
+        log_sepertor
+      end
+
       def log_sepertor
-        log "=========================================================="
+        log "=" * 60
       end
 
       def log(text)
@@ -36,10 +52,12 @@ module Capistrano
 
       def colorize_time(time_spent)
         return if time_spent.nil?
-        color = (time_spent > ALERT_TRASHOLD ? :red : (time_spent > WARNING_TRASHOLD ? :yellow : :green))
-        "#{time_spent}s".send(color)
+        ColorizedString["#{time_spent}s"].colorize(color(time_spent))
       end
 
+      def color(time_spent)
+        (time_spent > alert_threshold ? :red : (time_spent > warning_threshold ? :yellow : :green))
+      end
     end
   end
 end

data/lib/capistrano/measure/timer.rb

@@ -42,7 +42,7 @@ module Capistrano
       end
 
       def report_events
-        raise 'Performance measure is not completed' unless @open_events.empty?
+        raise ::Capistrano::Measure::Error, "Performance evaluation is not yet completed, as there are events still open: #{@open_events.map(&:name).join(', ')}" unless @open_events.empty?
         return to_enum(__callee__) unless block_given?
 
         (events + [Event.new]).each_cons(2) do |event, next_event|
@@ -55,7 +55,7 @@ module Capistrano
       def close_event(event_name)
         event = Event.new(event_name, :stop, Time.now, @indent-1)
         open_event = @open_events.last
-        raise "You're trying to stop unstarted event" unless event.eq?(open_event)
+        raise ::Capistrano::Measure::Error, "Cannot estimate time for event `#{event_name}`" unless event.eq?(open_event)
 
         event.elapsed_time = (event.time - open_event.time).to_i
         event

data/lib/capistrano/measure/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Measure
-    VERSION = "0.8.1"
+    VERSION = "0.10.0"
   end
 end

data/lib/capistrano/measure.rb

@@ -3,6 +3,7 @@ require 'capistrano/measure/version'
 require 'capistrano/measure/timer'
 require 'capistrano/measure/log_reporter'
 require 'capistrano/measure/adapter'
+require 'capistrano/measure/error'
 
 case ::Capistrano::Measure::Adapter::capistrano_version
 when 2
@@ -10,7 +11,7 @@ when 2
 when 3
   require 'capistrano/measure/integration/capistrano_3'
 else
-  raise 'This version of Capistrano is not supported.'
+  raise ::Capistrano::Measure::Error, 'This version of Capistrano is not supported.'
 end
 
 module Capistrano

data/spec/capistrano/measure/adapter_spec.rb

@@ -5,7 +5,8 @@ require 'capistrano/measure/adapter'
 
 describe Capistrano::Measure::Adapter do
   let(:logger) { ::StringLogger.new }
-  subject { Capistrano::Measure::Adapter.new(logger) }
+  let(:config) { {} }
+  subject { Capistrano::Measure::Adapter.new(logger, config) }
 
   it "end-to-end test" do
     subject.before_task('root_task')
@@ -19,7 +20,31 @@ describe Capistrano::Measure::Adapter do
 
     subject.print_report
 
-    expect(logger.to_s).not_to be_empty
+    expect(logger.to_s).to include("Performance Report")
+    expect(logger.to_s).to include("root_task")
+    expect(logger.to_s).to include("..sub_task")
+    expect(logger.to_s).to include("....sub_task1")
+  end
+
+  it "doesn't rise any errors by default" do
+    subject.before_task('root_task')
+    subject.after_task('sub_task')
+
+    subject.print_report
+
+    expect(logger.to_s).to include("Capistrano::Measure plugin encountered an error during performance evaluation")
+  end
+
+  it "raises an error in debug mode (and interrupts the deployment)" do
+    config[:measure_error_handling] = :raise
+
+    expect {
+      subject.before_task('root_task')
+      subject.after_task('sub_task')
+
+      subject.print_report
+    }.to raise_error(::Capistrano::Measure::Error)
+
   end
 
   describe "::capistrano_version" do

data/spec/capistrano/measure/lib_reporter_spec.rb

@@ -5,25 +5,36 @@ LogItem = Struct.new(:indent, :name, :elapsed_time)
 
 describe Capistrano::Measure::LogReporter do
   let(:logger) { ::StringLogger.new }
-  subject { Capistrano::Measure::LogReporter.new(logger) }
-
-  it "should be able to create with default logger" do
-    expect(::Logger).to receive(:new).with(STDOUT)
-    Capistrano::Measure::LogReporter.new
-  end
+  let(:config) { {} }
+  subject { Capistrano::Measure::LogReporter.new(logger, config) }
 
   describe "#render" do
     {green: [0, 30], yellow: [31, 60], red: [61, 100]}.each do |color, times|
       times.each do |elapsed_time|
         it "should render line with time in #{color} when elapsed time eq #{elapsed_time}" do
           subject.render([LogItem.new(0, 'test', elapsed_time)])
-          colorized_time = "#{elapsed_time}s".send(color)
+          colorized_time = ColorizedString["#{elapsed_time}s"].colorize(color)
 
           expect(logger.to_s).to include("test #{colorized_time}\n")
         end
       end
     end
 
+    context "with changed thresholds" do
+      let(:config) { { warning_threshold: 20, alert_threshold: 30 } }
+
+      {green: [0, 20], yellow: [21, 30], red: [31, 100]}.each do |color, times|
+        times.each do |elapsed_time|
+          it "should render line with time in #{color} when elapsed time eq #{elapsed_time}" do
+            subject.render([LogItem.new(0, 'test', elapsed_time)])
+            colorized_time = ColorizedString["#{elapsed_time}s"].colorize(color)
+
+            expect(logger.to_s).to include("test #{colorized_time}\n")
+          end
+        end
+      end
+    end
+
     it "should not render empty report" do
       subject.render([])
       expect(logger.to_s).to eq ""

data/spec/capistrano/measure/timer_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'capistrano/measure/error'
 require 'capistrano/measure/timer'
 
 describe Capistrano::Measure::Timer do
@@ -75,14 +76,14 @@ describe Capistrano::Measure::Timer do
     end
 
     it "should raise exception with unstarted event" do
-      expect{ subject.stop('test123') }.to raise_exception
+      expect{ subject.stop('test123') }.to raise_error(::Capistrano::Measure::Error)
     end
   end
 
   describe "#report_events" do
     it "should raise exception if called in the middle of process" do
       subject.start('test')
-      expect{ subject.report_events }.to raise_exception
+      expect{ subject.report_events }.to raise_error(::Capistrano::Measure::Error)
     end
 
     context "in completed state" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-measure
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Artūrs Mekšs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -119,6 +120,7 @@ files:
 - lib/capistrano-measure.rb
 - lib/capistrano/measure.rb
 - lib/capistrano/measure/adapter.rb
+- lib/capistrano/measure/error.rb
 - lib/capistrano/measure/integration/capistrano_2.rb
 - lib/capistrano/measure/integration/capistrano_3.rb
 - lib/capistrano/measure/log_reporter.rb
@@ -149,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Capistrano deployment speed measure tool