capistrano-maintenance 0.0.2 → 0.0.3

data/README.md

@@ -8,10 +8,27 @@ Usage
 
 Install the gem via rubygems:
 
-`gem install capistrano-maintenance`
+    gem install capistrano-maintenance
 
 And put this line into your deploy.rb file:
 
-`require 'capistrano/maintenance'`
+    require 'capistrano/maintenance'
 
 That's it. Everthing works like expected.
+
+Configuration
+-------------
+
+Everything should work out of the box general, but there are some additional adjustments you can make in your deploy.rb.
+
+    # change the default filename from maintenance.html to disabled.html
+    set :maintenance_basename, 'disabled'
+
+    # change default directory from default of #{shared_path}/system
+    set :maintenance_dirname, "#{shared_path}/public/system"
+
+    # use local template instead of included one with capistrano-maintenance
+    set :maintenance_template_path, 'app/views/maintenance.html'
+
+	# disable the warning on how to configure your server
+	set :maintenance_config_warning, false

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/gem_helper'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+task :default => :build

data/lib/capistrano/maintenance.rb

@@ -5,6 +5,7 @@ module Capistrano::Maintenance
   def self.load_into(configuration)
     configuration.load do
 
+      _cset(:maintenance_dirname) { "#{shared_path}/system" }
       _cset :maintenance_basename, "maintenance"
       _cset(:maintenance_template_path) { File.join(File.dirname(__FILE__), "templates", "maintenance.html.erb") }
 
@@ -34,31 +35,33 @@ module Capistrano::Maintenance
           DESC
           task :disable, :roles => :web, :except => { :no_release => true } do
             require 'erb'
-            on_rollback { run "rm -f #{shared_path}/system/#{maintenance_basename}.html" }
-
-            warn <<-EOHTACCESS
-
-              # Please add something like this to your site's Apache htaccess to redirect users to the maintenance page.
-              # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
-
-              ErrorDocument 503 /system/#{maintenance_basename}.html
-              RewriteEngine On
-              RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
-              RewriteCond %{DOCUMENT_ROOT}/system/#{maintenance_basename}.html -f
-              RewriteCond %{SCRIPT_FILENAME} !#{maintenance_basename}.html
-              RewriteRule ^.*$  -  [redirect=503,last]
-
-              # Or if you are using Nginx add this to your server config:
-
-              if (-f $document_root/system/maintenance.html) {
-                return 503;
-              }
-              error_page 503 @maintenance;
-              location @maintenance {
-                rewrite  ^(.*)$  /system/maintenance.html last;
-                break;
-              }
-            EOHTACCESS
+            on_rollback { run "rm -f #{mainteannce_dirname}/#{maintenance_basename}.html" }
+
+            if fetch(:maintenance_config_warning, true)
+              warn <<-EOHTACCESS
+
+                # Please add something like this to your site's Apache htaccess to redirect users to the maintenance page.
+                # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
+
+                ErrorDocument 503 /system/#{maintenance_basename}.html
+                RewriteEngine On
+                RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
+                RewriteCond %{DOCUMENT_ROOT}/system/#{maintenance_basename}.html -f
+                RewriteCond %{SCRIPT_FILENAME} !#{maintenance_basename}.html
+                RewriteRule ^.*$  -  [redirect=503,last]
+
+                # Or if you are using Nginx add this to your server config:
+
+                if (-f $document_root/system/maintenance.html) {
+                  return 503;
+                }
+                error_page 503 @maintenance;
+                location @maintenance {
+                  rewrite  ^(.*)$  /system/maintenance.html last;
+                  break;
+                }
+              EOHTACCESS
+            end
 
             reason = ENV['REASON']
             deadline = ENV['UNTIL']
@@ -66,7 +69,7 @@ module Capistrano::Maintenance
             template = File.read(maintenance_template_path)
             result = ERB.new(template).result(binding)
 
-            put result, "#{shared_path}/system/#{maintenance_basename}.html", :mode => 0644
+            put result, "#{maintenance_dirname}/#{maintenance_basename}.html", :mode => 0644
           end
 
           desc <<-DESC
@@ -76,7 +79,7 @@ module Capistrano::Maintenance
             web-accessible again.
           DESC
           task :enable, :roles => :web, :except => { :no_release => true } do
-            run "rm -f #{shared_path}/system/#{maintenance_basename}.html"
+            run "rm -f #{maintenance_dirname}/#{maintenance_basename}.html"
           end
 
         end

data/lib/capistrano/maintenance/version.rb

@@ -1,3 +1,3 @@
 module Capistrano::Maintenance
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-maintenance
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -36,6 +36,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - README.md
+- Rakefile
 - capistrano-maintenance.gemspec
 - lib/capistrano/maintenance.rb
 - lib/capistrano/maintenance/version.rb