capistrano_banner 0.0.4 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68e22bb02144e977f49d7ae355b53a3511d0cbf8
+  data.tar.gz: a5d368282895419acc92e8a81c63b73018e16c76
+SHA512:
+  metadata.gz: 9056944f37f628f0d766d1362be58572a82e07777baabe6ff4cef58b89d5836d83f0251b8b3f10a10428c3f0bf2b127da04197ee2c73c814b70bbc0f70556da2
+  data.tar.gz: 322d117f4d36669319147611456d18dfe68c587228c627d255264138d89bc7671bf4b8c3191509cb34447393d469c9b832fb74a7b4caf5a189fba99e2d5b3b81

data/README.md

@@ -1,20 +1,22 @@
-# CapistranoBanner
+# capistrano_banner
 
-display application banner, and pause in production environment
+`capistrano_banner` displays application banner, and pause in production stage
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Gemfile:
 
     gem 'capistrano_banner'
 
-And then execute:
+Then:
 
     $ bundle
 
-Or install it yourself as:
+### Note
 
-    $ gem install capistrano_banner
+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
 
@@ -29,23 +31,18 @@ $ artii --font=banner3-D yourapp > config/banner.txt
 
 (about artii: https://github.com/miketierney/artii )
 
-Then, call banner method in the bottom of your deploy.rb
+Then enable in Capfile:
 
-```ruby
-require 'capistrano_banner'  # if you wouldn't use bundle exec
-set :rails_env, 'production' # rails_env or rack_env must be fixed before call banner
-set :deploy_to, '/u/apps/yourapp'
+    require 'capistrano/banner'
 
-# :
-# :
+This line hooks `deploy:banner` task just before `deploy:starting`.
 
-banner
-```
+See also [capistrano(3) flow](http://capistranorb.com/documentation/getting-started/flow/).
 
-Let's execute cap!
+After all, let's execute cap!
 
 ```
-$ cap shell
+$ cap production deploy
   '##:::'##::'#######::'##::::'##:'########:::::'###::::'########::'########::
   . ##:'##::'##.... ##: ##:::: ##: ##.... ##:::'## ##::: ##.... ##: ##.... ##:
   :. ####::: ##:::: ##: ##:::: ##: ##:::: ##::'##:. ##:: ##:::: ##: ##:::: ##:
@@ -55,26 +52,34 @@ $ cap shell
   ::: ##::::. #######::. #######:: ##:::. ##: ##:::: ##: ##:::::::: ##::::::::
   :::..::::::.......::::.......:::..:::::..::..:::::..::..:::::::::..:::::::::
 
-  This is production environment. Are you ready? (y/N) > 
+  This is production stage. Are you ready? (y/N) > 
 ```
 
-In production environment, capistarano pauses and waits your input.
+In production stage, capistarano pauses and waits your input.
 
-## Options
+### Custom banner hook
 
-banner method can take options:
+In another way, you can call banner method in your task:
 
-- `:path => 'filepath'` path to your favor banner file
-- `: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
+```
+task :foobar do
+  CapistranoBanner.banner("./config/custom.txt")
+end
+```
+
+## Options
 
+`capistrano_banner` respects some capistrano settings:
 
-## Etc
+- `: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
 
-### multistage
+## LICENSE
 
-If you use capistrano/ext/multistage, you need write `banner` method call to *all* stages. capistrano_banner requires to set :rails_env or :rack_env before `banner`.
+See LICENSE.txt.
 
 ## Contributing
 

data/capistrano_banner.gemspec

@@ -6,10 +6,10 @@ require 'capistrano_banner/version'
 Gem::Specification.new do |gem|
   gem.name          = "capistrano_banner"
   gem.version       = CapistranoBanner::VERSION
-  gem.authors       = ["HORII Keima"]
-  gem.email         = ["holysugar@gmail.com"]
+  gem.authors       = ["HORII Keima", "KONDO Uchio"]
+  gem.email         = ["holysugar@gmail.com", "udzura@udzura.jp"]
   gem.description   = %q{capistrano application banner}
-  gem.summary       = %q{provids banner method to display 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($/)
@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'capistrano'
+  gem.add_runtime_dependency 'capistrano', '>= 3.0.0'
   gem.add_runtime_dependency 'term-ansicolor'
-  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'highline'
 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,14 @@
+require 'capistrano_banner/base'
+
+namespace :deploy do
+  desc 'Show banner of service'
+  task :banner do
+    path  = fetch(:banner_path, "./config/banner.txt")
+    stage = fetch(:stage, :development)
+    options = fetch(:banner_options, {})
+
+    CapistranoBanner::Base.new(stage, path).print_banner(options)
+  end
+
+  before :starting, :banner
+end

data/lib/capistrano_banner/base.rb

@@ -1,11 +1,12 @@
 require 'term/ansicolor'
-require 'thor'
+require 'highline'
 
 module CapistranoBanner
   class Base
-    def initialize(env, path)
-      @env = env
+    def initialize(stage, path)
+      @stage = stage
       @path = path
+      @ui = HighLine.new
     end
 
     def banner
@@ -17,20 +18,20 @@ module CapistranoBanner
     end
 
     def pause
-      exit unless Thor::Shell::Basic.new.yes?(prompt)
+      exit unless @ui.agree(prompt)
     end
 
-    def  prompt
-      "This is #{Term::ANSIColor.red @env} environment. Are you ready? (y/N) >"
+    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 @env
-      when 'production'  ; :red
-      when 'development' ; :green
-      else 'yellow'      ; :yellow
+      case @stage
+      when :production ; :red
+      when :staging    ; :yellow
+      else :green      ; :green
       end
     end
 
@@ -48,12 +49,7 @@ module CapistranoBanner
     end
   end
 
-  module IntegrationMethods
-    def banner(options = {})
-      path = self[:banner_path] || "./config/banner.txt"
-      env  = self[:rack_env] || self[:rails_env] || (raise "rails_env or rack_env is required.") # FIXME: or anything else?
-
-      Base.new(env, path).print_banner(options)
-    end
+  def self.banner(banner_path = "./config/banner.txt", stage = fetch(:stage), options = {})
+    Base.new(stage, banner_path).print_banner(options)
   end
 end

data/lib/capistrano_banner/version.rb

@@ -1,3 +1,3 @@
 module CapistranoBanner
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/capistrano_banner.rb

@@ -1,6 +1,3 @@
 require 'capistrano'
-
 require "capistrano_banner/version"
 require "capistrano_banner/base"
-
-Capistrano::Configuration.send(:include, CapistranoBanner::IntegrationMethods)

metadata

@@ -1,103 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: capistrano_banner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - HORII Keima
+- KONDO Uchio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: highline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     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
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - capistrano_banner.gemspec
+- lib/capistrano/banner.rb
+- lib/capistrano/tasks/banner.rake
 - lib/capistrano_banner.rb
 - lib/capistrano_banner/base.rb
 - lib/capistrano_banner/version.rb
 homepage: https://github.com/holysugar/capistrano_banner
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
-summary: provids banner method to display application banner
+specification_version: 4
+summary: provides a task to display application banner
 test_files: []
-has_rdoc: