capistrano-stopwatch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d40f306569044f14b61f564b95015268db06a7a414df135f4f93104df9718f50
+  data.tar.gz: 7f19751aa93bdea498de242180c728db833038262f929125184e764ef92f908e
+SHA512:
+  metadata.gz: 8b069d78a042c4d4aec02d6c461c899a5eb4b5955051d7c967a13dfcd62b2aaaacc1b3ad80967d953a7d48f4b8a13309bf600342e2dc9c89af17e7d0993e003c
+  data.tar.gz: 491a9b2acee78e44329e6a76327e88ccda9b678dcc0ea5948681410d1032de9da7b2d2b32c143ce598df2c9c8639fb75e3b4b26e978b09f2d820d77fe1657794

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shuhei.kitagawa@c-fo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-stopwatch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shuhei Kitagawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# Capistrano::Stopwatch
+
+`Capistrano::Stopwatch` is a gem to measure the execution time of each Capistrano tasks. `Capistrano::Stopwatch` requires Capistrano v3 or above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-stopwatch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-stopwatch
+
+## Usage
+
+Takes four simple steps to run `Capistrano::Stopwatch` on your environment.
+
+### 1. Require `Capistrano::Stopwatch` in Capfile
+
+```ruby
+# Capfile
+require 'capistrano-stopwatch'
+```
+
+### 2. Specify the tasks you want to measure 
+
+Right now, you need to manually specify tasks you want to measure execution time. All you need to do is just call `measure_duration` method in `config/deploy.rb` and hand it name of tasks.    
+
+```ruby
+# config/deploy.rb
+['deploy:starting', 'deploy:updating'].each do |n|
+  measure_duration(n)
+end
+```
+
+### 3. Specify when to finish
+
+Specify when to run `stopwatch:finish` task and execute `finish_stopwatch` lambda function. Usually, it is safe to run `stopwatch:finish` after the very last task in your Capistrano deploy flow.    
+
+
+```ruby
+# config/deploy.rb
+after 'test:stop', 'stopwatch:finish'
+```
+
+### 4. Specify how to handle the output
+
+Override `finish_stopwatch` and specify how to handle the output, which is a hash of task name and execution time. By default, `finish_stopwatch` simply prints the output to stdout.
+
+```ruby
+# config/deploy.rb
+set :finish_stopwatch, lambda { |durations|
+  File.open("durations.json", "w") {|f| f.puts(durations.to_json) }
+}
+```
+
+## Example
+
+```ruby
+# Capfile
+require 'capistrano-stopwatch'
+```
+
+```ruby
+# config/deploy.rb
+require 'json'
+
+set :finish_stopwatch, lambda { |durations|
+  File.open("durations.json", "w") {|f| f.puts(durations.to_json) }
+  puts durations
+}
+
+namespace :example do
+  task :first do
+    run_locally do
+      info 'Running first task'
+      sleep 1
+    end
+  end
+
+  task :second do
+    run_locally do
+      info 'Running second task'
+      sleep 2
+    end
+  end
+
+  task :third do
+    run_locally do
+      info 'Running third task'
+      sleep 3
+    end
+  end
+end
+
+['example:first', 'example:second', 'example:third'].each do |task|
+  measure_duration(task)
+end
+
+after 'example:third', 'stopwatch:finish'
+```
+
+```bash
+$ bundle ex cap development example:first example:second example:third
+00:00 example:first
+      Running first task
+00:01 example:second
+      Running second task
+00:03 example:third
+      Running third task
+00:06 stopwatch:finish
+      Finishing stopwatch
+{"example:first"=>1.001629, "example:second"=>2.002746, "example:third"=>3.004129}
+
+$ cat durations.json
+{"example:first":1.001246,"example:second":2.004474,"example:third":3.00379}
+```
+
+## Other options
+
+### CloudWatch Logs Insights
+
+[AWS CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html) might be another good option to gether information about task execution time, even though you need to set how to parse Capistrano logs.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shuheiktgw/capistrano-stopwatch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Capistrano::Stopwatch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shuheiktgw/capistrano-stopwatch/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano-stopwatch.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-stopwatch'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Shuhei Kitagawa']
+  spec.email         = ['shuhei.kitagawa@gmail.com']
+
+  spec.summary       = %q{Capistrano tasks to measure task execution time}
+  spec.description   = %q{Capistrano tasks to measure task execution time}
+  spec.homepage      = 'https://github.com/shuheiktgw/capistrano-stopwatch'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.0'
+end

data/lib/capistrano/stopwatch.rb

@@ -0,0 +1 @@
+require 'capistrano/stopwatch/stopwatch'

data/lib/capistrano/stopwatch/stopwatch.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/stopwatch.rake', __FILE__)

data/lib/capistrano/tasks/stopwatch.rake

@@ -0,0 +1,52 @@
+set :ex_durations, {}
+
+set :finish_stopwatch, lambda { |durations|
+  puts durations
+}
+
+namespace :stopwatch do
+  desc 'Finish stopwatch'
+  task :finish do
+    run_locally do
+      info 'Finishing stopwatch'
+      fetch(:finish_stopwatch).call(fetch(:ex_durations))
+    end
+  end
+end
+
+def measure_duration(task)
+  define_start(task)
+  define_stop(task)
+
+  before task, "stopwatch:#{ task }_start"
+  after task, "stopwatch:#{ task }_stop"
+end
+
+def define_start(task)
+  namespace :stopwatch do
+    desc 'Start stopwatch'
+    task "#{ task }_start" do
+      run_locally do
+        debug "Starting stopwatch for #{ task }"
+        set "#{ task }_timer_started_at", Time.now
+      end
+    end
+  end
+end
+
+def define_stop(task)
+  namespace :stopwatch do
+    desc 'Stop stopwatch'
+    task "#{ task }_stop" do
+      run_locally do
+        debug "Stopping stopwatch for #{ task }"
+
+        started_at = fetch("#{ task }_timer_started_at")
+        durations = fetch(:ex_durations)
+        durations[task] = Time.now - started_at
+
+        set :ex_durations, durations
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-stopwatch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shuhei Kitagawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Capistrano tasks to measure task execution time
+email:
+- shuhei.kitagawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-stopwatch.gemspec
+- lib/capistrano/stopwatch.rb
+- lib/capistrano/stopwatch/stopwatch.rb
+- lib/capistrano/tasks/stopwatch.rake
+homepage: https://github.com/shuheiktgw/capistrano-stopwatch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks to measure task execution time
+test_files: []