capistrano-banner 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60c45ab3385c15e9b925e9f3346787da0da37571
+  data.tar.gz: 46d62436e27375c14f49e3d18fe96c95fd9b1bd6
+SHA512:
+  metadata.gz: 683287d3c5ac3b17d6f40dd40dbb5dce14566ded8d16239cb2cb2b822dec5cfbb4724f4398c846e0d34454892e91e64237d8bf093ca9e08e216f69b3f9d2e489
+  data.tar.gz: b7ed2b1195185fe9699b69fbf002010da714c85bd310c998475b7ed7a13835192e06c458e1a95056149f8cea426d6dc399d4f4d83a517ef960399d326b7e6c82

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 HORII Keima
+
+MIT License
+
+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,90 @@
+# capistrano-banner
+
+`capistrano-banner` displays application banner, and pause in production stage
+
+## Installation
+
+Gemfile:
+
+    gem 'capistrano-banner'
+
+Then:
+
+    $ bundle
+
+### Note
+
+After version 0.1.0, `capistrano-banner` works well just with capistrano >= 3.
+
+If you're using capistrano =< 2, please use this gem versioned 0.0.x
+
+## Usage
+
+First, create your application banner in config/banner.txt.
+
+Like this:
+
+```zsh
+$ gem install artii
+$ artii --font=banner3-D yourapp > config/banner.txt
+```
+
+(about artii: https://github.com/miketierney/artii )
+
+Then enable in Capfile:
+
+    require 'capistrano/banner'
+
+This line hooks `deploy:banner` task just before `deploy:starting`.
+
+See also [capistrano(3) flow](http://capistranorb.com/documentation/getting-started/flow/).
+
+After all, let's execute cap!
+
+```
+$ cap production deploy
+  '##:::'##::'#######::'##::::'##:'########:::::'###::::'########::'########::
+  . ##:'##::'##.... ##: ##:::: ##: ##.... ##:::'## ##::: ##.... ##: ##.... ##:
+  :. ####::: ##:::: ##: ##:::: ##: ##:::: ##::'##:. ##:: ##:::: ##: ##:::: ##:
+  ::. ##:::: ##:::: ##: ##:::: ##: ########::'##:::. ##: ########:: ########::
+  ::: ##:::: ##:::: ##: ##:::: ##: ##.. ##::: #########: ##.....::: ##.....:::
+  ::: ##:::: ##:::: ##: ##:::: ##: ##::. ##:: ##.... ##: ##:::::::: ##::::::::
+  ::: ##::::. #######::. #######:: ##:::. ##: ##:::: ##: ##:::::::: ##::::::::
+  :::..::::::.......::::.......:::..:::::..::..:::::..::..:::::::::..:::::::::
+
+  This is production stage. Are you ready? (y/N) > 
+```
+
+In production stage, capistarano pauses and waits your input.
+
+### Custom banner hook
+
+In another way, you can call banner method in your task:
+
+```
+task :foobar do
+  CapistranoBanner.banner("./config/custom.txt")
+end
+```
+
+## Options
+
+`capistrano-banner` respects some capistrano settings:
+
+- `:banner_path` : A path to banner source file. Default to `"./config/banner.txt"`
+- `:banner_options` : Set specifc banner options with Hash:
+    - `:color => :colorname'` banner color (e.g. :red, :green and :blue ... see https://github.com/flori/term-ansicolor )
+    - `:pause => true` anyway pause
+    - `:force => true` don't pause even if production env
+
+## LICENSE
+
+See LICENSE.txt.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-banner.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-banner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-banner"
+  gem.version       = CapistranoBanner::VERSION
+  gem.authors       = ["HORII Keima", "KONDO Uchio"]
+  gem.email         = ["holysugar@gmail.com", "udzura@udzura.jp"]
+  gem.description   = %q{capistrano application banner}
+  gem.summary       = %q{provides a task to display application banner}
+  gem.homepage      = "https://github.com/holysugar/capistrano-banner"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'capistrano', '>= 3.0.0'
+  gem.add_runtime_dependency 'term-ansicolor'
+  gem.add_runtime_dependency 'highline'
+end

data/lib/capistrano-banner.rb

@@ -0,0 +1,3 @@
+require 'capistrano'
+require "capistrano-banner/version"
+require "capistrano-banner/base"

data/lib/capistrano-banner/base.rb

@@ -0,0 +1,64 @@
+require 'term/ansicolor'
+require 'highline'
+
+module CapistranoBanner
+  class Base
+    def initialize(stage, path)
+      @stage = stage
+      @path = path
+      @ui = HighLine.new
+    end
+
+    def banner
+      if @path.end_with? ".erb"
+        require 'erb'
+        template = File.read(@path)
+        ERB.new(template).result
+      else
+        File.read(@path)
+      end
+    end
+
+    def color_banner(color)
+      Term::ANSIColor.send(color, Term::ANSIColor.bold(banner))
+    end
+
+    def pause
+      exit unless @ui.agree(prompt)
+    end
+
+    def prompt
+      "This is #{Term::ANSIColor.send(color, @stage.to_s)} stage. Are you ready? (y/N) >"
+    end
+
+    def color(overwrite = nil)
+      return overwrite if overwrite
+
+      case @stage
+      when :production ; :red
+      when :staging    ; :yellow
+      else :green      ; :green
+      end
+    end
+
+    def warning_color?(color)
+      color == :red
+    end
+
+    def print_banner(options)
+      c = color(options[:color])
+      puts color_banner(c)
+
+      if !options[:force] && (warning_color?(c) || options[:pause])
+        pause
+      end
+    end
+  end
+
+  def self.banner(banner_path = nil, stage = fetch(:stage), options = {})
+    banner_path ||= (
+      File.exist?("./config/banner.txt.erb") ? "./config/banner.txt.erb" : "./config/banner.txt"
+    )
+    Base.new(stage, banner_path).print_banner(options)
+  end
+end

data/lib/capistrano-banner/version.rb

@@ -0,0 +1,3 @@
+module CapistranoBanner
+  VERSION = "0.2.1"
+end

data/lib/capistrano/banner.rb

@@ -0,0 +1,3 @@
+require 'capistrano-banner'
+require 'capistrano/deploy'
+load File.expand_path("../tasks/banner.rake", __FILE__)

data/lib/capistrano/tasks/banner.rake

@@ -0,0 +1,16 @@
+require 'capistrano-banner/base'
+
+namespace :deploy do
+  desc 'Show banner of service'
+  task :banner do
+    path = fetch(:banner_path, lambda {
+        File.exist?("./config/banner.txt.erb") ? "./config/banner.txt.erb" : "./config/banner.txt"
+      })
+    stage = fetch(:stage, :development)
+    options = fetch(:banner_options, {})
+
+    CapistranoBanner::Base.new(stage, path).print_banner(options)
+  end
+
+  before :starting, :banner
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-banner
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- HORII Keima
+- KONDO Uchio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: capistrano application banner
+email:
+- holysugar@gmail.com
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-banner.gemspec
+- lib/capistrano-banner.rb
+- lib/capistrano-banner/base.rb
+- lib/capistrano-banner/version.rb
+- lib/capistrano/banner.rb
+- lib/capistrano/tasks/banner.rake
+homepage: https://github.com/holysugar/capistrano-banner
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: provides a task to display application banner
+test_files: []