mina 0.1.1 → 0.1.2.pre1

data/HISTORY.md

@@ -1,3 +1,19 @@
+v0.1.2.pre1 - Jun 12, 2012
+--------------------------
+
+### Fixed:
+  * Fixed JRuby support.
+  * Respect .bashrc. (#5)
+
+### Changed:
+  * Implement `ssh("..", return: true)`.
+  * Rename simulate_mode to simulate_mode?. Same with verbose_mode?.
+  * Show the SSH command in the simulation output.
+
+### Misc:
+  * Prepare for Tomdoc.
+  * Stop invoking bash needlessly to prettify things.
+
 v0.1.1 - Jun 07, 2012
 ---------------------
 

data/README.md

@@ -11,539 +11,17 @@ is ran separately on their own SSH sessions. Mina only creates *one* SSH
 session per deploy, minimizing the SSH connection overhead.
 
     $ gem install mina
+    $ mina
 
-Features
---------
-
-* __Really fast.__ Mina only makes one SSH connection per deploy. It
-  builds a Bash script and executes it remotely, reducing the overhead of
-  creating SSH connections to do processing locally (like Vlad or Capistrano
-  does).
-
-* __Safe deploys.__ New releases are built on a temp folder. If the deploy
-  script fails at any point, the build is deleted and it'd be as if nothing
-  happened.
-
-* __Locks.__ Deploy scripts rely on a lockfile ensuring only one deploy can
-  happen at a time.
-
-* __Works with anything.__ While Mina is built with Rails projects it
-  mind, it can be used on just about any type of project deployable via SSH,
-  Ruby or not.
-
-* __Built with Rake.__ Setting up tasks will be very familiar! No YAML files
-  here. Everything is written in Ruby, giving you the power to be as flexible in
-  your configuration as needed.
-
-Setting up a project
---------------------
-
-Let's deploy a project using Mina.
-
-### Step 1: Create a config/deploy.rb
-
-In your project, type `mina init` to create a sample of this file.
-
-This is just a Rake file with tasks!
-
-    $ mina init
-    Created config/deploy.rb.
-
-See [About deploy.rb](#about_deployrb) for more info on what *deploy.rb* is.
-
-### Step 2: Set up your server
-
-Make a directory in your server called `/var/www/flipstack.com` (in *deploy_to*)
-change it's ownership to the correct user.
-
-    # SSH into your server, then:
-    $ mkdir /var/www/flipstack.com
-    $ chown -R username /var/www/flipstack.com
-
-    # Make sure 'username' is the same as what's on deploy.rb
-
-### Step 3: Run 'mina setup'
-
-Now do `mina setup` to set up the [folder structure](#directory_structure) in this
-path. This will connect to your server via SSH and create the right directories.
-
-    $ mina setup
-    -----> Creating folders... done.
-
-See [directory structure](#directory_structure) for more info.
-
-### Step 4: Deploy!
-
-Use `mina deploy` to run the `deploy` task defined in *config/deploy.rb*.
-
-    $ mina deploy
-    -----> Deploying to 2012-06-12-040248
-           ...
-           Lots of things happening...
-           ...
-    -----> Done.
-
-Command line options
---------------------
-
-* `--verbose` - This will show commands being done on the server. Off by
-  default.
-
-* `--simulate` - This will not invoke any SSH connections; instead, it will
-  simply output the script it builds.
-
-About deploy.rb
----------------
-
-The file `deploy.rb` is simply a Rakefile invoked by Rake. In fact, `mina` is
-mostly an alias that invokes Rake to load `deploy.rb`.
-
-As it's all Rake, you can define tasks that you can invoke using `mina`. In this
-example, it provides the `mina restart` command.
-
-``` ruby
-# Sample config/deploy.rb
-set :domain, 'your.server.com'
-
-task :restart do
-  queue 'sudo service restart apache'
-end
-```
-
-The magic of Mina is in the new commands it gives you.
-
-The `queue` command queues up Bash commands to be ran on the remote server.
-If you invoke `mina restart`, it will invoke the task above and run the queued
-commands on the remote server `your.server.com` via SSH.
-
-See [the command queue](#the_command_queue) for more information on the *queue*
-command.
-
-The command queue
------------------
-
-At the heart of it, Mina is merely sugar on top of Rake to queue commands
-and execute them remotely at the end.
-
-Take a look at this minimal *deploy.rb* configuration:
-
-``` ruby
-set :user, 'john'
-set :domain, 'flipstack.com'
-
-task :logs do
-  queue 'echo "Contents of the log file are as follows:"'
-  queue "tail -f /var/log/apache.log"
-end
-```
-
-Once you type `mina logs` in your terminal, it invokes the *queue*d commands
-remotely on the server using the command `ssh john@flipstack.com`.
-
-```
-# Run it in simulation mode so we see the command it will invoke:
-$ mina logs --simulate
-(
-  echo "Contents of the log file are as follows:"
-  tail -f /var/log/apache.log
-) | ssh john@flipstack.com -- bash -
-```
-
-Subtasks
---------
-
-Mina provides the helper `invoke` to invoke other tasks from a
-task.
-
-```ruby
-task :down do
-  invoke :maintenance_on
-  invoke :restart
-end
-
-task :maintenance_on
-  queue 'touch maintenance.txt'
-end
-
-task :restart
-  queue 'sudo service restart apache'
-end
-```
-
-In this example above, if you type `mina down`, it simply invokes the other
-subtasks which queues up their commands. The commands will be ran after
-everything.
-
-Deploying
----------
-
-Mina provides the `deploy` command which *queue*s up a deploy script for
-you.
-
-``` ruby
-set :domain, 'flipstack.com'
-set :user, 'flipstack'
-set :deploy_to, '/var/www/flipstack.com'
-set :repository, 'http://github.com/flipstack/flipstack.git'
-
-task :deploy do
-  deploy do
-    # Put things that prepare the empty release folder here.
-    # Commands queued here will be ran on a new release directory.
-    invoke :'git:clone'
-    invoke :'bundle:install'
-
-    # These are instructions to start the app after it's been prepared.
-    to :launch do
-      queue 'touch tmp/restart.txt'
-    end
-
-    # This optional block defines how a broken release should be cleaned up.
-    to :clean do
-      queue 'log "failed deployment"'
-    end
-  end
-end
-```
-
-It works by capturing the *queue*d commands inside the block, wrapping them
-in a deploy script, then *queue*ing them back in.
-
-How deploying works
--------------------
-
-Here is an example of a deploy! (Note that some commands have been simplified
-to illustrate the point better.)
-
-### Step 1: Build it
-
-The deploy process builds a new temp folder with instructions you provide.
-In this example, it will do `git:clone` and `bundle:install`.
-
-```
-$ mina deploy --verbose
------> Creating the build path
-       $ mkdir tmp/build-128293482394
------> Cloning the Git repository
-       $ git clone https://github.com/flipstack/flipstack.git . -n --recursive
-       Cloning... done.
------> Installing gem dependencies using Bundler
-       $ bundle install --without development:test
-       Using i18n (0.6.0)
-       Using multi_json (1.0.4)
-       ...
-       Your bundle is complete! It was installed to ./vendor/bundle
-```
-
-### Step 2: Move it to releases
-
-Once the project has been built, it will be moved to `releases/`. A symlink
-called `current/` will be created to point to the active release.
-
-```
------> Moving to releases/4
-       $ mv "./tmp/build-128293482394" "releases/4"
------> Symlinking to current
-       $ ln -nfs releases/4 current
-```
-
-### Step 3: Launch it
-
-Invoke the commands queued up in the `to :launch` block. These often
-commands to restart the webserver process. Once this in complete, you're done!
-
-```
------> Launching
-       $ cd releases/4
-       $ sudo service nginx restart
------> Done. Deployed v4
-```
-
-### What about failure?
-
-If it fails at any point, the release path will be deleted. If any commands are
-queued using the `to :clean` block, they will be ran. It will be as if nothing
-happened.
-
-```
-# Lets see what happens if a build fails:
------> Launching
-       $ cd releases/4
-       $ sudo service nginx restart
-       Starting nginx... error: can't start service
------> ERROR: Deploy failed.
------> Cleaning up build
-       $ rm -rf tmp/build-128293482394
------> Unlinking current
-       $ ln -nfs releases/3 current
-       OK
-```
-
-Directory structure
--------------------
-
-The deploy procedures make the assumption that you have a folder like so:
-
-    /var/www/flipstack.com/     # The deploy_to path
-     |-  releases/              # Holds releases, one subdir per release
-     |   |- 2012-06-12-838948
-     |   |- 2012-06-23-034828
-     |   '- ...
-     |-  shared/                # Holds files shared between releases
-     |   |- logs/               # Log files are usually stored here
-     |   `- ...
-     '-  current/               # A symlink to the current release in releases/
-
-It also assumes that the `deploy_to` path is fully writeable/readable for the
-user we're going to SSH with.
-
-Configuring settings
---------------------
-
-Settings are managed using the `set` and `settings` methods. This convention is
-inspired by Sinatra and Vlad.
-
-``` ruby
-set :version, "v2.0.5"
-
-settings.version    #=> "v2.0.5"
-settings.version?   #=> true
-```
-
-You can also retrieve settings without the `settings.` prefix.
-
-``` ruby
-set :version, "v2.0.5"
-
-version    #=> "v2.0.5"
-version?   #=> true
-```
-
-### Dynamic values
-
-You can also give settings using a lambda. When the setting is retrieved, it
-will be evaluated.
-
-``` ruby
-set :tag, lambda { "release/#{version}" }
-set :version, "v2.0.5"
-
-tag    #=> "release/v2.0.5"
-```
-
-### Inside and outside tasks
-
-All of these are accessible inside and outside tasks.
-
-``` ruby
-set :admin_email, "johnsmith@gmail.com"
-
-task :email do
-  set :message, "Deploy is done"
-
-  system "echo #{message} | mail #{admin_email}"
-end
-```
-
-### Validations
-
-If you would like an error to be thrown if a setting is not present, add a bang
-at the end.
-
-``` ruby
-task :restart do
-  queue "#{settings.nginx_path!}/sbin/nginx restart"
-end
-
-# $ mina restart
-# Error: You must set the :nginx_path setting
-```
-
-Defaults
---------
-
-There are a few deploy-related tasks and settings that are on by default.
-
-### Base settings
-
-* `verbose_mode` - True if the `--verbose` flag is on, false otherwise. Used to
-  signal if commands are to be shown.
-
-* `simulate_mode` - True if `--simulate` flag is on, false otherwise. Used to
-  signal if no SSH connections are to be made, and the scripts will just be
-  printed locally.
-
-* `term_mode` - If set to `:pretty`, prettifies the output with indentations.
-  (Default with deploys.)
-
-### SSH settings
-
-* `domain` - Hostname to SSH to. *Required.*
-
-* `user` - Username to connect to SSH with. Optional.
-
-* `identity_file` - Local path to the SSH key to use. Optional.
-
-``` ruby
-# Example:
-set :domain, 'flipstack.me'
-set :user, 'flipstack_www'
-set :identity_file, 'flipstack.pem'
-```
-
-### Deploy settings
-
-* `deploy_to` - Path to deploy to. *Required.*
-
-* `releases_path` - The path to where releases are kept. Defaults to
-  `releases`.
-
-* `shared_path` - Where shared files are kept. Defaults to
-  `shared`.
-
-* `current_path` - The path to the symlink to the current release. Defaults to
-  `current`.
-
-* `lock_file` - The deploy lock file. A deploy does not start if this file is
-  found. Defaults to `deploy.lock`.
-
-
-``` ruby
-# Example:
-set :deploy_to, '/var/www/flipstack.me'
-set :releases_path, 'releases'
-set :shared_path, 'shared'
-set :current_path, 'current'
-set :lock_file, 'deploy.lock'
-
-# This means the following paths will be
-# created on `mina setup`:
-#    /var/www/flipstack.me/
-#    /var/www/flipstack.me/releases/
-#    /var/www/flipstack.me/shared/
-```
-
-### Task - setup
-
-Prepares the `deploy_to` directory for deployments. Sets up subdirectories and
-sets permissions in the path.
-
-    $ mina setup
-    -----> Setting up
-           $ mkdir -p /var/www/kickstack.me
-           $ chmod g+r,a+rwx /var/www/kickstack.me
-           $ mkdir -p /var/www/kickstack.me/releases
-           $ mkdir -p /var/www/kickstack.me/shared
-           ...
-
-### Task - deploy:force_unlock
-
-Removes the deploy lock file. If a deploy is terminated midway, it may leave a
-lock file to signal that deploys shouldn't be made. This forces the removal of
-that lock file.
-
-    $ mina deploy
-    -----> ERROR: another deployment is ongoing.
-           Delete the lock file to continue.
-
-    $ mina deploy:force_unlock
-    -----> Unlocking
-           $ rm /var/www/kickstack.me/deploy.lock
-
-    $ mina deploy
-    # The deploy should proceed now
-
-Addons: Git
------------
-
-To deploy projects using git, add this to your `deploy.rb`:
-
-``` ruby
-require 'mina/git'
-
-set :repository, 'https://github.com/you/your-app.git'
-```
-
-### Settings
-
-This introduces the following settings:
-
-* `repository` - The repository path to clone from. *Required.*
-
-* `revision` - The SHA1 of the commit to be deployed. Defaults to whatever is
-the current HEAD in your local copy.
-
-### Task - git:clone
-
-Clones from the repo into the current folder.
-
-Addons: Bundler
----------------
-
-To manage Bundler installations, add this to your `deploy.rb`:
-
-``` ruby
-require 'mina/bundler'
-```
-
-### Settings
-
-This introduces the following settings:
-
-* `bundle_path` - The path where bundles are going to be installed. Defaults to
-`./vendor/bundler`.
-
-* `bundle_options` - Options that will be passed onto `bundle install`.  
-  Defaults to
-`--without development:test --path "#{bundle_path}" --binstubs bin/
---deployment"`.
-
-### Task - bundle:install
-
-Invokes `bundle:install` on the current directory, creating the bundle
-path (specified in `bundle_path`), and invoking `bundle install`.
-
-The `bundle_path` is only created if `bundle_path` is set (which is on
-by default).
-
-Addons: Rails
+Documentation
 -------------
 
-To manage Rails project installations, add this to your `deploy.rb`:
-
-``` ruby
-require 'mina/rails'
-```
-
-### Settings
-
-This introduces the following settings. All of them are optional.
-
- * `bundle_prefix` - Prefix to run commands via Bundler. Defaults to
- `RAILS_ENV="#{rails_env}" bundle exec`.
-
- * `rake` - The `rake` command. Defaults to `#{bundle_prefix} rake`.
-
- * `rails` - The `rails` command. Defaults to `#{bundle_prefix} rails`.
-
- * `rails_env` - The environment to run rake commands in. Defaults to
- `production`.
+Please consult the [project documentation](http://nadarei.co/mina) for full
+details.
 
-### Task - rails:db_migrate
-
-Invokes rake to migrate the database using `rake db:migrate`.
-
-### Task - rails:assets_precompile
-
-Precompiles assets. This invokes `rake assets:precomplie`.
-
-It also checks the current version to see if it has assets compiled. If it does,
-it reuses them, skipping the compilation step. To stop this behavior, invoke
-the `mina` command with `force_assets=1`.
-
-### Task - rails:assets_precompile:force
-
-Precompiles assets. This always skips the "reuse old assets if possible" step.
+Problems or suggestions? File issues at the [issue tracker][issues]
+(github.com).  You may also look at the [Trello board][trello] (trello.com) we
+use for development.
 
 Development & testing
 ---------------------
@@ -574,20 +52,20 @@ Try out the test environment:
 
     # To release the gem:
     # Install the Git changelog helper: https://gist.github.com/2880525
+    # Then:
+
     $ vim lib/mina/version.rb
     $ git clog -w
     $ vim HISTORY.md
+    $ git commit -m "Release v0.8.4."
     $ rake release
 
+    # Please don't forget to tag the release in github.com/nadarei/mina-docs
+    too!
+
     $ rake build      # Builds the gem file
     $ rake install    # Installs the gem locally
 
-Issues
-------
-
-File issues at the [issue tracker][issues] (github.com). You may also look at
-the [Trello board][trello] (trello.com) we use for development.
-
 Acknowledgements
 ----------------
 

data/Rakefile

@@ -1,30 +1,6 @@
 require 'bundler'
 require 'bundler/gem_tasks'
 
-# Do these:
-#
-#     *do `gem install reacco`
-#     * install http://github.com/rstacruz/git-update-ghpages
-
-ENV['github'] ||= 'nadarei/mina'
-
-namespace :doc do
-
-  task :build do
-    cmd = "reacco --literate --toc --github #{ENV['github']}"
-    cmd << " --analytics=#{ENV['analytics_id']}" if ENV['analytics_id']
-
-    system cmd
-    raise "Failed" unless $?.to_i == 0
-  end
-
-
-  desc "Updates online documentation"
-  task :deploy => :build do
-    system "git update-ghpages #{ENV['github']} -i doc"
-  end
-end
-
 task :spec do
   system "rm Gemfile.lock; sh -c 'rake=0.8 bundle exec rspec'"
   system "rm Gemfile.lock; sh -c 'rake=0.9 bundle exec rspec'"

data/lib/mina/default.rb

@@ -1,4 +1,4 @@
-set_default :term_mode, nil
+set_default :bash_options, '-i'
 
 # Default tasks here
 desc "Creates a sample config file."

data/lib/mina/deploy_helpers.rb

@@ -1,18 +1,24 @@
 module Mina
+  # Helpers for deployment
   module DeployHelpers
-    # Wraps the things inside it in a deploy script, and queues it.
+    #  Wraps the things inside it in a deploy script and queues it.
     # This generates a script using deploy_script and queues it.
+    #
+    # Returns nothing.
+    #
     def deploy(&blk)
       queue deploy_script(&blk)
     end
 
     # Wraps the things inside it in a deploy script.
     #
-    #     script = deploy_script do
-    #       invoke :'git:checkout'
-    #     end
+    #   script = deploy_script do
+    #     invoke :'git:checkout'
+    #   end
+    #
+    #   queue script
     #
-    #     queue script
+    # Returns the deploy script as a string, ready for `queue`ing.
     #
     def deploy_script(&blk)
       set_default :term_mode, :pretty

data/lib/mina/helpers.rb

@@ -1,11 +1,30 @@
 module Mina
+  # Helpers
   module Helpers
+
     # Invokes another Rake task.
+    #
+    # Invokes the task given in `task`. Returns nothing.
+    #
+    #     invoke :'git:clone'
+    #     invoke :restart
+    #
     def invoke(task)
       Rake.application.invoke_task task
     end
 
-    # Evaluates an ERB block and returns a string.
+    # Evaluates an ERB block in the current scope and returns a string.
+    #
+    #     a = 1
+    #     b = 2
+    #
+    #     # Assuming foo.erb is <%= a %> and <%= b %>
+    #     puts erb('foo.erb')
+    #
+    #     #=> "1 and 2"
+    #
+    # Returns the output string of the ERB template.
+    #
     def erb(file, b=binding)
       require 'erb'
       erb = ERB.new(File.read(file))
@@ -20,15 +39,24 @@ module Mina
     #     queue "sudo restart"
     #     run!
     #
+    # Returns nothing.
+    #
     def run!
       ssh commands(:default)
     end
 
     # Executes a command via SSH.
     #
-    # Options:
+    # Returns nothing usually, but if `{ return: true }` is given, returns the
+    # STDOUT output of the SSH session.
+    #
+    # options  - Hash of options.
+    #            :pretty  - Prettify the output.
+    #            :return  - If set to true, returns the output.
+    #
+    # Example
     #
-    #     pretty:    Prettify the output.
+    #     ssh("ls", return: true)
     #
     def ssh(cmd, options={})
       cmd = cmd.join("\n")  if cmd.is_a?(Array)
@@ -36,16 +64,30 @@ module Mina
       require 'shellwords'
 
       result = 0
-      if simulate_mode
+      script = Shellwords.escape("true;"+cmd)
+
+      if options[:return] == true
+        result = `#{ssh_command} -- bash -c #{script}`
+
+      elsif simulate_mode?
+        str = "Executing the following via '#{ssh_command}':"
+        puts "#!/usr/bin/env bash"
+        puts "# #{str}"
+        puts "# " + ("-" * str.size)
+        puts "#"
+
         puts cmd
+
       elsif settings.term_mode == :pretty
-        code = "#{ssh_command} -- bash -c %s" % [ Shellwords.escape("true;"+cmd) ]
+        code = "#{ssh_command} -- bash #{bash_options} -c #{script}"
         result = pretty_system("#{code} 2>&1")
+
       elsif settings.term_mode == :exec
-        code = "#{ssh_command} -t -- bash -c %s" % [ Shellwords.escape("true;"+cmd) ]
+        code = "#{ssh_command} -t -- bash #{bash_options} -c #{script}"
         exec code
+
       else
-        code = "#{ssh_command} -t -- bash -c %s" % [ Shellwords.escape("true;"+cmd) ]
+        code = "#{ssh_command} -t -- bash #{bash_options} -c #{script}"
         system code
         result = $?
       end
@@ -63,6 +105,7 @@ module Mina
     #
     #     set :domain, 'foo.com'
     #     set :user, 'diggity'
+    #
     #     puts ssh_command
     #     #=> 'ssh diggity@foo.com'
     #
@@ -70,15 +113,21 @@ module Mina
       args = domain!
       args = "#{user}@#{args}" if user?
       args << " -i #{identity_file}" if identity_file?
+      args << " -t"
       "ssh #{args}"
     end
 
-    # Works like 'system', but indents and puts color.
+    # Internal: Works like 'system', but indents and puts color.
+    #
     # Returns the exit code in integer form.
+    #
     def pretty_system(code)
+      require 'shellwords'
+      cmds = Shellwords.shellsplit(code)
+      cmds << "2>&1"
+
       status =
-        Tools.popen4('bash', '-') do |pid, i, o, e|
-          i.write "( #{code} ) 2>&1\n"
+        Tools.popen4(*cmds) do |pid, i, o, e|
           i.close
 
           last = nil
@@ -121,9 +170,12 @@ module Mina
     end
 
     # Queues code to be ran.
+    #
     # This queues code to be ran to the current code bucket (defaults to `:default`).
     # To get the things that have been queued, use commands[:default]
     #
+    # Returns nothing.
+    #
     #     queue "sudo restart"
     #     queue "true"
     #
@@ -134,6 +186,18 @@ module Mina
       commands(@to) << unindent(code)
     end
 
+    # Internal: Normalizes indentation on a given string.
+    #
+    # Returns the normalized string without extraneous indentation.
+    #
+    #     puts unindent %{
+    #       Hello
+    #         There
+    #     }
+    #     # Output:
+    #     # Hello
+    #     #   There
+    #
     def unindent(code)
       if code =~ /^\n([ \t]+)/
         code = code.gsub(/^#{$1}/, '')
@@ -142,7 +206,11 @@ module Mina
       code.strip
     end
 
-    # Returns a hash of the code blocks where commands have been queued.
+    # Returns an array of queued code strings.
+    #
+    # You may give an optional `aspect`.
+    #
+    # Returns an array of strings.
     #
     #     queue "sudo restart"
     #     queue "true"
@@ -163,16 +231,18 @@ module Mina
 
     # Starts a new block where new #commands are collected.
     #
-    #     queue "sudo restart"
-    #     queue "true"
-    #     commands.should == ['sudo restart', 'true']
+    # Returns nothing.
     #
-    #     isolate do
-    #       queue "reload"
-    #       commands.should == ['reload']
-    #     end
+    #   queue "sudo restart"
+    #   queue "true"
+    #   commands.should == ['sudo restart', 'true']
     #
-    #     commands.should == ['sudo restart', 'true']
+    #   isolate do
+    #     queue "reload"
+    #     commands.should == ['reload']
+    #   end
+    #
+    #   commands.should == ['sudo restart', 'true']
     #
     def isolate(&blk)
       old, @commands = @commands, nil
@@ -184,6 +254,8 @@ module Mina
     # Defines instructions on how to do a certain thing.
     # This makes the commands that are `queue`d go into a different bucket in commands.
     #
+    # Returns nothing.
+    #
     #     to :prepare do
     #       run "bundle install"
     #     end
@@ -202,6 +274,9 @@ module Mina
     end
 
     # Sets settings.
+    # Sets given symbol `key` to value in `value`.
+    #
+    # Returns the value.
     #
     #     set :domain, 'kickflip.me'
     #
@@ -210,6 +285,9 @@ module Mina
     end
 
     # Sets default settings.
+    # Sets given symbol `key` to value in `value` only if the key isn't set yet.
+    #
+    # Returns the value.
     #
     #     set_default :term_mode, :pretty
     #     set :term_mode, :system
@@ -235,6 +313,9 @@ module Mina
 
     # Hook to get settings.
     # See #settings for an explanation.
+    #
+    # Returns things.
+    #
     def method_missing(meth, *args, &blk)
       settings.send meth, *args
     end
@@ -247,21 +328,37 @@ module Mina
       $stderr.write "#{str}\n"
     end
 
+    # Converts a bash command to a command that echoes before execution.
+    # Used to show commands in verbose mode. This does nothing unless verbose mode is on.
+    #
+    # Returns a string of the compound bash command, typically in the format of
+    # `echo xx && xx`. However, if `verbose_mode?` is false, it returns the
+    # input string unharmed.
+    #
+    #     echo_cmd("ln -nfs releases/2 current")
+    #     #=> echo "$ ln -nfs releases/2 current" && ln -nfs releases/2 current
+    #
     def echo_cmd(str)
-      if verbose_mode
+      if verbose_mode?
         "echo #{("$ " + str).inspect} &&\n#{str}"
       else
         str
       end
     end
 
-    # Invoked when Rake exits.
+    # Internal: Invoked when Rake exits.
+    #
+    # Returns nothing.
+    #
     def mina_cleanup!
       run! if commands.any?
     end
 
     # Checks if Rake was invoked with --verbose.
-    def verbose_mode
+    #
+    # Returns true or false.
+    #
+    def verbose_mode?
       if Rake.respond_to?(:verbose)
         # Rake 0.9.x
         Rake.verbose == true
@@ -271,7 +368,11 @@ module Mina
       end
     end
 
-    def simulate_mode
+    # Checks if Rake was invoked with --simulate.
+    #
+    # Returns true or false.
+    #
+    def simulate_mode?
       !! ENV['simulate']
     end
   end

data/lib/mina/tools.rb

@@ -3,6 +3,7 @@ module Mina
     if IO.respond_to?(:popen4)
       def self.popen4(*cmd, &blk)
         IO.popen4 *cmd, &blk
+        $?
       end
     else
       def self.popen4(*cmd, &blk)

data/lib/mina/version.rb

@@ -1,5 +1,5 @@
 module Mina
   def self.version
-    "0.1.1"
+    "0.1.2.pre1"
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: mina
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2.pre1
+  prerelease: 6
 platform: ruby
 authors:
 - Rico Sta. Cruz
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000 Z
+date: 2012-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70204554987380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70204554987380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: &70204554986960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70204554986960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70204554986540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +54,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204554986540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Really fast deployer and server automation tool.
 email:
 - rico@nadarei.co
@@ -109,12 +124,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Really fast deployer and server automation tool.