trooper 0.6.0.alpha2 → 0.6.0.beta

data/lib/trooper/action.rb

@@ -11,27 +11,61 @@ module Trooper
     attr_reader :name, :description, :config, :block
     attr_accessor :commands
 
-    # expects a name, description and a block
+    # Public: Define a new action.
+    #
+    # name - The name of the action.
+    # description - A description of action to be used in the cli output.
+    # block - A block containing the tasks to run in this action.
+    #
+    # Examples
+    #
     #   Action.new(:my_action, 'Does great things') { run 'touch file' }
+    #
+    # Returns a new action object.
     def initialize(name, description, &block)
       @name, @description, @config = name, description, {}
       @commands, @block = [], block
     end
 
-    # eval's the block passed on initialize and returns the command array
+    # Public: Eval's the block passed on initialize.
+    #
+    # configuration - The configuration object to be used for block eval.
+    #
+    # Examples
+    #
+    #   @action.call(config_object) # => ['touch file']
+    #
+    # Returns an array of commands(strings).
     def call(configuration)
       @config = configuration
       eval_block(&block)
       commands
     end
     alias :execute :call
-
-    # validates the action 
+ 
+    # Public: Validates the action object. (NOT WORKING)
+    #
+    # Examples
+    #
+    #   @action.ok? # => true
+    #
+    # Returns true.
     def ok?
       true
     end
 
     # run is the base run command used by the dsl
+
+    # Public: Appends command(string) to commands(array).
+    #
+    # command - A String to be added to the commands array.
+    #
+    # Examples
+    #
+    #   @action.run 'touch file' # => 'touch file'
+    #   @action.run '' # => nil
+    #
+    # Returns the command or nil.
     def run(command)
       commands << command if command != ''
     end

data/lib/trooper/actions/prepare_prerequisite_action.rb

@@ -0,0 +1,34 @@
+require 'trooper/action'
+
+module Trooper
+  module Actions
+
+    class PreparePrerequisiteAction < Action
+
+      def initialize(config = {})
+        @name = :prepare_prerequisite
+        @description = "Preparing Prerequisites"
+        @config = config
+        @commands = []
+      end
+
+      def call(configuration)
+        @config = configuration
+        @commands = []
+
+        build_commands
+        commands
+      end
+
+      private
+
+      def build_commands
+        create_folders trooper_path
+        run "echo '#{@name}' >> #{prerequisite_list}"
+        run 'echo -e "Prerequisites Prepared"'
+      end
+      
+    end
+
+  end
+end

data/lib/trooper/actions/restart_server_action.rb

@@ -24,7 +24,7 @@ module Trooper
         cd application_path
         create_folder 'tmp'
         run 'touch tmp/restart.txt'
-        run 'echo "Server restarted!"'
+        run 'echo -e "Server restarted!"'
       end
       
     end

data/lib/trooper/actions/setup_trooper_action.rb

@@ -0,0 +1,33 @@
+require 'trooper/action'
+
+module Trooper
+  module Actions
+
+    class SetupTrooperAction < Action
+
+      def initialize(config = {})
+        @name = :setup_trooper
+        @description = "Setup Trooper"
+        @config = config
+        @commands = []
+      end
+
+      def call(configuration)
+        @config = configuration
+        @commands = []
+
+        build_commands
+        commands
+      end
+
+      private
+
+      def build_commands
+        create_folders path, trooper_path
+        run 'echo -e "Trooper Setup on Server"'
+      end
+      
+    end
+
+  end
+end

data/lib/trooper/config/action.rb

@@ -3,16 +3,19 @@ require 'trooper/action'
 require 'trooper/actions/clone_repository_action'
 require 'trooper/actions/install_gems_action'
 require 'trooper/actions/migrate_database_action'
+require 'trooper/actions/prepare_prerequisite_action'
 require 'trooper/actions/restart_server_action'
 require 'trooper/actions/rollback_migrate_action'
 require 'trooper/actions/setup_database_action'
+require 'trooper/actions/setup_trooper_action'
 require 'trooper/actions/update_repository_action'
 
 module Trooper
   module Config
     module Action
 
-      DEFAULT_ACTIONS = [Actions::CloneRepositoryAction, Actions::InstallGemsAction, 
+      DEFAULT_ACTIONS = [Actions::SetupTrooperAction, Actions::PreparePrerequisiteAction,
+                          Actions::CloneRepositoryAction, Actions::InstallGemsAction, 
                           Actions::MigrateDatabaseAction, Actions::RestartServerAction, 
                           Actions::RollbackMigrateAction, Actions::SetupDatabaseAction, 
                           Actions::UpdateRepositoryAction]

data/lib/trooper/config/defaults.rb

@@ -0,0 +1,20 @@
+require 'trooper/config/action'
+
+module Trooper
+  module Config
+    module Defaults
+      FILE_NAME = "Troopfile"
+      
+      include Trooper::Config::Action
+
+      def load_defaults!(options = {})
+        config[:file_name] = options[:file_name] || FILE_NAME
+        config[:environment] = options[:environment] || :production
+        config[:ruby_bin_path] = options[:ruby_bin_path] || ""
+        
+        load_default_actions!
+      end
+
+    end
+  end
+end

data/lib/trooper/config/environment.rb

@@ -28,9 +28,14 @@ module Trooper
       def path(arg)
         set :application_path => "#{arg}/application" 
         set :trooper_path => "#{arg}/trooper"
+        set :prerequisite_list => "#{arg}/trooper/prerequisite_list"
         set :path => arg 
       end
 
+      def ruby_bin_path(arg)
+        set :ruby_bin_path => arg.gsub(/[^\/]$/, '\1/') # /usr/local/bin/
+      end
+
     end
   end
 end

data/lib/trooper/configuration.rb

@@ -4,15 +4,14 @@ require 'trooper/arsenal'
 
 require 'trooper/config/environment'
 require 'trooper/config/strategy'
-require 'trooper/config/action'
+require 'trooper/config/defaults'
 
 module Trooper
   class Configuration < Hash
-    FILE_NAME = "Troopfile"
 
     include Trooper::Config::Environment
     include Trooper::Config::Strategy
-    include Trooper::Config::Action
+    include Trooper::Config::Defaults
 
     def self.init
       gem_dir = File.dirname(__FILE__)
@@ -30,16 +29,14 @@ module Trooper
     #   Configuration.new({:my_override => 'settings'})
     def initialize(options = {})
       @loaded = false
-      @file_name = options[:file_name] || FILE_NAME
-      self[:environment] = options[:environment] || :production
 
-      load_default_actions!
+      load_defaults! options
       load_troopfile! options
     end
 
     # returns a terminal friendly version of the configuration 
     def to_s
-      self.map {|k,v| "#{k}: #{v}" }.join("\n")
+      config.map {|k,v| "#{k}: #{v}" }.join("\n")
     end
 
     # will find and execute the strategy name passed
@@ -51,7 +48,7 @@ module Trooper
     # a way to set variables that will be available to all actions
     #   set(:my_variable => 'sdsd') # => available as method in an action
     def set(hash)
-      self.merge! hash
+      config.merge! hash
     end
 
     # returns true if the troopfile was loaded
@@ -61,6 +58,10 @@ module Trooper
 
     private
 
+    def config
+      self
+    end
+
     # loads the troopfile and sets the environment up
     def load_troopfile!(options)
       if troopfile?
@@ -70,18 +71,18 @@ module Trooper
         load_environment!
         set options
       else
-        raise Trooper::NoConfigurationFileError, "No Configuration file (#{@file_name}) can be found!"
+        raise Trooper::NoConfigurationFileError, "No Configuration file (#{self[:file_name]}) can be found!"
       end
     end
 
     # returns the troopfile file object
     def troopfile
-      File.open(@file_name)
+      File.open(config[:file_name])
     end
     
     # returns true if the troopfile exists
     def troopfile?
-      File.exists?(@file_name)
+      File.exists?(config[:file_name])
     end
 
   end

data/lib/trooper/dsl/bundler.rb

@@ -3,12 +3,12 @@ module Trooper
     module Bundler
       
       def bundle_exec(command)
-        use_bundle = using_bundler? ? "bundle exec " : ""
+        use_bundle = using_bundler? ? "#{ruby_bin_path}bundle exec " : ""
         run use_bundle + command
       end
 
       def bundle_install
-        run "bundle install --path #{trooper_path}/bundle --deployment --without development test" if using_bundler?
+        run "#{ruby_bin_path}bundle install --path #{trooper_path}/bundle --deployment --without development test" if using_bundler?
       end
 
       def rake(command)
@@ -20,6 +20,10 @@ module Trooper
       def using_bundler?
         File.exists? "Gemfile"
       end
+
+      def ruby_bin_path
+        config[:ruby_bin_path] || ""
+      end
       
     end
   end

data/lib/trooper/dsl/rake.rb

@@ -3,7 +3,13 @@ module Trooper
     module Rake
       
       def rake(command)
-        run "rake #{command}"
+        run "#{ruby_bin_path}rake #{command}"
+      end
+
+      private
+
+      def ruby_bin_path
+        config[:ruby_bin_path] || ""
       end
       
     end

data/lib/trooper/strategy.rb

@@ -8,28 +8,32 @@ module Trooper
     def initialize(name, description, config = {}, &block)
       @name, @description, @config = name, description, config
       @run_list = []
-      eval_block(&block)
+      @block = block if block_given?
     end
 
     def execute(config = {})
       @config = config
+      
+      eval_block
+
       Trooper.logger.debug "Configuration\n#{config}"
       Trooper.logger.strategy description
       successful = nil
-
+      
       runners.each do |runner|
         begin
           Trooper.logger.info "\e[4mRunning on #{runner}\n"
 
-          run_list.each do |item, name|
-            self.send("#{item}_execute", runner, name)
+          run_list.each do |strategy, type, name|
+            commands = build_commands strategy, type, name
+            runner_execute! runner, commands if commands
           end
 
           successful = true
           Trooper.logger.success "\e[4mAll Actions Completed\n"
         rescue Exception => e
           Trooper.logger.error "#{e.class.to_s} : #{e.message}\n\n#{e.backtrace.join("\n")}"
-          
+
           successful = false
           break #stop commands running on other servers
         ensure
@@ -40,47 +44,78 @@ module Trooper
       successful
     end
 
+    def build_run_list
+      eval_block
+      run_list
+    end
+
     def ok?
       true
     end
 
-    def call(strategy_name)
-      if Arsenal.strategies[strategy_name]
-        Arsenal.strategies[strategy_name].run_list.each do |action|
-          @run_list << action
+    def call(*strategy_names)
+      [*strategy_names].each do |strategy_name|
+        if Arsenal.strategies[strategy_name]
+          Arsenal.strategies[strategy_name].build_run_list.each do |action|
+            # strategy_name, type, name
+            @run_list << action
+          end
         end
-      end  
+      end
+    end
+
+    def prerequisites(*strategy_names)
+      unless @run_list.detect { |a| a[2] == :prepare_prerequisite }
+        @run_list << [@name, :action, :prepare_prerequisite] 
+      end
+      [*strategy_names].each do |strategy_name|
+        if Arsenal.strategies[strategy_name]
+          Arsenal.strategies[strategy_name].build_run_list.each do |action|
+            # strategy_name, type, name
+            @run_list << [action[0], :prerequisite, action[2]]
+          end
+        end  
+      end
     end
 
     def actions(*action_names)
       [*action_names].each do |name| 
-        @run_list << [:action, name]
+        # strategy_name, type, name
+        @run_list << [self.name, :action, name]
       end
     end
 
-    def method_missing(method_sym, *arguments, &block)
-      config[method_sym] || super
-    end
+    def build_commands(strategy_name, type, action_name)
+      action = Arsenal.actions[action_name]
 
-    private
+      if action
+        commands = action.call config
 
-    def eval_block(&block)
-      if block_given?
-        if block.arity == 1
-          block.call self
+        case type
+        when :prerequisite
+          commands << "echo '#{action.name}' >> #{prerequisite_list}"
+          commands << "echo '#{action.description}'"
+          commands = "touch #{prerequisite_list}; if grep -vz #{action_name} #{prerequisite_list}; then #{commands.join(' && ')}; else echo 'Already Done'; fi"    
+          Trooper.logger.action "Prerequisite: #{action.description}"
         else
-          instance_eval &block
+          Trooper.logger.action action.description
         end
+        
+        commands
+      else
+        raise MissingActionError, "Cant find action: #{action_name}"
       end
     end
 
-    def action_execute(runner, name)
-      action = Arsenal.actions[name]
+    def method_missing(method_sym, *arguments, &block)
+      config[method_sym] || super
+    end
 
-      if action
-        commands = action.call config
-        Trooper.logger.action action.description
-        runner_execute!(runner, commands)
+    private
+
+    def eval_block
+      if @block
+        instance_eval &@block
       end
     end
 

data/lib/trooper/template/troopfile.rb

@@ -1,29 +1,38 @@
+#Basic settings
 user 'my_user'
 hosts 'stage.example.com'
+path "/fullpath/to/folder"
 repository 'git@git.bar.co.uk:whatever.git'
-path "/path/to/data/folder"
+# ruby_bin_path "/fullpath/to/ruby/bin/folder" # Define if you have issues with gems
 
-set :my_value => 'something'
+# set :my_value => 'something' # Setting a custom value
 
-env :production do
-  hosts 'production1.example.com', 'production2.example.com'
-  set :my_value => 'something_else'
+# Set environment specific settings and or actions   
+# env :stage do
+#   hosts 'stage.example.com', 'stage.example.com'
+#   set :my_value => 'something_else'
 
-  action :restart do
-    run 'touch tmp/restert.txt'
-  end
-end
+#   action :my_action do
+#     #some action
+#   end
+# end
+
+# action :my_action do
+#   #some action
+# end
 
-action :restart do
-  run 'touch tmp/restert.txt'
+strategy :setup, 'Setting up Application on the Server' do
+  actions :setup_trooper, :clone_repository, :setup_database
 end
 
 strategy :update, 'Update the code base on the server' do
+  prerequisites :setup
   actions :update_repository, :install_gems
   call :restart
 end
 
 strategy :deploy, 'Full deployment to the server' do
+  prerequisites :setup
   call :update
   actions :migrate_database
   call :restart

data/lib/trooper/version.rb

@@ -3,7 +3,7 @@ module Trooper
     MAJOR = 0
     MINOR = 6
     TINY  = 0
-    PRE   = 'alpha2'
+    PRE   = 'beta'
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end
 end

data/lib/trooper.rb

@@ -11,6 +11,10 @@ module Trooper
   class MissingStrategyError < TrooperError
   end
 
+  # When a acton is not defined
+  class MissingActionError < TrooperError
+  end
+
   # When a CLI argument is missing or badly formed
   class CliArgumentError < TrooperError
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trooper
 version: !ruby/object:Gem::Version
-  version: 0.6.0.alpha2
+  version: 0.6.0.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000 Z
+date: 2012-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -168,13 +168,16 @@ files:
 - lib/trooper/actions/clone_repository_action.rb
 - lib/trooper/actions/install_gems_action.rb
 - lib/trooper/actions/migrate_database_action.rb
+- lib/trooper/actions/prepare_prerequisite_action.rb
 - lib/trooper/actions/restart_server_action.rb
 - lib/trooper/actions/rollback_migrate_action.rb
 - lib/trooper/actions/setup_database_action.rb
+- lib/trooper/actions/setup_trooper_action.rb
 - lib/trooper/actions/update_repository_action.rb
 - lib/trooper/arsenal.rb
 - lib/trooper/cli.rb
 - lib/trooper/config/action.rb
+- lib/trooper/config/defaults.rb
 - lib/trooper/config/environment.rb
 - lib/trooper/config/strategy.rb
 - lib/trooper/configuration.rb
@@ -205,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 987069315358731721
+      hash: -2382425093214391347
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: