tomo 1.1.1 → 1.4.0

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

@@ -34,9 +34,7 @@ module Tomo::Plugin::Nodenv
       require_setting :nodenv_node_version
       node_version = settings[:nodenv_node_version]
 
-      unless node_installed?(node_version)
-        remote.run "nodenv install #{node_version.shellescape}"
-      end
+      remote.run "nodenv install #{node_version.shellescape}" unless node_installed?(node_version)
       remote.run "nodenv global #{node_version.shellescape}"
     end
 

data/lib/tomo/plugin/puma.rb

@@ -5,8 +5,6 @@ module Tomo::Plugin
     extend Tomo::PluginDSL
 
     tasks Tomo::Plugin::Puma::Tasks
-
-    # rubocop:disable Layout/LineLength
     defaults puma_check_timeout: 15,
              puma_host: "0.0.0.0",
              puma_port: "3000",
@@ -16,6 +14,5 @@ module Tomo::Plugin
              puma_systemd_socket_path: ".config/systemd/user/%{puma_systemd_socket}",
              puma_systemd_service_template_path: File.expand_path("puma/systemd/service.erb", __dir__),
              puma_systemd_socket_template_path: File.expand_path("puma/systemd/socket.erb", __dir__)
-    # rubocop:enable Layout/LineLength
   end
 end

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

@@ -2,8 +2,7 @@ module Tomo::Plugin::Puma
   class Tasks < Tomo::TaskLibrary
     SystemdUnit = Struct.new(:name, :template, :path)
 
-    # rubocop:disable Metrics/AbcSize
-    def setup_systemd
+    def setup_systemd # rubocop:disable Metrics/AbcSize
       linger_must_be_enabled!
 
       setup_directories
@@ -13,7 +12,6 @@ module Tomo::Plugin::Puma
       remote.run "systemctl --user daemon-reload"
       remote.run "systemctl", "--user", "enable", service.name, socket.name
     end
-    # rubocop:enable Metrics/AbcSize
 
     %i[start stop status].each do |action|
       define_method(action) do
@@ -37,9 +35,7 @@ module Tomo::Plugin::Puma
     end
 
     def log
-      remote.attach "journalctl", "-q",
-                    raw("--user-unit=#{service.name.shellescape}"),
-                    *settings[:run_args]
+      remote.attach "journalctl", "-q", raw("--user-unit=#{service.name.shellescape}"), *settings[:run_args]
     end
 
     private
@@ -102,22 +98,17 @@ module Tomo::Plugin::Puma
     end
 
     def assert_active!
-      return true if remote.run? "systemctl", "--user", "is-active",
-                                 service.name,
-                                 silent: true, raise_on_error: false
+      return true if remote.run? "systemctl", "--user", "is-active", service.name, silent: true, raise_on_error: false
 
-      remote.run "systemctl", "--user", "status", service.name,
-                 raise_on_error: false
-      remote.run "journalctl -q -n 50 --user-unit=#{service.name.shellescape}",
-                 raise_on_error: false
+      remote.run "systemctl", "--user", "status", service.name, raise_on_error: false
+      remote.run "journalctl -q -n 50 --user-unit=#{service.name.shellescape}", raise_on_error: false
 
       die "puma failed to start (see previous systemctl and journalctl output)"
     end
 
     def listening?
       test_url = "http://localhost:#{port}"
-      remote.run? "curl -sS --connect-timeout 1 --max-time 10 #{test_url}"\
-                  " > /dev/null"
+      remote.run? "curl -sS --connect-timeout 1 --max-time 10 #{test_url} > /dev/null"
     end
   end
 end

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

@@ -8,6 +8,10 @@ module Tomo::Plugin::Rails
       remote.rails("console", settings[:run_args], attach: true)
     end
 
+    def db_console
+      remote.rails("dbconsole", "--include-password", settings[:run_args], attach: true)
+    end
+
     def db_migrate
       remote.rake("db:migrate")
     end
@@ -40,11 +44,9 @@ module Tomo::Plugin::Rails
 
     def db_structure_load
       if !structure_sql_present?
-        logger.warn "db/structure.sql is not present; "\
-                    "skipping db:structure:load."
+        logger.warn "db/structure.sql is not present; skipping db:structure:load."
       elsif database_schema_loaded?
-        logger.info "Database structure already loaded; "\
-                    "skipping db:structure:load."
+        logger.info "Database structure already loaded; skipping db:structure:load."
       else
         remote.rake("db:structure:load")
       end

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

@@ -31,8 +31,7 @@ module Tomo::Plugin::Rbenv
     end
 
     def compile_ruby
-      require_setting :rbenv_ruby_version
-      ruby_version = settings[:rbenv_ruby_version]
+      ruby_version = version_setting || extract_ruby_ver_from_version_file
 
       unless ruby_installed?(ruby_version)
         logger.info(
@@ -51,5 +50,20 @@ module Tomo::Plugin::Rbenv
       end
       false
     end
+
+    def version_setting
+      settings[:rbenv_ruby_version]
+    end
+
+    def extract_ruby_ver_from_version_file
+      path = paths.release.join(".ruby-version")
+      version = remote.capture("cat", path, raise_on_error: false).strip
+      return version unless version.empty?
+
+      die <<~REASON
+        Could not guess ruby version from .ruby-version file.
+        Use the :rbenv_ruby_version setting to specify the version of ruby to install.
+      REASON
+    end
   end
 end

data/lib/tomo/plugin/testing.rb

@@ -1,6 +1,4 @@
-unless defined?(Tomo::Testing)
-  raise "The testing plugin cannot be used outside of unit tests"
-end
+raise "The testing plugin cannot be used outside of unit tests" unless defined?(Tomo::Testing)
 
 module Tomo::Plugin
   class Testing < Tomo::TaskLibrary

data/lib/tomo/remote.rb

@@ -21,9 +21,7 @@ module Tomo
 
     def attach(*command, default_chdir: nil, **command_opts)
       full_command = shell_builder.build(*command, default_chdir: default_chdir)
-      ssh.ssh_exec(
-        Script.new(full_command, **{ pty: true }.merge(command_opts))
-      )
+      ssh.ssh_exec(Script.new(full_command, **{ pty: true }.merge(command_opts)))
     end
 
     def run(*command, attach: false, default_chdir: nil, **command_opts)

data/lib/tomo/runtime.rb

@@ -3,8 +3,7 @@ require "time"
 module Tomo
   class Runtime
     autoload :ConcurrentRubyLoadError, "tomo/runtime/concurrent_ruby_load_error"
-    autoload :ConcurrentRubyThreadPool,
-             "tomo/runtime/concurrent_ruby_thread_pool"
+    autoload :ConcurrentRubyThreadPool, "tomo/runtime/concurrent_ruby_thread_pool"
     autoload :Context, "tomo/runtime/context"
     autoload :Current, "tomo/runtime/current"
     autoload :ExecutionPlan, "tomo/runtime/execution_plan"
@@ -28,8 +27,7 @@ module Tomo
 
     attr_reader :tasks
 
-    def initialize(deploy_tasks:, setup_tasks:, hosts:, task_filter:,
-                   settings:, plugins_registry:)
+    def initialize(deploy_tasks:, setup_tasks:, hosts:, task_filter:, settings:, plugins_registry:)
       @deploy_tasks = deploy_tasks.freeze
       @setup_tasks = setup_tasks.freeze
       @hosts = hosts.freeze
@@ -68,8 +66,7 @@ module Tomo
 
     private
 
-    attr_reader :deploy_tasks, :setup_tasks, :hosts, :task_filter, :settings,
-                :plugins_registry
+    attr_reader :deploy_tasks, :setup_tasks, :hosts, :task_filter, :settings, :plugins_registry
 
     def new_task_runner(release_type, args)
       run_settings = { release_path: release_path_for(release_type) }

data/lib/tomo/runtime/concurrent_ruby_thread_pool.rb

@@ -4,10 +4,7 @@ begin
   gem "concurrent-ruby", concurrent_ver
   require "concurrent"
 rescue LoadError => e
-  Tomo::Runtime::ConcurrentRubyLoadError.raise_with(
-    e.message,
-    version: concurrent_ver
-  )
+  Tomo::Runtime::ConcurrentRubyLoadError.raise_with(e.message, version: concurrent_ver)
 end
 
 module Tomo

data/lib/tomo/runtime/execution_plan.rb

@@ -77,10 +77,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: host, task_filter: task_filter, task_runner: task_runner)
           end
           steps.reject!(&:empty?)
           result << steps unless steps.empty?

data/lib/tomo/runtime/explanation.rb

@@ -7,10 +7,7 @@ module Tomo
         @concurrency = concurrency
       end
 
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def to_s
+      def to_s # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         desc = []
         threads = [applicable_hosts.length, concurrency].min
         desc << "CONCURRENTLY (#{threads} THREADS):" if threads > 1
@@ -32,9 +29,6 @@ module Tomo
         end
         desc.join("\n")
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       private
 

data/lib/tomo/runtime/settings_required_error.rb

@@ -21,9 +21,7 @@ module Tomo
       private
 
       def settings_sentence
-        if settings.length == 1
-          return "a value for the #{yellow(settings.first.to_s)} setting."
-        end
+        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  ")

data/lib/tomo/runtime/task_runner.rb

@@ -19,11 +19,7 @@ module Tomo
       def validate_task!(name)
         return if tasks_by_name.key?(name)
 
-        UnknownTaskError.raise_with(
-          name,
-          unknown_task: name,
-          known_tasks: tasks_by_name.keys
-        )
+        UnknownTaskError.raise_with(name, unknown_task: name, known_tasks: tasks_by_name.keys)
       end
 
       def run(task:, remote:)

data/lib/tomo/runtime/unknown_task_error.rb

@@ -17,10 +17,7 @@ module Tomo
       private
 
       def spelling_suggestion
-        sugg = Error::Suggestions.new(
-          dictionary: known_tasks,
-          word: unknown_task
-        )
+        sugg = Error::Suggestions.new(dictionary: known_tasks, word: unknown_task)
         sugg.to_console if sugg.any?
       end
 

data/lib/tomo/script.rb

@@ -2,11 +2,7 @@ module Tomo
   class Script
     attr_reader :script
 
-    def initialize(script,
-                   echo: true,
-                   pty: false,
-                   raise_on_error: true,
-                   silent: false)
+    def initialize(script, echo: true, pty: false, raise_on_error: true, silent: false)
       @script = script
       @echo = echo
       @pty = pty

data/lib/tomo/shell_builder.rb

@@ -3,8 +3,9 @@ require "shellwords"
 module Tomo
   class ShellBuilder
     def self.raw(string)
-      string.define_singleton_method(:shellescape) { string }
-      string
+      string.dup.tap do |raw_string|
+        raw_string.define_singleton_method(:shellescape) { string }
+      end
     end
 
     def initialize
@@ -45,9 +46,7 @@ module Tomo
     end
 
     def build(*command, default_chdir: nil)
-      if @chdir.empty? && default_chdir
-        return chdir(default_chdir) { build(*command) }
-      end
+      return chdir(default_chdir) { build(*command) } if @chdir.empty? && default_chdir
 
       command_string = command_to_string(*command)
       modifiers = [cd_chdir, unset_env, export_env, set_umask].compact.flatten
@@ -97,11 +96,7 @@ module Tomo
     def set_umask
       return if @umask.nil?
 
-      umask_value = if @umask.is_a?(Integer)
-                      @umask.to_s(8).rjust(4, "0")
-                    else
-                      @umask
-                    end
+      umask_value = @umask.is_a?(Integer) ? @umask.to_s(8).rjust(4, "0") : @umask
       "umask #{umask_value.to_s.shellescape}"
     end
   end

data/lib/tomo/ssh/child_process.rb

@@ -30,17 +30,12 @@ module Tomo
       end
 
       def result
-        Result.new(
-          exit_status: exit_status,
-          stdout: stdout_buffer.string,
-          stderr: stderr_buffer.string
-        )
+        Result.new(exit_status: exit_status, stdout: stdout_buffer.string, stderr: stderr_buffer.string)
       end
 
       private
 
-      attr_reader :command, :exit_status, :on_data,
-                  :stdout_buffer, :stderr_buffer
+      attr_reader :command, :exit_status, :on_data, :stdout_buffer, :stderr_buffer
 
       def start_io_thread(source, buffer)
         new_thread_inheriting_current_vars do

data/lib/tomo/ssh/connection.rb

@@ -6,12 +6,7 @@ module Tomo
   module SSH
     class Connection
       def self.dry_run(host, options)
-        new(
-          host,
-          options,
-          exec_proc: proc { CLI.exit },
-          child_proc: proc { Result.empty_success }
-        )
+        new(host, options, exec_proc: proc { CLI.exit }, child_proc: proc { Result.empty_success })
       end
 
       attr_reader :host
@@ -31,16 +26,14 @@ module Tomo
       end
 
       def ssh_subprocess(script, verbose: false)
-        ssh_args = build_args(script, verbose)
+        ssh_args = build_args(script, verbose: verbose)
         handle_data = ->(data) { logger.script_output(script, data) }
 
         logger.script_start(script)
         result = child_proc.call(*ssh_args, on_data: handle_data)
         logger.script_end(script, result)
 
-        if result.failure? && script.raise_on_error?
-          raise_run_error(script, ssh_args, result)
-        end
+        raise_run_error(script, ssh_args, result) if result.failure? && script.raise_on_error?
 
         result
       end
@@ -57,7 +50,7 @@ module Tomo
         Tomo.logger
       end
 
-      def build_args(script, verbose=false)
+      def build_args(script, verbose: false)
         options.build_args(host, script, control_path, verbose)
       end
 
@@ -69,13 +62,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: host, result: result, script: script, ssh_args: ssh_args)
       end
     end
   end

data/lib/tomo/ssh/connection_validator.rb

@@ -15,10 +15,10 @@ module Tomo
 
       def assert_valid_executable!
         result = begin
-                   ChildProcess.execute(executable, "-V")
-                 rescue StandardError => e
-                   handle_bad_executable(e)
-                 end
+          ChildProcess.execute(executable, "-V")
+        rescue StandardError => e
+          handle_bad_executable(e)
+        end
 
         Tomo.logger.debug(result.output)
         return if result.success? && supported?(result.output)
@@ -27,10 +27,7 @@ module Tomo
       end
 
       def assert_valid_connection!
-        script = Script.new(
-          "echo hi",
-          silent: !Tomo.debug?, echo: false, raise_on_error: false
-        )
+        script = Script.new("echo hi", silent: !Tomo.debug?, echo: false, raise_on_error: false)
         res = connection.ssh_subprocess(script, verbose: Tomo.debug?)
         raise_connection_failure(res) if res.exit_status == 255
         raise_unknown_error(res) if res.failure? || res.stdout.chomp != "hi"

data/lib/tomo/ssh/executable_error.rb

@@ -7,8 +7,7 @@ module Tomo
         hint = if executable.to_s.include?("/")
                  "Is the ssh binary properly installed in this location?"
                else
-                 "Is #{yellow(executable)} installed and in your "\
-                 "#{blue('$PATH')}?"
+                 "Is #{yellow(executable)} installed and in your #{blue('$PATH')}?"
                end
 
         <<~ERROR

data/lib/tomo/ssh/options.rb

@@ -20,8 +20,7 @@ module Tomo
         freeze
       end
 
-      # rubocop:disable Metrics/AbcSize
-      def build_args(host, script, control_path, verbose)
+      def build_args(host, script, control_path, verbose) # rubocop:disable Metrics/AbcSize
         args = [verbose ? "-v" : ["-o", "LogLevel=ERROR"]]
         args << "-A" if forward_agent
         args << connect_timeout_option
@@ -34,13 +33,11 @@ module Tomo
 
         [executable, args, script.to_s].flatten
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 
       attr_writer :executable
-      attr_accessor :connect_timeout, :extra_opts, :forward_agent,
-                    :reuse_connections, :strict_host_key_checking
+      attr_accessor :connect_timeout, :extra_opts, :forward_agent, :reuse_connections, :strict_host_key_checking
 
       def control_opts(path, verbose)
         opts = [