mina 0.1.3.pre1 → 0.2.0.pre2

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
  - 1.9.3
  - rbx-18mode
  - rbx-19mode
- - ruby-head
 env:
  - "rake=0.8"
  - "rake=0.9"

data/HISTORY.md

@@ -1,16 +1,40 @@
-v0.1.3 - Jul 13, 2012 (Unreleased)
-----------------------------------
+v0.2.0 - Unreleased
+-------------------
+
+This release had two pre releases:
+
+  * v0.2.0.pre2 (Aug 2, 2012)
+  * v0.1.3.pre1 (Jul 13, 2012)
 
 ### Fixed:
+  * [pre2] Call ssh with no double use `-t` parameter.
+  * [pre2] Fix Ruby 1.8 compatibility.
+  * [pre2] Fix the "undefined method > for Process::Status" error.
+  * [pre2] Using `force_migrate=1` and `force_assets=1` to `rails:db_migrate`
+    and `rails:assets_precompile` now works well.
   * [pre1] Respect the `bundle_bin` setting when doing `bundle exec` in Rails commands. (#29)
   * [pre1] Doing `rails:assets_precompile` now properly skips asset compilation if not needed. (#25)
 
 ### Added:
+  * [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.__
+  * [pre2] __Display the git commit nicely when deploying.__
+  * [pre2] __Force quit when 2 `^C`s are pressed.__
+  * [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)
+  * Update sample deploy script:
+    - [pre2] Update default deploy.rb to note :branch.
+    - [pre2] Add `link_shared_paths` to the sample deploy script.
   * [pre1] Doing `rails:db_migrate` now skips doing migrations if they're not needed. (#18)
   * [pre1] Added the `mina console` command for Rails.
   * [pre1] Make asset paths configurable using the `asset_paths` setting.
 
 ### Changed:
+  * [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.
   * [pre1] Show prettier abort messages when ^C'd.
 

data/data/deploy.rb

@@ -1,25 +1,44 @@
+# 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'
 
 # Basic settings:
-# domain     - 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)
+#   domain       - The hostname to SSH to.
+#   deploy_to    - Path to deploy into.
+#   repository   - Git repo to clone from. (needed by mina/git)
+#   branch       - Branch name to deploy. (needed by mina/git)
 
 set :domain, 'foobar.com'
 set :deploy_to, '/var/www/foobar.com'
 set :repository, 'git://...'
-# set :user, 'foobar'
-# set :port, '30000'
+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']
+
+# Optional settings:
+#   set :user, 'foobar'    # Username in the server to SSH to.
+#   set :port, '30000'     # SSH port number.
 
 desc "Deploys the current version to the server."
 task :deploy 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'
+    invoke :'deploy:link_shared_paths'
     invoke :'bundle:install'
     invoke :'rails:db_migrate'
     invoke :'rails:assets_precompile'

data/lib/mina/bundler.rb

@@ -6,19 +6,12 @@ settings.bundle_options ||= lambda { %{--without development:test --path "#{bund
 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_bin} 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_bin} install #{bundle_options}]}
-      }
-    end
+    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_bin} install #{bundle_options}]}
+    }
   end
-end
+end

data/lib/mina/default.rb

@@ -7,16 +7,17 @@ task :init do
   config_file = Rake.application.rakefile
 
   unless config_file.to_s.empty?
-    error "You already have #{config_file}."
+    print_str "! You already have #{config_file}."
     exit 8
   end
 
+  outfile = './config/deploy.rb'
   require 'fileutils'
   FileUtils.mkdir_p './config'
-  FileUtils.cp Mina.root_path('data/deploy.rb'), './config/deploy.rb'
+  FileUtils.cp Mina.root_path('data/deploy.rb'), outfile
 
-  puts 'Created deploy.rb.'
-  puts "Edit it, then run `#{name} setup` after."
+  print_str "-----> Created #{outfile}"
+  print_str "Edit this file, then run `#{name} setup` after."
 end
 
 task :default => :help

data/lib/mina/deploy.rb

@@ -44,18 +44,33 @@ end
 
 desc "Sets up a site."
 task :setup do
+  set :term_mode, :pretty
+
   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"}
+  user = settings.user? ? "#{settings.user}" : "username"
+
+  queue %{
+    echo "-----> Setting up #{deploy_to}" && (
+      #{echo_cmd %{mkdir -p "#{deploy_to}"}} &&
+      #{echo_cmd %{chown -R `whoami` "#{deploy_to}"}} &&
+      #{echo_cmd %{chmod g+rx,u+rwx "#{deploy_to}"}} &&
+      #{echo_cmd %{cd "#{deploy_to}"}} &&
+      #{echo_cmd %{mkdir -p "#{releases_path}"}} &&
+      #{echo_cmd %{chmod g+rx,u+rwx "#{releases_path}"}} &&
+      #{echo_cmd %{mkdir -p "#{shared_path}"}} &&
+      #{echo_cmd %{chmod g+rx,u+rwx "#{shared_path}"}} &&
+      echo "" &&
+      #{echo_cmd %{ls -la "#{deploy_to}"}} &&
+      echo "" &&
+      echo "-----> Done."
+    ) || (
+      echo "! ERROR: Setup failed."
+      echo "! Ensure that the path '#{deploy_to}' is accessible to the SSH user."
+      echo "! Try doing:"
+      echo "!    sudo mkdir -p \\"#{deploy_to}\\" && sudo chown -R #{user} \\"#{deploy_to}\\""
+    )
+  }
 end
 
 desc "Runs a command in the server."

data/lib/mina/git.rb

@@ -1,19 +1,42 @@
+settings.branch ||= "master"
+
 namespace :git do
   desc "Clones the Git repository to the release path."
   task :clone do
-    settings.revision ||= `git rev-parse HEAD`.strip
+    if revision?
+      error "The Git option `:revision` has now been deprecated."
+      error "Please use `:commit` or `:branch` instead."
+      exit
+    end
 
-    if settings.revision.empty?
-      error "Git revision is empty. Check if you are in git tree."
-      exit 1
+    clone = if commit?
+      %[
+        echo "-----> Using git commit '#{commit}'" &&
+        #{echo_cmd %[git clone "#{repository!}" . --recursive]} &&
+        #{echo_cmd %[git checkout -b current_release "#{commit}" --force]} &&
+      ]
+    else
+      %{
+        if [ ! -d "#{deploy_to}/scm/objects" ]; then
+          echo "-----> Cloning the Git repository"
+          #{echo_cmd %[git clone "#{repository!}" "#{deploy_to}/scm" --bare]}
+        else
+          echo "-----> Fetching new git commits"
+          #{echo_cmd %[(cd "#{deploy_to}/scm" && git fetch "#{repository!}" "#{branch}:#{branch}" --force)]}
+        fi &&
+        echo "-----> Using git branch '#{branch}'" &&
+        #{echo_cmd %[git clone "#{deploy_to}/scm" . --depth 1 --recursive --branch "#{branch}"]} &&
+      }
     end
 
-    queue %{
-      echo "-----> Cloning the Git repository"
-      #{echo_cmd %[git clone "#{repository!}" . -n --recursive]} &&
-      echo "-----> Using revision #{revision}" &&
-      #{echo_cmd %[git checkout -q "#{revision}" -b current_release 1>/dev/null]} &&
-      #{echo_cmd %[rm -rf .git]}
-    }
+    status = %[
+      echo "-----> Using this git commit" &&
+      echo &&
+      #{echo_cmd %[git log --format="%aN (%h):%n> %s" -n 1]} &&
+      #{echo_cmd %[rm -rf .git]} &&
+      echo
+    ]
+
+    queue clone + status
   end
 end

data/lib/mina/helpers.rb

@@ -42,7 +42,23 @@ module Mina
     # Returns nothing.
     #
     def run!
-      ssh commands(:default)
+      report_time { ssh commands(:default) }
+    end
+
+    # Report time elapsed in the block.
+    # Returns the output of the block.
+    def report_time(&blk)
+      time, output = measure &blk
+      print_str "Elapsed time: %.2f seconds" % [time]
+      output
+    end
+
+    # Measures the time (in ms) a block takes.
+    # Returns a [time, output] tuple.
+    def measure(&blk)
+      t = Time.now
+      output = yield
+      [(Time.now - t).to_i, output]
     end
 
     # Executes a command via SSH.
@@ -73,34 +89,40 @@ module Mina
         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 #{bash_options} -c #{script}"
-        result = pretty_system(code)
-
-      elsif settings.term_mode == :exec
-        code = "#{ssh_command} -t -- bash #{bash_options} -c #{script}"
-        exec code
-
       else
-        code = "#{ssh_command} -t -- bash #{bash_options} -c #{script}"
-        system code
-        result = $?
-      end
-
-      unless result == 0
-        err = Failed.new("Failed with status #{result}")
-        err.exitstatus = result
-        raise err
+        code = "#{ssh_command} -- bash #{bash_options} -c #{script}"
+        if settings.term_mode == :pretty
+          result = pretty_system(code)
+        elsif settings.term_mode == :exec
+          exec code
+        else
+          system code
+          result = $?.to_i
+        end
       end
 
+      die result if 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
+
     # Returns the SSH command to be executed.
     #
     #     set :domain, 'foo.com'
@@ -204,6 +226,21 @@ module Mina
       result
     end
 
+    # Starts a new block where #commands are collected, to be executed inside `path`.
+    #
+    # Returns nothing.
+    #
+    #   in_directory './webapp' do
+    #     queue "./reload"
+    #   end
+    #
+    #   commands.should == ['cd ./webapp && (./reload && true)']
+    #
+    def in_directory(path, &blk)
+      isolated_commands = isolate { yield; commands }
+      isolated_commands.each { |cmd| queue "(cd #{path} && (#{cmd}))" }
+    end
+
     # Defines instructions on how to do a certain thing.
     # This makes the commands that are `queue`d go into a different bucket in commands.
     #
@@ -221,9 +258,9 @@ module Mina
     #
     def to(name, &blk)
       old, @to = @to, name
-      result = yield
+      yield
+    ensure
       @to = old
-      result
     end
 
     # Sets settings.

data/lib/mina/output_helpers.rb

@@ -62,13 +62,20 @@ module Mina
     def pretty_system(code)
       require 'shellwords'
       cmds = Shellwords.shellsplit(code)
+      interrupted = false
 
       status =
         Tools.popen4(*cmds) do |pid, i, o, e|
           trap "INT" do
             puts ""
-            print_status "Mina: SIGINT received."
-            Process.kill "TERM", pid
+            unless interrupted
+              print_status "Mina: SIGINT received."
+              Process.kill "TERM", pid
+              interrupted = true
+            else
+              print_status "Mina: SIGINT received again. Force quitting..."
+              Process.kill "KILL", pid
+            end
           end
 
           # Read stderr in the background.

data/lib/mina/rails.rb

@@ -6,6 +6,24 @@ settings.bundle_prefix ||= lambda { %{RAILS_ENV="#{rails_env}" #{bundle_bin} exe
 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
 
 # Macro used later by :rails, :rake, etc
 make_run_task = lambda { |name, sample_args|
@@ -59,27 +77,26 @@ namespace :rails do
   task :db_migrate do
     if ENV['force_migrate']
       invoke :'rails:db_migrate:force'
-      return
+    else
+      message = verbose_mode? ?
+        '$((count)) changes found, migrating database' :
+        'Migrating database'
+
+      queue check_for_changes_script \
+        :check => 'db/schema.rb',
+        :at => ['db/schema.rb'],
+        :skip => %[
+          echo "-----> DB schema unchanged; skipping DB migration"
+        ],
+        :changed => %[
+          echo "-----> #{message}"
+          #{echo_cmd %[#{rake} db:migrate]}
+        ],
+        :default => %[
+          echo "-----> Migrating database"
+          #{echo_cmd %[#{rake} db:migrate]}
+        ]
     end
-
-    message = verbose_mode? ?
-      '$((count)) changes found, migrating database' :
-      'Migrating database'
-
-    queue check_for_changes_script \
-      check: 'db/schema.rb',
-      at: ['db/schema.rb'],
-      skip: %[
-        echo "-----> DB schema unchanged; skipping DB migration"
-      ],
-      changed: %[
-        echo "-----> #{message}"
-        #{echo_cmd %[#{rake} db:migrate]}
-      ],
-      default: %[
-        echo "-----> Migrating database"
-        #{echo_cmd %[#{rake} db:migrate]}
-      ]
   end
 
   desc "Migrates the Rails database."
@@ -94,7 +111,7 @@ namespace :rails do
   task :'assets_precompile:force' do
     queue %{
       echo "-----> Precompiling asset files"
-      #{echo_cmd %[#{rake} assets:precompile]}
+      #{echo_cmd %[#{rake_assets_precompile}]}
     }
   end
 
@@ -102,28 +119,27 @@ namespace :rails do
   task :'assets_precompile' do
     if ENV['force_assets']
       invoke :'rails:assets_precompile:force'
-      return
+    else
+      message = verbose_mode? ?
+        '$((count)) changes found, precompiling asset files' :
+        'Precompiling asset files'
+
+      queue check_for_changes_script \
+        :check => 'public/assets/',
+        :at => [*asset_paths],
+        :skip => %[
+          echo "-----> Skipping asset precompilation"
+          #{echo_cmd %[cp -R "#{deploy_to}/#{current_path}/public/assets" "./public/assets"]}
+        ],
+        :changed => %[
+          echo "-----> #{message}"
+          #{echo_cmd %[#{rake_assets_precompile}]}
+        ],
+        :default => %[
+          echo "-----> Precompiling asset files"
+          #{echo_cmd %[#{rake_assets_precompile}]}
+        ]
     end
-
-    message = verbose_mode? ?
-      '$((count)) changes found, precompiling asset files' :
-      'Precompiling asset files'
-
-    queue check_for_changes_script \
-      check: 'public/assets/',
-      at: [*asset_paths],
-      skip: %[
-        echo "-----> Skipping asset precompilation"
-        #{echo_cmd %[cp -R "#{deploy_to}/#{current_path}/public/assets" "./public/assets"]}
-      ],
-      changed: %[
-        echo "-----> #{message}"
-        #{echo_cmd %[#{rake} assets:precompile]}
-      ],
-      default: %[
-        echo "-----> Precompiling asset files"
-        #{echo_cmd %[#{rake} assets:precompile]}
-      ]
   end
 
 end

data/lib/mina/version.rb

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

data/test_env/config/deploy.rb

@@ -21,7 +21,6 @@ require 'mina/git'
 set :domain, 'localhost'
 set :deploy_to, "#{Dir.pwd}/deploy"
 set :repository, "#{Mina.root_path}"
-set :revision, 'HEAD'
 
 desc "Deploys."
 task :deploy do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mina
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre1
+  version: 0.2.0.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
+date: 2012-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,7 +98,6 @@ files:
 - spec/commands/command_spec.rb
 - spec/commands/custom_config_spec.rb
 - spec/commands/deploy_spec.rb
-- spec/commands/git_spec.rb
 - spec/commands/outside_project_spec.rb
 - spec/commands/real_deploy_spec.rb
 - spec/commands/verbose_spec.rb

data/spec/commands/git_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-require 'command_helper'
-
-describe "Invoking the 'mina deploy' command outside of git tree" do
-  before do
-    temp_path = "/tmp/mina-spec"
-    FileUtils.mkdir_p("#{temp_path}/config")
-    FileUtils.cp root('spec/fixtures/empty_env/config/deploy.rb'), "#{temp_path}/config/deploy.rb"
-    Dir.chdir temp_path
-  end
-
-  after do
-    FileUtils.rm_rf "/tmp/mina-spec"
-    Dir.chdir root
-  end
-
-  it 'should prompt empty revision error message' do
-    run_command 'deploy', 'simulate=1'
-    exitstatus.should_not eq(0)
-    stderr.should match(/git revision is empty/i)
-  end
-end