magentify 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+_files

data/features/deploy.feature

@@ -0,0 +1,9 @@
+Feature: Deployment
+  In order to deploy Magento
+  As a developer
+  I want my release to be uploaded and symlinks to shared resources created
+
+  Scenario: User runs $ cap deploy
+    Given an app
+    When I execute deploy
+    Then the PEOPLE_LIKE_YOU file should be written to shared

data/features/magentify.feature

@@ -0,0 +1,14 @@
+Feature: Magentify
+  In order to deploy Magento with Capistrano
+  As a developer
+  I want my project to be configured to use Magento specific deploy tasks
+
+  Scenario: User runs $ magentify .
+    Given an app
+    When I execute magentify .
+    Then deploy.rb should load mage.rb
+
+  Scenario: User runs $ cap -T
+    Given an app
+    When I execute cap -T
+    Then cap -T should list mage

data/features/setup.feature

@@ -0,0 +1,9 @@
+Feature: Setup
+  In order to deploy Magento
+  As a developer
+  I want the correct folder structure created on the remote server
+
+  Scenario: User runs $ cap deploy:setup
+    Given an app
+    When I execute deploy:setup
+    Then the shared folder structure should be created

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,38 @@
+Given /^an app$/ do
+  # Create the git repo
+  FileUtils.mkdir_p @repo_dir
+  Dir.chdir(@repo_dir) do
+    system "git --bare init > /dev/null 2>&1"
+  end
+
+  # Create and capify the dummy app, and push it to the local repo
+  FileUtils.mkdir_p @app_dir
+  Dir.chdir(@app_dir) do
+    [
+      %Q{git init > /dev/null 2>&1} ,
+      %Q{mkdir config > /dev/null 2>&1},
+      %Q{magentify . > /dev/null 2>&1},
+      %Q{git add . > /dev/null 2>&1},
+      %Q{git commit -m "first commit" > /dev/null 2>&1},
+      %Q{git remote add origin file://#{@repo_dir} > /dev/null 2>&1},
+      %Q{git push origin master > /dev/null 2>&1}
+    ].each do |command|
+      system command
+    end
+  end
+
+  # Write a custom deploy file to the app, using an ERB template
+  deploy_variables = {
+    :deploy_to => File.join(@test_files_dir, "deployed"),
+    :repository => @repo_dir,
+    :git_executable => `which git`.strip,
+    :logged_in_user => Etc.getlogin
+  }
+
+  template_path     = File.expand_path(File.join(__FILE__, "..", "..", "templates", "deploy.erb"))
+  compiled_template = ERB.new(File.read(template_path)).result(binding)
+
+  File.open(File.join(@app_dir, "config", "deploy.rb"), 'w') {|f| 
+    f.write compiled_template
+  }
+end

data/features/step_definitions/deploy_steps.rb

@@ -0,0 +1,10 @@
+When /^I execute deploy$/ do
+  Dir.chdir(@app_dir) do
+    system "cap deploy:setup > /dev/null"
+    system "cap deploy > /dev/null"
+  end
+end
+
+Then /^the PEOPLE_LIKE_YOU file should be written to shared$/ do
+  File.exists?(File.join(@test_files_dir, "deployed", "shared", "PEOPLE_LIKE_YOU")).should be_true
+end

data/features/step_definitions/magentify_steps.rb

@@ -0,0 +1,19 @@
+When /^I execute magentify \.$/ do
+  Dir.chdir(@app_dir) do
+    system "magentify . > /dev/null"
+  end
+end
+
+Then /^deploy\.rb should load mage\.rb$/ do
+  pending # express the regexp above with the code you wish you had
+end
+
+When /^I execute cap \-T$/ do
+  Dir.chdir(@app_dir) do
+    system "cap -T > /dev/null"
+  end
+end
+
+Then /^cap \-T should list mage$/ do
+  pending # express the regexp above with the code you wish you had
+end

data/features/step_definitions/setup_steps.rb

@@ -0,0 +1,9 @@
+When /^I execute deploy:setup$/ do
+  Dir.chdir(@app_dir) do
+    system "cap deploy:setup > /dev/null"
+  end
+end
+
+Then /^the shared folder structure should be created$/ do
+  pending # express the regexp above with the code you wish you had
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+# require 'spec'
+require 'erb'
+require 'etc'
+
+Before do
+  @test_files_dir = File.join(Dir.pwd, "_files")
+  @app_dir  = File.join(@test_files_dir, "app")
+  @repo_dir = File.join(@test_files_dir, "repo")
+
+  FileUtils.rm_r(@test_files_dir) if File.exists?(@test_files_dir)
+  FileUtils.mkdir_p(@test_files_dir)
+end

data/features/templates/deploy.erb

@@ -0,0 +1,19 @@
+set :application, "magento"
+set :domain,      "#{application}.com"
+set :deploy_to,   "<%= deploy_variables[:deploy_to] %>"
+
+set :user,        "<%= deploy_variables[:logged_in_user] %>"
+set :repository,  "file://<%= deploy_variables[:repository] %>"
+set :scm,         :git
+# Or: `accurev`, `bzr`, `cvs`, `darcs`, `subversion`, `mercurial`, `perforce`, `subversion` or `none`
+set :scm_command, "<%= deploy_variables[:git_executable] %>"
+
+role :web,        "localhost"                         # Your HTTP server, Apache/etc
+role :app,        "localhost"                         # This may be the same as your `Web` server
+role :db,         "localhost", :primary => true       # This is where Rails migrations will run
+
+set  :keep_releases,  3
+
+set :app_symlinks, ["/media", "/var", "/sitemaps", "/staging"]
+set :app_shared_dirs, ["/app/etc", "/sitemaps", "/media", "/var", "/staging"]
+set :app_shared_files, ["/app/etc/local.xml"]

data/lib/mage.rb

@@ -1,3 +1,4 @@
+load Gem.find_files('nonrails.rb').last.to_s
 set :app_symlinks, ["/media", "/var", "/sitemaps", "/staging"]
 set :app_shared_dirs, ["/app/etc", "/sitemaps", "/media", "/var", "/staging"]
 set :app_shared_files, ["/app/etc/local.xml"]

data/lib/magentify/version.rb

@@ -1,3 +1,3 @@
 module Magentify
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/nonrails.rb

@@ -0,0 +1,124 @@
+# =========================================================================
+# These are the tasks that are available to help with deploying web apps,
+# and specifically, NON Rails applications. You can have cap give you a summary
+# of them with `cap -T'.
+# =========================================================================
+
+namespace :deploy do
+  desc <<-DESC
+    [Overload] Deploys your project. This calls `update'. Note that \
+    this will generally only work for applications that have already been deployed \
+    once. For a "cold" deploy, you'll want to take a look at the `deploy:cold' \
+    task, which handles the cold start specifically.
+  DESC
+  task :default do
+    update
+  end
+
+  desc <<-DESC
+    [Overload] Touches up the released code. This is called by update_code \
+    after the basic deploy finishes.
+
+    This method should be overridden to meet the requirements of your allocation.
+  DESC
+  task :finalize_update, :except => { :no_release => true } do
+    #
+  end
+
+  desc <<-DESC
+    [Overload] Default actions cancelled
+  DESC
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    #
+  end
+
+  desc <<-DESC
+    [Overload] Default actions cancelled.
+  DESC
+  task :migrate, :roles => :db, :only => { :primary => true } do
+    #
+  end
+
+  desc <<-DESC
+    [Overload] Default actions cancelled.
+  DESC
+  task :migrations do
+    set :migrate_target, :latest
+    #
+  end
+
+  desc <<-DESC
+    [Overload] Default actions only calls 'update'.
+  DESC
+  task :cold do
+    update
+  end
+
+  desc <<-DESC
+    [Overload] Default actions cancelled.
+  DESC
+  task :start, :roles => :app do
+    #
+  end
+
+  desc <<-DESC
+    [Overload] Default actions cancelled.
+  DESC
+  task :stop, :roles => :app do
+    #
+  end
+
+  namespace :web do
+    desc <<-DESC
+      Present a maintenance page to visitors. Disables your application's web \
+      interface by writing a "maintenance.html" file to each web server. The \
+      servers must be configured to detect the presence of this file, and if \
+      it is present, always display it instead of performing the request.
+
+      By default, the maintenance page will just say the site is down for \
+      "maintenance", and will be back "shortly", but you can customize the \
+      page by specifying the REASON and UNTIL environment variables:
+
+        $ cap deploy:web:disable \\
+              REASON="hardware upgrade" \\
+              UNTIL="12pm Central Time"
+
+      Further customization will require that you write your own task.
+    DESC
+    task :disable, :roles => :web, :except => { :no_release => true } do
+      require 'erb'
+      on_rollback { run "rm #{shared_path}/system/maintenance.html" }
+
+      warn <<-EOHTACCESS
+
+        # Please add something like this to your site's 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.html
+        RewriteEngine On
+        RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
+        RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
+        RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+        RewriteRule ^.*$  -  [redirect=503,last]
+      EOHTACCESS
+
+      reason = ENV['REASON']
+      deadline = ENV['UNTIL']
+
+      template = File.read(File.join(File.dirname(__FILE__), "templates", "maintenance.rhtml"))
+      result = ERB.new(template).result(binding)
+
+      put result, "#{shared_path}/system/maintenance.html", :mode => 0644
+    end
+
+    desc <<-DESC
+      Makes the application web-accessible again. Removes the \
+      "maintenance.html" page generated by deploy:web:disable, which (if your \
+      web servers are configured correctly) will make your application \
+      web-accessible again.
+    DESC
+    task :enable, :roles => :web, :except => { :no_release => true } do
+      run "rm #{shared_path}/system/maintenance.html"
+    end
+  end
+end

data/magentify.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["alistair.stead@designdisclosure.com"]
   gem.description   = %q{An extension to Capistrano to deploy Magento. Adding the specific requirements and additional tasks.}
   gem.summary       = %q{Deploying Magento PHP applications with Capistrano.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/alistairstead/Magentify"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magentify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70328495790360 !ruby/object:Gem::Requirement
+  requirement: &70095624644500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.5.10
   type: :runtime
   prerelease: false
-  version_requirements: *70328495790360
+  version_requirements: *70095624644500
 description: An extension to Capistrano to deploy Magento. Adding the specific requirements
   and additional tasks.
 email:
@@ -37,11 +37,21 @@ files:
 - README.md
 - Rakefile
 - bin/magentify
+- features/deploy.feature
+- features/magentify.feature
+- features/setup.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/deploy_steps.rb
+- features/step_definitions/magentify_steps.rb
+- features/step_definitions/setup_steps.rb
+- features/support/env.rb
+- features/templates/deploy.erb
 - lib/mage.rb
 - lib/magentify.rb
 - lib/magentify/version.rb
+- lib/nonrails.rb
 - magentify.gemspec
-homepage: ''
+homepage: https://github.com/alistairstead/Magentify
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -65,4 +75,13 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Deploying Magento PHP applications with Capistrano.
-test_files: []
+test_files:
+- features/deploy.feature
+- features/magentify.feature
+- features/setup.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/deploy_steps.rb
+- features/step_definitions/magentify_steps.rb
+- features/step_definitions/setup_steps.rb
+- features/support/env.rb
+- features/templates/deploy.erb