capistrano-hostmenu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d795ea1362f08f1483ed9bc56e9e8370df5c0b1c
+  data.tar.gz: 27471bb378fb5a8eb14972c98785df573164e91a
+SHA512:
+  metadata.gz: 6712121f3e1dd486dd87ee1372d785f0bca0a64786eea8a78f6833a433b740a4dc0e328e41e01e4baf7178ab4b5cc35fd661b8b8b076e035c68b4379b4cf0153
+  data.tar.gz: 8d35b3e09c4e23d975adeb9d5a8887d4193e86f04bd9a59a219681979f20fc8077aed871d0c50fc25debc72c1f14f60232a8600a85b9c56d81f7c9f57f71d765

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    capistrano-hostmenu (0.1.0)
+      capistrano (>= 3.0.0)
+
+GEM
+  specs:
+    capistrano (3.3.5)
+      capistrano-stats (~> 1.1.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (~> 1.3)
+    capistrano-stats (1.1.1)
+    colorize (0.7.5)
+    i18n (0.7.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.2)
+    rake (10.4.2)
+    sshkit (1.6.1)
+      colorize (>= 0.7.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  capistrano-hostmenu!
+  rake

data/README.md

@@ -0,0 +1,45 @@
+# capistrano-hostmenu
+A capistrano plugin which allows you to choose deploy host via a text menu.
+
+Here's an example:
+
+~~~sh
+Please choose which server(s) to deploy:
+  [1] example1.com
+  [2] example2.com
+  [3] all (default)
+Please enter host_numbers (3):
+~~~
+
+## Installation
+
+~~~sh
+gem install capistrano-hostmenu
+~~~
+
+or put this in your `Gemfile` then run `bundle install`:
+
+~~~ruby
+gem 'capistrano-hostmenu'
+~~~
+
+After the gem is installed, put this in your `Capfile`:
+
+~~~ruby
+require 'capistrano/hostmenu'
+~~~
+
+Then you will see host selecting menu any time before deploying.
+
+## Configurations
+
+set these variables in your deploy config (commonly `deploy.rb`)
+
+~~~ruby
+set :host_menu_prompt_msg,                'Please choose which server(s) to deploy:'.blue
+set :host_menu_default_selection,         :all # or :first, 1
+set :host_menu_caption_of_all,            'all'
+set :host_menu_caption_of_default,        '(default)'
+set :host_menu_invalid_range_msg,         'Please provide a number in (1..%d)'.red
+set :host_menu_invalid_multi_choose_msg,  'Do you mean to choose all servers?'.red
+~~~

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+
+# Generate documentation
+YARD::Rake::YardocTask.new(:doc) do |t|
+  #t.files   = %w{lib/hsf.rb}
+end
+
+## Developping tasks
+require "rake/extensiontask"
+
+# `rake compile` to compile
+Rake::ExtensionTask.new "hsf" do |ext|
+  ext.name = "hsf_cpp"
+end

data/lib/capistrano/hostmenu.rb

@@ -0,0 +1,100 @@
+module Capistrano
+
+  class Hostmenu
+
+    include ::Capistrano::DSL
+
+    def self.set_default_config
+      set :host_menu_prompt_msg,                'Please choose which server(s) to deploy:'.blue
+      set :host_menu_default_selection,         :all # or :first, 1
+      set :host_menu_caption_of_all,            'all'
+      set :host_menu_caption_of_default,        '(default)'
+      set :host_menu_invalid_range_msg,         'Please provide a number in (1..%d)'.red
+      set :host_menu_invalid_multi_choose_msg,  'Do you mean to choose all servers?'.red
+    end
+
+    def initialize
+      if deploy_hosts.size > 1
+        prompt_menu default: fetch(:host_menu_default_selection)
+      end
+    end
+
+    def prompt_menu default: :all
+      puts fetch(:host_menu_prompt_msg)
+
+      default     = input_for(default)
+      default_cap = fetch(:host_menu_caption_of_default)
+
+      (deploy_hosts + [fetch(:host_menu_caption_of_all)]).each_with_index do |host, i|
+        cap = if i == default - 1
+                "[%d] %s %s" % [i+1, host, default_cap]
+              else
+                "[%d] %s" % [i+1, host]
+              end
+        puts "  " << cap.green
+      end
+
+      ask :host_numbers, default.to_s
+      set_hosts
+    end
+
+    private
+
+      def input_for selection
+        case selection
+        when :all
+          max_selection
+        when 0
+          1
+        when Fixnum
+          selection
+        else
+          1
+        end
+      end
+
+      def max_selection
+        deploy_hosts.size + 1
+      end
+
+      def deploy_hosts
+        release_roles(:all)
+      end
+
+      def selection_for_all
+        max_selection
+      end
+
+      def set_hosts
+        ids = fetch(:host_numbers).split(/\s*,\s*/).map(&:to_i).uniq
+        unless ids.all? {|i| (1..max_selection).include? i}
+          puts fetch(:host_menu_invalid_range_msg) % max_selection
+          exit 1
+        end
+
+        if ids.size > 1 && ids.include?(selection_for_all)
+          puts fetch(:host_menu_invalid_multi_choose_msg)
+          exit 1
+        end
+
+        unless ids.include?(selection_for_all)
+          set_host_filter ids.map {|i| deploy_hosts[i-1].hostname}
+        end
+      end
+
+      def set_host_filter hosts
+        if defined? Capistrano::Configuration::Servers::HostFilter
+          set :filter, hosts: hosts
+        else
+          # hack for Capistrano v3.3+
+          Capistrano::Configuration.env.send(:servers).send(:servers).select! do |srv|
+            hosts.include?(srv.hostname)
+          end
+        end
+      end
+
+  end
+end
+
+load File.expand_path('../tasks/hostmenu.rake', __FILE__)
+

data/lib/capistrano/tasks/hostmenu.rake

@@ -0,0 +1,40 @@
+namespace :deploy do
+
+  desc 'print environment variables'
+  task :info do
+    puts "--" * 50
+    puts "About to deploy, check your seatbelt~"
+    puts "env:    #{fetch(:rails_env).bold.blue}"
+    puts "branch: #{fetch(:branch).bold.green}"
+    puts "server: #{roles(:all).map(&:hostname).join("\n        ").red}"
+    puts "--" * 50
+  end
+
+  desc <<-DESC
+        Prompt a text based list menu for user to select. \
+        Following changes will only be applied on selected servers.
+
+        User will see menu like this:
+
+        ~~~
+        Please select target host(s):
+          [1] my.example1.com
+          [2] my.example2.com
+          [3] all (default)
+        Please enter host_numbers (3):
+        ~~~
+    DESC
+  task :host_menu do
+    next if fetch(:show_host_menu) == false
+
+    Capistrano::Hostmenu.new
+    invoke 'deploy:info' unless fetch(:host_menu_show_info_after_select) == false
+  end
+end
+
+
+Capistrano::Hostmenu.set_default_config
+
+Capistrano::DSL.stages.each do |stage|
+  after stage, 'deploy:host_menu'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-hostmenu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- qhwa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: qhwa@163.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/capistrano/hostmenu.rb
+- lib/capistrano/tasks/hostmenu.rake
+homepage: https://github.com/qhwa/capistrano-hostmenu
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+- 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.4.5
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin that prompt a text menu to choose target host.
+test_files: []
+has_rdoc: false