mina-puma-systemd 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad4af73589fe1c4dcb53e8816185ef82340a7c3534fb6454084bb4e328858d08
-  data.tar.gz: c2977d9ac9933c091a584e8eabc245634a8e04539a5e00727a3c4a1b70b70b3c
+  metadata.gz: cee49f9c394f0983df8630691473adf2ba83c7f63380457d327edb635d5f68bf
+  data.tar.gz: ee26eed2ddaf3f0ee8601c5ccf9072fee4ec4a116ea31ac3c6a3f32f35a361cf
 SHA512:
-  metadata.gz: 54f162124df84afbdf1930a45e6f050683e2164e580a221ef6b5d84f99bf8c774e462ab6dad3d121765dcd1fb2a83dda477c306dac82e0c908e72f16311c5b51
-  data.tar.gz: 1f640b0744defe3e0fc4e8a1408973d3f21f93a09ae093bb40743da5a77f1fe955f6b503a86d8f86ca2dc03ff6efa176a25e4ad60f273b71f302353ed050796e
+  metadata.gz: 536e4e40908b2ec4588bd22763e76c8e9495a60f728839eb65975bacf64eb66e0ee733d45d035faad65e8342dfd2542dcc57efaefc9210a418d5fbe50a268eb3
+  data.tar.gz: 7b9a8996aeece1afb2845439d3dea35dd1c5bc58813c976475b4154670962e848b28db3a011edc945c271a132454cd03816368c340db889669119ae3a2df127a

data/README.md

@@ -10,6 +10,8 @@ This gem provides several mina tasks:
     mina puma:start           # Start puma
     mina puma:stop            # Stop puma
     mina puma:status          # Get status
+    mina puma:enable          # Enables systemd service
+    mina puma:disable         # Disables systemd service
 
 ## Installation
 
@@ -22,7 +24,6 @@ And then execute:
     $ bundle
 
 Note: by just including this gem, does not mean your development server will be Puma, for that, you need explicitly add `gem 'puma'` to your Gemfile and configure it.
-This gem does not (yet) create puma and systemd service config files, you have to do it manually.
 
 ## Usage
 
@@ -45,6 +46,16 @@ You can tweak some settings:
 * `puma_systemctl` - systemctl command, default is ` sudo systemctl`. Other option would be `systemctl --user` if you have setup pumas as user service. 
 * `puma_service_name` - puma service name , default is `puma_#{fetch(:application_name)}_#{fetch(:puma_env)}`
 
+## Setting up server
+
+    mina puma:install       # copies templates for puma config and systemd service to config/deploy/templates
+    mina puma:print         # prints generated config files to stdout
+    mina puma:print_service # prints generated systemd service to stdout
+    mina puma:print_config  # prints generated puma.rb to stdout
+    mina puma:setup         # install config files on service in enables systemd service
+
+Later commmand relies on sudo to work. If you don't want to grant sudo, print config files to console and install em manually.
+
 
 Then:
 
@@ -80,10 +91,6 @@ deploy          ALL=(ALL)       NOPASSWD: SERVICES
 
 If you are paranoid, substitute `*` with exact service name. Better option would be to run as user service, but it did not work for me out of box on AWS AMI2.
 
-## TODO
-* Generate and upload puma.rb file
-* Generate and upload puma systemd service
-
 ## Contributing
 
 1. Fork it

data/lib/mina/puma_systemd/tasks.rake

@@ -4,12 +4,25 @@ require 'mina/rails'
 namespace :puma do
   set :shared_dirs, fetch(:shared_dirs, []).push("tmp/sockets", "tmp/pids")
 
-  set :puma_role,      -> { fetch(:user) }
+  set :puma_user,      -> { fetch(:user) }
+  set :puma_group,     -> { fetch(:user) }
   set :puma_env,       -> { fetch(:rails_env, 'production') }
   set :puma_root_path, -> { fetch(:current_path) }
 
+  set :puma_bundle_exec, -> { "/home/#{fetch(:puma_user)}/.rbenv/bin/rbenv exec bundle exec" }
+  set :systemd_root, -> { "/etc/systemd/system" }
+
   set :puma_systemctl, -> { fetch(:systemctl, "sudo systemctl")}
   set :puma_service_name, -> { "puma_#{fetch(:application_name)}_#{fetch(:puma_env)}" }
+  set :puma_service_config, -> { "#{fetch(:systemd_root)}/#{fetch(:puma_service_name)}.service" }
+  set :puma_config, -> { "#{fetch(:shared_path)}/puma.rb" }
+
+  set :puma_workers, 0
+  set :puma_threads, "1,5"
+
+  set :puma_restart_command, "bundle exec puma"
+  set :puma_preload_app, false
+  set :puma_init_active_record, true
 
   desc 'Enable puma'
   task enable: :remote_environment do
@@ -60,4 +73,99 @@ namespace :puma do
     command "#{fetch(:puma_systemctl)} status -l #{fetch(:puma_service_name)}"
   end
 
+
+  desc 'Install Puma config template to repo'
+  task :install do
+    run :local do
+      if File.exist? path_for_service_template
+        error! %(file exists; please rm to continue: #{path_for_service_template})
+      else
+        command %(mkdir -p config/deploy/templates)
+        command %(cp #{path_for_service_template(installed: false)} #{path_for_service_template})
+      end
+      if File.exist? path_for_config_template
+        error! %(file exists; please rm to continue: #{path_for_config_template})
+      else
+        command %(mkdir -p config/deploy/templates)
+        command %(cp #{path_for_config_template(installed: false)} #{path_for_config_template})
+      end
+    end
+  end
+
+  desc 'Print nginx config in local terminal'
+  task :print do
+    puts "----  puma.service ----------"
+    puts processed_puma_service_template
+    puts "----  puma.rb ---------------"
+    puts processed_puma_config_template
+  end
+
+  desc 'Print puma service config in local terminal'
+  task :print_service do
+    puts processed_puma_service_template
+  end
+
+  desc 'Print puma config in local terminal'
+  task :print_config do
+    puts processed_puma_config_template
+  end
+
+  desc 'Setup puma service on server'
+  task :setup do
+    puma_service_config = fetch(:puma_service_config)
+    puma_config = fetch(:puma_config)
+
+    comment %(Installing puma service config file to #{puma_service_config})
+    command %(echo -ne '#{escaped_puma_service_template}' | sudo tee #{puma_service_config} > /dev/null)
+
+    comment %(Installing puma.rb config file to #{puma_config})
+    command %(echo -ne '#{escaped_puma_config_template}' > #{puma_config})
+
+    invoke :'puma:enable'
+  end
+
+  def path_for_service_template installed: true
+    installed ?
+      File.expand_path('./config/deploy/templates/puma.service.template') :
+      File.expand_path('../../templates/puma.service.template', __FILE__)
+  end
+
+  def path_for_config_template installed: true
+    installed ?
+      File.expand_path('./config/deploy/templates/puma.rb.template') :
+      File.expand_path('../../templates/puma.rb.template', __FILE__)
+  end
+
+  def puma_service_template
+    installed_path = path_for_service_template
+    template_path = path_for_service_template installed: false
+
+    File.exist?(installed_path) ? installed_path : template_path
+  end
+
+  def processed_puma_service_template
+    erb = File.read(puma_service_template)
+    ERB.new(erb, trim_mode: '-').result(binding)
+  end
+
+  def escaped_puma_service_template
+    processed_puma_service_template.gsub("\n","\\n").gsub("'","\\'")
+  end
+
+  def puma_config_template
+    installed_path = path_for_config_template
+    template_path = path_for_config_template installed: false
+
+    File.exist?(installed_path) ? installed_path : template_path
+  end
+
+  def processed_puma_config_template
+    erb = File.read(puma_config_template)
+    ERB.new(erb, trim_mode: '-').result(binding)
+  end
+
+  def escaped_puma_config_template
+    processed_puma_config_template.gsub("\n","\\n").gsub("'","\\'")
+  end
+
 end

data/lib/mina/puma_systemd/version.rb

@@ -1,5 +1,5 @@
 module Mina
   module PumaSystemd
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/mina/templates/puma.rb.template

@@ -0,0 +1,43 @@
+#!/usr/bin/env puma
+
+environment "<%= fetch(:puma_env) %>"
+
+app_dir = "<%= fetch(:current_path) %>"
+
+directory app_dir
+rackup "#{app_dir}/config.ru"
+pidfile "#{app_dir}/tmp/pids/puma.pid"
+state_path "#{app_dir}/tmp/pids/puma.state"
+stdout_redirect "#{app_dir}/log/puma_access.log", "#{app_dir}/log/puma_error.log", true
+bind "unix://#{app_dir}/tmp/sockets/puma.sock"
+<% if fetch(:puma_tag) %>
+tag "<%= fetch(:puma_tag)%>"
+<% end %>
+
+threads <%= fetch(:puma_threads) %>
+workers <%= fetch(:puma_workers) %>
+
+restart_command "<%= fetch(:puma_restart_command) %>"
+
+<% if fetch(:puma_preload_app) %>
+preload_app!
+<% else %>
+prune_bundler
+<% end %>
+
+on_restart do
+  puts "Refreshing Gemfile"
+  ENV["BUNDLE_GEMFILE"] = "<%= fetch(:bundle_gemfile, "#{fetch(:current_path)}/Gemfile") %>"
+end
+
+<% if fetch(:puma_preload_app) && fetch(:puma_init_active_record) %>
+before_fork do
+  ActiveRecord::Base.connection_pool.disconnect!
+end
+
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+end
+<% end %>

data/lib/mina/templates/puma.service.template

@@ -0,0 +1,34 @@
+[Unit]
+Description=Puma HTTP Server for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=network.target
+<%= "Requires=#{fetch(:puma_service_name)}.socket" if fetch(:puma_enable_socket_service) %>
+
+[Service]
+Type=notify
+WatchdogSec=10
+
+User=<%= fetch(:puma_user) %>
+Group=<%= fetch(:puma_group) %>
+WorkingDirectory=<%= fetch(:current_path) %>
+
+ExecStart=<%= fetch(:puma_bundle_exec) %> puma -C <%= fetch(:shared_path) %>/puma.rb config.ru
+ExecStop=<%= fetch(:puma_bundle_exec) %> pumactl -S <%= fetch(:shared_path) %>/pids/puma.state stop
+ExecReload=<%= fetch(:puma_bundle_exec) %> pumactl -F <%= fetch(:shared_path) %>/puma.rb phased-restart
+
+PIDFile=<%= fetch(:shared_path) %>/tmp/pids/puma.pid
+
+<%="EnvironmentFile=#{fetch(:puma_service_unit_env_file)}" if fetch(:puma_service_unit_env_file) %>
+
+<% fetch(:puma_service_unit_env_vars, []).each do |environment_variable| %>
+<%="Environment=#{environment_variable}" %>
+<% end -%>
+Environment=ALLOC_ARENA_MAX=2
+
+
+Restart=always
+RestartSec=1
+
+SyslogIdentifier=puma_<%= "#{fetch(:application)}_#{fetch(:stage)}" %>
+
+[Install]
+WantedBy=multi-user.target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mina-puma-systemd
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Vladimir Elchinov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2023-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mina
@@ -81,12 +81,14 @@ files:
 - lib/mina/puma_systemd.rb
 - lib/mina/puma_systemd/tasks.rake
 - lib/mina/puma_systemd/version.rb
+- lib/mina/templates/puma.rb.template
+- lib/mina/templates/puma.service.template
 - mina-puma-systemd.gemspec
 homepage: https://github.com/railsblueprint/mina-puma-systemd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Puma tasks for Mina and systemd
 test_files: []