capistrano-laravel 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b03cb47879f02595e858aa71eadaadc8457cfb5b
+  data.tar.gz: 92f4535330e34d0f8e313c2b8cacf429a1df6639
+SHA512:
+  metadata.gz: 63567ba7474436fbeb694ffb11d908c92411fd80e0575f395c8952319fb33f6cdc654870acb5c2a45912b8c2f2011864bf8041719cc1e8f257cd1b81adca52ee
+  data.tar.gz: ad6d24774e0fbf6b7979a2ea198c20e11862dba6b13295e56ba0b9d8065c49a8d708ce2f8056ae23450839e0ad82e0d833e652d506495e635714e9dd142abf71

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,6 +1,6 @@
-# Capistrano::FilePermissions
+# Capistrano::laravel
 
-File permissions handling for Capistrano v3.*
+Deploy Laravel applications with Capistrano v3.*
 
 ## Installation
 
@@ -29,14 +29,75 @@ require 'capistrano/laravel'
 
 ### Configuration
 
-The gem makes the following configuration variables available (shown with defaults)
+The gem makes the following configuration variables available (shown with defaults).
 
 ```ruby
+# Which roles to execute commands on.
 set :laravel_roles, :all
-set :laravel_artisan_flags, "--env production"
+
+# Determines which operations to perform based on which version
+# of the Laravel framework your project is using.
+set :laravel_version, 5.1
+
+# If using Laravel 5+, a dotenv file is used for environment configuration.
+# This variable uploads the given file from the the host to the guest.
+set :laravel_dotenv_file, './.env'
+
+# Flags to add to artisan calls.
+set :laravel_artisan_flags, "--env=production"
+
+# Will set linked folders based on your Laravel version
+set :laravel_set_linked_dirs, false
+
+# Will set ACL paths based on your Laravel version
+set :laravel_set_acl_paths, true
+
+# Which user to set ACL permissions for.
 set :laravel_server_user, "www-data"
 ```
 
+### Tasks
+
+The tasks are more or less automatic and are executed as follows:
+
+```ruby
+  before "deploy:starting", :prepare_laravel do
+    invoke "laravel:configure_folders"
+  end
+
+  before "deploy:updated", :laravel_tasks do
+    invoke "laravel:upload_dotenv_file"
+    invoke "laravel:optimize_release"
+    invoke "laravel:create_acl_paths"
+    invoke "deploy:set_permissions:acl"
+  end
+```
+
+#### Task Descriptions
+
+```ruby
+# Execute an artisan command
+invoke "laravel:artisan", "command"
+
+# Run any optimization commands
+invoke "laravel:optimize_release"
+
+# Configure linked dirs/acl dirs
+invoke "laravel:configure_folders"
+
+# Upload the dotenv file from local to remote
+invoke "laravel:upload_dotenv_file"
+
+# Seed the database
+invoke "laravel:seed_db"
+
+# Create any missing folders for ACL
+invoke "laravel:create_acl_paths"
+
+# Run migrations for the database
+invoke "laravel:migrate_db"
+```
+
 ## Contributing
 
 1. Fork it

data/capistrano-laravel.gemspec

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-laravel'
-  spec.version       = '0.0.2'
-  spec.authors       = ['Peter Mitchell']
-  spec.email         = ['peterjmit@gmail.com']
-  spec.description   = %q{Laravel deployment for Capistrano 3.x}
+  spec.version       = '0.0.3'
+  spec.authors       = ['Peter Mitchell', 'Andrew Miller']
+  spec.email         = ['peterjmit@gmail.com', 'ikari7789@yahoo.com']
+  spec.description   = %q{Laravel specific deployment options for Capistrano 3.x}
   spec.summary       = %q{Laravel deployment for Capistrano 3.x}
-  spec.homepage      = 'https://github.com/peterjmit/capistrano-laravel'
+  spec.homepage      = 'https://github.com/capistrano/laravel'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'capistrano', '>= 3.0.0'
-  spec.add_dependency 'capistrano-composer', '>= 0.0.3'
-  spec.add_dependency 'capistrano-file-permissions'
+  spec.add_dependency 'capistrano', '~> 3.0'
+  spec.add_dependency 'capistrano-composer', '~> 0.0.6'
+  spec.add_dependency 'capistrano-file-permissions', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake', '~> 10.4'
 end

data/lib/capistrano/laravel.rb

@@ -1,11 +1,4 @@
 require "capistrano/composer"
 require "capistrano/file-permissions"
-require "capistrano/laravel/artisan"
-require "capistrano/laravel/laravel"
-# require "capistrano/laravel/migrations"
 
-namespace :load do
-  task :defaults do
-    load 'capistrano/laravel/defaults.rb'
-  end
-end
+load File.expand_path("../tasks/laravel.rake", __FILE__)

data/lib/capistrano/laravel/helpers.rb

@@ -0,0 +1,6 @@
+module Capistrano
+  module Laravel
+    module Helpers
+    end
+  end
+end

data/lib/capistrano/laravel/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Laravel
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/tasks/laravel.rake

@@ -1,8 +1,174 @@
-namespace :deploy do
-  task :optimize do
-    invoke "laravel:artisan", "optimize"
+require 'capistrano/laravel/helpers'
+
+include Comparable
+include Capistrano::Laravel::Helpers
+
+namespace :load do
+  task :defaults do
+    set :laravel_roles, :all
+    set :laravel_migrate_roles, :all
+    set :laravel_version, 5.1
+    set :laravel_dotenv_file, './.env'
+    set :laravel_artisan_flags, '--env=production'
+    set :laravel_artisan_migrate_flags, '--env=production'
+    set :laravel_set_linked_dirs, true
+    set :laravel_set_acl_paths, true
+    set :laravel_create_linked_acl_paths, true
+    set :laravel_server_user, 'www-data'
+
+    # Folders to link between releases
+    set :laravel_4_linked_dirs, [
+      'app/storage'
+    ]
+    set :laravel_5_linked_dirs, [
+      'storage'
+    ]
+    set :laravel_5_1_linked_dirs, [
+      'storage'
+    ]
+
+    # Folders to set permissions on based on laravel version
+    set :laravel_4_acl_paths, [
+      'app/storage',
+      'app/storage/cache',
+      'app/storage/logs',
+      'app/storage/meta',
+      'app/storage/sessions',
+      'app/storage/views'
+    ]
+    set :laravel_5_acl_paths, [
+      'storage',
+      'storage/app',
+      'storage/framework',
+      'storage/framework/cache',
+      'storage/framework/sessions',
+      'storage/framework/views',
+      'storage/logs'
+    ]
+    set :laravel_5_1_acl_paths, [
+      'bootstrap/cache',
+      'storage',
+      'storage/app',
+      'storage/framework',
+      'storage/framework/cache',
+      'storage/framework/sessions',
+      'storage/framework/views',
+      'storage/logs'
+    ]
+  end
+end
+
+namespace :laravel do
+  desc 'Set the ACL for the web user based on Laravel version.'
+  task :configure_folders do
+    laravel_version = fetch(:laravel_version)
+    laravel_linked_dirs = []
+    laravel_acl_paths = []
+    if laravel_version < 5 # Laravel 4
+      laravel_linked_dirs = fetch(:laravel_4_linked_dirs)
+      laravel_acl_paths   = fetch(:laravel_4_acl_paths)
+    elsif laravel_version < 5.1 # Laravel 5
+      laravel_linked_dirs = fetch(:laravel_5_linked_dirs)
+      laravel_acl_paths   = fetch(:laravel_5_acl_paths)
+    else # Laravel 5.1 or greater
+      laravel_linked_dirs = fetch(:laravel_5_1_linked_dirs)
+      laravel_acl_paths   = fetch(:laravel_5_1_acl_paths)
+    end
+
+    if fetch(:laravel_set_linked_dirs)
+      set :linked_dirs, fetch(:linked_dirs, []).push(*laravel_linked_dirs)
+    end
+
+    if fetch(:laravel_set_acl_paths)
+      set :file_permissions_paths, fetch(:file_permissions_paths, []).push(*laravel_acl_paths)
+      set :file_permissions_users, [fetch(:laravel_server_user)]
+    end
+  end
+
+  desc 'Create missing directories.'
+  task :create_linked_acl_paths do
+    if fetch(:laravel_create_linked_acl_paths)
+      if fetch(:laravel_version) < 5
+        laravel_acl_paths = fetch(:laravel_4_acl_paths)
+      elsif fetch(:laravel_version) < 5.1
+        laravel_acl_paths = fetch(:laravel_5_acl_paths)
+      else
+        laravel_acl_paths = fetch(:laravel_5_1_acl_paths)
+      end
+
+      on roles fetch(:laravel_roles) do
+        laravel_acl_paths.each do |path|
+          acl_path = release_path.join(path)
+          if test("[ ! -e '#{acl_path}' ]")
+            execute :mkdir, '-vp', acl_path
+          else
+            info "#{acl_path} already exists."
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Upload dotenv file for release.'
+  task :upload_dotenv_file do
+    if fetch(:laravel_version) >= 5
+      on roles fetch(:laravel_roles) do
+        unless fetch(:laravel_dotenv_file).empty?
+          upload! fetch(:laravel_dotenv_file), "#{release_path}/.env"
+        end
+      end
+    end
+  end
+
+  desc 'Execute a provided artisan command'
+  task :artisan, :command_name do |_t, args|
+    # ask only runs if argument is not provided
+    ask(:cmd, 'list')
+    command = args[:command_name] || fetch(:cmd)
+
+    on roles fetch(:laravel_roles) do
+      within release_path do
+        execute :php, :artisan, command, *args.extras, fetch(:laravel_artisan_flags)
+      end
+    end
+  end
+
+  desc 'Optimize the configuration'
+  task :optimize_config do
+    invoke 'laravel:artisan', 'config:cache' if fetch(:laravel_version) >= 5
+  end
+
+  desc 'Optimize the routing file'
+  task :optimize_route do
+    invoke 'laravel:artisan', 'route:cache' if fetch(:laravel_version) >= 5
+  end
+
+  desc 'Optimize a Laravel installation for optimimum performance in production.'
+  task :optimize_release do
+    invoke 'laravel:artisan', :optimize, :'--force'
+  end
+
+  desc 'Run migrations against the database using Artisan.'
+  task :migrate_db do |_t, args|
+    on roles fetch(:laravel_migrate_roles) do
+      within release_path do
+        execute :php, :artisan, :migrate, *args.extras, fetch(:laravel_artisan_migrate_flags)
+      end
+    end
+  end
+
+  desc 'Rollback migrations against the database using Artisan.'
+  task :rollback_db do
+    on roles fetch(:laravel_roles) do
+      within release_path do
+        execute :php, :artisan, 'migrate:rollback', *args.extras, fetch(:laravel_artisan_migrate_flags)
+      end
+    end
   end
 
-  after :updated, "deploy:optimize"
-  after :updated, 'deploy:set_permissions:acl'
+  before 'deploy:starting', 'laravel:configure_folders'
+  after 'deploy:symlink:shared', 'laravel:create_linked_acl_paths'
+  after 'deploy:symlink:shared', 'deploy:set_permissions:acl'
+  after 'deploy:symlink:shared', 'laravel:upload_dotenv_file'
+  before 'deploy:updated', 'laravel:optimize_release'
 end

metadata

@@ -1,103 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-laravel
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Mitchell
+- Andrew Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: capistrano-composer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: capistrano-file-permissions
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Laravel deployment for Capistrano 3.x
+        version: '10.4'
+description: Laravel specific deployment options for Capistrano 3.x
 email:
 - peterjmit@gmail.com
+- ikari7789@yahoo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -105,36 +97,31 @@ files:
 - capistrano-laravel.gemspec
 - lib/capistrano-laravel.rb
 - lib/capistrano/laravel.rb
-- lib/capistrano/laravel/artisan.rb
-- lib/capistrano/laravel/defaults.rb
-- lib/capistrano/laravel/laravel.rb
-- lib/capistrano/laravel/migrations.rb
-- lib/capistrano/tasks/artisan.rake
+- lib/capistrano/laravel/helpers.rb
+- lib/capistrano/laravel/version.rb
 - lib/capistrano/tasks/laravel.rake
-- lib/capistrano/tasks/migrations.rake
-homepage: https://github.com/peterjmit/capistrano-laravel
+homepage: https://github.com/capistrano/laravel
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Laravel deployment for Capistrano 3.x
 test_files: []

data/lib/capistrano/laravel/artisan.rb

@@ -1 +0,0 @@
-load File.expand_path("../../tasks/artisan.rake", __FILE__)

data/lib/capistrano/laravel/defaults.rb

@@ -1,17 +0,0 @@
-set :laravel_roles, :all
-set :laravel_artisan_flags, "--env production"
-set :laravel_server_user, "www-data"
-
-# fix bug in capistrano-file-permissions
-set :linked_dirs, []
-
-set :file_permissions_paths, [
-  'app/storage',
-  'app/storage/cache',
-  'app/storage/logs',
-  'app/storage/meta',
-  'app/storage/sessions',
-  'app/storage/views',
-]
-set :file_permissions_users, [fetch(:laravel_server_user)]
-

data/lib/capistrano/laravel/laravel.rb

@@ -1 +0,0 @@
-load File.expand_path("../../tasks/laravel.rake", __FILE__)

data/lib/capistrano/laravel/migrations.rb

@@ -1 +0,0 @@
-load File.expand_path("../../tasks/migrations.rake", __FILE__)

data/lib/capistrano/tasks/artisan.rake

@@ -1,14 +0,0 @@
-namespace :laravel do
-  desc "Exceute a provided artisan command"
-  task :artisan, :command_name do |t, args|
-    # ask only runs if argument is not provided
-    ask(:cmd, "list")
-    command = args[:command_name] || fetch(:cmd)
-
-    on roles fetch(:laravel_roles) do
-      within release_path do
-        execute :php, :artisan, command, *args.extras, fetch(:laravel_artisan_flags)
-      end
-    end
-  end
-end

data/lib/capistrano/tasks/migrations.rake

@@ -1,7 +0,0 @@
-namespace :deploy do
-  task :migrate do
-    within release_path do
-      invoke "laravel:artisan", "migrate"
-    end
-  end
-end