mina-traackr 0.3.0

data/lib/mina/output_helpers.rb

@@ -0,0 +1,92 @@
+# # 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
+
+    # ### 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(line)
+      if line =~ /^\-+> (.*?)$/
+        print_status $1
+      elsif line =~ /^! (.*?)$/
+        print_error $1
+      elsif line =~ /^\$ (.*?)$/
+        print_command $1
+      else
+        print_stdout line
+      end
+    end
+
+    # ### print_char
+    # Prints a single character.
+    def print_char(ch)
+      $last ||= ''
+
+      if ch == "\n"
+        print_clear
+        print_str $last
+        $last = ''
+      else
+        print '       ' if $last == ''
+        print ch
+        $last += ch
+      end
+    end
+
+    def print_clear
+      print "\033[1K\r"
+    end
+
+    # ### 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
+
+    # ### 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
+  end
+end

data/lib/mina/rails.rb

@@ -0,0 +1,206 @@
+# # Modules: Rails
+# Adds settings and tasks for managing Rails projects.
+#
+#     require 'mina/rails'
+
+require 'mina/bundler'
+
+# ## 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. 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"
+
+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] => :environment do |t, args|
+    arguments = args[:arguments]
+    command = send name
+    unless arguments
+      puts %{You need to provide arguments. Try: mina "#{name}[#{sample_args}]"}
+      exit 1
+    end
+    queue echo_cmd %[cd "#{deploy_to!}/#{current_path!}" && #{command} #{arguments}]
+  end
+}
+
+def check_for_changes_script(options={})
+  diffs = options[:at].map { |path|
+    %[diff -r "#{deploy_to}/#{current_path}/#{path}" "./#{path}" 2>/dev/null]
+  }.join("\n")
+
+  unindent %[
+    if [ -e "#{deploy_to}/#{current_path}/#{options[:check]}" ]; then
+      count=`(
+        #{reindent 4, diffs}
+      ) | wc -l`
+
+      if [ "$((count))" = "0" ]; then
+        #{reindent 4, options[:skip]} &&
+        exit
+      else
+        #{reindent 4, options[:changed]}
+      fi
+    else
+      #{reindent 2, options[:default]}
+    fi
+  ]
+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 && 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']
+      invoke :'rails:db_migrate:force'
+    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
+  end
+
+  # ### rails:db_migrate:force
+  desc "Migrates the Rails database."
+  task :'db_migrate:force' do
+    queue %{
+      echo "-----> Migrating database"
+      #{echo_cmd %[#{rake} db:migrate]}
+    }
+  end
+
+  # ### rails:assets_precompile:force
+  desc "Precompiles assets."
+  task :'assets_precompile:force' do
+    queue %{
+      echo "-----> Precompiling asset files"
+      #{echo_cmd %[#{rake_assets_precompile}]}
+    }
+  end
+
+  # ### rails:assets_precompile
+  desc "Precompiles assets (skips if nothing has changed since the last release)."
+  task :'assets_precompile' do
+    if ENV['force_assets']
+      invoke :'rails:assets_precompile:force'
+    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
+  end
+
+end

data/lib/mina/rake.rb

@@ -0,0 +1,9 @@
+# This file is invoked from Rake.
+extend Mina::Helpers
+extend Mina::DeployHelpers
+extend Mina::SshHelpers
+extend Mina::OutputHelpers
+extend Mina::ExecHelpers
+
+require 'mina/default'
+require 'mina/deploy' if Rake.application.have_rakefile

data/lib/mina/rbenv.rb

@@ -0,0 +1,47 @@
+# # 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 RBENV_ROOT="#{rbenv_path}"}}
+    #{echo_cmd %{export PATH="#{rbenv_path}/bin:$PATH"}}
+
+    if ! which 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,88 @@
+# # 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]}" --create}} || exit 1
+  }
+end
+
+# ### rvm:wrapper[]
+# Creates a rvm wrapper for a given executable.
+#
+# This is usually placed in the `:setup` task.
+#
+#     task ::setup => :environment do
+#       ...
+#       invoke :'rvm:wrapper[ruby-1.9.3-p125@gemset_name,wrapper_name,binary_name]'
+#     end
+#
+task :'rvm:wrapper', :env, :name, :bin do |t,args|
+  unless args[:env] && args[:name] && args[:bin]
+    print_error "Task 'rvm:wrapper' needs an RVM environment name, an wrapper name and the binary name as arguments"
+    print_error "Example: invoke :'rvm:wrapper[ruby-1.9.2@myapp,myapp,unicorn_rails]'"
+    die
+  end
+
+  queue %{
+    echo "-----> creating RVM wrapper '#{args[:name]}_#{args[:bin]}' using '#{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 wrapper #{args[:env]} #{args[:name]} #{args[:bin]} }} || exit 1
+  }
+end

data/lib/mina/settings.rb

@@ -0,0 +1,32 @@
+module Mina
+  class Settings < Hash
+    def method_missing(meth, *args, &blk)
+      name = meth.to_s
+
+      return evaluate(self[meth])  if name.size == 1
+
+      # Ruby 1.8.7 doesn't let you do string[-1]
+      key, suffix = name[0..-2].to_sym, name[-1..-1]
+
+      case suffix
+      when '='
+        self[key] = args.first
+      when '?'
+        include? key
+      when '!'
+        raise Error, "Setting :#{key} is not set" unless include?(key)
+        evaluate self[key]
+      else
+        evaluate self[meth]
+      end
+    end
+
+    def evaluate(value)
+      if value.is_a?(Proc)
+        value.call
+      else
+        value
+      end
+    end
+  end
+end