mina 0.1.0

data/Rakefile

@@ -0,0 +1,33 @@
+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'"
+end
+
+task :default => :spec

data/bin/mina

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems' unless Object.const_defined?(:Gem)
+require 'mina'
+require 'rake'
+
+# Intercept: if invoked as 'mina --help', don't let it pass through Rake, or else
+# we'll see the Rake help screen. Redirect it to 'mina help'.
+if ARGV.delete('--help') || ARGV.delete('-h')
+  ARGV << 'help'
+end
+
+if ARGV.delete('--version') || ARGV.delete('-V')
+  puts "Mina, version v#{Mina.version}"
+  exit
+end
+
+if ARGV.delete('--simulate') || ARGV.delete('-S')
+  ENV['simulate'] = '1'
+end
+
+scope = self
+
+Rake.application.instance_eval do
+  standard_exception_handling do
+    # Initialize Rake and make it think it's Mina.
+    init 'mina'
+    @rakefiles = ['Minafile', 'config/deploy.rb']
+
+    # Workaround: Rake 0.9+ doesn't record task descriptions unless it's needed.
+    # Need it for 'mina help'
+    if Rake::TaskManager.respond_to?(:record_task_metadata)
+      Rake::TaskManager.record_task_metadata = true
+    end
+
+    # Load the Mina Rake DSL.
+    require 'mina/rake'
+
+    # Allow running without a Rakefile
+    load_rakefile  if have_rakefile
+
+    # Run tasks
+    top_level
+
+    scope.mina_cleanup! if top_level_tasks.any?
+  end
+end
+

data/data/deploy.rb

@@ -0,0 +1,30 @@
+require 'mina/bundler'
+require 'mina/rails'
+require 'mina/git'
+
+# Basic settings:
+# host       - The hostname to SSH to
+# deploy_to  - Path to deploy into
+# repository - Git repo to clone from (needed by mina/git)
+# user       - Username in the  server to SSH to (optional)
+
+set :host, 'foobar.com'
+set :deploy_to, '/var/www/foobar.com'
+set :repository, 'git://...'
+# set :user, 'foobar.com'
+
+desc "Deploys the current version to the server."
+task :deploy do
+  deploy do
+    # Put things that will set up an empty directory into a fully set-up
+    # instance of your project.
+    invoke :'git:checkout'
+    invoke :'bundle:install'
+    invoke :'rails:db_migrate'
+    invoke :'rails:assets_precompile'
+
+    to :launch do
+      queue 'touch tmp/restart.txt'
+    end
+  end
+end

data/data/deploy.sh.erb

@@ -0,0 +1,98 @@
+<%
+  prepare = commands(:default).map { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
+  launch  = commands(:launch).map  { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
+  clean   = commands(:clean).map   { |s| "(\n\n#{indent 2, s}\n\n)" }.join(" && ")
+%>
+#!/usr/bin/env bash
+
+# Go to the deploy path
+cd "<%= deploy_to %>" || (
+  echo "=====> ERROR: not set up."
+  echo "The path '<%= deploy_to %>' is not accessible on the server."
+  echo "You may need to run 'mina setup' first."
+  false
+) || exit 16
+
+# Check lockfile
+if [ -e "<%= lock_file %>" ]; then
+  echo "=====> ERROR: another deployment is ongoing."
+  echo "The file '<%= lock_file %>' was found."
+  echo "If no other deployment is ongoing, delete the file to continue."
+  exit 17
+fi
+
+# Determine $previous_path and other variables
+[ -h "<%= current_path %>" ] && [ -d "<%= current_path %>" ] && previous_path=$(cd "<%= current_path %>" >/dev/null && pwd -LP)
+build_path="./tmp/build-`date +%s`$RANDOM"
+version=$((`cat "<%= deploy_to %>/last_version" 2>/dev/null`+1))
+release_path="<%= releases_path %>/$version"
+
+# Sanity check
+if [ -e "$build_path" ]; then
+  echo "=====> ERROR: Path already exists"
+  exit 18
+fi
+
+# Bootstrap script (in deployer)
+(
+  echo "-----> Creating a temporary build path"
+  <%= echo_cmd %[touch "#{lock_file}"] %> &&
+  <%= echo_cmd %[mkdir -p "$build_path"] %> &&
+  <%= echo_cmd %[cd "$build_path"] %> &&
+  (
+<%= indent 4, (prepare.empty? ? "true" : prepare) %>
+  )
+) &&
+
+#
+# Rename to the real release path, then symlink 'current'
+(
+  echo "-----> Build finished"
+  echo "-----> Moving build to $release_path"
+  <%= echo_cmd %[mv "$build_path" "$release_path"] %> &&
+
+  echo "-----> Updating the <%= current_path %> symlink" &&
+  <%= echo_cmd %[ln -nfs "$release_path" "#{current_path}"] %>
+) &&
+
+# ============================
+# === Start up serve => (in deployer)
+(
+  echo "-----> Launching"
+  <%= echo_cmd %[cd "$release_path"] %>
+<%= indent 2, (launch.empty? ? "true" : launch) %>
+) &&
+
+# ============================
+# === Complete & unlock
+(
+  rm -f "<%= lock_file %>"
+  echo "$version" > "./last_version"
+  echo "-----> Done. Deployed v$version"
+) ||
+
+# ============================
+# === Failed deployment
+(
+  echo "=====> ERROR: Deploy failed."
+
+<%= indent 2, clean %>
+
+  echo "-----> Cleaning up build"
+  [ -e "$build_path" ] && (
+    <%= echo_cmd %[rm -rf "$build_path"] %>
+  )
+  [ -e "$release_path" ] && (
+    echo "Deleting release"
+    <%= echo_cmd %[rm -rf "$release_path"] %>
+  )
+  (
+    echo "Unlinking current"
+    [ -n "$previous_path" ] && <%= echo_cmd %[ln -nfs "$previous_path" "#{current_path}"] %>
+  )
+
+  # Unlock
+  <%= echo_cmd %[rm -f "#{lock_file}"] %>
+  echo "OK"
+  exit 8
+)

data/lib/mina.rb

@@ -0,0 +1,20 @@
+module Mina
+  PREFIX = File.dirname(__FILE__)
+  ROOT = File.expand_path('../../', __FILE__)
+
+  require 'mina/version'
+
+  autoload :DeployHelpers, 'mina/deploy_helpers'
+  autoload :Helpers, 'mina/helpers'
+  autoload :Settings, 'mina/settings'
+  autoload :Tools, 'mina/tools'
+
+  Error = Class.new(Exception)
+  class Failed < Error
+    attr_accessor :exitstatus
+  end
+
+  def self.root_path(*a)
+    File.join ROOT, *a
+  end
+end

data/lib/mina/bundler.rb

@@ -0,0 +1,23 @@
+
+settings.bundle_path ||= './vendor/bundle'
+settings.bundle_options ||= lambda { %{--without development:test --path "#{bundle_path}" --binstubs bin/ --deployment} }
+
+namespace :bundle do
+  desc "Install gem dependencies using Bundler."
+  task :install do
+    if bundle_path.nil?
+      queue %{
+        echo "-----> Installing gem dependencies using Bundler"
+        #{echo_cmd %[bundle install #{bundle_options}]}
+      }
+    else
+      queue %{
+        echo "-----> Installing gem dependencies using Bundler"
+        #{echo_cmd %[mkdir -p "#{deploy_to}/#{shared_path}/bundle"]}
+        #{echo_cmd %[mkdir -p "#{File.dirname bundle_path}"]}
+        #{echo_cmd %[ln -s "#{deploy_to}/#{shared_path}/bundle" "#{bundle_path}"]}
+        #{echo_cmd %[bundle install #{bundle_options}]}
+      }
+    end
+  end
+end

data/lib/mina/default.rb

@@ -0,0 +1,97 @@
+set_default :term_mode, nil
+
+# Default tasks here
+desc "Creates a sample config file."
+task :init do
+  name = Rake.application.name
+  config_file = Rake.application.rakefile
+
+  unless config_file.to_s.empty?
+    error "You already have #{config_file}."
+    exit 8
+  end
+
+  require 'fileutils'
+  FileUtils.mkdir_p './config'
+  FileUtils.cp Mina.root_path('data/deploy.rb'), './config/deploy.rb'
+
+  puts 'Created deploy.rb.'
+  puts 'Edit it, then run `#{name} setup` after.'
+end
+
+task :default => :help
+
+module HelpHelpers
+  def get_tasks(&blk)
+    Rake.application.tasks.select &blk
+  end
+
+  def print_tasks(tasks, width=nil)
+    name = Rake.application.name
+
+    width ||= tasks.map { |t| t.name_with_args.length }.max || 10
+    tasks.each do |t|
+      if t.comment
+        puts "  #{name} %-#{width}s   # %s" % [ t.name_with_args, t.comment ]
+      else
+        puts "  #{name} %s" % [ t.name_with_args ]
+      end
+    end
+  end
+
+  SYSTEM_TASKS = %w[help tasks init]
+  def system_tasks() get_tasks { |t| SYSTEM_TASKS.include? t.name }; end
+  def top_tasks()    get_tasks { |t| ! t.name.include?(':') && t.comment && !system_tasks.include?(t) }; end
+  def sub_tasks()    get_tasks { |t| t.name.include?(':') }; end
+
+  def show_task_help(options={})
+    puts "Basic usage:"
+    print_tasks system_tasks
+
+    if top_tasks.any?
+      puts "\nServer tasks:"
+      print_tasks top_tasks
+    end
+
+    if sub_tasks.any? && options[:full]
+      puts "\nMore tasks:"
+      print_tasks sub_tasks
+    end
+  end
+end
+
+extend HelpHelpers
+
+desc "Show help."
+task :help do
+  name = Rake.application.name
+
+  puts "#{name} - Really fast server deployment and automation tool\n\n"
+  puts "Options:"
+
+  opts = [
+    [ "-h, --help", "Show help" ],
+    [ "-V, --version", "Show program version" ],
+    [ "-v, --verbose", "Show commands as they happen" ],
+    [ "-S, --simulate", "Run in simulation mode" ],
+    [ "-t, --trace", "Show backtraces when errors occur" ]
+  ]
+  opts.each { |args| puts "  %-17s %s" % args }
+  puts ""
+
+  show_task_help
+
+  unless Rake.application.have_rakefile
+    puts ""
+    puts "Run this command in a project with a 'config/deploy.rb' file to see more options."
+  end
+
+  puts ""
+  puts "All of Rake's options are also available as '#{name}' options. See 'rake --help'"
+  puts "for more information."
+end
+
+desc "Show all tasks."
+task :tasks do
+  show_task_help :full => true
+end

data/lib/mina/deploy.rb

@@ -0,0 +1,57 @@
+set_default :releases_path, "releases"
+set_default :shared_path, "shared"
+set_default :current_path, "current"
+set_default :lock_file, "deploy.lock"
+
+namespace :deploy do
+  desc "Forces a deploy unlock."
+  task :force_unlock do
+    queue %{echo "-----> Unlocking"}
+    queue echo_cmd %{rm -f "#{deploy_to}/#{lock_file}"}
+  end
+
+  desc "Links paths set in :shared_paths."
+  task :link_shared_paths do
+    dirs = settings.shared_paths!.map { |file| File.dirname("./#{file}") }.uniq
+
+    cmds = dirs.map do |dir|
+      echo_cmd %{mkdir -p "#{dir}"}
+    end
+
+    cmds += shared_paths.map do |file|
+      echo_cmd %{ln -s "#{shared_path}/#{file}" "./#{file}"}
+    end
+
+    queue %{
+      echo "-----> Symlinking shared paths"
+      #{cmds.join(" &&\n")}
+    }
+  end
+end
+
+desc "Sets up a site."
+task :setup do
+  settings.deploy_to!
+
+  queue %{echo "-----> Setting up #{deploy_to}"}
+  queue echo_cmd %{mkdir -p "#{deploy_to}"}
+  queue echo_cmd %{chown -R `whoami` "#{deploy_to}"}
+  queue echo_cmd %{chmod g+rx,u+rwx "#{deploy_to}"}
+  queue echo_cmd %{cd "#{deploy_to}"}
+  queue echo_cmd %{mkdir -p "#{releases_path}"}
+  queue echo_cmd %{chmod g+rx,u+rwx "#{releases_path}"}
+  queue echo_cmd %{mkdir -p "#{shared_path}"}
+  queue echo_cmd %{chmod g+rx,u+rwx "#{shared_path}"}
+  queue %{echo "-----> Done"}
+end
+
+desc "Runs a command in the server."
+task :run, :command do |t, args|
+  command = args[:command]
+  unless command
+    puts %[You need to provide a command. Try: mina "run[ls -la]"]
+    exit 1
+  end
+
+  queue %[cd #{deploy_to!} && #{command}]
+end

data/lib/mina/deploy_helpers.rb

@@ -0,0 +1,25 @@
+module Mina
+  module DeployHelpers
+    # Wraps the things inside it in a deploy script, and queues it.
+    # This generates a script using deploy_script and queues it.
+    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
+    #
+    #     queue script
+    #
+    def deploy_script(&blk)
+      set_default :term_mode, :pretty
+      code = isolate do
+        yield
+        erb Mina.root_path('data/deploy.sh.erb')
+      end
+    end
+  end
+end

data/lib/mina/git.rb

@@ -0,0 +1,14 @@
+namespace :git do
+  desc "Clones the Git repository to the release path."
+  task :clone do
+    settings.revision ||= `git rev-parse HEAD`.strip
+
+    queue %{
+      echo "-----> Cloning the Git repository"
+      #{echo_cmd %[git clone "#{repository!}" . -n --recursive]} &&
+      echo "-----> Using revision #{revision}" &&
+      #{echo_cmd %[git checkout "#{revision}" -b current_release 1>/dev/null]} &&
+      #{echo_cmd %[rm -rf .git]}
+    }
+  end
+end