mina 0.2.0.pre2 → 0.2.0

data/.gitignore

@@ -3,3 +3,4 @@ test_env/deploy
 .rvmrc
 Gemfile.lock
 pkg/
+docs

data/HISTORY.md

@@ -1,5 +1,5 @@
-v0.2.0 - Unreleased
--------------------
+v0.2.0
+------
 
 This release had two pre releases:
 
@@ -7,6 +7,12 @@ This release had two pre releases:
   * v0.1.3.pre1 (Jul 13, 2012)
 
 ### Fixed:
+  * Allow changing `:term_mode` in the setup task. (#51, @alfuken)
+  * Prevent `git log` from using a pager. (#42, @tmak)
+  * `deploy:cleanup` can now be called in a deploy script. (#50, @dariocravero)
+  * Don't invoke bash anymore (!), assume that bash is the shell for the user.
+    Fixes Ubuntu 12, and many other things.
+  * Fixed `ssh(cmd, return: true)` that used to exit. (#53 from @jpascal)
   * [pre2] Call ssh with no double use `-t` parameter.
   * [pre2] Fix Ruby 1.8 compatibility.
   * [pre2] Fix the "undefined method > for Process::Status" error.
@@ -16,6 +22,13 @@ This release had two pre releases:
   * [pre1] Doing `rails:assets_precompile` now properly skips asset compilation if not needed. (#25)
 
 ### Added:
+  * __Added the 'queue!' helper.__
+  * Add support for __Whenever__. (#47, @jpascal)
+  * Add a new `:environment` task that gets loaded on setup/deploy.
+  * __Add explicit support for rbenv/rvm.__ (#5, #39)
+    * Implement :'rvm:use[...]'. (#5, #39)
+    * Implement :'rbenv:load'. (#5, #39)
+  * Revert `rails:optimize_for_3.2` from the pre2 release. (#32)
   * [pre2] __Optimize git:clone by caching the repository.__ This way, updates are
     faster because not the entire repo is cloned everytime. (#10)
   * [pre2] __Show elapsed time that a deploy takes.__
@@ -24,7 +37,7 @@ This release had two pre releases:
   * [pre2] New `die` helper.
   * [pre2] New `report_time` helper.
   * [pre2] New `to_directory` helper. (#35)
-  * [pre2] Put optional optimizations for Rails 3.2 asset pipeline. (#32)
+  * [pre2] Put optional optimizations for Rails 3.2 asset pipeline. (#32) -- reverted
   * Update sample deploy script:
     - [pre2] Update default deploy.rb to note :branch.
     - [pre2] Add `link_shared_paths` to the sample deploy script.
@@ -33,6 +46,15 @@ This release had two pre releases:
   * [pre1] Make asset paths configurable using the `asset_paths` setting.
 
 ### Changed:
+  * Force removal of shared path destinations before linking with
+    `deploy:link_shared_paths`. Fixes symlinking of `log/` in Rails projects.
+  * __Rails: speed up default asset compilation a bit by invoking
+    `assets:precompile` with `RAILS_GROUPS=assets`.__
+  * Add helpful error message when there is a problem with
+    deploy.rb or a custom Rakefile. (#37, @sge-jesse-adams)
+  * Update the default deploy.rb to add notes about 'mina setup' customizations.
+  * Make `mina run`, `mina rake`, `mina console` use the new `:environment` task.
+  * Allow calling `die` without arguments.
   * [pre2] __Improve output of `mina init`.__
   * [pre2] Prettier output for `mina setup`. Also, show a better error message for it.
   * [pre1] Refactor pretty printing to be simpler, cleaner, and extensible.

data/Rakefile

@@ -1,9 +1,20 @@
 require 'bundler'
 require 'bundler/gem_tasks'
 
+github = ENV['github'] || 'nadarei/mina'
+
 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'"
 end
 
+task :docs do
+  files = ['manual/index.md', 'manual/modules.md', 'HISTORY.md'] + Dir['lib/**/*.rb']
+  system "lidoc #{files.join ' '} -o docs --github #{github}"
+end
+
+task :'docs:deploy' => :docs do
+  system "git-update-ghpages #{github} -i docs -p docs"
+end
+
 task :default => :spec

data/bin/mina

@@ -42,7 +42,12 @@ Rake.application.instance_eval do
       require 'mina/rake'
 
       # Allow running without a Rakefile
-      load_rakefile  if have_rakefile || custom_rakefile
+      begin
+        load_rakefile  if have_rakefile || custom_rakefile
+      rescue Exception
+        puts "Error loading Rakefile!"
+        raise "There may be a problem with config/deploy.rb and/or Rakefile"
+      end
 
       # Run tasks
       top_level

data/data/deploy.rb

@@ -1,13 +1,8 @@
-# For help in making your deploy script, see the Mina documentation:
-#
-#  - http://nadarei.co/mina
-#  - http://nadarei.co/mina/tasks
-#  - http://nadarei.co/mina/settings
-#  - http://nadarei.co/mina/helpers
-
 require 'mina/bundler'
 require 'mina/rails'
 require 'mina/git'
+# require 'mina/rbenv'  # for rbenv support. (http://rbenv.org)
+# require 'mina/rvm'    # for rvm support. (http://rvm.io)
 
 # Basic settings:
 #   domain       - The hostname to SSH to.
@@ -22,19 +17,40 @@ set :branch, 'master'
 
 # Manually create these paths in shared/ (eg: shared/config/database.yml) in your server.
 # They will be linked in the 'deploy:link_shared_paths' step.
-set :shared_paths, ['config/database.yml']
+set :shared_paths, ['config/database.yml', 'log']
 
 # Optional settings:
 #   set :user, 'foobar'    # Username in the server to SSH to.
 #   set :port, '30000'     # SSH port number.
 
+# This task is the environment that is loaded for most commands, such as
+# `mina deploy` or `mina rake`.
+task :environment do
+  # If you're using rbenv, use this to load the rbenv environment.
+  # Be sure to commit your .rbenv-version to your repository.
+  # invoke :'rbenv:load'
+
+  # For those using RVM, use this to load an RVM version@gemset.
+  # invoke :'rvm:use[ruby-1.9.3-p125@default]'
+end
+
+# Put any custom mkdir's in here for when `mina setup` is ran.
+# For Rails apps, we'll make some of the shared paths that are shared between
+# all releases.
+task :setup => :environment do
+  queue! %[mkdir -p "#{deploy_to}/shared/log"]
+  queue! %[chmod g+rx,u+rwx "#{deploy_to}/shared/log"]
+
+  queue! %[mkdir -p "#{deploy_to}/shared/config"]
+  queue! %[chmod g+rx,u+rwx "#{deploy_to}/shared/config"]
+
+  queue! %[touch "#{deploy_to}/shared/config/database.yml"]
+  queue  %[-----> Be sure to edit 'shared/config/database.yml'.]
+end
+
 desc "Deploys the current version to the server."
-task :deploy do
+task :deploy => :environment do
   deploy do
-    # This makes asset compilation faster in Rails 3.2 -- remove this for other
-    # Rails versions.
-    invoke :'rails:optimize_for_3.2'
-
     # Put things that will set up an empty directory into a fully set-up
     # instance of your project.
     invoke :'git:clone'
@@ -48,3 +64,11 @@ task :deploy do
     end
   end
 end
+
+# For help in making your deploy script, see the Mina documentation:
+#
+#  - http://nadarei.co/mina
+#  - http://nadarei.co/mina/tasks
+#  - http://nadarei.co/mina/settings
+#  - http://nadarei.co/mina/helpers
+

data/lib/mina/bundler.rb

@@ -1,9 +1,36 @@
+# # Modules: Bundler
+# Adds settings and tasks for managing Ruby Bundler.
+#
+#     require 'mina/bundler'
 
-settings.bundle_bin ||= 'bundle'
-settings.bundle_path ||= './vendor/bundle'
-settings.bundle_options ||= lambda { %{--without development:test --path "#{bundle_path}" --binstubs bin/ --deployment} }
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### bundle_bin
+# Sets the bundle path.
+
+set_default :bundle_bin, 'bundle'
+
+# ### bundle_path
+# Sets the path to where the gems are expected to be.
+#
+# This path will be symlinked to `./shared/bundle` so that the gems cache will
+# be shared between all releases.
+
+set_default :bundle_path, './vendor/bundle'
+
+# ### bundle_options
+# Sets the options for installing gems via Bundler.
+
+set_default :bundle_options, lambda { %{--without development:test --path "#{bundle_path}" --binstubs bin/ --deployment} }
+
+# ## Deploy tasks
+# These tasks are meant to be invoked inside deploy scripts, not invoked on
+# their own.
 
 namespace :bundle do
+  # ### bundle:install
+  # Installs gems.
   desc "Install gem dependencies using Bundler."
   task :install do
     queue %{

data/lib/mina/default.rb

@@ -1,8 +1,25 @@
+# # Modules: Default
+# This module is loaded when invoking `mina` with or without a project.
+
 set_default :bash_options, '-i'
 
-# Default tasks here
+# ## Tasks
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### environment
+# Make the `:environment` task exist by default. This is meant to be overridden
+# by users.
+
+task :environment do
+end
+
+# ### init
+# Initializes a new Mina project.
+#
+#     $ mina init
+
 desc "Creates a sample config file."
-task :init do
+task :init => :environment do
   name = Rake.application.name
   config_file = Rake.application.rakefile
 
@@ -63,6 +80,9 @@ end
 
 extend HelpHelpers
 
+# ### help
+# Shows the help screen.
+
 desc "Show help."
 task :help do
   name = Rake.application.name
@@ -93,6 +113,11 @@ task :help do
   puts "for more information."
 end
 
+# ### tasks
+# Display all tasks in a nice table.
+#
+#     $ mina tasks
+
 desc "Show all tasks."
 task :tasks do
   show_task_help :full => true

data/lib/mina/deploy.rb

@@ -1,3 +1,9 @@
+# # Modules: Deployment
+# This module is automatically loaded for all Mina projects.
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
 set_default :releases_path, "releases"
 set_default :shared_path, "shared"
 set_default :current_path, "current"
@@ -5,12 +11,26 @@ set_default :lock_file, "deploy.lock"
 set_default :keep_releases, 5
 
 namespace :deploy do
+  # ## Tasks
+
+  # ### deploy:force_unlock
+  # Forces a deploy unlock by deleting the lock file.
+  #
+  #     $ mina deploy:force_unlock
+  #
+  # You can also combine that task with `deploy`:
+  #
+  #     $ mina deploy:force_unlock deploy
+
   desc "Forces a deploy unlock."
   task :force_unlock do
     queue %{echo "-----> Unlocking"}
     queue echo_cmd %{rm -f "#{deploy_to}/#{lock_file}"}
   end
 
+  # ### deploy:link_shared_paths
+  # Links the shared paths in the `shared_paths` setting.
+
   desc "Links paths set in :shared_paths."
   task :link_shared_paths do
     dirs = settings.shared_paths!.map { |file| File.dirname("./#{file}") }.uniq
@@ -20,31 +40,43 @@ namespace :deploy do
     end
 
     cmds += shared_paths.map do |file|
-      echo_cmd %{ln -s "#{deploy_to}/#{shared_path}/#{file}" "./#{file}"}
+      [
+        echo_cmd(%{rm -rf "./#{file}"}),
+        echo_cmd(%{ln -s "#{deploy_to}/#{shared_path}/#{file}" "./#{file}"})
+      ]
     end
 
     queue %{
       echo "-----> Symlinking shared paths"
-      #{cmds.join(" &&\n")}
+      #{cmds.flatten.join(" &&\n")}
     }
   end
 
-  desc "Clean up old releases. By default, the last 5 releases are kept on
-    each server (though you can change this with the keep_releases setting).
-    All other deployed revisions are removed from the servers."
+  # ### deploy:cleanup
+  # Cleans up old releases.
+  #
+  # By default, the last 5 releases are kept on each server (though you can
+  # change this with the keep_releases setting).  All other deployed revisions
+  # are removed from the servers."
+
+  desc "Clean up old releases."
   task :cleanup do
-    queue %{echo "-----> Cleaning up old releases (keeping #{keep_releases!})"}
-    queue echo_cmd %{cd "#{deploy_to!}" || exit 15}
-    queue echo_cmd %{cd "#{releases_path!}" || exit 16}
-    queue echo_cmd %{count=`ls -1d [0-9]* | sort -rn | wc -l`}
-    queue echo_cmd %{remove=$((count > 5 ? count - #{keep_releases} : 0))}
-    queue echo_cmd %{ls -1d [0-9]* | sort -rn | tail -n $remove | xargs rm -rf {}}
+    queue %{
+      echo "-----> Cleaning up old releases (keeping #{keep_releases!})"
+      #{echo_cmd %{cd "#{deploy_to!}/#{releases_path!}" || exit 15}}
+      #{echo_cmd %{count=`ls -1d [0-9]* | sort -rn | wc -l`}}
+      #{echo_cmd %{remove=$((count > 5 ? count - #{keep_releases} : 0))}}
+      #{echo_cmd %{ls -1d [0-9]* | sort -rn | tail -n $remove | xargs rm -rf {}}}
+    }
   end
 end
 
+# ### setup
+# Sets up a site's directory structure.
+
 desc "Sets up a site."
 task :setup do
-  set :term_mode, :pretty
+  set_default :term_mode, :pretty
 
   settings.deploy_to!
 
@@ -73,8 +105,13 @@ task :setup do
   }
 end
 
+# ### run[]
+# Runs a command on a server.
+#
+#     $ mina run[tail -f logs.txt]
+
 desc "Runs a command in the server."
-task :run, :command do |t, args|
+task :run, [:command] => [:environment] do |t, args|
   command = args[:command]
   unless command
     puts %[You need to provide a command. Try: mina "run[ls -la]"]

data/lib/mina/deploy_helpers.rb

@@ -1,7 +1,9 @@
+# # Helpers: Deploy helpers
+# Helpers for deployment.
 module Mina
-  # Helpers for deployment
   module DeployHelpers
-    #  Wraps the things inside it in a deploy script and queues it.
+    # ### deploy
+    # Wraps the things inside it in a deploy script and queues it.
     # This generates a script using deploy_script and queues it.
     #
     # Returns nothing.
@@ -10,6 +12,7 @@ module Mina
       queue deploy_script(&blk)
     end
 
+    # ### deploy_script
     # Wraps the things inside it in a deploy script.
     #
     #   script = deploy_script do

data/lib/mina/git.rb

@@ -1,6 +1,23 @@
-settings.branch ||= "master"
+# # Modules: Git
+# Adds settings and tasks related to managing Git.
+#
+#     require 'mina/git'
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### branch
+# Sets the branch to be deployed.
+
+set_default :branch, "master"
 
 namespace :git do
+  # ## Deploy tasks
+  # These tasks are meant to be invoked inside deploy scripts, not invoked on
+  # their own.
+
+  # ### git:clone
+  # Clones the Git repository. Meant to be used inside a deploy script.
   desc "Clones the Git repository to the release path."
   task :clone do
     if revision?
@@ -32,7 +49,7 @@ namespace :git do
     status = %[
       echo "-----> Using this git commit" &&
       echo &&
-      #{echo_cmd %[git log --format="%aN (%h):%n> %s" -n 1]} &&
+      #{echo_cmd %[git --no-pager log --format="%aN (%h):%n> %s" -n 1]} &&
       #{echo_cmd %[rm -rf .git]} &&
       echo
     ]

data/lib/mina/helpers.rb

@@ -1,7 +1,8 @@
+# # Helpers: Default helpers
 module Mina
-  # Helpers
   module Helpers
 
+    # ### invoke
     # Invokes another Rake task.
     #
     # Invokes the task given in `task`. Returns nothing.
@@ -13,6 +14,7 @@ module Mina
       Rake.application.invoke_task task
     end
 
+    # ### erb
     # Evaluates an ERB block in the current scope and returns a string.
     #
     #     a = 1
@@ -31,6 +33,7 @@ module Mina
       erb.result b
     end
 
+    # ### run!
     # SSHs into the host and runs the code that has been queued.
     #
     # This is already automatically invoked before Rake exits to run all
@@ -45,6 +48,7 @@ module Mina
       report_time { ssh commands(:default) }
     end
 
+    # ### report_time
     # Report time elapsed in the block.
     # Returns the output of the block.
     def report_time(&blk)
@@ -53,6 +57,7 @@ module Mina
       output
     end
 
+    # ### measure
     # Measures the time (in ms) a block takes.
     # Returns a [time, output] tuple.
     def measure(&blk)
@@ -61,14 +66,19 @@ module Mina
       [(Time.now - t).to_i, output]
     end
 
+    # ## SSH helpers
+    # You don't need to invoke these helpers, they're already invoked automatically.
+
+    # ### ssh
     # Executes a command via SSH.
     #
     # 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.
+    # `options` is a hash of options:
+    #
+    #  - `:pretty` - Prettify the output if true.
+    #  - `:return`  - If set to true, returns the output.
     #
     # Example
     #
@@ -80,10 +90,10 @@ module Mina
       require 'shellwords'
 
       result = 0
-      script = Shellwords.escape("true;"+cmd)
+      script = Shellwords.escape(cmd)
 
       if options[:return] == true
-        result = `#{ssh_command} -- bash -c #{script}`
+        result = `#{ssh_command} -- #{script}`
 
       elsif simulate_mode?
         str = "Executing the following via '#{ssh_command}':"
@@ -94,7 +104,7 @@ module Mina
         puts cmd
 
       else
-        code = "#{ssh_command} -- bash #{bash_options} -c #{script}"
+        code = "#{ssh_command} -- #{script}"
         if settings.term_mode == :pretty
           result = pretty_system(code)
         elsif settings.term_mode == :exec
@@ -105,24 +115,11 @@ module Mina
         end
       end
 
-      die result if result > 0
+      die result if result.is_a? Fixnum && result > 0
       result
     end
 
-    # Exits with a nice looking message.
-    # Returns nothing.
-    #
-    #     die 2
-    #     die 2, "Tests failed"
-    #
-    def die(code, msg=null)
-      str = "Failed with status #{code}"
-      str += " (#{msg})" if msg
-      err = Failed.new(str)
-      err.exitstatus = code
-      raise err
-    end
-
+    # ### ssh_command
     # Returns the SSH command to be executed.
     #
     #     set :domain, 'foo.com'
@@ -140,6 +137,42 @@ module Mina
       "ssh #{args}"
     end
 
+    # ### mina_cleanup
+    # __Internal:__ Invoked when Rake exits.
+    #
+    # Returns nothing.
+    #
+    def mina_cleanup!
+      run! if commands.any?
+    end
+
+    # ## Errors
+
+    # ### die
+    # Exits with a nice looking message.
+    # Returns nothing.
+    #
+    #     die 2
+    #     die 2, "Tests failed"
+    #
+    def die(code=1, msg=null)
+      str = "Failed with status #{code}"
+      str += " (#{msg})" if msg
+      err = Failed.new(str)
+      err.exitstatus = code
+      raise err
+    end
+
+    # ### error
+    # __Internal:__ Prints to stdout.
+    # Consider using `print_error` instead.
+    def error(str)
+      $stderr.write "#{str}\n"
+    end
+
+    # ## Queueing
+
+    # ### queue
     # Queues code to be ran.
     #
     # This queues code to be ran to the current code bucket (defaults to `:default`).
@@ -157,30 +190,35 @@ module Mina
       commands(@to) << unindent(code)
     end
 
-    # Internal: Normalizes indentation on a given string.
+    # ### queue!
+    # Shortcut for `queue`ing a command that shows up in verbose mode.
+
+    def queue!(code)
+      queue echo_cmd(code)
+    end
+
+    # ### echo_cmd
+    # 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 the normalized string without extraneous indentation.
+    # 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.
     #
-    #     puts unindent %{
-    #       Hello
-    #         There
-    #     }
-    #     # Output:
-    #     # Hello
-    #     #   There
+    #     echo_cmd("ln -nfs releases/2 current")
+    #     #=> echo "$ ln -nfs releases/2 current" && ln -nfs releases/2 current
     #
-    def unindent(code)
-      if code =~ /^\n([ \t]+)/
-        code = code.gsub(/^#{$1}/, '')
+    def echo_cmd(str)
+      if verbose_mode?
+        "echo #{Shellwords.escape("$ " + str)} &&\n#{str}"
+      else
+        str
       end
-
-      code.strip
     end
 
-    def reindent(n, code)
-      indent n, unindent(code)
-    end
+    # ## Commands
 
+    # ### commands
     # Returns an array of queued code strings.
     #
     # You may give an optional `aspect`.
@@ -204,20 +242,21 @@ module Mina
       end)[aspect]
     end
 
-    # Starts a new block where new #commands are collected.
+    # ### isolate
+    # Starts a new block where new `commands` are collected.
     #
     # Returns nothing.
     #
-    #   queue "sudo restart"
-    #   queue "true"
-    #   commands.should == ['sudo restart', 'true']
+    #     queue "sudo restart"
+    #     queue "true"
+    #     commands.should == ['sudo restart', 'true']
     #
-    #   isolate do
-    #     queue "reload"
-    #     commands.should == ['reload']
-    #   end
+    #     isolate do
+    #       queue "reload"
+    #       commands.should == ['reload']
+    #     end
     #
-    #   commands.should == ['sudo restart', 'true']
+    #     commands.should == ['sudo restart', 'true']
     #
     def isolate(&blk)
       old, @commands = @commands, nil
@@ -226,6 +265,7 @@ module Mina
       result
     end
 
+    # ### in_directory
     # Starts a new block where #commands are collected, to be executed inside `path`.
     #
     # Returns nothing.
@@ -263,6 +303,9 @@ module Mina
       @to = old
     end
 
+    # ## Settings helpers
+
+    # ### set
     # Sets settings.
     # Sets given symbol `key` to value in `value`.
     #
@@ -274,6 +317,7 @@ module Mina
       settings.send :"#{key}=", value
     end
 
+    # ### set_default
     # Sets default settings.
     # Sets given symbol `key` to value in `value` only if the key isn't set yet.
     #
@@ -291,9 +335,11 @@ module Mina
       settings.send :"#{key}=", value  unless settings.send(:"#{key}?")
     end
 
+    # ### settings
     # Accesses the settings hash.
     #
     #     set :domain, 'kickflip.me'
+    #
     #     settings.domain  #=> 'kickflip.me'
     #     domain           #=> 'kickflip.me'
     #
@@ -301,6 +347,7 @@ module Mina
       @settings ||= Settings.new
     end
 
+    # ### method_missing
     # Hook to get settings.
     # See #settings for an explanation.
     #
@@ -310,40 +357,9 @@ module Mina
       settings.send meth, *args
     end
 
-    def indent(count, str)
-      str.gsub(/^/, " "*count)
-    end
-
-    def error(str)
-      $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?
-        "echo #{("$ " + str).inspect} &&\n#{str}"
-      else
-        str
-      end
-    end
-
-    # Internal: Invoked when Rake exits.
-    #
-    # Returns nothing.
-    #
-    def mina_cleanup!
-      run! if commands.any?
-    end
+    # ## Command line mode helpers
 
+    # ### verbose_mode?
     # Checks if Rake was invoked with --verbose.
     #
     # Returns true or false.
@@ -358,6 +374,7 @@ module Mina
       end
     end
 
+    # ### simulate_mode?
     # Checks if Rake was invoked with --simulate.
     #
     # Returns true or false.
@@ -365,5 +382,41 @@ module Mina
     def simulate_mode?
       !! ENV['simulate']
     end
+
+    # ## Internal helpers
+
+    # ### indent
+    # Indents a given code block with `count` spaces before it.
+    def indent(count, str)
+      str.gsub(/^/, " "*count)
+    end
+
+    # ### unindent
+    # __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}/, '')
+      end
+
+      code.strip
+    end
+
+    # ### reindent
+    # Resets the indentation on a given code block.
+    def reindent(n, code)
+      indent n, unindent(code)
+    end
+
   end
 end

data/lib/mina/output_helpers.rb

@@ -1,35 +1,49 @@
+# # Helpers: Output helpers
+# Protip! make a module that overrides these settings, then use `extend YourModule`
+# to make your own pretty printing thing.
 module Mina
   module OutputHelpers
-    # Protip! make a module that overrides these settings, then use `extend YourModule`
-    # to make your own pretty printing thing.
+
+    # ### print_status
+    # Prints a status message. (`----->`)
     def print_status(msg)
       puts ""  if verbose_mode?
       puts "#{color('----->', 32)} #{msg}"
     end
 
+    # ### print_error
+    # Prints an error message (header).
     def print_error(msg)
       puts " #{color("!", 33)}     #{color(msg, 31)}"
     end
 
+    # ### print_stderr
+    # Prints an error message (body), or prints stderr output.
     def print_stderr(msg)
       puts "       #{color(msg, 31)}"
     end
 
+    # ### print_command
+    # Prints a command.
     def print_command(msg)
       puts "       #{color("$", 32)} #{color(msg, 32)}"
     end
 
+    # ### print_stdout
+    # Prints a normal message.
     def print_stdout(msg)
       puts "       #{msg}"
     end
 
-    # Internal: Colorizes a string.
+    # ### color
+    # Colorizes a string.
     # Returns the string `str` with the color `c`.
     def color(str, c)
       ENV['NO_COLOR'] ? str : "\033[#{c}m#{str}\033[0m"
     end
 
-    # Internal: Prints a string by delegating it to the proper output helper.
+    # ### print_str
+    # Prints a string by delegating it to the proper output helper.
     #
     # It takes an input with text and prints them nicely. The text block can
     # have statuses (prefixed with `-----> `), errors (prefixed with `! `),
@@ -55,7 +69,8 @@ module Mina
       end
     end
 
-    # Internal: Works like `system`, but indents and puts color.
+    # ### pretty_system
+    # __Internal:__ Works like `system`, but indents and puts color.
     #
     # Returns the exit code in integer form.
     #

data/lib/mina/rails.rb

@@ -1,33 +1,65 @@
+# # Modules: Rails
+# Adds settings and tasks for managing Rails projects.
+#
+#     require 'mina/rails'
+
 require 'mina/bundler'
 
-settings.rails_env ||= 'production'
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### rails_env
+# Sets the Rails environment for `rake` and `rails` commands.
+#
+# Note that changing this will NOT change the environment that your application
+# is ran in.
+set_default :rails_env, 'production'
+
+# ### bundle_prefix
+# Prefix for Bundler commands.
 # TODO: This should be lambda
-settings.bundle_prefix ||= lambda { %{RAILS_ENV="#{rails_env}" #{bundle_bin} exec} }
-settings.rake ||= lambda { %{#{bundle_prefix} rake} }
-settings.rails ||= lambda { %{#{bundle_prefix} rails} }
-settings.asset_paths ||= ['vendor/assets/', 'app/assets/']
-settings.rake_assets_precompile ||= lambda { "#{rake} assets:precompile" }
-
-desc "Makes Rails 3.2 deploys faster."
-task :'rails:optimize_for_3.2' do
-  # This is 100% faster in Rails 3.2 because it skips re-invoking the
-  # Rake+Rails environment twice, and reuses the compilation cache for
-  # generating digest and non-digest assets. See:
-  # https://github.com/rails/rails/blob/3-2-stable/actionpack/lib/sprockets/assets.rake
-  settings.rake_assets_precompile = lambda {
-    "#{rake} assets:precompile:primary assets:precompile:nondigest RAILS_ENV=production RAILS_GROUPS=assets"
-  }
-
-  # A safer, but slower (and still faster than default) version would be the
-  # one below. This will respect your config.assets.digest setting.
-  # settings.rake_assets_precompile = lambda {
-  #   "#{rake} assets:precompile:all RAILS_ENV=production RAILS_GROUPS=assets"
-  # }
-end
+
+set_default :bundle_prefix, lambda { %{RAILS_ENV="#{rails_env}" #{bundle_bin} exec} }
+
+# ### rake
+# The prefix for `rake` commands. Use like so:
+#
+#     queue "#{rake} db:migrate"
+
+set_default :rake, lambda { %{#{bundle_prefix} rake} }
+
+# ### rails
+# The prefix for `rails` commands. Use like so:
+#
+#     queue "#{rails} console"
+
+set_default :rails, lambda { %{#{bundle_prefix} rails} }
+
+# ### asset_paths
+# The paths to be checked.
+#
+# Whenever assets are compiled, the asset files are checked if they have
+# changed from the previous release.
+#
+# If they're unchanged, compiled assets will simply be copied over to the new
+# release.
+#
+# Override this if you have custom asset paths declared in your Rails's
+# `config.assets.paths` setting.
+
+set_default :asset_paths, ['vendor/assets/', 'app/assets/']
+
+# ### rake_assets_precompile
+# The command to invoke when precompiling assets.
+# Override me if you like.
+
+settings.rake_assets_precompile ||= lambda { "#{rake} assets:precompile RAILS_GROUPS=assets" }
+
+# ----
 
 # Macro used later by :rails, :rake, etc
 make_run_task = lambda { |name, sample_args|
-  task name, :arguments do |t, args|
+  task name, [:arguments] => :environment do |t, args|
     arguments = args[:arguments]
     command = send name
     unless command
@@ -61,18 +93,41 @@ def check_for_changes_script(options={})
   ]
 end
 
+# ## Command-line tasks
+# These tasks can be invoked in the command line.
+
+# ### rails[]
+# Invokes a rails command.
+#
+#     $ mina rails[console]
+
 desc "Execute a Rails command in the current deploy."
 make_run_task[:rails, 'console']
 
+# ### rake[]
+# Invokes a rake command.
+#
+#     $ mina rake db:cleanup
+
 desc "Execute a Rake command in the current deploy."
 make_run_task[:rake, 'db:migrate']
 
+# ### console
+# Opens the Ruby console for the currently-deployed version.
+#
+#    $ mina console
+
 desc "Starts an interactive console."
 task :console do
-  queue echo_cmd %[cd "#{deploy_to!}/#{current_path!}" && #{rails} console]
+  queue echo_cmd %[cd "#{deploy_to!}/#{current_path!}" && #{rails} console && exit]
 end
 
+# ## Deploy tasks
+# These tasks are meant to be invoked inside deploy scripts, not invoked on
+# their own.
+
 namespace :rails do
+  # ### rails:db_migrate
   desc "Migrates the Rails database (skips if nothing has changed since the last release)."
   task :db_migrate do
     if ENV['force_migrate']
@@ -99,6 +154,7 @@ namespace :rails do
     end
   end
 
+  # ### rails:db_migrate:force
   desc "Migrates the Rails database."
   task :'db_migrate:force' do
     queue %{
@@ -107,6 +163,7 @@ namespace :rails do
     }
   end
 
+  # ### rails:assets_precompile:force
   desc "Precompiles assets."
   task :'assets_precompile:force' do
     queue %{
@@ -115,6 +172,7 @@ namespace :rails do
     }
   end
 
+  # ### rails:assets_precompile
   desc "Precompiles assets (skips if nothing has changed since the last release)."
   task :'assets_precompile' do
     if ENV['force_assets']

data/lib/mina/rbenv.rb

@@ -0,0 +1,46 @@
+# # Modules: rbenv
+# Adds settings and tasks for managing [rbenv] installations.
+#
+# [rbenv]: https://github.com/sstephenson/rbenv
+#
+#     require 'mina/rbenv'
+#
+# ## Common usage
+#
+#     task :environment do
+#       invoke :'rbenv:load'
+#     end
+#
+#     task :deploy => :environment do
+#       ...
+#     end
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### rbenv_path
+# Sets the path where *rbenv* is installed.
+#
+# You may override this if rbenv is placed elsewhere in your setup.
+
+set_default :rbenv_path, "$HOME/.rbenv"
+
+# ## Tasks
+
+# ### rbenv:load
+# Loads the *rbenv* runtime.
+
+task :'rbenv:load' do
+  queue %{
+    echo "-----> Loading rbenv"
+    #{echo_cmd %{export PATH="#{rbenv_path}/bin:$PATH"}}
+
+    if ! which -s rbenv >/dev/null; then
+      echo "! rbenv not found"
+      echo "! If rbenv is installed, check your :rbenv_path setting."
+      exit 1
+    fi
+
+    #{echo_cmd %{eval "$(rbenv init -)"}}
+  }
+end

data/lib/mina/rvm.rb

@@ -0,0 +1,58 @@
+# # Modules: RVM
+# Adds settings and tasks for managing [RVM] installations.
+#
+# [rvm]: http://rvm.io
+#
+#     require 'mina/rvm'
+#
+# ## Common usage
+#
+#     task :environment do
+#       invoke :'rvm:use[ruby-1.9.3-p125@gemset_name]'
+#     end
+#
+#     task :deploy => :environment do
+#       ...
+#     end
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### rvm_path
+# Sets the path to RVM.
+#
+# You can override this in your projects if RVM is installed in a different
+# path, say, if you have a system-wide RVM install.
+
+set_default :rvm_path, "$HOME/.rvm/scripts/rvm"
+
+# ## Tasks
+
+# ### rvm:use[]
+# Uses a given RVM environment provided as an argument.
+#
+# This is usually placed in the `:environment` task.
+#
+#     task :environment do
+#       invoke :'rvm:use[ruby-1.9.3-p125@gemset_name]'
+#     end
+#
+task :'rvm:use', :env do |t, args|
+  unless args[:env]
+    print_error "Task 'rvm:use' needs an RVM environment name as an argument."
+    print_error "Example: invoke :'rvm:use[ruby-1.9.2@default]'"
+    die
+  end
+
+  queue %{
+    echo "-----> Using RVM environment '#{args[:env]}'"
+    if [[ ! -s "#{rvm_path}" ]]; then
+      echo "! Ruby Version Manager not found"
+      echo "! If RVM is installed, check your :rvm_path setting."
+      exit 1
+    fi
+
+    source #{rvm_path}
+    #{echo_cmd %{rvm use "#{args[:env]}"}} || exit 1
+  }
+end

data/lib/mina/version.rb

@@ -1,5 +1,5 @@
 module Mina
   def self.version
-    "0.2.0.pre2"
+    "0.2.0"
   end
 end

data/lib/mina/whenever.rb

@@ -0,0 +1,28 @@
+# # Modules: Whenever
+# Adds settings and tasks for managing projects with [whenever}.
+#
+# [whenever]: http://rubygems.org/gems/whenever
+
+namespace :whenever do
+  desc "Clear crontab"
+  task :clear do
+    queue %{
+      echo "-----> Clear crontab for #{domain}"
+      #{echo_cmd %[cd #{deploy_to!}/#{current_path!} ; bundle exec whenever --clear-crontab #{domain} --set 'environment=production&path=#{deploy_to!}/#{current_path!}']}
+    }
+  end
+  desc "Update crontab"
+  task :update do
+    queue %{
+      echo "-----> Update crontab for #{domain}"
+      #{echo_cmd %[cd #{deploy_to!}/#{current_path!} ; bundle exec whenever --update-crontab #{domain} --set 'environment=production&path=#{deploy_to!}/#{current_path!}']}
+    }
+  end
+  desc "Write crontab"
+  task :write do
+    queue %{
+      echo "-----> Update crontab for #{domain}"
+      #{echo_cmd %[cd #{deploy_to!}/#{current_path!} ; bundle exec whenever --write-crontab #{domain} --set 'environment=production&path=#{deploy_to!}/#{current_path!}']}
+    }
+  end
+end

data/manual/index.md

@@ -0,0 +1,15 @@
+# Welcome to Mina
+
+Really fast deployer and server automation tool.
+
+Mina works really fast because it's a deploy Bash script generator. It
+generates an entire procedure as a Bash script and runs it remotely in the
+server.
+
+Compare this to the likes of Vlad or Capistrano, where each command
+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
+

data/manual/modules.md

@@ -0,0 +1,2 @@
+Modules
+=======

data/spec/commands/verbose_spec.rb

@@ -9,12 +9,12 @@ describe "Invoking the 'mina' command in a project" do
   it 'should echo commands in verbose mode' do
     mina 'deploy', '--verbose', '--simulate'
 
-    stdout.should include %[echo "$ git]
+    stdout.should include %[echo #{Shellwords.escape('$ git')}]
   end
 
   it 'should not echo commands when not in verbose mode' do
     mina 'deploy', '--simulate'
 
-    stdout.should_not include %[echo "$ git]
+    stdout.should_not include %[echo #{Shellwords.escape('$ git')}]
   end
 end

data/test_env/config/deploy.rb

@@ -11,6 +11,8 @@
 # In fact, let's make that folder right now.
 require 'fileutils'
 FileUtils.mkdir_p "#{Dir.pwd}/deploy"
+FileUtils.mkdir_p "#{Dir.pwd}/deploy/config"
+File.open("#{Dir.pwd}/deploy/config/database.yml", 'w') { |f| f.write "Hello" }
 
 # -- Stubs end, deploy script begins! --------------
 
@@ -21,6 +23,11 @@ require 'mina/git'
 set :domain, 'localhost'
 set :deploy_to, "#{Dir.pwd}/deploy"
 set :repository, "#{Mina.root_path}"
+set :shared_paths, ['config/database.yml']
+
+task :environment do
+  queue %[echo "-----> Loading env"]
+end
 
 desc "Deploys."
 task :deploy do
@@ -29,6 +36,7 @@ task :deploy do
   deploy do
     queue %[ruby -e "\\$stderr.write \\\"This is stdout output\n\\\""]
     invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
     invoke :'bundle:install'
     invoke :'rails:db_migrate'
 

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: mina
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre2
-  prerelease: 6
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Rico Sta. Cruz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -90,9 +90,14 @@ files:
 - lib/mina/output_helpers.rb
 - lib/mina/rails.rb
 - lib/mina/rake.rb
+- lib/mina/rbenv.rb
+- lib/mina/rvm.rb
 - lib/mina/settings.rb
 - lib/mina/tools.rb
 - lib/mina/version.rb
+- lib/mina/whenever.rb
+- manual/index.md
+- manual/modules.md
 - mina.gemspec
 - spec/command_helper.rb
 - spec/commands/command_spec.rb
@@ -124,9 +129,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23