capistrano-forkcms 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8b4c0990c9f4473ff2a104e47f03b573126778c
-  data.tar.gz: acf272f5407fd07c42b18be94d0c8ce60f059a2f
+  metadata.gz: 0adbc416fef6b18cf432dfa74924a7e36711eb52
+  data.tar.gz: 724dba6b24dfa9d04dd29bf665559103966881b3
 SHA512:
-  metadata.gz: 129fb6075d179fbbdc02faf22d5e50867576360d3c629ee6b08cf598f82b4d8f2dfe8923c737b83223aca7f0976b913132313b64cbfed74031a2c338679380df
-  data.tar.gz: c64f1b054c70d3124c8b97e8790ac1f8b078c2bd624112e0c2073516cade4a8d56b09c184b06ea921db71a3eb57376c2bed16afcd2908a55be56bfd4ddbda76c
+  metadata.gz: 294dc28ba5f80776698813de6918fca12d6ac2d84e6bafe7576c486909a8667c14cc89856dc1386e42ea7a33b3344d518f4595ffe7af200437085c5fd5d49b21
+  data.tar.gz: 43c71454a43298214d5b04effcd07ac4e30d0a9aa0617cc2c2374ee2306f69a1a501540c993471b68b2285a99608d50a59c268793dc5ee137b07da1111e2d130

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem 'capistrano', '~> 3.1'
 gem 'capistrano-composer', '~> 0.0.6'
+gem 'capistrano-cachetool', '~> 1.0.0'

data/README.md

@@ -27,6 +27,7 @@ Require the module in your Capfile:
 The plugin comes with two tasks:
 
 * `forkcms:configure:composer`, which will configure the `capistrano/composer` plugin.
+* `forkcms:opcache:reset`, which will reset the opcache.
 * `forkcms:symlink:document_root`, which will link the document_root to the current-folder. 
 
 But you won't need any of them as everything is wired automagically.
@@ -37,7 +38,11 @@ But you won't need any of them as everything is wired automagically.
 Configuration options:
 
 * `:php_bin_custom_path`, this will allow you to configure a custom PHP binary, the fallback is `php`.
-  
+* `:opcache_reset_strategy`, the reset strategy. Possible options: file, fcgi
+* `opcache_reset_fcgi_connection_string`, the fcgi-connection string used for the [cachetool](http://gordalina.github.io/cachetool/).
+   required when `:opcache_reset_strategy` is `fcgi`.
+* `opcache_reset_base_url`, the public url of your website. Required when `:opcache_reset_strategy` is `file`
+
 
 ## How to use with a fresh Fork install
 
@@ -78,10 +83,18 @@ set :keep_releases, 3
 
 ```
 server "$your-server-hostname", user: "sites", roles: %w{app db web}
-set :deploy_to, "$your-path-where-everything-should-be-deployed"
-set :document_root, "$your-document-root"
+set :deploy_to, "$your-path-where-everything-should-be-deployed" # eg: /home/johndoe/apps/website
+set :document_root, "$your-document-root" # eg: /var/www
+
+set :opcache_reset_strategy, "fcgi"
+set :opcache_reset_fcgi_connection_string, "$your-php-fpm-socket-or-connection-string" # eg: /var/run/php_71_fpm_sites.sock
+
+# or if you are not using FCGI/FPM
+#set :opcache_reset_strategy, "file"
+#set :opcache_reset_base_url, "$your-public-url" # eg: "http://www.fork-cms.com"
+
 ```
-    
+
 
 ## Contributing
 

data/capistrano-forkcms.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "capistrano", "~> 3.1"
   spec.add_dependency "capistrano-composer", "~> 0.0.6"
+  spec.add_dependency "capistrano-cachetool", "~> 1.0.0"
 end

data/lib/capistrano/forkcms.rb

@@ -1,4 +1,5 @@
 require "capistrano/composer"
+require "capistrano/cachetool"
 
 namespace :load do
   task :defaults do

data/lib/capistrano/forkcms/defaults.rb

@@ -8,15 +8,20 @@ set :linked_dirs, -> { ["app/logs", "app/sessions", "src/Frontend/Files"] }
 # Run required tasks after the stage
 Capistrano::DSL.stages.each do |stage|
   after stage, "forkcms:configure:composer"
+  after stage, "forkcms:configure:cachetool"
 end
 
 
 # Make sure the composer executable is installed
 namespace :deploy do
   after :starting, "composer:install_executable"
+  after :starting, "cachetool:install_executable"
   after :publishing, "forkcms:symlink:document_root"
+  after :publishing, "forkcms:opcache:reset"
 end
 
 
 # Load the tasks
-load File.expand_path("../../tasks/forkcms.rake", __FILE__)
+load File.expand_path("../../tasks/configure.rake", __FILE__)
+load File.expand_path("../../tasks/opcache.rake", __FILE__)
+load File.expand_path("../../tasks/symlink.rake", __FILE__)

data/lib/capistrano/forkcms/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Forkcms
-    VERSION = "1.0.2"
+    VERSION = "2.0.0"
   end
 end

data/lib/capistrano/tasks/{forkcms.rake → configure.rake}

@@ -11,6 +11,15 @@ namespace :forkcms do
       # Set the correct bin
       SSHKit.config.command_map[:composer] = "#{fetch :php_bin_path} #{fetch :deploy_to}/shared/composer.phar"
     end
+
+    desc <<-DESC
+      Configures cachetool
+      It make sure the command is mapped correctly and the correct flags are used.
+    DESC
+    task :cachetool do
+      # Set the correct bin
+      SSHKit.config.command_map[:cachetool] = "#{fetch :php_bin_path} #{fetch :deploy_to}/shared/cachetool.phar"
+    end
   end
 
   namespace :symlink do

data/lib/capistrano/tasks/opcache.rake

@@ -0,0 +1,40 @@
+namespace :forkcms do
+  namespace :opcache do
+    desc <<-DESC
+      Reset the opcache
+    DESC
+    task :reset do
+      if fetch(:opcache_reset_strategy) === "file"
+        invoke "forkcms:opcache:reset_with_file"
+      elsif fetch(:opcache_reset_strategy) === "fcgi"
+        invoke "forkcms:opcache:reset_with_fcgi"
+      else
+        raise "Invalid value for :opcache_reset_strategy, possible values are: file, fcgi."
+      end
+    end
+
+    task :reset_with_file do
+      # make sure that we have all needed variables
+      raise "opcache_reset_base_url not set" unless fetch(:opcache_reset_base_url)
+
+      on roles(:web) do
+        stream = StringIO.new("<?php clearstatcache(true); if (function_exists('opcache_reset')) { opcache_reset(); }")
+        upload! stream, "#{current_path}/php-opcache-reset.php"
+        execute :curl, "-L --fail --silent --show-error", "#{fetch :opcache_reset_base_url}/php-opcache-reset.php"
+        execute :rm, "#{current_path}/php-opcache-reset.php"
+      end
+    end
+
+    task :reset_with_fcgi do
+      # make sure that we have all needed variables
+      raise "opcache_reset_fcgi_connection_string not set" unless fetch(:opcache_reset_fcgi_connection_string)
+
+      invoke "cachetool:run", "opcache:reset", "--fcgi=#{fetch :opcache_reset_fcgi_connection_string}"
+
+      # reenable our command, see https://github.com/capistrano/capistrano/issues/1686 for more information
+      Rake::Task["cachetool:run"].reenable
+
+      invoke "cachetool:run", "stat:clear", "--fcgi=#{fetch :opcache_reset_fcgi_connection_string}"
+    end
+  end
+end

data/lib/capistrano/tasks/symlink.rake

@@ -0,0 +1,22 @@
+namespace :forkcms do
+  namespace :symlink do
+    desc <<-DESC
+      Links the document root to the current folder
+      The document root is the folder that the webserver will serve, it should link to the current path.
+    DESC
+    task :document_root do
+      on roles(:web) do
+        if test("[ -L #{fetch :document_root} ]") && capture("readlink -- #{fetch :document_root}") == "#{current_path}/"
+          # all is well, the symlink is correct
+        elsif test("[ -d #{fetch :document_root} ]") || test("[ -f #{fetch :document_root} ]")
+          error "Document root #{fetch :document_root} already exists."
+          error "To link it, issue the following command:"
+          error "ln -sf #{current_path}/ #{fetch :document_root}"
+        else
+          execute :mkdir, "-p", File.dirname(fetch(:document_root))
+          execute :ln, "-sf", "#{current_path}/", fetch(:document_root)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-forkcms
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Tijs Verkoyen
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: capistrano-cachetool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Capistrano ForkCMS - Easy deployment of ForkCMS 5+ apps with Ruby over
   SSH
 email:
@@ -100,7 +114,9 @@ files:
 - lib/capistrano/forkcms.rb
 - lib/capistrano/forkcms/defaults.rb
 - lib/capistrano/forkcms/version.rb
-- lib/capistrano/tasks/forkcms.rake
+- lib/capistrano/tasks/configure.rake
+- lib/capistrano/tasks/opcache.rake
+- lib/capistrano/tasks/symlink.rake
 homepage: https://github.com/tijsverkoyen/capistrano-forkcms
 licenses:
 - MIT