mina 0.2.0 → 0.2.1

data/HISTORY.md

@@ -1,5 +1,25 @@
-v0.2.0
-------
+v0.2.1 - Sep 08, 2012
+---------------------
+
+This release is to fix some issues that should've been cleaned up in the
+previous release, but wasn't.
+
+### Fixed:
+  * **Fix SSH helpers giving a 'class required' error.**
+  * **Send stdout even in term_mode = :pretty mode.**
+  * Rbenv: Fix compatibility with Debian, Arch, Fedora. (#44)
+  * Supress the "--depth is ignored in local clones" warning. (#56)
+
+### Added:
+  * Add the `:ssh_options` setting. (#23)
+  * Add the `:forward_agent` setting. (#23)
+
+### Changed:
+  * Make the `:term_mode` setting accept strings, not just symbols. (eg: `set
+    :term_mode, 'exec'`)
+
+v0.2.0 - Sep 08, 2012
+---------------------
 
 This release had two pre releases:
 

data/lib/mina.rb

@@ -6,6 +6,7 @@ module Mina
 
   autoload :DeployHelpers, 'mina/deploy_helpers'
   autoload :OutputHelpers, 'mina/output_helpers'
+  autoload :SshHelpers, 'mina/ssh_helpers'
   autoload :Helpers, 'mina/helpers'
   autoload :Settings, 'mina/settings'
   autoload :Tools, 'mina/tools'

data/lib/mina/default.rb

@@ -1,7 +1,27 @@
 # # Modules: Default
 # This module is loaded when invoking `mina` with or without a project.
 
-set_default :bash_options, '-i'
+# ## Settings
+# Here are some of the common settings. All settings are optional unless
+# otherwise noted.
+#
+# ### deploy_to
+# (Required) Path to deploy to.
+#
+# ### domain
+# (Required) Host name to deploy to.
+#
+# ### port
+# SSH port number.
+#
+# ### forward_agent
+# If set to `true`, enables SSH agent forwarding.
+#
+# ### identity_file
+# The local path to the SSH private key file.
+#
+# ### ssh_options
+# Switches to be passed to the `ssh` command.
 
 # ## Tasks
 # Any and all of these settings can be overriden in your `deploy.rb`.

data/lib/mina/git.rb

@@ -9,7 +9,7 @@
 # ### branch
 # Sets the branch to be deployed.
 
-set_default :branch, "master"
+set_default :branch, 'master'
 
 namespace :git do
   # ## Deploy tasks
@@ -18,6 +18,7 @@ namespace :git do
 
   # ### 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?
@@ -42,7 +43,7 @@ namespace :git do
           #{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}"]} &&
+        #{echo_cmd %[git clone "#{deploy_to}/scm" . --recursive --branch "#{branch}"]} &&
       }
     end
 

data/lib/mina/helpers.rb

@@ -1,4 +1,5 @@
 # # Helpers: Default helpers
+
 module Mina
   module Helpers
 
@@ -9,7 +10,7 @@ module Mina
     #
     #     invoke :'git:clone'
     #     invoke :restart
-    #
+
     def invoke(task)
       Rake.application.invoke_task task
     end
@@ -26,7 +27,7 @@ module Mina
     #     #=> "1 and 2"
     #
     # Returns the output string of the ERB template.
-    #
+
     def erb(file, b=binding)
       require 'erb'
       erb = ERB.new(File.read(file))
@@ -43,7 +44,7 @@ module Mina
     #     run!
     #
     # Returns nothing.
-    #
+
     def run!
       report_time { ssh commands(:default) }
     end
@@ -51,6 +52,15 @@ module Mina
     # ### report_time
     # Report time elapsed in the block.
     # Returns the output of the block.
+    #
+    #     report_time do
+    #       sleep 2
+    #       # do other things
+    #     end
+    #
+    #     # Output:
+    #     # Elapsed time: 2.0 seconds
+
     def report_time(&blk)
       time, output = measure &blk
       print_str "Elapsed time: %.2f seconds" % [time]
@@ -60,88 +70,18 @@ module Mina
     # ### measure
     # 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
 
-    # ## 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` is a hash of options:
-    #
-    #  - `:pretty` - Prettify the output if true.
-    #  - `:return`  - If set to true, returns the output.
-    #
-    # Example
-    #
-    #     ssh("ls", return: true)
-    #
-    def ssh(cmd, options={})
-      cmd = cmd.join("\n")  if cmd.is_a?(Array)
-
-      require 'shellwords'
-
-      result = 0
-      script = Shellwords.escape(cmd)
-
-      if options[:return] == true
-        result = `#{ssh_command} -- #{script}`
-
-      elsif simulate_mode?
-        str = "Executing the following via '#{ssh_command}':"
-        puts "#!/usr/bin/env bash"
-        puts "# #{str}"
-        puts "#"
-
-        puts cmd
-
-      else
-        code = "#{ssh_command} -- #{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.is_a? Fixnum && result > 0
-      result
-    end
-
-    # ### ssh_command
-    # Returns the SSH command to be executed.
-    #
-    #     set :domain, 'foo.com'
-    #     set :user, 'diggity'
-    #
-    #     puts ssh_command
-    #     #=> 'ssh diggity@foo.com'
-    #
-    def ssh_command
-      args = domain!
-      args = "#{user}@#{args}" if user?
-      args << " -i #{identity_file}" if identity_file?
-      args << " -p #{port}" if port?
-      args << " -t"
-      "ssh #{args}"
-    end
-
     # ### mina_cleanup
     # __Internal:__ Invoked when Rake exits.
     #
     # Returns nothing.
-    #
+
     def mina_cleanup!
       run! if commands.any?
     end
@@ -154,7 +94,7 @@ module Mina
     #
     #     die 2
     #     die 2, "Tests failed"
-    #
+
     def die(code=1, msg=null)
       str = "Failed with status #{code}"
       str += " (#{msg})" if msg
@@ -166,6 +106,7 @@ module Mina
     # ### error
     # __Internal:__ Prints to stdout.
     # Consider using `print_error` instead.
+
     def error(str)
       $stderr.write "#{str}\n"
     end
@@ -184,7 +125,7 @@ module Mina
     #     queue "true"
     #
     #     commands == ['sudo restart', 'true']
-    #
+
     def queue(code)
       commands
       commands(@to) << unindent(code)
@@ -207,7 +148,7 @@ module Mina
     #
     #     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 #{Shellwords.escape("$ " + str)} &&\n#{str}"
@@ -234,7 +175,7 @@ module Mina
     #
     #     commands == ["sudo restart", "true"]
     #     commands(:clean) == ["rm"]
-    #
+
     def commands(aspect=:default)
       (@commands ||= begin
         @to = :default
@@ -257,7 +198,7 @@ module Mina
     #     end
     #
     #     commands.should == ['sudo restart', 'true']
-    #
+
     def isolate(&blk)
       old, @commands = @commands, nil
       result = yield
@@ -275,7 +216,7 @@ module Mina
     #   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}))" }
@@ -295,7 +236,7 @@ module Mina
     #
     #     commands(:prepare) == ["bundle install"]
     #     commands(:restart) == ["nginx -s restart"]
-    #
+
     def to(name, &blk)
       old, @to = @to, name
       yield
@@ -312,7 +253,7 @@ module Mina
     # Returns the value.
     #
     #     set :domain, 'kickflip.me'
-    #
+
     def set(key, value)
       settings.send :"#{key}=", value
     end
@@ -330,7 +271,7 @@ module Mina
     #     set :term_mode, :system
     #     set_default :term_mode, :pretty
     #     settings.term_mode.should == :system
-    #
+
     def set_default(key, value)
       settings.send :"#{key}=", value  unless settings.send(:"#{key}?")
     end
@@ -342,7 +283,7 @@ module Mina
     #
     #     settings.domain  #=> 'kickflip.me'
     #     domain           #=> 'kickflip.me'
-    #
+
     def settings
       @settings ||= Settings.new
     end
@@ -352,7 +293,7 @@ module Mina
     # See #settings for an explanation.
     #
     # Returns things.
-    #
+
     def method_missing(meth, *args, &blk)
       settings.send meth, *args
     end
@@ -363,7 +304,7 @@ module Mina
     # Checks if Rake was invoked with --verbose.
     #
     # Returns true or false.
-    #
+
     def verbose_mode?
       if Rake.respond_to?(:verbose)
         # Rake 0.9.x
@@ -378,7 +319,7 @@ module Mina
     # Checks if Rake was invoked with --simulate.
     #
     # Returns true or false.
-    #
+
     def simulate_mode?
       !! ENV['simulate']
     end
@@ -387,6 +328,7 @@ module Mina
 
     # ### indent
     # Indents a given code block with `count` spaces before it.
+
     def indent(count, str)
       str.gsub(/^/, " "*count)
     end
@@ -403,7 +345,7 @@ module Mina
     #     # Output:
     #     # Hello
     #     #   There
-    #
+
     def unindent(code)
       if code =~ /^\n([ \t]+)/
         code = code.gsub(/^#{$1}/, '')
@@ -414,6 +356,7 @@ module Mina
 
     # ### reindent
     # Resets the indentation on a given code block.
+
     def reindent(n, code)
       indent n, unindent(code)
     end

data/lib/mina/output_helpers.rb

@@ -4,6 +4,33 @@
 module Mina
   module OutputHelpers
 
+    # ### 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 `! `),
+    # commands (prefixed with `$ `) or anything else. Depending on the type of
+    # the message, they will be delegated to the proper print_* helper.
+    #
+    #     -----> Unlocking
+    #     $ unlock foo
+    #     Unlocked.
+    #     ! ERROR: Failed
+    #
+    # Returns nothing.
+    #
+    def print_str(str)
+      if str =~ /^\-+> (.*?)$/
+        print_status $1
+      elsif str =~ /^! (.*?)$/
+        print_error $1
+      elsif str =~ /^\$ (.*?)$/
+        print_command $1
+      else
+        print_stdout str
+      end
+    end
+
     # ### print_status
     # Prints a status message. (`----->`)
     def print_status(msg)
@@ -42,33 +69,6 @@ module Mina
       ENV['NO_COLOR'] ? str : "\033[#{c}m#{str}\033[0m"
     end
 
-    # ### 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 `! `),
-    # commands (prefixed with `$ `) or anything else. Depending on the type of
-    # the message, they will be delegated to the proper print_* helper.
-    #
-    #     -----> Unlocking
-    #     $ unlock foo
-    #     Unlocked.
-    #     ! ERROR: Failed
-    #
-    # Returns nothing.
-    #
-    def print_str(str)
-      if str =~ /^\-+> (.*?)$/
-        print_status $1
-      elsif str =~ /^! (.*?)$/
-        print_error $1
-      elsif str =~ /^\$ (.*?)$/
-        print_command $1
-      else
-        print_stdout str
-      end
-    end
-
     # ### pretty_system
     # __Internal:__ Works like `system`, but indents and puts color.
     #
@@ -104,6 +104,14 @@ module Mina
             end
           end
 
+          # Read stdin in the background and send it out.
+          p2 = fork do
+            trap("INT") {}
+            while (char = STDIN.getbyte rescue nil)
+              i.putc char if char
+            end
+          end
+
           # Read stdout.
           while str = o.gets
             print_str str

data/lib/mina/rails.rb

@@ -13,25 +13,28 @@ require 'mina/bundler'
 #
 # 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
+# Prefix for Bundler commands. Often to something like `RAILS_ENV=production
+# bundle exec`.
+#
+#     queue! "#{bundle_prefix} annotate -r"
 
 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"
+#     queue! "#{rake} db:migrate"
 
 set_default :rake, lambda { %{#{bundle_prefix} rake} }
 
 # ### rails
 # The prefix for `rails` commands. Use like so:
 #
-#     queue "#{rails} console"
+#     queue! "#{rails} console"
 
 set_default :rails, lambda { %{#{bundle_prefix} rails} }
 
@@ -62,7 +65,7 @@ make_run_task = lambda { |name, sample_args|
   task name, [:arguments] => :environment do |t, args|
     arguments = args[:arguments]
     command = send name
-    unless command
+    unless arguments
       puts %{You need to provide arguments. Try: mina "#{name}[#{sample_args}]"}
       exit 1
     end

data/lib/mina/rake.rb

@@ -1,6 +1,7 @@
 # This file is invoked from Rake.
 extend Mina::Helpers
 extend Mina::DeployHelpers
+extend Mina::SshHelpers
 extend Mina::OutputHelpers
 
 require 'mina/default'

data/lib/mina/rbenv.rb

@@ -35,7 +35,7 @@ task :'rbenv:load' do
     echo "-----> Loading rbenv"
     #{echo_cmd %{export PATH="#{rbenv_path}/bin:$PATH"}}
 
-    if ! which -s rbenv >/dev/null; then
+    if ! which rbenv >/dev/null; then
       echo "! rbenv not found"
       echo "! If rbenv is installed, check your :rbenv_path setting."
       exit 1

data/lib/mina/ssh_helpers.rb

@@ -0,0 +1,76 @@
+# # Helpers: SSH helpers
+# You don't need to invoke these helpers, they're already invoked automatically.
+#
+module Mina
+  module SshHelpers
+    # ### ssh
+    # Executes a command via SSH.
+    #
+    # Returns nothing usually, but if `{ return: true }` is given, returns the
+    # STDOUT output of the SSH session.
+    #
+    # `options` is a hash of options:
+    #
+    #  - `:pretty` - Prettify the output if true.
+    #  - `:return`  - If set to true, returns the output.
+    #
+    # Example
+    #
+    #     ssh("ls", return: true)
+
+    def ssh(cmd, options={})
+      cmd = cmd.join("\n")  if cmd.is_a?(Array)
+
+      require 'shellwords'
+
+      result = 0
+      script = Shellwords.escape(cmd)
+
+      if options[:return] == true
+        result = `#{ssh_command} -- #{script}`
+
+      elsif simulate_mode?
+        str = "Executing the following via '#{ssh_command}':"
+        puts "#!/usr/bin/env bash"
+        puts "# #{str}"
+        puts "#"
+
+        puts cmd
+
+      else
+        code = "#{ssh_command} -- #{script}"
+        if settings.term_mode.to_s == 'pretty'
+          result = pretty_system(code)
+        elsif settings.term_mode.to_s == 'exec'
+          exec code
+        else
+          system code
+          result = $?.to_i
+        end
+      end
+
+      die result if result.is_a?(Fixnum) && result > 0
+      result
+    end
+
+    # ### ssh_command
+    # Returns the SSH command to be executed.
+    #
+    #     set :domain, 'foo.com'
+    #     set :user, 'diggity'
+    #
+    #     puts ssh_command
+    #     #=> 'ssh diggity@foo.com'
+
+    def ssh_command
+      args = domain!
+      args = "#{user}@#{args}" if user?
+      args << " -i #{identity_file}" if identity_file?
+      args << " -p #{port}" if port?
+      args << " -A" if forward_agent?
+      args << " #{ssh_options}"  if ssh_options?
+      args << " -t"
+      "ssh #{args}"
+    end
+  end
+end

data/lib/mina/version.rb

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

data/lib/mina/whenever.rb

@@ -1,6 +1,5 @@
 # # Modules: Whenever
-# Adds settings and tasks for managing projects with [whenever}.
-#
+# Adds settings and tasks for managing projects with [whenever].
 # [whenever]: http://rubygems.org/gems/whenever
 
 namespace :whenever do

data/test_env/config/deploy.rb

@@ -60,3 +60,8 @@ namespace :passenger do
     }
   end
 end
+
+task :rofl do
+  set :term_mode, :pretty
+  queue %[echo "Password:"; read x; echo out: $x;]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mina
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -93,6 +93,7 @@ files:
 - lib/mina/rbenv.rb
 - lib/mina/rvm.rb
 - lib/mina/settings.rb
+- lib/mina/ssh_helpers.rb
 - lib/mina/tools.rb
 - lib/mina/version.rb
 - lib/mina/whenever.rb