capistrano_banner 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in capistrano_banner.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2012 HORII Keima
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,76 @@
1
+ # CapistranoBanner
2
+
3
+ display application banner, and pause in production environment
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'capistrano_banner'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install capistrano_banner
18
+
19
+ ## Usage
20
+
21
+ First, you need create your application banner in config/banner.txt
22
+
23
+ like this:
24
+
25
+ ```zsh
26
+ $ gem install artii
27
+ $ rehash
28
+ $ artii --font=banner3-D yourapp > config/banner.txt
29
+ ```
30
+
31
+ Then, call banner method in the bottom of your deploy.rb
32
+
33
+ ```ruby
34
+ set :rails_env, 'production'
35
+ set :deploy_to, '/u/apps/yourapp'
36
+
37
+ # :
38
+ # :
39
+
40
+ banner
41
+ ```
42
+
43
+ Let's execute cap!
44
+
45
+ ```
46
+ $ cap shell (reward-server)-(master5)-(aradmin)
47
+ '##:::'##::'#######::'##::::'##:'########:::::'###::::'########::'########::
48
+ . ##:'##::'##.... ##: ##:::: ##: ##.... ##:::'## ##::: ##.... ##: ##.... ##:
49
+ :. ####::: ##:::: ##: ##:::: ##: ##:::: ##::'##:. ##:: ##:::: ##: ##:::: ##:
50
+ ::. ##:::: ##:::: ##: ##:::: ##: ########::'##:::. ##: ########:: ########::
51
+ ::: ##:::: ##:::: ##: ##:::: ##: ##.. ##::: #########: ##.....::: ##.....:::
52
+ ::: ##:::: ##:::: ##: ##:::: ##: ##::. ##:: ##.... ##: ##:::::::: ##::::::::
53
+ ::: ##::::. #######::. #######:: ##:::. ##: ##:::: ##: ##:::::::: ##::::::::
54
+ :::..::::::.......::::.......:::..:::::..::..:::::..::..:::::::::..:::::::::
55
+
56
+ This is production environment. Are you ready? (y/N) >
57
+ ```
58
+
59
+ If production environment, pause and wait your input.
60
+
61
+ ## Options
62
+
63
+ banner method can take options:
64
+
65
+ - `:path => 'filepath'` path to your favor banner file
66
+ - `:color => :colorname'` banner color
67
+ - `:pause => true` anyway pause
68
+ - `:force => true` don't pause even if production env
69
+
70
+ ## Contributing
71
+
72
+ 1. Fork it
73
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
74
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
75
+ 4. Push to the branch (`git push origin my-new-feature`)
76
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,22 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'capistrano_banner/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "capistrano_banner"
8
+ gem.version = CapistranoBanner::VERSION
9
+ gem.authors = ["HORII Keima"]
10
+ gem.email = ["holysugar@gmail.com"]
11
+ gem.description = %q{capistrano application banner}
12
+ gem.summary = %q{provids banner method to display application banner}
13
+ gem.homepage = "https://github.com/holysugar/capistrano_banner"
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
17
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18
+ gem.require_paths = ["lib"]
19
+
20
+ gem.add_dependency 'capistrano'
21
+ gem.add_dependency 'term-ansicolor'
22
+ end
@@ -0,0 +1,56 @@
1
+ module CapistranoBanner
2
+ class Base
3
+ def initialize(env, path)
4
+ @env = env
5
+ @path = path
6
+ end
7
+
8
+ def banner
9
+ File.read(@path)
10
+ end
11
+
12
+ def color_banner(color)
13
+ Term::ANSIColor.send(color, Term::ANSIColor.bold(banner))
14
+ end
15
+
16
+ def pause
17
+ exit unless Thor::Shell::Basic.new.yes?(prompt)
18
+ end
19
+
20
+ def prompt
21
+ "This is #{Term::ANSIColor.red @env} environment. Are you ready? (y/N) >"
22
+ end
23
+
24
+ def color(overwrite = nil)
25
+ return overwrite if overwrite
26
+
27
+ case @env
28
+ when 'production' ; :red
29
+ when 'development' ; :green
30
+ else 'yellow' ; :yellow
31
+ end
32
+ end
33
+
34
+ def warning_color?(color)
35
+ color == :red
36
+ end
37
+
38
+ def print_banner(options)
39
+ c = color(options[:color])
40
+ puts color_banner(c)
41
+
42
+ if !options[:force] && (warning_color?(c) || options[:pause])
43
+ pause
44
+ end
45
+ end
46
+ end
47
+
48
+ module IntegrationMethods
49
+ def banner(options = {})
50
+ path = self[:banner_path] || "./config/banner.txt"
51
+ env = self[:rails_env] || self[:rack_env] || (raise "rails_env or rack_env is required.") # FIXME: or somthing else?
52
+
53
+ Base.new(env, path).print_banner(options)
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,3 @@
1
+ module CapistranoBanner
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ require "capistrano_banner/version"
2
+ require "capistrano_banner/base"
3
+
4
+ Capistrano::Configuration.send(:include, CapistranoBanner::IntegrationMethods)
metadata ADDED
@@ -0,0 +1,86 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: capistrano_banner
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - HORII Keima
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-10-23 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: capistrano
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: '0'
30
+ - !ruby/object:Gem::Dependency
31
+ name: term-ansicolor
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: '0'
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ description: capistrano application banner
47
+ email:
48
+ - holysugar@gmail.com
49
+ executables: []
50
+ extensions: []
51
+ extra_rdoc_files: []
52
+ files:
53
+ - .gitignore
54
+ - Gemfile
55
+ - LICENSE.txt
56
+ - README.md
57
+ - Rakefile
58
+ - capistrano_banner.gemspec
59
+ - lib/capistrano_banner.rb
60
+ - lib/capistrano_banner/base.rb
61
+ - lib/capistrano_banner/version.rb
62
+ homepage: https://github.com/holysugar/capistrano_banner
63
+ licenses: []
64
+ post_install_message:
65
+ rdoc_options: []
66
+ require_paths:
67
+ - lib
68
+ required_ruby_version: !ruby/object:Gem::Requirement
69
+ none: false
70
+ requirements:
71
+ - - ! '>='
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ required_rubygems_version: !ruby/object:Gem::Requirement
75
+ none: false
76
+ requirements:
77
+ - - ! '>='
78
+ - !ruby/object:Gem::Version
79
+ version: '0'
80
+ requirements: []
81
+ rubyforge_project:
82
+ rubygems_version: 1.8.24
83
+ signing_key:
84
+ specification_version: 3
85
+ summary: provids banner method to display application banner
86
+ test_files: []