caput 0.9.5 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f70afda0863b53a3471a330a939a2a16e6c11bf54bf091cde7f868ec8d24af8
-  data.tar.gz: 18b1cad9051efcaaa9f98f8f9cfb3f34283b94e02d8a49451bcb8df7264ba43f
+  metadata.gz: 2ac684204558dde49abeacec8c4f9d208cdf6f343952ba1055f9eeb17556bb4c
+  data.tar.gz: d48dd167c60706289e1b957ed2af737822b741b2cca3425fb384f1fc70d3e96d
 SHA512:
-  metadata.gz: c68f1efe34c294399396b0b04b2fd5284ee88e08b9c36a4696dcd11a979e21eab145e8f76152d65f35580b3f86edc20e784d26d9b481172b9537ecbbf477ec85
-  data.tar.gz: 670fcae494a9817033ab253ec75eade086399cf314691417a0ceb1326c7a217a7fd3e94ae1a2dd3bbdb958604322b40c92714496ac4c203ca5f110a14aadb112
+  metadata.gz: fe9bae1509657360e2f54d27f3c7367c971357f5a24894f01e51f2b70e8662bf0ff7b4635e2fb36b4bfb3c727fbae554aa6a3649bec14f7df4286d93f1fe247a
+  data.tar.gz: 7182daf83c4216718aba8b8a6a8914b435f425ab11c8463e9048084f493843d96ab46e54f5aa0bdf8c373f6c27344d4287175342b1e697149180eaa875eb133b

data/README.md

@@ -51,6 +51,35 @@ Edit `caput.conf` with the correct values for your setup:
 
 > Make sure MySQL and Nginx are installed on the server. Caput will notify you if these dependencies are missing.
 
+If not already the case, update the config/database.yml file to use MySQL for storage instead of the default Sqlite3. The below section can be used as a template.
+
+```production:
+  primary: &production_primary
+    adapter: mysql2
+    encoding: utf8mb4
+    database: <%= Rails.application.credentials.dig(:mysql, :database) %>
+    username: <%= Rails.application.credentials.dig(:mysql, :username) %>
+    password: <%= Rails.application.credentials.dig(:mysql, :password) %>
+    host: localhost
+    port: 3306
+  cache:
+    <<: *production_primary
+  queue:
+    <<: *production_primary
+  cable:
+    <<: *production_primary
+```
+
+The above also requires the database information is added to the Rails credentials file by running rails credentials:edit and adding a MySQL section.
+
+```mysql:
+  database: <DATABASE NAME>
+  username: <DATABASE USERNAME>
+  password: <DATABASE PASSWORD>
+```
+
+The database name is typically the application name suffixed with '_production'.
+
 ### 3. Prepare the server
 
 Run:
@@ -61,7 +90,7 @@ caput server
 
 Caput will:
 
-- Validate prerequisites (MySQL client/server, Nginx, setup user, DNS)  
+- Validate prerequisites (MySQL client/server, Nginx, setup user, DNS) 
 - Create the Capistrano-compatible folder structure 
 - Set up a **systemd service** for Puma to serve requests in the background  
 - Configure permissions for the `deploy` user  
@@ -81,7 +110,12 @@ This will:
 - Add Capistrano configuration and necessary files to your local Rails repository  
 - Make the repository ready for deployments  
 
-> Currently, `caput server` and `caput local` must be run separately, in that order. In the future, these may be combined into a single `caput setup` command.
+### 5. Deploy the application
+
+Once the above has been performed, the application can be deployed using standard Capistrano commands.
+
+```cap production deploy
+```
 
 ---
 

data/lib/caput/config.rb

@@ -36,7 +36,7 @@ module Caput
 
         # Ruby version to use with rbenv. This version will be installed via rbenv on the server.
         # It needs to match the RUBY version used by the Ruby on Rails application being deployed.
-        RUBY_VERSION="3.2.2"
+        RUBY_VERSION="3.3.6"
 
         # Path on the server where app will be deployed. This will be the root directory on the
         # server where the Ruby on Rails application will be deployed by Capistrano.

data/lib/caput/local.rb

@@ -35,7 +35,6 @@ module Caput
 
       FileUtils.mkdir_p('config/deploy')
       deploy_rb = 'config/deploy.rb'
-      backup_file(deploy_rb)
       File.open(deploy_rb, 'a') do |f|
         f.puts <<~DEPLOY
 
@@ -48,6 +47,7 @@ module Caput
           set :puma_pid, "#{deploy_path}/shared/tmp/pids/puma.pid"
           ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp
           set :linked_files, fetch(:linked_files, []).push('config/master.key')
+          set :linked_dirs, fetch(:linked_dirs, []).push('storage')
         DEPLOY
       end
 
@@ -73,10 +73,5 @@ module Caput
       end
     end
 
-    def backup_file(path)
-      return unless File.exist?(path)
-      bak = "#{path}.bak"
-      FileUtils.cp(path, bak)
-    end
   end
 end

data/lib/caput/server.rb

@@ -104,11 +104,65 @@ module Caput
         if [ -d "#{deploy_path}" ]; then
           echo "Deploy directories already exist"
         else
-          sudo mkdir -p "#{deploy_path}/shared/tmp/pids" "#{deploy_path}/shared/tmp/sockets" "#{deploy_path}/shared/log"
+          sudo mkdir -p \
+              "#{deploy_path}/shared/tmp/pids" \
+              "#{deploy_path}/shared/tmp/sockets" \
+              "#{deploy_path}/shared/log" \
+              "#{deploy_path}/shared/storage" \
+              "#{deploy_path}/shared/config"
           sudo chown -R #{deploy_user}:#{deploy_user} "#{deploy_path}"
         fi
       BASH
 
+      puts "Upload master key if it exists"
+      master_path = "config/master.key"
+      if File.exist?(master_path)
+        remote.upload_file!(master_path, "/tmp/master.key")
+        remote.exec!("sudo mv /tmp/master.key #{deploy_path}/shared/config/master.key")
+        remote.exec!("sudo chmod 0400 #{deploy_path}/shared/config/master.key")
+      else
+        puts "Note: No master key exists in local directory"
+      end
+
+      puts "\nCreate MySQL user if it doesn't exist"
+
+      # Get username and password from the local configuration file
+      require 'active_support'
+      require 'active_support/encrypted_configuration'
+      require 'yaml'
+      rails_root = Dir.pwd
+      credentials_path = File.join(rails_root, 'config', 'credentials.yml.enc')
+      master_key_path = File.join(rails_root, 'config', 'master.key')
+      master_key = ENV['RAILS_MASTER_KEY'] || (File.exist?(master_key_path) && File.read(master_key_path).strip)
+      raise "Master key not found in ENV['RAILS_MASTER_KEY'] or #{master_key_path}" unless master_key
+
+      # Create encrypted configuration
+      conf = ActiveSupport::EncryptedConfiguration.new(
+        config_path: credentials_path,
+        key_path: master_key_path,
+        env_key: 'RAILS_MASTER_KEY',
+        raise_if_missing_key: true
+      )
+
+      creds = YAML.safe_load(conf.read)
+      mysql_database = creds.dig('mysql', 'database')
+      mysql_username = creds.dig('mysql', 'username')
+      mysql_password = creds.dig('mysql', 'password')
+
+      sql = <<~SQL
+        CREATE DATABASE IF NOT EXISTS #{mysql_database};
+        CREATE USER IF NOT EXISTS #{mysql_username}@localhost IDENTIFIED BY '#{mysql_password}';
+        GRANT ALL PRIVILEGES ON #{mysql_database}.* TO #{mysql_username}@localhost;
+        FLUSH PRIVILEGES;
+      SQL
+
+      # Escape quotes for bash
+      escaped_sql = sql.strip.gsub('"', '\"').gsub('$', '\$')
+
+      # Build the full command to run on the remote server
+     cmd = %Q(sudo mysql -e "#{escaped_sql}")
+     remote.exec!(cmd)
+
       puts "\nInstall Nginx site config..."
       nginx_conf = <<~NGINX
         server {
@@ -150,6 +204,8 @@ module Caput
         Type=simple
         User=#{deploy_user}
         WorkingDirectory=#{deploy_path}/current
+        Environment="RAILS_ENV=production"
+        Environment="RACK_ENV=production"
         ExecStart=#{deploy_path}/shared/bin/start_puma.sh
         Restart=always
 
@@ -230,6 +286,7 @@ module Caput
       BASH
 
       puts "\nServer preparation complete."
+      puts "\nBefore deploying, please verify that the deploy user has access to the the code repository."
     end
 
     def check_sudo!(user, server)

data/lib/caput/version.rb

@@ -1,3 +1,3 @@
 module Caput
-  VERSION = '0.9.5'
+  VERSION = '0.9.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caput
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.7
 platform: ruby
 authors:
 - Martin Bergek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-09 00:00:00.000000000 Z
+date: 2025-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor