capistrano-craft 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09f776fa507f01ebc0ba95804640d29136b275a1'
+  data.tar.gz: 5117c84753e343bbf86dacaf7730d61fe2daf2e4
+SHA512:
+  metadata.gz: 0255aadbcfd907b73a5bed129038f64315dbab38b44f721002c9807f854960ac1a106b0553eebf3b7bbd612716a85c8c49b6aabc8214728c8bedf19c865e2277
+  data.tar.gz: feecf14faf1ca427911734b386f42c67ffbcc0158b1da3a1cad3b013e4ba41827af72d3dc0b0ced8cf7490958a344e1c8a6279b53297dbabacdc8620704c7190

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at chrisdyer1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    capistrano-craft (0.1.0)
+      capistrano (~> 3.1)
+      capistrano-composer (~> 0.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.4.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.11.2)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-composer (0.0.6)
+      capistrano (>= 3.0.0.pre)
+    concurrent-ruby (1.1.5)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    net-scp (2.0.0)
+      net-ssh (>= 2.6.5, < 6.0.0)
+    net-ssh (5.2.0)
+    rake (13.0.0)
+    sshkit (1.20.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-craft!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Chris Dyer
+
+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,43 @@
+# Capistrano::Craft
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capistrano/craft`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-craft'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-craft
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-craft. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Capistrano::Craft project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/capistrano-craft/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task :default

data/capistrano-craft.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/craft/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-craft"
+  spec.version       = Capistrano::Craft::VERSION
+  spec.authors       = ["Chris Dyer"]
+  spec.email         = ["chris@cdyer.co.uk"]
+
+  spec.summary       = %q{Capistrano Craft - Easy deployment of Symfony 4 apps with Ruby over SSH}
+  spec.description   = %q{Craft CMS specific Capistrano tasks}
+  spec.homepage      = "https://github.com/dyerc/capistrano-craft"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dyerc/capistrano-craft"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+  spec.add_dependency 'capistrano-composer', '~> 0.0.6'
+end

data/lib/capistrano/craft.rb

@@ -0,0 +1,15 @@
+require "capistrano/dsl/craft"
+self.extend Capistrano::DSL::Craft
+
+SSHKit::Backend::Netssh.send(:include, Capistrano::DSL::Craft)
+SSHKit::Backend::Local.send(:include, Capistrano::DSL::Craft)
+
+require "capistrano/composer"
+require "capistrano/craft/craft"
+require "capistrano/craft/version"
+
+namespace :load do
+  task :defaults do
+    load "capistrano/craft/defaults.rb"
+  end
+end

data/lib/capistrano/craft/craft.rb

@@ -0,0 +1,3 @@
+load File.expand_path("../../tasks/craft.rake", __FILE__)
+load File.expand_path("../../tasks/db.rake", __FILE__)
+load File.expand_path("../../tasks/deploy.rake", __FILE__)

data/lib/capistrano/craft/defaults.rb

@@ -0,0 +1,24 @@
+#
+# Craft CMS defaults
+#
+
+set :config_path, "config"
+set :php, "php"
+
+set :craft_local_env, -> { "#{Dir.pwd}/.env" }
+set :craft_remote_env, -> { "#{fetch(:deploy_to)}/shared/.env" }
+
+set :craft_local_db_dump, "db.sql"
+set :craft_local_backups, "backups"
+set :craft_remote_backups, "shared/backups"
+
+# assets
+set :craft_compile_assets, "npm run production --production --silent"
+
+# console
+set :craft_console_path, -> { "craft" }
+set :craft_console_flags, ""
+
+# Role filtering
+set :craft_roles, :all
+set :craft_deploy_roles, :all

data/lib/capistrano/craft/version.rb

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

data/lib/capistrano/dsl/craft.rb

@@ -0,0 +1,103 @@
+module Capistrano
+  module DSL
+    module Craft
+      def craft_app_path
+        release_path.join(fetch(:app_path))
+      end
+
+      def craft_console_path
+        release_path.join(fetch(:craft_console_path))
+      end
+      
+      def craft_console(command, params = '')
+        on release_roles(fetch(:craft_deploy_roles)) do
+          execute fetch(:php), craft_console_path, command, params, fetch(:craft_console_flags)
+        end
+      end
+
+      def confirm(question)
+        set :confirmed, proc {
+          puts <<-EOF
+
+  ************************** WARNING ***************************
+  #{question}
+  **************************************************************
+
+          EOF
+          ask :answer, "y/N"
+          if fetch(:answer).strip == 'y' then true else false end
+        }.call
+
+        unless fetch(:confirmed)
+          exit
+        end
+      end
+
+      # Database
+
+      def backup_file_name
+        now = Time.now
+        backup_date = [now.year, now.strftime("%m"), now.strftime("%d")]
+        backup_time = [now.strftime("%H"), now.strftime("%M"), now.strftime("%S")]
+
+        unless Dir.exist?(fetch(:craft_local_backups))
+          Dir.mkdir(fetch(:craft_local_backups))
+        end
+
+        File.join(fetch(:craft_local_backups), "#{backup_date.join('-')}_#{backup_time.join('-')}.sql")
+      end
+
+      def postgres_dump(env, output)
+        execute SSHKit::Command.new <<-EOCOMMAND
+          source "#{env}"
+          PGPASSWORD=$DB_PASSWORD pg_dump -U $DB_USER -h $DB_SERVER -p $DB_PORT -F p --no-owner $DB_DATABASE > #{output}
+        EOCOMMAND
+      end
+
+      def mysql_dump(env, output)
+      end
+
+      def postgres_restore(env, input)
+        execute SSHKit::Command.new <<-EOCOMMAND
+          source "#{env}"
+          PGPASSWORD=$DB_PASSWORD dropdb -U $DB_USER -h $DB_SERVER -p $DB_PORT $DB_DATABASE
+          PGPASSWORD=$DB_PASSWORD createdb -U $DB_USER -h $DB_SERVER -p $DB_PORT $DB_DATABASE
+          PGPASSWORD=$DB_PASSWORD psql -U $DB_USER -d $DB_DATABASE -h $DB_SERVER -p $DB_PORT -q < "#{input}"
+        EOCOMMAND
+      end
+
+      def mysql_restore(env, input)
+      end
+
+      def craft_database(env)
+        driver = capture SSHKit::Command.new <<-EOCOMMAND
+          source "#{env}"
+          echo $DB_DRIVER
+        EOCOMMAND
+
+        case driver.strip
+        when "pgsql" then return :pgsql
+        when "mysql" then return :mysql
+        else
+          raise "Unable to determine remote server database driver"
+        end
+      end
+
+      def database_dump(env, input)
+        if craft_database(env) == :pgsql
+          postgres_dump(env, input)
+        else
+          mysql_dump(env, input)
+        end
+      end
+
+      def database_restore(env, input)
+        if craft_database(env) == :pgsql
+          postgres_restore(env, input)
+        else
+          mysql_restore(env, input)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/craft.rake

@@ -0,0 +1,52 @@
+namespace :craft do
+
+  desc "Ensure folder permissions are correct"
+  task :set_permissions do
+    on release_roles(fetch(:craft_deploy_roles)) do
+      within release_path do
+        # https://docs.craftcms.com/v3/installation.html#step-2-set-the-file-permissions
+
+        execute "chmod 744 .env"
+        execute "chmod 744 composer.json"
+        execute "chmod 744 composer.lock"
+        execute "chmod 744 config/license.key"
+        execute "chmod -R 744 storage/*"
+        execute "chmod -R 744 vendor/*"
+        execute "chmod -R 744 web/cpresources/*"
+      end
+    end
+  end
+
+  namespace :cache do
+    task :clear do
+      on release_roles(fetch(:craft_deploy_roles)) do
+        craft_console "cache/flush"
+      end
+    end
+  end
+
+  namespace :assets do
+    desc "Synchronise assets between local and remote server"
+    task :sync do
+      run_locally do
+        on release_roles(fetch(:craft_deploy_roles)) do
+          puts "User -> " + role.user
+          execute :rsync, "-vzO #{role.user}@#{role.hostname}:#{shared_path}/web/assets/ web/assets"
+          execute :rsync, "-vzO web/assets/ #{role.user}@#{role.hostname}:#{shared_path}/web/assets"
+        end
+      end
+    end
+  end
+
+  desc "Pull database and sync assets"
+	task :pull do
+		invoke "db:pull"
+		invoke "craft:sync_assets"
+	end
+
+	desc "Push database and sync assets"
+	task :push do
+		invoke "db:push"
+		invoke "craft:sync_assets"
+	end
+end

data/lib/capistrano/tasks/db.rake

@@ -0,0 +1,69 @@
+namespace :db do
+  namespace :local do
+    desc "Export the local database to craft_local_db_dump (db.sql)"
+    task :backup do
+      run_locally do
+        database_dump(fetch(:craft_local_env), fetch(:craft_local_db_dump))
+      end
+    end
+
+    desc "Import into the local database from craft_local_db_dump (db.sql)"
+    task :import do
+      run_locally do
+        database_restore(fetch(:craft_local_env), fetch(:craft_local_db_dump))
+      end
+    end
+  end
+
+  desc "Download a backup of the remote database"
+  task :backup do
+    on release_roles(fetch(:craft_deploy_roles)) do
+      # Export remote dump file
+      backup_file = "#{fetch(:deploy_to)}/shared/db.sql"
+      database_dump(fetch(:craft_remote_env), backup_file)
+
+      download! backup_file, backup_file_name
+
+      # Remove temp file
+      execute "rm #{backup_file}"
+
+      set :backup_filename, backup_file_name
+    end
+  end
+
+  desc "Imports the remote database into the local environment"
+  task :pull do
+    invoke 'db:backup'
+
+    on release_roles(fetch(:craft_deploy_roles)) do
+      database_restore(fetch(:craft_local_env), fetch(:backup_filename))
+    end
+  end
+
+  desc "Export the local database, overwriting the remote server"
+  task :push do
+    # Save the remote database
+    invoke 'db:backup'
+
+    # Save the local database
+    invoke 'db:local:backup'
+
+    on release_roles(fetch(:craft_deploy_roles)) do
+      # Upload local dump file
+      uploaded_file = "#{fetch(:deploy_to)}/shared/db.sql"
+      upload! fetch(:craft_local_db_dump), uploaded_file
+
+      confirm <<-EOF
+Are you sure you want to drop and recreate the remote database?
+
+A backup of the remote database has been taken in the file #{fetch(:backup_filename)} but you should verify this is correct before proceeding.
+      EOF
+
+      # Import into production
+      database_restore(fetch(:craft_remote_env), uploaded_file)
+
+      # Remove temp file
+      execute "rm #{uploaded_file}"
+    end
+  end
+end

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,17 @@
+namespace :deploy do
+  task :updating do
+    invoke "craft:set_permissions"
+  end
+
+  desc 'Compile assets'
+  task :compile_assets do
+    on release_roles(fetch(:craft_deploy_roles)) do
+      within release_path do
+        execute :npm, "install", "--production", "--silent"
+        execute fetch(:craft_compile_assets)
+      end
+    end
+  end
+
+  after 'deploy:updated', 'deploy:compile_assets'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-craft
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Dyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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
+description: Craft CMS specific Capistrano tasks
+email:
+- chris@cdyer.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-craft.gemspec
+- lib/capistrano/craft.rb
+- lib/capistrano/craft/craft.rb
+- lib/capistrano/craft/defaults.rb
+- lib/capistrano/craft/version.rb
+- lib/capistrano/dsl/craft.rb
+- lib/capistrano/tasks/craft.rake
+- lib/capistrano/tasks/db.rake
+- lib/capistrano/tasks/deploy.rake
+homepage: https://github.com/dyerc/capistrano-craft
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dyerc/capistrano-craft
+  source_code_uri: https://github.com/dyerc/capistrano-craft
+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.14.3
+signing_key: 
+specification_version: 4
+summary: Capistrano Craft - Easy deployment of Symfony 4 apps with Ruby over SSH
+test_files: []