capistrano-craft 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 249fbb6884c17a8c88689bb3766cf51d64ecd3d6
-  data.tar.gz: 77503ac4c7d107900c120cca8ca06f4d97feaa4a
+SHA256:
+  metadata.gz: 8bd49dc866da5b1f1b81620fff6c77d952e8d5067f3f6bc1268026eb87016f07
+  data.tar.gz: 29e36ef83ca0703c993e80f48051a9e8b5fcdf289881122f96f2ad28b5464b7c
 SHA512:
-  metadata.gz: 52ac278d6f8e8460c6cc3c5ef5315621d10f16b4be981bd9fae1913774afc8158a1d26785357a4ccaa075e2cee7ae2540ead7bc5bfcb89f0f584deb0215b38a6
-  data.tar.gz: 8da018126d8717da21f1fcf9bd3d4eb670f11bc7dfbce5af5a3e63e850f8994a9299599730eafcc7c0f61d6986b8f78b1dc009c0f5e87229288f90cf075e62b0
+  metadata.gz: 75b24eee818dd00358fe1cdf9694167ccaa1827b0281e2cfdae67b6e0ee3f01a51a46d15dd290d722cbd98d30ec5cabafac7bd44b7836e5bd73abe0ce75276a6
+  data.tar.gz: 33313144755a227f0940fe9715dcc1c6548176630291e78a0739ed88413c3aed86fd906bcb4b19cf1dd78d67f80bf6c9862d7f103480c8bfc121aa3029ab5138

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Release Notes for Capistrano Craft
+
+## 0.3.0 - 2020-08-13
+
+- Better compatibility with Craft 3.5
+- Project config automatically applied after deployment. A backup command is executed first as an insurance against database corruption

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in capitrano-craft.gemspec
 gemspec
+
+gem "rspec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-craft (0.1.3)
+    capistrano-craft (0.3.0)
       capistrano (~> 3.1)
       capistrano-composer (~> 0.0.6)
 
@@ -10,21 +10,35 @@ GEM
   specs:
     airbrussh (1.4.0)
       sshkit (>= 1.6.1, != 1.7.0)
-    capistrano (3.11.2)
+    capistrano (3.12.1)
       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.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.5)
       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)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sshkit (1.21.0)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
 
@@ -33,6 +47,7 @@ PLATFORMS
 
 DEPENDENCIES
   capistrano-craft!
+  rspec
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -1,9 +1,11 @@
 # Capistrano::Craft
 
-As of November 2019 this is very still very much under development. Please make sure you have appropriate backups to avoid any potential data loss.
-
 This gem automates the deployment of Craft CMS apps with Capistrano. It will automatically detect local and remote environment settings to make synchronizing of database and assets straightforward.
 
+- [x] Support for asset and database synchronization
+- [x] Support for PostgreSQL databases
+- [ ] Support for MySQL databases
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,10 +20,13 @@ Or install system wide:
 
 ## Usage
 
+For a beginners guide to deploying your site (especially useful if you have little to no experience with Ruby) please see this blog article: https://cdyer.co.uk/blog/deploying-craft-cms-to-a-vps-server-with-capistrano
+
 The setting you will likely need to customize is:
 ```
 # This should be your command to compile assets for production
-set :craft_compile_assets, "npm run production --production --silent"
+set :craft_compile_assets, true
+set :craft_compile_assets_command, "npm install && npm run production --production --silent"
 ```
 
 If you are using PHP-FPM it is necessary to restart it after deployment. Currently capistrano-craft doesn't handle this for you and you may need to add something along the lines of the following to your `deploy.rb` file.
@@ -38,7 +43,7 @@ end
 
 ### Compiling Assets
 
-Change `:craft_compile_assets` to be your production asset compilation command. By default, it is assumed your project has a `package.json` file and  `npm install` will be run first. The default asset compilcation command is `npm run production --production --silent`
+Change `:craft_compile_assets_command` to be your production asset compilation command. By default, it is assumed your project has a `package.json` file and  `npm install` will be run first. The default asset compilcation command is `npm run production --production --silent`. You can disable asset compilation altogether by settng `:craft_compile_assets` to `false`.
 
 ### Synchronize Database
 
@@ -65,7 +70,8 @@ set :craft_local_backups, "backups"
 set :craft_remote_backups, "shared/backups"
 
 # assets
-set :craft_compile_assets, "npm run production --production --silent"
+set :craft_compile_assets, true                                      
+set :craft_compile_assets_command, "yarn install && yarn run production"
 
 # console
 set :craft_console_path, -> { "craft" }

data/lib/capistrano/craft/defaults.rb

@@ -17,7 +17,8 @@ set :craft_local_backups, "backups"
 set :craft_remote_backups, "shared/backups"
 
 # assets
-set :craft_compile_assets, "production"
+set :craft_compile_assets, true
+set :craft_compile_assets_command, "yarn install && yarn run production"
 
 # console
 set :craft_console_path, -> { "craft" }

data/lib/capistrano/craft/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Craft
-    VERSION = "0.1.3"
+    VERSION = "0.3.0"
   end
 end

data/lib/capistrano/dsl/craft.rb

@@ -47,55 +47,88 @@ module Capistrano
         File.join(fetch(:craft_local_backups), "#{backup_date.join('-')}_#{backup_time.join('-')}.sql")
       end
 
-      def postgres_dump(env, output)
+      def postgres_dump(env, config, 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}
+          PGPASSWORD=$DB_PASSWORD pg_dump -U $DB_USER -h #{config[:host]} -p #{config[:port]} -F p --no-owner #{config[:database]} > #{output}
         EOCOMMAND
       end
 
       def mysql_dump(env, output)
       end
 
-      def postgres_restore(env, input)
+      def postgres_restore(env, config, 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}"
+          PGPASSWORD=$DB_PASSWORD dropdb -U $DB_USER -h #{config[:host]} -p #{config[:port]} #{config[:database]}
+          PGPASSWORD=$DB_PASSWORD createdb -U $DB_USER -h #{config[:host]} -p #{config[:port]} #{config[:database]}
+          PGPASSWORD=$DB_PASSWORD psql -U $DB_USER -d #{config[:database]} -h #{config[:host]} -p #{config[:port]} -q < "#{input}"
         EOCOMMAND
       end
 
       def mysql_restore(env, input)
       end
 
-      def craft_database(env)
-        driver = capture SSHKit::Command.new <<-EOCOMMAND
+      def database_config(env)
+        config = capture SSHKit::Command.new <<-EOCOMMAND
           source "#{env}"
-          echo $DB_DRIVER
+          echo "$DB_DSN,$DB_DRIVER,$DB_SERVER,$DB_PORT,$DB_DATABASE"
         EOCOMMAND
 
-        case driver.strip
-        when "pgsql" then return :pgsql
-        when "mysql" then return :mysql
+        params = config.split(",")
+        parsed = {}
+
+        if params[0].length > 0
+          # Using the newer style DB_DSN config style
+          dsn = params[0].split(":")
+
+          # Split in config chunks eg. host=<host>
+          database = dsn[1].split(";").map { |str|
+            tuple = str.split("=")
+            [tuple[0], tuple[1]]
+          }.to_h
+
+          parsed = {
+            driver: dsn[0],
+            host: database["host"],
+            port: database["port"],
+            database: database["dbname"]
+          }
         else
-          raise "Unable to determine database driver: \"#{driver.strip}\""
+          # Using the older style config style
+          parsed = {
+            driver: params[1],
+            host: params[2],
+            port: params[3],
+            database: params[4]
+          }
         end
+
+        case parsed[:driver].strip
+        when "pgsql" then parsed[:driver] = :pgsql
+        when "mysql" then parsed[:driver] = :mysql
+        else
+          raise "Unable to determine database driver: \"#{parsed[:driver].strip}\""
+        end
+
+        return parsed
       end
 
       def database_dump(env, input)
-        if craft_database(env) == :pgsql
-          postgres_dump(env, input)
+        config = database_config(env)
+        if config[:driver] == :pgsql
+          postgres_dump(env, config, input)
         else
-          mysql_dump(env, input)
+          mysql_dump(env, config, input)
         end
       end
 
       def database_restore(env, input)
-        if craft_database(env) == :pgsql
-          postgres_restore(env, input)
+        config = database_config(env)
+        if config[:driver] == :pgsql
+          postgres_restore(env, config, input)
         else
-          mysql_restore(env, input)
+          mysql_restore(env, config, input)
         end
       end
     end

data/lib/capistrano/tasks/craft.rake

@@ -26,6 +26,16 @@ namespace :craft do
     end
   end
 
+  namespace :config do
+    desc "Apply the project config to database after running Craft backup command"
+    task :apply do
+      on release_roles(fetch(:craft_deploy_roles)) do
+        craft_console "backup/db"
+        craft_console "project-config/apply"
+      end
+    end
+  end
+
   namespace :assets do
     desc "Synchronise assets between local and remote server"
     task :sync do

data/lib/capistrano/tasks/db.rake

@@ -26,7 +26,7 @@ namespace :db do
       download! remote_backup_file, local_backup_file
 
       # Remove temp file
-      execute "rm #{backup_file}"
+      execute "rm #{remote_backup_file}"
 
       set :backup_filename, local_backup_file
     end

data/lib/capistrano/tasks/deploy.rake

@@ -5,14 +5,16 @@ namespace :deploy do
 
   desc 'Compile assets'
   task :compile_assets do
-    on release_roles(fetch(:craft_deploy_roles)) do
-      within release_path do
-        execute :yarn, "install"
-        execute :yarn, "run", fetch(:craft_compile_assets)
+    if fetch(:craft_compile_assets)
+      on release_roles(fetch(:craft_deploy_roles)) do
+        within release_path do
+          execute "cd #{release_path} && #{fetch(:craft_compile_assets_command)}"
+        end
       end
     end
   end
 
   after 'deploy:updated', 'deploy:compile_assets'
+  after 'deploy:finished', 'craft:config:apply'
   after 'deploy:finished', 'craft:cache:clear'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-craft
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Dyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -46,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -82,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Capistrano Craft - Easy deployment of Symfony 4 apps with Ruby over SSH