tomo 1.18.3 → 1.20.0

data/lib/tomo/console/non_interactive_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Console
     class NonInteractiveError < Tomo::Error
@@ -5,8 +7,8 @@ module Tomo
 
       def to_console
         error = ""
-        error << "#{operation_name} requires an interactive console."
-        error << "\n\n#{seems_like_ci}" if ci_var
+        error += "#{operation_name} requires an interactive console."
+        error += "\n\n#{seems_like_ci}" if ci_var
         error
       end
 

data/lib/tomo/console.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 require "io/console"
 
@@ -56,7 +58,7 @@ module Tomo
     private_constant :CI_VARS
 
     def ci?
-      (env.keys & CI_VARS).any?
+      env.keys.intersect?(CI_VARS)
     end
 
     def assert_interactive

data/lib/tomo/error/suggestions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Error
     class Suggestions
@@ -12,7 +14,7 @@ module Tomo
 
       def to_a
         @_suggestions ||= if defined?(DidYouMean::SpellChecker)
-                            checker = DidYouMean::SpellChecker.new(dictionary: dictionary)
+                            checker = DidYouMean::SpellChecker.new(dictionary:)
                             suggestions = checker.correct(word)
                             suggestions || []
                           else

data/lib/tomo/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Error < StandardError
     autoload :Suggestions, "tomo/error/suggestions"

data/lib/tomo/host.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Host
     PATTERN = /^(?:(\S+)@)?(\S*?)$/
@@ -10,7 +12,7 @@ module Tomo
       user, address = host.match(PATTERN).captures
       raise ArgumentError, "host cannot be blank" if address.empty?
 
-      new(user: user, address: address, **kwargs)
+      new(user:, address:, **kwargs)
     end
 
     def initialize(address:, port: nil, log_prefix: nil, roles: nil, user: nil, privileged_user: "root")
@@ -31,7 +33,7 @@ module Tomo
 
     def to_s
       str = user ? "#{user}@#{address}" : address
-      str << ":#{port}" unless port == 22
+      str += ":#{port}" unless port == 22
       str
     end
 

data/lib/tomo/logger/tagged_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Logger
     class TaggedIO

data/lib/tomo/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module Tomo

data/lib/tomo/path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "delegate"
 require "pathname"
 

data/lib/tomo/paths.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Paths
     def initialize(settings)

data/lib/tomo/plugin/bundler/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo::Plugin::Bundler
   module Helpers
     def bundle(*args, **opts)

data/lib/tomo/plugin/bundler/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module Tomo::Plugin::Bundler

data/lib/tomo/plugin/bundler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "bundler/helpers"
 require_relative "bundler/tasks"
 

data/lib/tomo/plugin/core/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 
 module Tomo::Plugin::Core

data/lib/tomo/plugin/core/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 require "securerandom"
 

data/lib/tomo/plugin/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "core/helpers"
 require_relative "core/tasks"
 

data/lib/tomo/plugin/env/tasks.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "monitor"
+require "securerandom"
 
 module Tomo::Plugin::Env
   class Tasks < Tomo::TaskLibrary # rubocop:disable Metrics/ClassLength
@@ -14,17 +17,25 @@ module Tomo::Plugin::Env
       update
     end
 
-    def update
+    def update # rubocop:disable Metrics/MethodLength
       return if settings[:env_vars].empty?
 
       modify_env_file do |env|
         settings[:env_vars].each do |name, value|
-          next if value == :prompt && contains_entry?(env, name)
+          case value
+          when :prompt
+            next if contains_entry?(env, name)
+
+            value = prompt_for(name, message: <<~MSG)
+              The remote host needs a value for the $#{name} environment variable.
+              Please provide a value at the prompt.
+            MSG
+          when :generate_secret
+            next if contains_entry?(env, name)
+
+            value = SecureRandom.hex(64)
+          end
 
-          value = prompt_for(name, message: <<~MSG) if value == :prompt
-            The remote host needs a value for the $#{name} environment variable.
-            Please provide a value at the prompt.
-          MSG
           replace_entry(env, name, value)
         end
       end

data/lib/tomo/plugin/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "env/tasks"
 
 module Tomo::Plugin

data/lib/tomo/plugin/git/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo::Plugin::Git
   module Helpers
     def git(*args, **opts)

data/lib/tomo/plugin/git/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 require "time"
 

data/lib/tomo/plugin/git.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "git/helpers"
 require_relative "git/tasks"
 

data/lib/tomo/plugin/nodenv/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 
 module Tomo::Plugin::Nodenv

data/lib/tomo/plugin/nodenv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "nodenv/tasks"
 
 module Tomo::Plugin

data/lib/tomo/plugin/puma/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo::Plugin::Puma
   class Tasks < Tomo::TaskLibrary
     SystemdUnit = Struct.new(:name, :template, :path)

data/lib/tomo/plugin/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "puma/tasks"
 
 module Tomo::Plugin

data/lib/tomo/plugin/rails/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo::Plugin::Rails
   module Helpers
     def rails(*args, **opts)

data/lib/tomo/plugin/rails/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo::Plugin::Rails
   class Tasks < Tomo::TaskLibrary
     def assets_precompile

data/lib/tomo/plugin/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "rails/helpers"
 require_relative "rails/tasks"
 

data/lib/tomo/plugin/rbenv/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 
 module Tomo::Plugin::Rbenv
@@ -19,7 +21,7 @@ module Tomo::Plugin::Rbenv
 
     def modify_bashrc
       existing_rc = remote.capture("cat", paths.bashrc, raise_on_error: false)
-      return if existing_rc.include?("rbenv init")
+      return if existing_rc.include?("rbenv init") && existing_rc.include?("$HOME/.rbenv/bin")
 
       remote.write(text: <<~BASHRC + existing_rc, to: paths.bashrc)
         if [ -d $HOME/.rbenv ]; then

data/lib/tomo/plugin/rbenv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "rbenv/tasks"
 
 module Tomo::Plugin

data/lib/tomo/plugin/testing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 raise "The testing plugin cannot be used outside of unit tests" unless defined?(Tomo::Testing)
 
 module Tomo::Plugin

data/lib/tomo/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   module Plugin
   end

data/lib/tomo/plugin_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   module PluginDSL
     def self.extended(mod)

data/lib/tomo/remote.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module Tomo
@@ -20,14 +22,14 @@ module Tomo
     end
 
     def attach(*command, default_chdir: nil, **command_opts)
-      full_command = shell_builder.build(*command, default_chdir: default_chdir)
+      full_command = shell_builder.build(*command, default_chdir:)
       ssh.ssh_exec(Script.new(full_command, pty: true, **command_opts))
     end
 
     def run(*command, attach: false, default_chdir: nil, **command_opts)
-      attach(*command, default_chdir: default_chdir, **command_opts) if attach
+      attach(*command, default_chdir:, **command_opts) if attach
 
-      full_command = shell_builder.build(*command, default_chdir: default_chdir)
+      full_command = shell_builder.build(*command, default_chdir:)
       ssh.ssh_subprocess(Script.new(full_command, **command_opts))
     end
 

data/lib/tomo/result.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Tomo
   class Result
     def self.empty_success
-      new(stdout: "", stderr: "", exit_status: 0)
+      new(stdout: +"", stderr: +"", exit_status: 0)
     end
 
     attr_reader :stdout, :stderr, :exit_status

data/lib/tomo/runtime/concurrent_ruby_load_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class ConcurrentRubyLoadError < Tomo::Error

data/lib/tomo/runtime/concurrent_ruby_thread_pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 concurrent_ver = "~> 1.1"
 
 begin

data/lib/tomo/runtime/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class Context

data/lib/tomo/runtime/current.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     module Current

data/lib/tomo/runtime/execution_plan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module Tomo
@@ -35,7 +37,7 @@ module Tomo
         open_connections do |remotes|
           plan.each do |steps|
             steps.each do |step|
-              step.execute(thread_pool: thread_pool, remotes: remotes)
+              step.execute(thread_pool:, remotes:)
             end
             thread_pool.run_to_completion
           end
@@ -76,7 +78,7 @@ module Tomo
       def build_plan(tasks, task_filter)
         tasks.each_with_object([]) do |task, result|
           steps = hosts.map do |host|
-            HostExecutionStep.new(tasks: task, host: host, task_filter: task_filter, task_runner: task_runner)
+            HostExecutionStep.new(tasks: task, host:, task_filter:, task_runner:)
           end
           steps.reject!(&:empty?)
           result << steps unless steps.empty?

data/lib/tomo/runtime/explanation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class Explanation
@@ -22,7 +24,7 @@ module Tomo
             indent = threads > 1 ? "  = " : ""
             if threads > 1 && step.applicable_tasks.length > 1
               desc << "#{indent}IN SEQUENCE:"
-              indent.sub!("=", "   ")
+              indent = indent.sub("=", "   ")
             end
             desc << step.explain.gsub(/^/, indent)
           end

data/lib/tomo/runtime/host_execution_step.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class HostExecutionStep
@@ -25,7 +27,7 @@ module Tomo
 
             task_host = task.is_a?(PrivilegedTask) ? host.as_privileged : host
             remote = remotes[task_host]
-            task_runner.run(task: task, remote: remote)
+            task_runner.run(task:, remote:)
           end
         end
       end

data/lib/tomo/runtime/inline_thread_pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class InlineThreadPool

data/lib/tomo/runtime/no_tasks_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class NoTasksError < Error

data/lib/tomo/runtime/privileged_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     module PrivilegedTask

data/lib/tomo/runtime/settings_interpolation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class SettingsInterpolation
@@ -40,7 +42,7 @@ module Tomo
 
       def dump_settings(hash)
         key_len = hash.keys.map { |k| k.to_s.length }.max
-        dump = "Settings: {\n"
+        dump = +"Settings: {\n"
         hash.to_a.sort_by(&:first).each do |key, value|
           justified_key = "#{key}:".ljust(key_len + 1)
           dump << "  #{justified_key} #{value.inspect},\n"

data/lib/tomo/runtime/settings_required_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class SettingsRequiredError < Tomo::Error
@@ -24,7 +26,7 @@ module Tomo
         return "a value for the #{yellow(settings.first.to_s)} setting." if settings.length == 1
 
         sentence = "values for these settings:\n\n  "
-        sentence << settings.map { |s| yellow(s.to_s) }.join("\n  ")
+        sentence + settings.map { |s| yellow(s.to_s) }.join("\n  ")
       end
     end
   end

data/lib/tomo/runtime/task_aborted_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class TaskAbortedError < Tomo::Error

data/lib/tomo/runtime/task_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class TaskRunner
@@ -24,15 +26,15 @@ module Tomo
 
       def run(task:, remote:)
         validate_task!(task)
-        Current.with(task: task, remote: remote) do
+        Current.with(task:, remote:) do
           Tomo.logger.task_start(task)
           tasks_by_name[task].call
         end
       end
 
       def connect(host)
-        Current.with(host: host) do
-          conn = SSH.connect(host: host, options: ssh_options)
+        Current.with(host:) do
+          conn = SSH.connect(host:, options: ssh_options)
           remote = Remote.new(conn, context, helper_modules)
           return remote unless block_given?
 

data/lib/tomo/runtime/template_not_found_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class TemplateNotFoundError < Error

data/lib/tomo/runtime/unknown_task_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Runtime
     class UnknownTaskError < Error
@@ -10,7 +12,7 @@ module Tomo
         ERROR
 
         sugg = spelling_suggestion || missing_plugin_suggestion
-        error << sugg if sugg
+        error += sugg if sugg
         error
       end
 

data/lib/tomo/runtime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "time"
 
 module Tomo
@@ -51,15 +53,15 @@ module Tomo
     end
 
     def run!(task, *args, privileged: false)
-      task = task.dup.extend(PrivilegedTask) if privileged
-      execution_plan_for([task], release: :current, args: args).execute
+      task = String.new(task).extend(PrivilegedTask) if privileged
+      execution_plan_for([task], release: :current, args:).execute
     end
 
     def execution_plan_for(tasks, release: :current, args: [])
       ExecutionPlan.new(
-        tasks: tasks,
-        hosts: hosts,
-        task_filter: task_filter,
+        tasks:,
+        hosts:,
+        task_filter:,
         task_runner: new_task_runner(release, args)
       )
     end
@@ -74,7 +76,7 @@ module Tomo
         .merge(settings)
         .merge(run_args: args)
 
-      TaskRunner.new(plugins_registry: plugins_registry, settings: run_settings)
+      TaskRunner.new(plugins_registry:, settings: run_settings)
     end
 
     def release_path_for(type)

data/lib/tomo/script.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   class Script
     attr_reader :script

data/lib/tomo/shell_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 
 module Tomo

data/lib/tomo/ssh/child_process.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open3"
 require "shellwords"
 require "stringio"
@@ -6,7 +8,7 @@ module Tomo
   module SSH
     class ChildProcess
       def self.execute(*command, on_data: ->(data) {})
-        process = new(*command, on_data: on_data)
+        process = new(*command, on_data:)
         process.wait_for_exit
         process.result
       end
@@ -31,7 +33,7 @@ module Tomo
       end
 
       def result
-        Result.new(exit_status: exit_status, stdout: stdout_buffer.string, stderr: stderr_buffer.string)
+        Result.new(exit_status:, stdout: stdout_buffer.string, stderr: stderr_buffer.string)
       end
 
       private

data/lib/tomo/ssh/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "securerandom"
 require "tmpdir"
@@ -26,7 +28,7 @@ module Tomo
       end
 
       def ssh_subprocess(script, verbose: false)
-        ssh_args = build_args(script, verbose: verbose)
+        ssh_args = build_args(script, verbose:)
         handle_data = ->(data) { logger.script_output(script, data) }
 
         logger.script_start(script)
@@ -62,7 +64,7 @@ module Tomo
       end
 
       def raise_run_error(script, ssh_args, result)
-        ScriptError.raise_with(result.output, host: host, result: result, script: script, ssh_args: ssh_args)
+        ScriptError.raise_with(result.output, host:, result:, script:, ssh_args:)
       end
     end
   end

data/lib/tomo/ssh/connection_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tomo
   module SSH
     class ConnectionError < Error