capistrano-ext-params 0.1.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-09-05
+
+* 1 major enhancement
+
+  * Birthday! :required added to task options. ensured before task execution.
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/capistrano/ext/params.rb

data/README.txt

@@ -0,0 +1,73 @@
+= capistrano-ext-params
+
+http://github.com/andynu/capistrano-ext-params
+
+== DESCRIPTION:
+
+This package adds optional and required params to capistrano.
+
+All required parameters are ensured to have a non-null value before the task executes, and all optional parameters will be validated against their :values.
+
+== FEATURES/PROBLEMS:
+
+* PROBLEM: not released
+
+== SYNOPSIS:
+
+# please wait until 1.0
+# this is the goal, not the current state of things.
+
+task :name, :roles => :server,
+     :required => {
+       :first_param => {
+         :type => :string,
+         :values => %w[ value_one value_two value_three]
+       }
+     },
+     :optional => {
+       :second_param => {
+         :type => :number
+       }
+     } do
+
+== REQUIREMENTS:
+
+* capistrano
+
+== INSTALL:
+
+* gem install 'capistrano-ext-required-params'
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 FIX
+
+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/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :racc
+# Hoe.plugin :rubyforge
+Hoe.plugin :gemcutter
+
+Hoe.spec 'capistrano-ext-params' do
+  developer('Andrew Nutter-Upham', 'andynu@.com')
+
+  # self.rubyforge_name = 'capistrano-ext-paramsx' # if different than 'capistrano-ext-params'
+  extra_deps << ['capistrano','>= 0']
+  extra_deps << ['capistrano-ext-set-helpers',' >= 0']
+end
+
+# vim: syntax=ruby

data/lib/capistrano/ext/params.rb

@@ -0,0 +1,121 @@
+require 'capistrano'
+class CapistranoExtParams
+  VERSION = '0.1.0'
+end
+
+module Capistrano
+  class TaskDefinition
+    alias_method :original_brief_description, :brief_description
+    def brief_description(max_length=nil)
+        brief = original_brief_description(max_length)
+        unless @options.nil? || @options[:required_params].nil? || @options[:required_params].empty?
+            brief << " " * (max_length-brief.length) if max_length > brief.length
+            brief << "requires " + @options[:required_params].join(",")
+        end
+        brief
+    end
+  end
+end
+
+
+module Capistrano
+  class Configuration
+    module Execution
+
+      def ensure_params(params=[])
+        params = [ params ].flatten
+
+        # Query user for any undefined variables
+        params.each do |param|
+          param_desc = $parameter_descriptions[param] || "value for #{param}"
+          unless exists?(param)
+            set_ask( param, "#{param} - #{param_desc}: " )
+          end
+
+          puts "  %s: %s" % [param, fetch(param)]
+        end
+      end
+
+      alias_method :original_execute_task, :execute_task
+      def execute_task(task)
+        puts "     options #{task.options}"
+        ensure_params(task.options[:required_params]) if task.options[:required_params]
+        original_execute_task(task)
+      end
+
+    end
+
+  end
+end
+
+module Capistrano
+  class CLI
+    module Help
+      #alias_method :original_explain_task, :explain_task
+
+      def explain_task(config,name)
+
+        def print( task )
+          puts "-"*HEADER_LEN
+          puts "Usage:\n\tcap %s %s %s" % [
+            $recipe,
+            task.fully_qualified_name,
+            [
+              [task.options[:required_params]].flatten.compact.map {|param| " %s=ARG" % [param] },
+              [task.options[:optional_params]].flatten.compact.map {|param| " [%s=ARG]" % [param] }
+            ].flatten.join()
+          ]
+          puts "-"*HEADER_LEN
+          puts format_text(task.description)
+          puts "-"*HEADER_LEN
+          if task.options[:required_params]
+            puts "Required Parameters"
+            task.options[:required_params].each do |param|
+              param_desc = $parameter_descriptions[param] || param
+              puts "\t#{param} - #{param_desc}"
+            end
+          end
+          if task.options[:optional_params]
+            puts "Optional Parameters"
+            task.options[:optional_params].each do |param|
+              param_details = $optional_parameter_descriptions[param]
+              if param_details
+                param_desc = "#{param_details[:desc]} (default=#{param_details[:default]})"
+              else
+                param_desc = param
+              end
+              puts "\t#{param} - #{param_desc}"
+            end
+          end
+        end
+
+        task = config.find_task(name)
+
+        # if name is for a namespace, then explain all tasks in namespace
+        if task.nil?
+          # Following logic adapted from Namespaces#find_task
+          parts = name.to_s.split(/:/)
+
+          ns = config
+          until parts.empty?
+            next_part = parts.shift
+            ns = next_part.empty? ? nil : ns.namespaces[next_part.to_sym]
+            return nil if ns.nil?
+          end
+
+          # print each task
+          ns.tasks.each do |_name,_task|
+            print( task )
+            puts "\n\n"
+          end
+
+        else
+          print( task )
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-ext-params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Nutter-Upham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &11150400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11150400
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext-set-helpers
+  requirement: &11149740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11149740
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &11148980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: *11148980
+description: ! 'This package adds optional and required params to capistrano.
+
+
+  All required parameters are ensured to have a non-null value before the task executes,
+  and all optional parameters will be validated against their :values.'
+email:
+- andynu@.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/capistrano/ext/params.rb
+- .gemtest
+homepage: http://github.com/andynu/capistrano-ext-params
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+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: capistrano-ext-params
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: This package adds optional and required params to capistrano
+test_files: []