capistrano-hyperf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba1cdfda93527d54d5a58ba672ddbadd15306c1da191a118c7502edd3227c342
+  data.tar.gz: adf7955ade166131c57f5f37654cc8afad06cb498bdfc7468aa33c05eaf3cbde
+SHA512:
+  metadata.gz: 707249b8a5ba8478e52a4641618e6c327d059b502a80f3857aac1908dc584cf8a80fc99a73d51f95c0077aa7fb68b6204518fa97e2dc0080dcb68050b183e883
+  data.tar.gz: 9ecd20ca5d2c5872738a6a29763a61747b8ef7ba27ad534460008d3fa3ca6a5c23f158317a9ef301ab47368e3d7bb497a5759816f137dae8f7085451140ff674

data/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.rake]
+indent_size = 2
+
+[*.rb]
+indent_size = 2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Gang Wu
+
+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,133 @@
+# Capistrano::Hyperf
+
+Deploy Hyperf applications with Capistrano 3.x
+
+## Installation
+
+If managing your Capistrano deploy as a ruby project, add this line to your
+application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.0.0'
+gem 'capistrano-hyperf'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install capistrano-hyperf
+```
+
+## Usage
+
+Require the module in your `Capfile`:
+
+```ruby
+require 'capistrano/hyperf'
+```
+
+### Configuration
+
+The gem makes the following configuration variables available (shown with defaults).
+
+```ruby
+# Which roles to consider as hyperf roles
+set :hyperf_roles, :all
+
+# The hyperf flags to include on bin/hyperf.php commands by default
+set :hyperf_run_flags, ""
+
+# Which roles to use for running migrations
+set :hyperf_migration_roles, :all
+
+# The hyperf flags to include on commands when running migrations
+set :hyperf_migration_run_flags, "--force"
+
+# Whether to upload the dotenv file on deploy
+set :hyperf_upload_dotenv_file_on_deploy, true
+
+# Which dotenv file to transfer to the server
+set :hyperf_dotenv_file, '.env'
+
+# The user that the server is running under (used for ACLs)
+set :hyperf_server_user, 'www-data'
+
+# Ensure the dirs in :linked_dirs exist?
+set :hyperf_ensure_linked_dirs_exist, true
+
+# Link the directores in hyperf_linked_dirs?
+set :hyperf_set_linked_dirs, true
+
+# Linked directories for a standard hyperf application
+set :hyperf_linked_dirs, [
+    'runtime/logs',
+]
+
+# Ensure the paths in :file_permissions_paths exist?
+set :hyperf_ensure_acl_paths_exist, true
+
+# Set ACLs for the paths in hyperf_acl_paths?
+set :hyperf_set_acl_paths, true
+
+# Paths that should have ACLs set for a standard hyperf application
+set :hyperf_acl_paths, [
+    'runtime/logs',
+]
+```
+
+### Tasks
+
+The following tasks are added to your deploy automagically when adding
+capistrano/hyperf to your deploy.
+
+```ruby
+before 'deploy:starting', 'hyperf:resolve_linked_dirs'
+before 'deploy:starting', 'hyperf:resolve_acl_paths'
+after  'deploy:starting', 'hyperf:ensure_linked_dirs_exist'
+after  'deploy:updating', 'hyperf:ensure_acl_paths_exist'
+before 'deploy:updated',  'deploy:set_permissions:acl'
+before 'deploy:updated',  'hyperf:upload_dotenv_file'
+```
+
+#### Task Descriptions
+
+```ruby
+# Determine which folders, if any, to use for linked directories.
+invoke 'hyperf:resolve_linked_dirs'
+
+# Determine which paths, if any, to have ACL permissions set.
+invoke 'hyperf:resolve_acl_paths'
+
+# Ensure that linked dirs exist.
+invoke 'hyperf:ensure_linked_dirs_exist'
+
+# Ensure that ACL paths exist.
+invoke 'hyperf:ensure_acl_paths_exist'
+
+# Upload dotenv file for release.
+invoke 'hyperf:upload_dotenv_file'
+
+# Execute a provided hyperf command.
+# Replace :command_name with the command to execute
+invoke 'hyperf:run[:command_name]'
+
+# Run the database migrations.
+invoke 'hyperf:migrate'
+
+# Rollback the last database migration.
+invoke 'hyperf:migrate_rollback'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gokure/capistrano-hyperf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-hyperf.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-hyperf'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Gang Wu']
+  spec.email         = ['gokure@gmail.com']
+
+  spec.summary       = 'Hyperf specific deployment options for Capistrano 3.x'
+  spec.description   = 'Hyperf deployment for Capistrano 3.x'
+  spec.homepage      = 'https://github.com/gokure/capistrano-hyperf'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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.6'
+  spec.add_dependency 'capistrano-file-permissions', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/hyperf.rb

@@ -0,0 +1,4 @@
+require 'capistrano/composer'
+require 'capistrano/file-permissions'
+
+load File.expand_path('tasks/hyperf.rake', __dir__)

data/lib/capistrano/tasks/hyperf.rake

@@ -0,0 +1,169 @@
+include Comparable
+
+namespace :load do
+  task :defaults do
+    # Which roles to consider as hyperf roles
+    set :hyperf_roles, :all
+
+    # The hyperf flags to include on bin/hyperf.php commands by default
+    set :hyperf_run_flags, ""
+
+    # Which roles to use for running migrations
+    set :hyperf_migration_roles, :all
+
+    # The hyperf flags to include on commands when running migrations
+    set :hyperf_migration_run_flags, "--force"
+
+    # Whether to upload the dotenv file on deploy
+    set :hyperf_upload_dotenv_file_on_deploy, true
+
+    # Which dotenv file to transfer to the server
+    set :hyperf_dotenv_file, '.env'
+
+    # The user that the server is running under (used for ACLs)
+    set :hyperf_server_user, 'www-data'
+
+    # Ensure the dirs in :linked_dirs exist?
+    set :hyperf_ensure_linked_dirs_exist, true
+
+    # Link the directores in hyperf_linked_dirs?
+    set :hyperf_set_linked_dirs, true
+
+    # Linked directories for a standard hyperf application
+    set :hyperf_linked_dirs, [
+      'runtime/logs',
+    ]
+
+    # Ensure the paths in :file_permissions_paths exist?
+    set :hyperf_ensure_acl_paths_exist, true
+
+    # Set ACLs for the paths in hyperf_acl_paths?
+    set :hyperf_set_acl_paths, true
+
+    # Paths that should have ACLs set for a standard hyperf application
+    set :hyperf_acl_paths, [
+      'runtime/logs',
+    ]
+  end
+end
+
+namespace :hyperf do
+  desc 'Determine which folders, if any, to use for linked directories.'
+  task :resolve_linked_dirs do
+    hyperf_linked_dirs = fetch(:hyperf_linked_dirs)
+    if fetch(:hyperf_set_linked_dirs)
+      set :linked_dirs, fetch(:linked_dirs, []).push(*hyperf_linked_dirs)
+    end
+  end
+
+  desc 'Determine which paths, if any, to have ACL permissions set.'
+  task :resolve_acl_paths do
+    next unless fetch(:hyperf_set_acl_paths)
+    hyperf_acl_paths = fetch(:hyperf_acl_paths)
+    set :file_permissions_paths, fetch(:file_permissions_paths, [])
+      .push(*hyperf_acl_paths)
+      .uniq
+    set :file_permissions_users, fetch(:file_permissions_users, [])
+      .push(fetch(:hyperf_server_user))
+      .uniq
+  end
+
+  desc 'Ensure that linked dirs exist.'
+  task :ensure_linked_dirs_exist do
+    next unless fetch(:hyperf_ensure_linked_dirs_exist)
+
+    on roles fetch(:hyperf_roles) do
+      fetch(:linked_dirs).each do |path|
+        within shared_path do
+          execute :mkdir, '-p', path
+        end
+      end
+    end
+  end
+
+  desc 'Ensure that ACL paths exist.'
+  task :ensure_acl_paths_exist do
+    next unless fetch(:hyperf_set_acl_paths) &&
+                fetch(:hyperf_ensure_acl_paths_exist)
+
+    on roles fetch(:hyperf_roles) do
+      fetch(:file_permissions_paths).each do |path|
+        within release_path do
+          execute :mkdir, '-p', path
+        end
+      end
+    end
+  end
+
+  desc 'Upload dotenv file for release.'
+  task :upload_dotenv_file do
+    next unless fetch(:hyperf_upload_dotenv_file_on_deploy)
+
+    dotenv_file = fetch(:hyperf_dotenv_file)
+
+    run_locally do
+      if dotenv_file.empty? || test("[ ! -e #{dotenv_file} ]")
+        raise Capistrano::ValidationError,
+              "Must prepare dotenv file [#{dotenv_file}] locally before deploy!"
+      end
+    end
+
+    on roles fetch(:hyperf_roles) do
+      upload! dotenv_file, "#{release_path}/.env"
+    end
+  end
+
+  desc 'Execute a provided hyperf command.'
+  task :run, [:command_name] do |_t, args|
+    ask(:cmd, 'list') # Ask only runs if argument is not provided
+    command = args[:command_name] || fetch(:cmd)
+
+    on roles fetch(:hyperf_roles) do
+      within release_path do
+        execute :php,
+                "bin/hyperf.php",
+                command,
+                *args.extras,
+                fetch(:hyperf_run_flags)
+      end
+    end
+
+    # Enable task hyperf to be ran more than once
+    Rake::Task['hyperf:run'].reenable
+  end
+
+  desc 'Run the database migrations.'
+  task :migrate do
+    hyperf_roles = fetch(:hyperf_roles)
+    hyperf_run_flags = fetch(:hyperf_run_flags)
+
+    set(:hyperf_roles, fetch(:hyperf_migration_roles))
+    set(:hyperf_run_flags, fetch(:hyperf_migration_run_flags))
+
+    Rake::Task['hyperf:run'].invoke(:migrate)
+
+    set(:hyperf_roles, hyperf_roles)
+    set(:hyperf_run_flags, hyperf_run_flags)
+  end
+
+  desc 'Rollback the last database migration.'
+  task :migrate_rollback do
+    hyperf_roles = fetch(:hyperf_roles)
+    hyperf_run_flags = fetch(:hyperf_run_flags)
+
+    set(:hyperf_roles, fetch(:hyperf_migration_roles))
+    set(:hyperf_run_flags, fetch(:hyperf_migration_run_flags))
+
+    Rake::Task['hyperf:run'].invoke('migrate:rollback')
+
+    set(:hyperf_roles, hyperf_roles)
+    set(:hyperf_run_flags, hyperf_run_flags)
+  end
+
+  before 'deploy:starting', 'hyperf:resolve_linked_dirs'
+  before 'deploy:starting', 'hyperf:resolve_acl_paths'
+  after  'deploy:starting', 'hyperf:ensure_linked_dirs_exist'
+  after  'deploy:updating', 'hyperf:ensure_acl_paths_exist'
+  before 'deploy:updated',  'deploy:set_permissions:acl'
+  before 'deploy:updated',  'hyperf:upload_dotenv_file'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-hyperf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gang Wu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: capistrano-composer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: capistrano-file-permissions
+  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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hyperf deployment for Capistrano 3.x
+email:
+- gokure@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-hyperf.gemspec
+- lib/capistrano-hyperf.rb
+- lib/capistrano/hyperf.rb
+- lib/capistrano/tasks/hyperf.rake
+homepage: https://github.com/gokure/capistrano-hyperf
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Hyperf specific deployment options for Capistrano 3.x
+test_files: []