capistrano-cachetool 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbee95d3248c61d1250fb770f6be480099ed4125
+  data.tar.gz: 2bbf08c7b04b64936088acaf75eb5692c940ba20
+SHA512:
+  metadata.gz: 21db05dd2c090ee9347a2c95716012c9af666e4bcbfcb1a57bf0c9045d32723ac85fd2fbcc84110f93720fd5b457e3726bbaf4a22b98f9c956837d26e730db33
+  data.tar.gz: e29df4384f78b3418ba35fa025f914f72aa945529feaf6e9ef40dd5ad8a70d44a85643fc927ae04309061899d29495dbbd7732c9d65b6e8f153ee019ad955d10

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-cachetool.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tijs Verkoyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Capistrano::Cachetool
+
+Exposes the [Cachetool by Goralina](http://gordalina.github.io/cachetool/) in Capistrano 3.x
+
+This plugin is heavily inspired on [capistrano/composer](https://github.com/capistrano/composer).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-cachetool'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-cachetool
+
+
+## Usage
+
+Require the module in your Capfile:
+
+require 'capistrano/cachetool'
+capistrano/cachetool comes with 2 tasks:
+
+* `cachetool:install_executable`
+* `cachetool:run`
+
+By default it is assumed that you have the cachetool executable installed and in your $PATH on all target hosts.
+
+### Configuration
+
+Configurable options, shown here with defaults:
+
+```
+set :cachetool_roles, :all
+set :cachetool_download_url, "https://gordalina.github.io/cachetool/downloads/cachetool.phar"
+set :cachetool_working_dir, -> { fetch(:release_path) }
+```
+
+### Installing cachetool as part of a deployment
+
+Add the following to deploy.rb to manage the installation of cachetool during deployment (cachetool.phar is install in the shared path).
+
+```
+SSHKit.config.command_map[:cachetool] = "php #{shared_path.join("cachetool.phar")}"
+
+namespace :deploy do
+  after :starting, 'cachetool:install_executable'
+end
+```
+
+### Accessing cachetool commands directly
+
+This library also provides a `cachetool:run` task which allows access to any `cachetool` command.
+
+From the command line you can run
+
+```
+cap production cachetool:run['opcache:status', '--cli']
+```
+
+If you use zsh you will need to wrap the command in quotes:
+
+```
+cap production "cachetool:run['opcache:status', '--cli']" 
+```
+
+Or from within a rake task using capistrano's invoke
+
+```
+task :my_custom_cachetool_task do
+  invoke "cachetool:run", :update, "--dev --prefer-dist"
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/tijsverkoyen/capistrano-cachetool/issues](https://github.com/tijsverkoyen/capistrano-cachetool/issues).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano-cachetool.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/cachetool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-cachetool"
+  spec.version       = Capistrano::Cachetool::VERSION
+  spec.authors       = ["Tijs Verkoyen"]
+  spec.email         = ["capistrano-cachetool@verkoyen.eu"]
+
+  spec.summary       = %q{Cachetool support for Capistrano 3.x}
+  spec.description   = %q{Exposes the [Cachetool by Goralina](http://gordalina.github.io/cachetool/) in Capistrano 3.x}
+  spec.homepage      = "https://github.com/tijsverkoyen/capistrano-cachetool"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/capistrano/cachetool/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Cachetool
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano/cachetool.rb

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

data/lib/capistrano/tasks/cachetool.rake

@@ -0,0 +1,42 @@
+namespace :cachetool do
+  desc <<-DESC
+    Installs cachetool.phar to the shared directory
+    In order to use the .phar file, the cachetool command needs to be mapped:
+      SSHKit.config.command_map[:cachetool] = "\#{shared_path.join("cachetool.phar")}"
+    This is best used after deploy:starting:
+      namespace :deploy do
+        after :starting, 'cachetool:install_executable'
+      end
+  DESC
+  task :install_executable do
+    on release_roles(fetch(:cachetool_roles)) do
+      within shared_path do
+        if test "[", "!", "-e", "cachetool.phar", "]"
+          execute :curl, "-sO", fetch(:cachetool_download_url)
+          execute :chmod, "+x", "cachetool.phar"
+        end
+      end
+    end
+  end
+
+  desc <<-DESC
+    Access a cachetool command directly
+    This tasks allows access to any cachetool command.
+  DESC
+  task :run, :command do |t, args|
+    args.with_defaults(:command => :list)
+    on release_roles(fetch(:cachetool_roles)) do
+      within fetch(:cachetool_working_dir) do
+        execute :cachetool, args[:command], *args.extras
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :cachetool_roles, :all
+    set :cachetool_download_url, "https://gordalina.github.io/cachetool/downloads/cachetool.phar"
+    set :cachetool_working_dir, -> { fetch(:release_path) }
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-cachetool
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tijs Verkoyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Exposes the [Cachetool by Goralina](http://gordalina.github.io/cachetool/)
+  in Capistrano 3.x
+email:
+- capistrano-cachetool@verkoyen.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-cachetool.gemspec
+- lib/capistrano/cachetool.rb
+- lib/capistrano/cachetool/version.rb
+- lib/capistrano/tasks/cachetool.rake
+homepage: https://github.com/tijsverkoyen/capistrano-cachetool
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Cachetool support for Capistrano 3.x
+test_files: []