mina 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2b6b88e6812eb7ebcfceb198931304b415e71c8
-  data.tar.gz: a4d2b0b278e6ab972d7776c00fcee34cbf1c245d
+  metadata.gz: 7c6b0b3ddff51096031d949735044ec53b0c2484
+  data.tar.gz: 9645495211ff5442aad8b0986735da7d93157d86
 SHA512:
-  metadata.gz: 64e84169e5dd133db2734012303969569f3025ef71a5a127016d6e70285c97420b610063e3066630fa07f385aa6cd4b3c5d2b39825c07b76822af42bed2d2005
-  data.tar.gz: 559043af839f8a34e61585d641976780160bd0c88a3523c9161a607d7f2f5ae329e351cee8ba9728549225b017e5b73fbc0d4777b6c767048ea4435706e19b05
+  metadata.gz: b70f4bcecbf9673c99898e5ee87d06b2db3adfd50545db587964f3e9a713112142d16fbd4eadba6a7c9a9711350a1bf0577d70b7a3b32b00d9be815901e2a7dd
+  data.tar.gz: a4d75cb1b9d44f45e8c7535b8b345cc061ad717f993d346779152af44265cc141e8e086f70abcd1d99b9b90a585e5a8a4edcdd22146af9a27a740d5fa50f6d2f

data/HISTORY.md

@@ -1,3 +1,30 @@
+Latest version - Mar 27, 2015
+-----------------------------
+
+### Fixed:
+  * invoke does not work after a to block (#285)
+
+### Added:
+  * before and after hooks
+
+
+Latest version - Mar 10, 2015
+-----------------------------
+
+### Fixed:
+  * link typo in readme (#273) [Henare Degan]
+  * up formatting of code block in readme (#274) [Henare Degan]
+  * Rolling back to previous release (#9) [Tyler Mandry]
+  * ruby 1.8.7 and rake 0.9 issue with invoke
+
+### Changed:
+  * update 3rd party list
+  * update docs, added db_rollback rails command
+
+[Tyler Mandry]: https://github.com/tmandry
+[Henare Degan]: https://github.com/henare
+
+
 v0.3.2 - January 24, 2015
 -----------------------------
 

data/Makefile

@@ -3,6 +3,7 @@ Readme.md: \
 	support/guide.md \
 	support/helpers.md \
 	support/modules.md \
+	support/third_party_modules.md \
 	support/Readme-footer.md
 	cat $^ > $@
 
@@ -15,6 +16,7 @@ support/modules.md: \
 	lib/mina/rails.rb \
 	lib/mina/rbenv.rb \
 	lib/mina/rvm.rb \
+	lib/mina/npm.rb \
 	lib/mina/whenever.rb
 	cat $^ | ruby support/to_md.rb > $@
 

data/Readme.md

@@ -56,13 +56,13 @@ change it's ownership to the correct user.
 ### Step 3: Run 'mina setup'
 
 Back at your computer, do `mina setup` to set up the [folder 
-structure](#directory-structure) in this path. This will connect to your server 
+structure](#directory_structure) in this path. This will connect to your server 
 via SSH and create the right directories.
 
     $ mina setup
     -----> Creating folders... done.
 
-See [directory structure](#directory-structure) for more info.
+See [directory structure](#directory_structure) for more info.
 
 ### Step 4: Deploy!
 
@@ -199,8 +199,7 @@ task :deploy do
 
     # These are instructions to start the app after it's been prepared.
     to :launch do
-      queue "mkdir -p #{deploy_to}/#{current_path}/tmp/"
-      queue "touch #{deploy_to}/#{current_path}/tmp/restart.txt"
+      queue 'touch tmp/restart.txt'
     end
 
     # This optional block defines how a broken release should be cleaned up.
@@ -300,7 +299,7 @@ Basic usage:
 
 ### Tasks
 
-There are many tasks available. See the [tasks reference](http://mina-deploy.github.io/mina/tasks/index.html), or 
+There are many tasks available. See the [tasks reference](http://mina-deploy.github.io/mina/tasks/), or
 type `mina tasks`.
 
 ### Variables
@@ -316,7 +315,8 @@ You can add as many variables as needed.
 # Helpers
 
 ### invoke
-Invokes another Rake task. By default if the task has already been invoked it will not been executed again (see the `:reenable` option).
+Invokes another Rake task.
+By default if the task has already been invoked it will not been executed again (see the `:reenable` option).
 
 Invokes the task given in `task`. Returns nothing.
 
@@ -325,8 +325,10 @@ invoke :'git:clone'
 invoke :restart
 ~~~
 
-__Options:__
-  `:reenable` (bool) - Execute the task even next time. Defaults to `false`
+Options:
+  reenable (bool) - Execute the task even next time.
+
+task.to_s is a ruby 1.8.7 fix
 
 ### erb
 Evaluates an ERB block in the current scope and returns a string.
@@ -354,6 +356,22 @@ run!
 
 Returns nothing.
 
+### run_local!
+runs the code locally that has been queued.
+Has to be in :before_hook or :after_hook queue
+
+This is already automatically invoked before Rake exits to run all
+commands that have been queued up.
+
+~~~ ruby
+to :before_hook do
+  queue "cp file1 file2"
+end
+run_local!(:before_hook)
+~~~
+
+Returns nothing.
+
 ### report_time
 Report time elapsed in the block.
 Returns the output of the block.
@@ -613,6 +631,9 @@ 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.
 
+### bundle_withouts
+Sets the colon-separated list of groups to be skipped from installation.
+
 ### bundle_options
 Sets the options for installing gems via Bundler.
 
@@ -649,7 +670,7 @@ The local path to the SSH private key file.
 Switches to be passed to the `ssh` command.
 
 ### env_vars
-Environment variables passed to the `ssh` command (e.g. "foo=bar baz=1").
+Environment variables to be passed to `ssh` command. (e.g. "foo=bar baz=1")
 
 ## Tasks
 Any and all of these settings can be overriden in your `deploy.rb`.
@@ -730,6 +751,20 @@ 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:rollback
+Rollbacks the latest release.
+
+Changes the current link to previous release, and deletes the newest deploy release
+Does NOT rollback the database, use
+
+~~~ ruby
+mina "rake[db:rollback]"
+~~~
+
+Delete existing sym link and create a new symlink pointing to the previous release
+
+Remove latest release folder (current release)
+
 ### setup
 Sets up a site's directory structure.
 
@@ -737,7 +772,7 @@ Sets up a site's directory structure.
 Runs a command on a server.
 
 ~~~ ruby
-$ mina run[tail -f logs.txt]
+$ mina "run[tail -f logs.txt]"
 ~~~
 
 # Modules: Foreman
@@ -751,21 +786,22 @@ NOTE: Requires sudo privileges
 
 ## Common usage
 
-~~~ ruby
-set :application, "app-name"
+   set :application, "app-name"
 
-task :deploy => :environment do
-  deploy do
-    # ...
-    invoke 'foreman:export'
-    # ...
-  end
-  to :launch do
-    invoke 'foreman:restart'
-  end
-end
+   task :deploy => :environment do
+~~~ ruby
+ deploy do
+   # ...
+   invoke 'foreman:export'
+   # ...
+ end
+ to :launch do
+   invoke 'foreman:restart'
+ end
 ~~~
 
+   end
+
 ## Settings
 Any and all of these settings can be overriden in your `deploy.rb`.
 
@@ -866,14 +902,14 @@ These tasks can be invoked in the command line.
 Invokes a rails command.
 
 ~~~ ruby
-$ mina rails[console]
+$ mina "rails[console]"
 ~~~
 
 ### rake[]
 Invokes a rake command.
 
 ~~~ ruby
-$ mina rake db:cleanup
+$ mina "rake[db:migrate]"
 ~~~
 
 ### console
@@ -891,6 +927,8 @@ their own.
 
 ### rails:db_migrate:force
 
+### rails:db_rollback
+
 ### rails:assets_precompile:force
 
 ### rails:assets_precompile
@@ -982,12 +1020,7 @@ task ::setup => :environment do
 end
 ~~~
 
-Adds settings and tasks for managing projects with [whenever].
-[whenever]: http://rubygems.org/gems/whenever
-
-
-# Modules: NPM
-Adds settings and tasks for managing NodeJS projects.
+Adds settings and tasks for managing Node packages.
 
 ~~~ ruby
 require 'mina/npm'
@@ -996,16 +1029,54 @@ require 'mina/npm'
 ## Settings
 Any and all of these settings can be overriden in your `deploy.rb`.
 
+### npm_bin
+Sets the npm binary.
+
+### bower_bin
+Sets the bower binary.
+
+### grunt_bin
+Sets the grunt binary.
+
 ### npm_options
-Parameters to pass to the npm binary. Default to `--production`.
+Sets the options for installing modules via npm.
 
-----
+### bower_options
+Sets the options for installing modules via bower.
+
+### grunt_options
+Sets the options for grunt.
+
+### grunt_task
+Sets the task parameters for grunt.
 
 ## Deploy tasks
 These tasks are meant to be invoked inside deploy scripts, not invoked on
 their own.
 
 ### npm:install
+Installs node modules. Takes into account if executed `in_directory` and namespaces the installed modules in the shared folder.
+
+### bower:install
+Installs bower modules. Takes into account if executed `in_directory` and namespaces the installed modules in the shared folder.
+
+### bower:install
+Installs bower modules. Takes into account if executed `in_directory` and namespaces the installed modules in the shared folder.
+
+# Modules: Whenever
+Adds settings and tasks for managing projects with [whenever].
+
+[whenever]: http://rubygems.org/gems/whenever
+
+## Common usage
+~~~ ruby
+require 'mina/whenever'
+task :deploy => :environment do
+  deploy do
+    ...
+  invoke :'whenever:update'
+end
+~~~
 
 3rd party modules
 ------
@@ -1014,6 +1085,7 @@ their own.
 * [mina-stack](https://github.com/div/mina-stack)
 * [mina-rsync](https://github.com/moll/mina-rsync)
 * [mina-sidekiq](https://github.com/Mic92/mina-sidekiq)
+* [mina-delayed_job](https://github.com/d4be4st/mina-delayed_job)
 * [mina-nginx](https://github.com/hbin/mina-nginx)
 * [mina-newrelic](https://github.com/navinpeiris/mina-newrelic)
 * [mina-rbenv-addons](https://github.com/stas/mina-rbenv-addons)
@@ -1033,7 +1105,7 @@ their own.
 Acknowledgements
 ----------------
 
-© 2012-2014, Nadarei. Released under the [MIT 
+© 2012-2015, Nadarei. Released under the [MIT 
 License](http://www.opensource.org/licenses/mit-license.php).
 
 Mina is authored and maintained by [Rico Sta. Cruz][rsc] and [Michael 
@@ -1056,7 +1128,8 @@ Michael:
 
 [rsc]: http://ricostacruz.com
 [mg]:  http://devblog.michaelgalero.com/
-[c]:   https://github.com/mina-deploy/mina/graphs/contributors
+[c]:   http://github.com/mina-deploy/mina/graphs/contributors
 [nd]:  http://nadarei.co
 [issues]: https://github.com/mina-deploy/mina/issues
 [trello]: https://trello.com/board/mina/4fc8b3023d9c9a4d72e573e6
+

data/data/deploy.rb

@@ -54,6 +54,9 @@ end
 
 desc "Deploys the current version to the server."
 task :deploy => :environment do
+  to :before_hook do
+    # Put things to run locally before ssh
+  end
   deploy do
     # Put things that will set up an empty directory into a fully set-up
     # instance of your project.

data/lib/mina.rb

@@ -7,6 +7,7 @@ module Mina
   autoload :DeployHelpers, 'mina/deploy_helpers'
   autoload :OutputHelpers, 'mina/output_helpers'
   autoload :SshHelpers, 'mina/ssh_helpers'
+  autoload :LocalHelpers, 'mina/local_helpers'
   autoload :ExecHelpers, 'mina/exec_helpers'
   autoload :Helpers, 'mina/helpers'
   autoload :Settings, 'mina/settings'

data/lib/mina/default.rb

@@ -24,7 +24,7 @@
 # Switches to be passed to the `ssh` command.
 
 # ### env_vars
-# Environment variables to be passed to `ssh` command.
+# Environment variables to be passed to `ssh` command. (e.g. "foo=bar baz=1")
 
 # ## Tasks
 # Any and all of these settings can be overriden in your `deploy.rb`.

data/lib/mina/helpers.rb

@@ -5,6 +5,7 @@ module Mina
 
     # ### invoke
     # Invokes another Rake task.
+    # By default if the task has already been invoked it will not been executed again (see the `:reenable` option).
     #
     # Invokes the task given in `task`. Returns nothing.
     #
@@ -59,6 +60,23 @@ module Mina
       report_time { ssh commands(:default) }
     end
 
+    # ### run_local!
+    # runs the code locally that has been queued.
+    # Has to be in :before_hook or :after_hook queue
+    #
+    # This is already automatically invoked before Rake exits to run all
+    # commands that have been queued up.
+    #
+    #     to :before_hook do
+    #       queue "cp file1 file2"
+    #     end
+    #     run_local!(:before_hook)
+    #
+    # Returns nothing.
+    def run_local!(aspect)
+      report_time { local commands(aspect) }
+    end
+
     # ### report_time
     # Report time elapsed in the block.
     # Returns the output of the block.
@@ -93,7 +111,9 @@ module Mina
     # Returns nothing.
 
     def mina_cleanup!
+      run_local!(:before_hook) if commands(:before_hook).any?
       run! if commands.any?
+      run_local!(:after_hook) if commands(:after_hook).any?
     end
 
     # ## Errors
@@ -138,6 +158,7 @@ module Mina
 
     def queue(code)
       commands
+      @to ||= :default
       commands(@to) << unindent(code)
     end
 
@@ -187,9 +208,8 @@ module Mina
     #     commands == ["sudo restart", "true"]
     #     commands(:clean) == ["rm"]
 
-    def commands(aspect=:default)
+    def commands(aspect = :default)
       (@commands ||= begin
-        @to = :default
         Hash.new { |h, k| h[k] = Array.new }
       end)[aspect]
     end

data/lib/mina/local_helpers.rb

@@ -0,0 +1,98 @@
+# # Helpers: Local helpers
+# You don't need to invoke these helpers, they're already invoked automatically.
+
+module Mina
+  module LocalHelpers
+    # ### local
+    # Executes a command.
+    #
+    # Returns nothing usually, but if `{ return: true }` is given, returns the
+    # STDOUT output.
+    #
+    # `options` is a hash of options:
+    #
+    #  - `:pretty` - Prettify the output if true.
+    #  - `:return`  - If set to true, returns the output.
+    #
+    # Example
+    #
+    #     local("ls", return: true)
+
+    def local(cmd, options = {})
+      require 'shellwords'
+
+      cmd = cmd.join("\n") if cmd.is_a?(Array)
+      script = Shellwords.escape(cmd)
+
+      if options[:return] == true
+        `#{script}`
+      elsif simulate_mode?
+        Local.simulate(cmd)
+      else
+        result = Local.invoke(script, self)
+        Local.ensure_successful result, self
+      end
+    end
+
+    # ## Private methods
+    # `local` delegates to these.
+
+    module Local
+      extend self
+
+      # ### Local.simulate
+      # __Internal:__ Prints command.
+
+      def simulate(cmd)
+        str = "Executing the following:"
+        puts "#!/usr/bin/env bash"
+        puts "# #{str}"
+        puts "#"
+
+        puts cmd
+
+        0
+      end
+
+      # ### Local.invoke
+      # __Internal:__ Initiates an SSH session with script `script` with given
+      # `term_mode`.  Called by `local`.
+
+      def invoke(script, this)
+        # Ruby 1.8.7 doesn't let you have empty symbols
+        term_mode = :"#{this.settings.term_mode}" if this.settings.term_mode
+        code = "#{script}"
+
+        # Certain environments can't do :pretty mode.
+        term_mode = :exec  if term_mode == :pretty && !pretty_supported?
+
+        case term_mode
+        when :pretty
+          this.pretty_system(code)
+        when :exec
+          exec code
+        else
+          system code
+          $?.to_i
+        end
+      end
+
+      # TODO: Move to concern
+      def pretty_supported?
+        # open4 is not supported under Windows.
+        # https://github.com/nadarei/mina/issues/58
+        require 'rbconfig'
+        ! (RbConfig::CONFIG['host_os'] =~ /mswin|mingw/)
+      end
+
+      # ### Local.ensure_successful
+      # __Internal:__ Halts the execution if the given result code is not
+      # successful (non-zero).
+
+      def ensure_successful(result, this)
+        this.die result if result.is_a?(Fixnum) && result > 0
+        result
+      end
+    end
+  end
+end

data/lib/mina/rake.rb

@@ -2,6 +2,7 @@
 extend Mina::Helpers
 extend Mina::DeployHelpers
 extend Mina::SshHelpers
+extend Mina::LocalHelpers
 extend Mina::OutputHelpers
 extend Mina::ExecHelpers
 

data/lib/mina/version.rb

@@ -1,5 +1,5 @@
 module Mina
   def self.version
-    "0.3.3"
+    "0.3.4"
   end
 end

data/lib/mina/whenever.rb

@@ -1,6 +1,17 @@
 # # Modules: Whenever
 # Adds settings and tasks for managing projects with [whenever].
+#
 # [whenever]: http://rubygems.org/gems/whenever
+#
+#
+# ## Common usage
+#     require 'mina/whenever'
+#
+#     task :deploy => :environment do
+#       deploy do
+#         ...
+#       invoke :'whenever:update'
+#     end
 
 namespace :whenever do
   desc "Clear crontab"

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ class RakeScope
   include Rake::DSL  if Rake.const_defined?(:DSL)
   include Mina::Helpers
   include Mina::SshHelpers
+  include Mina::LocalHelpers
 end
 
 def rake(&blk)

data/support/Readme-footer.md

@@ -2,8 +2,7 @@
 Acknowledgements
 ----------------
 
-© 2012-2014, Nadarei. Released under the [MIT 
-License](http://www.opensource.org/licenses/mit-license.php).
+© 2012-2015, Nadarei. Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
 
 Mina is authored and maintained by [Rico Sta. Cruz][rsc] and [Michael 
 Galero][mg] with help from its [contributors][c]. It is sponsored by our 
@@ -25,8 +24,8 @@ Michael:
 
 [rsc]: http://ricostacruz.com
 [mg]:  http://devblog.michaelgalero.com/
-[c]:   http://github.com/nadarei/mina/contributors
+[c]:   http://github.com/mina-deploy/mina/graphs/contributors
 [nd]:  http://nadarei.co
-[issues]: https://github.com/nadarei/mina/issues
+[issues]: https://github.com/mina-deploy/mina/issues
 [trello]: https://trello.com/board/mina/4fc8b3023d9c9a4d72e573e6
 

data/support/third_party_modules.md

@@ -0,0 +1,23 @@
+3rd party modules
+------
+
+* [mina-rollbar](https://github.com/code-lever/mina-rollbar)
+* [mina-stack](https://github.com/div/mina-stack)
+* [mina-rsync](https://github.com/moll/mina-rsync)
+* [mina-sidekiq](https://github.com/Mic92/mina-sidekiq)
+* [mina-delayed_job](https://github.com/d4be4st/mina-delayed_job)
+* [mina-nginx](https://github.com/hbin/mina-nginx)
+* [mina-newrelic](https://github.com/navinpeiris/mina-newrelic)
+* [mina-rbenv-addons](https://github.com/stas/mina-rbenv-addons)
+* [mina-multistage](https://github.com/endoze/mina-multistage)
+* [mina-s3](https://github.com/stas/mina-s3)
+* [mina-scp](https://github.com/adie/mina-scp)
+* [mina-hooks](https://github.com/elskwid/mina-hooks)
+* [mina-slack](https://github.com/TAKAyukiatkwsk/mina-slack)
+* [mina-cakephp](https://github.com/mobvox/mina-cakephp)
+* [mina-unicorn](https://github.com/openteam/mina-unicorn)
+* [mina-puma](https://github.com/sandelius/mina-puma)
+* [mina-mercurial](https://github.com/rainlabs/mina-mercurial)
+* [mina-faye](https://github.com/NingenUA/mina-faye)
+* [mina-clockwork](https://github.com/907th/mina-clockwork)
+* [mina-ftp](https://github.com/stas/mina-ftp)

data/test_env/config/deploy.rb

@@ -19,6 +19,7 @@ File.open("#{Dir.pwd}/deploy/config/database.yml", 'w') { |f| f.write "Hello" }
 require 'mina/rails'
 require 'mina/bundler'
 require 'mina/git'
+require 'pry'
 
 set :domain, 'localhost'
 set :deploy_to, "#{Dir.pwd}/deploy"
@@ -35,12 +36,18 @@ desc "Deploys."
 task :deploy => :environment do
   queue "bundle() { true; }" # Stub the bundle command.
 
+  to :before_hook do
+    queue %[ echo "-----> This is before hook"]
+  end
+
   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'
+    to :default 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'
+    end
 
     to :launch do
       invoke :'passenger:restart'
@@ -50,7 +57,17 @@ end
 
 desc "Restarts the passenger server."
 task :restart do
+  set :term_mode, :pretty
+  to :before do
+    queue %(
+      echo "-----> Copying files"
+      #{echo_cmd %[cp deploy/last_version deploy/last_version_2]}
+    )
+  end
   invoke :'passenger:restart'
+  to :after do
+    queue "echo '-----> After'"
+  end
 end
 
 namespace :passenger do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mina
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Rico Sta. Cruz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,6 +100,7 @@ files:
 - lib/mina/foreman.rb
 - lib/mina/git.rb
 - lib/mina/helpers.rb
+- lib/mina/local_helpers.rb
 - lib/mina/npm.rb
 - lib/mina/output_helpers.rb
 - lib/mina/rails.rb
@@ -137,6 +138,7 @@ files:
 - support/Readme-header.md
 - support/guide.md
 - support/index.html
+- support/third_party_modules.md
 - support/to_md.rb
 - test_env/config/deploy.rb
 homepage: http://github.com/nadarei/mina