magentify 0.0.3 → 0.0.4

data/README.md

@@ -1,29 +1,58 @@
 # Magentify
 
-TODO: Write a gem description
+[Capistrano](http://capify.org) is an open source tool for executing commands on multiple servers in parallel. It is intended to be used to easily deploying applications. While it was built specifically for deploying Rails apps, it is designed to be easily extended to deploy any type of application or run any number of commands. This project is a deployment recipes collection that works specifically with [Magento](http://www.magentocommerce.com/).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install magentify
+    
+## Project setup
 
-    gem 'magentify'
+    $ magentify .
 
-And then execute:
+## Usage
 
-    $ bundle
+Once you have run `magentify` on your project it will add a Capfile and deploy.rb configuration file
 
-Or install it yourself as:
+``` ruby config/deploy.rb
+set :application, "magento"
+set :domain,      "#{application}.com"
+set :deploy_to,   "/var/www/#{domain}"
 
-    $ gem install magentify
+set :user,        "deploy"
+set :repository,  "git@github.com:user/project.git"
+set :scm,         :git
 
-## Usage
+role :web,        "000.000.000.000"   # Your HTTP server, Apache/etc
+role :app,        "000.000.000.000"   # This may be the same as your `Web` server or a separate administration server
+
+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"]
+```
+
+Once you have magentified your project you can run:
+
+    $ cap -T
+    
+This will list all the available tasks that can be run with a shot description. For more detailed information about each of the tests run:
+
+    $ cap -e [task_name]
+    
+For detailed information about how to configure and use Capistrano for deployment you should read the Capistrano wiki pages:
 
-TODO: Write usage instructions here
+* [Getting Started](https://github.com/capistrano/capistrano/wiki/2.x-Getting-Started)
+* [From the beginning](https://github.com/capistrano/capistrano/wiki/2.x-From-The-Beginning)
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Create a cucumber scenario to describe your feature
+4. Add the steps to test the functionality
+5. Add your Feature or Fix to satisfy the tests.
+6. Commit your changes (`git commit -am 'Added some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request

data/bin/magentify

@@ -53,9 +53,8 @@ set :repository,  "#{domain}:/var/repos/#{application}.git"
 set :scm,         :git
 # Or: `accurev`, `bzr`, `cvs`, `darcs`, `subversion`, `mercurial`, `perforce`, `subversion` or `none`
 
-role :web,        domain                         # Your HTTP server, Apache/etc
-role :app,        domain                         # This may be the same as your `Web` server
-role :db,         domain, :primary => true       # This is where Rails migrations will run
+role :web, domain   # Your HTTP server, Apache/etc
+role :app, domain   # This may be the same as your `Web` server or a separate administration server
 
 set  :keep_releases,  3
 

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: features
+autotest: --color
+autotest-all: --color 

data/features/compiler.feature

@@ -0,0 +1,24 @@
+Feature: Compiler
+  In order to make Magento fast
+  As a developer
+  I want the compiler to be run during finalize_deploy
+
+  Scenario: User runs $ cap deploy with compile true
+    Given an app
+    When I execute deploy with --set compile=true
+    Then the Magento compiler should be executed
+
+  Scenario: User runs $ cap deploy with compile false
+    Given an app
+    When I execute deploy with --set compile=false
+    Then the Magento compiler should not be executed
+
+  Scenario: User enables compiler
+    Given an app
+    When I execute mage:enable_compiler
+    Then the Magento compiler should be executed with enable option
+
+  Scenario: User disables compiler
+    Given an app
+    When I execute mage:disable_compiler
+    Then the Magento compiler should be executed with disable option

data/features/deploy.feature

@@ -11,4 +11,16 @@ Feature: Deployment
   Scenario: User runs $ cap deploy with missing config
     Given an app
     When I have deploy.rb with missing config
-    Then [error] should be returned
+    Then [error] should be returned
+
+  Scenario: User runs $ cap mage:disable
+    Given an app
+    When I execute deploy
+    And I execute mage:disable
+    Then the maintenance.flag file should be written to current
+
+  Scenario: User runs $ cap mage:enable
+    Given an app
+    When I execute deploy
+    And I execute mage:enable
+    Then the maintenance.flag file should be removed from current

data/features/indexer.feature

@@ -0,0 +1,9 @@
+Feature: Indexer
+  In order to make Magento fast
+  As a developer
+  I want the indexer to run to fill flat tables
+
+  Scenario: User runs $ mage:indexer
+    Given an app
+    When I execute mage:indexer
+    Then the Magento indexer should be executed

data/features/log.feature

@@ -0,0 +1,9 @@
+Feature: Log
+  In order to free disk space
+  As a developer
+  I want the log script to clear logs
+
+  Scenario: User runs $ mage:clean_log
+    Given an app
+    When I execute mage:clean_log
+    Then the Magento log should be executed

data/features/step_definitions/common_steps.rb

@@ -6,11 +6,15 @@ Given /^an app$/ do
   end
 
   # Create and capify the dummy app, and push it to the local repo
-  FileUtils.mkdir_p @app_dir
-  Dir.chdir(@app_dir) do
+  FileUtils.mkdir_p @src_dir
+  Dir.chdir(@src_dir) do
     [
       %Q{git init > /dev/null 2>&1} ,
-      %Q{mkdir config > /dev/null 2>&1},
+      %Q{mkdir -p app/etc media var shell staging sitemaps > /dev/null 2>&1},
+      %Q{touch  shell/compiler.php > /dev/null 2>&1},
+      %Q{touch  shell/index.php > /dev/null 2>&1},
+      %Q{touch  shell/log.php > /dev/null 2>&1},
+      %Q{touch  app/etc/local.xml > /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},
@@ -32,7 +36,7 @@ Given /^an app$/ do
   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| 
+  File.open(File.join(@src_dir, "config", "deploy.rb"), 'w') {|f| 
     f.write compiled_template
   }
 end

data/features/step_definitions/compiler_steps.rb

@@ -0,0 +1,39 @@
+When /^I execute deploy with \-\-set compile=true$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap deploy --set compile=true 2>&1]
+  end
+end
+
+Then /^the Magento compiler should be executed$/ do
+  @out.match('php -f compiler.php -- compile').should be_true
+end
+
+When /^I execute deploy with \-\-set compile=false$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap deploy --set compile=false 2>&1]
+  end
+end
+
+Then /^the Magento compiler should not be executed$/ do
+  @out.match('php -f compiler.php -- compile').should be_false
+end
+
+When /^I execute mage:enable_compiler$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap mage:enable_compiler 2>&1]
+  end
+end
+
+Then /^the Magento compiler should be executed with enable option$/ do
+  @out.match('php -f compiler.php -- enable').should be_true
+end
+
+When /^I execute mage:disable_compiler$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap mage:disable_compiler 2>&1]
+  end
+end
+
+Then /^the Magento compiler should be executed with disable option$/ do
+  @out.match('php -f compiler.php -- disable').should be_true
+end

data/features/step_definitions/deploy_steps.rb

@@ -1,5 +1,5 @@
 When /^I execute deploy$/ do
-  Dir.chdir(@app_dir) do
+  Dir.chdir(@src_dir) do
     system "cap deploy:setup > /dev/null 2>&1"
     system "cap deploy > /dev/null 2>&1"
   end
@@ -21,14 +21,34 @@ When /^I have deploy\.rb with missing config$/ do
   template_path     = File.expand_path(File.join(__FILE__, "..", "..", "templates", "deploy-fail.erb"))
   compiled_template = ERB.new(File.read(template_path)).result(binding)
 
-  File.open(File.join(@app_dir, "config", "deploy.rb"), 'w') {|f| 
+  File.open(File.join(@src_dir, "config", "deploy.rb"), 'w') {|f| 
     f.write compiled_template
   }
+  Dir.chdir(@src_dir) do
+    @out = %x[cap deploy 2>&1]
+  end
 end
 
 Then /^\[error\] should be returned$/ do
-  Dir.chdir(@app_dir) do
-    result = %x[cap -T]
-    result.match('error').should be_true
+  @out.match('Please').should be_true
+end
+
+When /^I execute mage:disable$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap mage:disable 2>&1]
+  end
+end
+
+Then /^the maintenance\.flag file should be written to current$/ do
+  File.exists?(File.join(@test_files_dir, "deployed", "current", "maintenance.flag")).should be_true
+end
+
+When /^I execute mage:enable$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap mage:enable 2>&1]
   end
+end
+
+Then /^the maintenance\.flag file should be removed from current$/ do
+  File.exists?(File.join(@test_files_dir, "deployed", "current", "maintenance.flag")).should be_false
 end

data/features/step_definitions/indexer_steps.rb

@@ -0,0 +1,9 @@
+When /^I execute mage:indexer$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap mage:indexer 2>&1]
+  end
+end
+
+Then /^the Magento indexer should be executed$/ do
+  @out.match('php -f indexer.php -- reindexall').should be_true
+end

data/features/step_definitions/log_steps.rb

@@ -0,0 +1,9 @@
+When /^I execute mage:clean_log$/ do
+  Dir.chdir(@src_dir) do
+    @out = %x[cap mage:clean_log 2>&1]
+  end
+end
+
+Then /^the Magento log should be executed$/ do
+  @out.match('php -f log.php -- clean').should be_true
+end

data/features/step_definitions/magentify_steps.rb

@@ -1,21 +1,21 @@
 When /^I execute magentify \.$/ do
-  Dir.chdir(@app_dir) do
+  Dir.chdir(@src_dir) do
     system "magentify . > /dev/null 2>&1"
   end
 end
 
 Then /^Capfile should load mage\.rb$/ do
-  File.open(File.join(@app_dir, "Capfile"), 'rb').read().match('mage\.rb').should be_true
+  File.open(File.join(@src_dir, "Capfile"), 'rb').read().match('mage\.rb').should be_true
 end
 
 When /^I execute cap \-T$/ do
-  Dir.chdir(@app_dir) do
+  Dir.chdir(@src_dir) do
     system "cap -T > /dev/null 2>&1"
   end
 end
 
 Then /^mage tasks should be listed$/ do
-  Dir.chdir(@app_dir) do
+  Dir.chdir(@src_dir) do
     result = %x[cap -T]
     result.match('Clear the Magento Cache').should be_true
   end

data/features/step_definitions/setup_steps.rb

@@ -1,5 +1,5 @@
 When /^I execute deploy:setup$/ do
-  Dir.chdir(@app_dir) do
+  Dir.chdir(@src_dir) do
     system "cap deploy:setup > /dev/null 2>&1"
   end
 end

data/features/support/env.rb

@@ -4,9 +4,13 @@ require 'etc'
 
 Before do
   @test_files_dir = File.join(Dir.pwd, "_files")
-  @app_dir  = File.join(@test_files_dir, "app")
+  @src_dir  = File.join(@test_files_dir, "src")
   @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)
+  # Iinstall the latest version of the gem
+  system "gem uninstall magenify --version '>= 0' --executables --force > /dev/null 2>&1"
+  system "rake build > /dev/null 2>&1"
+  system "rake install > /dev/null 2>&1"
 end

data/features/templates/deploy-fail.erb

@@ -10,7 +10,6 @@ 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
 

data/features/templates/deploy.erb

@@ -10,7 +10,6 @@ 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
 

data/lib/mage.rb

@@ -4,12 +4,17 @@ load Gem.find_files('nonrails.rb').last.to_s
 # These variables MUST be set in the client capfiles. If they are not set,
 # the deploy will fail with an error.
 # =========================================================================
-
-_cset(:app_symlinks) { 
-  abort "[error] Please specify an array of symlinks to shared resources, set :app_symlinks, ['/media', .. '/staging']"
+_cset(:app_symlinks) {
+  abort "Please specify an array of symlinks to shared resources, set :app_symlinks, ['/media', ./. '/staging']"
+}
+_cset(:app_shared_dirs)  {
+  abort "Please specify an array of shared directories to be created, set :app_shared_dirs"
+}
+_cset(:app_shared_files)  {
+  abort "Please specify an array of shared files to be symlinked, set :app_shared_files"
 }
-_cset(:app_shared_dirs)  { abort "[error] Please specify, set :app_shared_dirs" }
-_cset(:app_shared_files)  { abort "[error] Please specify, set :app_shared_files" }
+
+_cset :compile, false
 
 namespace :mage do
   desc <<-DESC
@@ -24,7 +29,7 @@ namespace :mage do
     It is safe to run this task on servers that have already been set up; it \
     will not destroy any deployed revisions or data.
   DESC
-  task :setup, :roles => :web, :except => { :no_release => true } do
+  task :setup, :roles => [:web, :app], :except => { :no_release => true } do
     if app_shared_dirs
       app_shared_dirs.each { |link| run "#{try_sudo} mkdir -p #{shared_path}#{link} && chmod g+w #{shared_path}#{link}"}
     end
@@ -40,7 +45,7 @@ namespace :mage do
     Any directories deployed from the SCM are first removed and then replaced with \
     symlinks to the same directories within the shared location.
   DESC
-  task :finalize_update, :roles => :web, :except => { :no_release => true } do    
+  task :finalize_update, :roles => [:web, :app], :except => { :no_release => true } do    
     run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
 
     if app_symlinks
@@ -56,14 +61,12 @@ namespace :mage do
       # Add symlinks the directoris in the shared location
       app_shared_files.each { |link| run "ln -s #{shared_path}#{link} #{latest_release}#{link}" }
     end
-    # TODO should add configoration for this happening post deployment.
-    compiler
   end
 
   desc <<-DESC
     Clear the Magento Cache
   DESC
-  task :cc, :roles => :web do
+  task :cc, :roles => [:web, :app] do
     run "cd #{current_path} && rm -rf var/cache/*"
   end
 
@@ -84,38 +87,41 @@ namespace :mage do
   desc <<-DESC
     Run the Magento compiler
   DESC
-  task :compiler, :roles => :web do
-    run "cd #{current_path}/shell && php -f compiler.php -- compile"
+  task :compiler, :roles => [:web, :app] do
+    if fetch(:compile, true)
+      run "cd #{current_path}/shell && php -f compiler.php -- compile"
+    end
   end
 
   desc <<-DESC
     Enable the Magento compiler
   DESC
-  task :enable_compiler, :roles => :web do
+  task :enable_compiler, :roles => [:web, :app] do
     run "cd #{current_path}/shell && php -f compiler.php -- enable"
   end
 
   desc <<-DESC
     Disable the Magento compiler
   DESC
-  task :disable_compiler, :roles => :web do
+  task :disable_compiler, :roles => [:web, :app] do
     run "cd #{current_path}/shell && php -f compiler.php -- disable"
   end
 
   desc <<-DESC
     Run the Magento indexer
   DESC
-  task :indexer, :roles => :app do
+  task :indexer, :roles => [:web, :app] do
     run "cd #{current_path}/shell && php -f indexer.php -- reindexall"
   end
 
   desc <<-DESC
     Clean the Magento logs
   DESC
-  task :clean_logs, :roles => :web do
+  task :clean_log, :roles => [:web, :app] do
     run "cd #{current_path}/shell && php -f log.php -- clean"
   end
 end
 
 after   'deploy:setup', 'mage:setup'
-after   'deploy:finalize_update', 'mage:finalize_update'
+after   'deploy:finalize_update', 'mage:finalize_update'
+after   'deploy:create_symlink', 'mage:compiler'

data/lib/magentify/version.rb

@@ -1,3 +1,3 @@
 module Magentify
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magentify
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000 Z
+date: 2012-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70214939636340 !ruby/object:Gem::Requirement
+  requirement: &70222656570860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.5.10
   type: :runtime
   prerelease: false
-  version_requirements: *70214939636340
+  version_requirements: *70222656570860
 description: An extension to Capistrano to deploy Magento. Adding the specific requirements
   and additional tasks.
 email:
@@ -37,11 +37,18 @@ files:
 - README.md
 - Rakefile
 - bin/magentify
+- cucumber.yml
+- features/compiler.feature
 - features/deploy.feature
+- features/indexer.feature
+- features/log.feature
 - features/magentify.feature
 - features/setup.feature
 - features/step_definitions/common_steps.rb
+- features/step_definitions/compiler_steps.rb
 - features/step_definitions/deploy_steps.rb
+- features/step_definitions/indexer_steps.rb
+- features/step_definitions/log_steps.rb
 - features/step_definitions/magentify_steps.rb
 - features/step_definitions/setup_steps.rb
 - features/support/env.rb
@@ -78,11 +85,17 @@ signing_key:
 specification_version: 3
 summary: Deploying Magento PHP applications with Capistrano.
 test_files:
+- features/compiler.feature
 - features/deploy.feature
+- features/indexer.feature
+- features/log.feature
 - features/magentify.feature
 - features/setup.feature
 - features/step_definitions/common_steps.rb
+- features/step_definitions/compiler_steps.rb
 - features/step_definitions/deploy_steps.rb
+- features/step_definitions/indexer_steps.rb
+- features/step_definitions/log_steps.rb
 - features/step_definitions/magentify_steps.rb
 - features/step_definitions/setup_steps.rb
 - features/support/env.rb