tomo 1.1.1 → 1.4.0

data/lib/tomo/commands/default.rb

@@ -42,9 +42,7 @@ module Tomo
         # do anything, so if we got this far, something has gone wrong.
 
         if options.any?
-          raise CLI::Error,
-                "Options must be specified after the command: " +
-                yellow("tomo #{args.first} [options]")
+          raise CLI::Error, "Options must be specified after the command: " + yellow("tomo #{args.first} [options]")
         end
 
         raise_unrecognized_command(args.first)

data/lib/tomo/commands/init.rb

@@ -70,6 +70,14 @@ module Tomo
         nil
       end
 
+      def git_branch
+        return unless File.file?(".git/config")
+
+        `git rev-parse --abbrev-ref HEAD`.chomp
+      rescue SystemCallError
+        nil
+      end
+
       def node_version
         `node --version`.chomp.sub(/^v/i, "")
       rescue SystemCallError
@@ -82,10 +90,29 @@ module Tomo
         nil
       end
 
+      def rubocop?
+        File.exist?(".rubocop.yml")
+      end
+
+      def erb_2_2_or_later?
+        erb_version = Gem::Version.new(ERB.version[/\d[\d.]+/])
+        Gem::Requirement.new(">= 2.2").satisfied_by?(erb_version)
+      end
+
+      def ruby_version_file?
+        File.exist?(".ruby-version")
+      end
+
       def config_rb_template(app)
         path = File.expand_path("../templates/config.rb.erb", __dir__)
         template = IO.read(path)
-        ERB.new(template).result(binding)
+
+        # TODO: remove once we drop Ruby 2.5 support?
+        if erb_2_2_or_later?
+          ERB.new(template, trim_mode: "-").result(binding)
+        else
+          ERB.new(template, nil, "-").result(binding)
+        end
       end
     end
   end

data/lib/tomo/commands/run.rb

@@ -3,9 +3,7 @@ module Tomo
     class Run < CLI::Command
       include CLI::DeployOptions
 
-      option :privileged,
-             "--[no-]privileged",
-             "Run the task using a privileged user (e.g. root)"
+      option :privileged, "--[no-]privileged", "Run the task using a privileged user (e.g. root)"
 
       include CLI::ProjectOptions
       include CLI::CommonOptions

data/lib/tomo/configuration.rb

@@ -3,16 +3,13 @@ module Tomo
     autoload :DSL, "tomo/configuration/dsl"
     autoload :Environment, "tomo/configuration/environment"
     autoload :Glob, "tomo/configuration/glob"
-    autoload :PluginFileNotFoundError,
-             "tomo/configuration/plugin_file_not_found_error"
+    autoload :PluginFileNotFoundError, "tomo/configuration/plugin_file_not_found_error"
     autoload :PluginsRegistry, "tomo/configuration/plugins_registry"
     autoload :ProjectNotFoundError, "tomo/configuration/project_not_found_error"
     autoload :RoleBasedTaskFilter, "tomo/configuration/role_based_task_filter"
-    autoload :UnknownEnvironmentError,
-             "tomo/configuration/unknown_environment_error"
+    autoload :UnknownEnvironmentError, "tomo/configuration/unknown_environment_error"
     autoload :UnknownPluginError, "tomo/configuration/unknown_plugin_error"
-    autoload :UnspecifiedEnvironmentError,
-             "tomo/configuration/unspecified_environment_error"
+    autoload :UnspecifiedEnvironmentError, "tomo/configuration/unspecified_environment_error"
 
     def self.from_config_rb(path=DEFAULT_CONFIG_PATH)
       ProjectNotFoundError.raise_with(path: path) unless File.file?(path)
@@ -27,8 +24,7 @@ module Tomo
       raise DSL::ErrorFormatter.decorate(e, path, config_rb&.lines)
     end
 
-    attr_accessor :environments, :deploy_tasks, :setup_tasks, :hosts, :plugins,
-                  :settings, :task_filter, :path
+    attr_accessor :environments, :deploy_tasks, :setup_tasks, :hosts, :plugins, :settings, :task_filter, :path
 
     def initialize
       @environments = {}
@@ -94,7 +90,7 @@ module Tomo
       plugins_registry = PluginsRegistry.new
 
       (["core"] + plugins.uniq).each do |plug|
-        if %w[. /].include?(plug[0])
+        if plug.start_with?(".", "/")
           plug = File.expand_path(plug, File.dirname(path)) unless path.nil?
           plugins_registry.load_plugin_from_path(plug)
         else
@@ -116,9 +112,7 @@ module Tomo
     end
 
     def raise_unknown_environment(environ)
-      UnknownEnvironmentError.raise_with(
-        name: environ, known_environments: environments.keys
-      )
+      UnknownEnvironmentError.raise_with(name: environ, known_environments: environments.keys)
     end
   end
 end

data/lib/tomo/configuration/dsl/error_formatter.rb

@@ -50,7 +50,7 @@ module Tomo
           HINT
         end
 
-        def highlighted_lines
+        def highlighted_lines # rubocop:disable Metrics/AbcSize
           first = [1, error_line_no - 1].max
           last = [dsl_lines.length, error_line_no + 1].min
           width = last.to_s.length

data/lib/tomo/configuration/dsl/hosts_and_settings.rb

@@ -7,8 +7,7 @@ module Tomo
           self
         end
 
-        def host(address, port: 22, roles: [],
-                 log_prefix: nil, privileged_user: "root")
+        def host(address, port: 22, roles: [], log_prefix: nil, privileged_user: "root")
           @config.hosts << Host.parse(
             address,
             privileged_user: privileged_user,

data/lib/tomo/configuration/plugins_registry.rb

@@ -1,8 +1,7 @@
 module Tomo
   class Configuration
     class PluginsRegistry
-      autoload :FileResolver,
-               "tomo/configuration/plugins_registry/file_resolver"
+      autoload :FileResolver, "tomo/configuration/plugins_registry/file_resolver"
       autoload :GemResolver, "tomo/configuration/plugins_registry/gem_resolver"
 
       attr_reader :helper_modules, :settings

data/lib/tomo/configuration/plugins_registry/gem_resolver.rb

@@ -39,7 +39,7 @@ module Tomo
       def constantize(path)
         parts = path.split("/")
         parts.reduce(Object) do |parent, part|
-          child = part.gsub(/^[a-z]|_[a-z]/) { |str| str.chars.last.upcase }
+          child = part.gsub(/^[a-z]|_[a-z]/) { |str| str[-1].upcase }
           parent.const_get(child, false)
         end
       end

data/lib/tomo/configuration/unknown_environment_error.rb

@@ -36,10 +36,7 @@ module Tomo
       end
 
       def suggestions
-        @_suggestions ||= Error::Suggestions.new(
-          dictionary: known_environments,
-          word: name
-        )
+        @_suggestions ||= Error::Suggestions.new(dictionary: known_environments, word: name)
       end
     end
   end

data/lib/tomo/console.rb

@@ -12,22 +12,20 @@ module Tomo
       def_delegators :@instance, :interactive?, :prompt, :menu
     end
 
-    def initialize(env=ENV, input=$stdin)
+    def initialize(env=ENV, input=$stdin, output=$stdout)
       @env = env
       @input = input
+      @output = output
     end
 
     def interactive?
-      input.respond_to?(:raw) &&
-        input.respond_to?(:tty?) &&
-        input.tty? &&
-        !ci?
+      input.respond_to?(:raw) && input.respond_to?(:tty?) && input.tty? && !ci?
     end
 
     def prompt(question)
       assert_interactive
 
-      print question
+      output.print question
       line = input.gets
       raise_non_interactive if line.nil?
 
@@ -42,7 +40,7 @@ module Tomo
 
     private
 
-    attr_reader :env, :input
+    attr_reader :env, :input, :output
 
     CI_VARS = %w[
       JENKINS_HOME
@@ -66,10 +64,7 @@ module Tomo
     end
 
     def raise_non_interactive
-      NonInteractiveError.raise_with(
-        task: Runtime::Current.task,
-        ci_var: (env.keys & CI_VARS).first
-      )
+      NonInteractiveError.raise_with(task: Runtime::Current.task, ci_var: (env.keys & CI_VARS).first)
     end
   end
 end

data/lib/tomo/console/menu.rb

@@ -12,8 +12,7 @@ module Tomo
       extend Forwardable
       include Colors
 
-      def initialize(question, options, key_reader: KeyReader.new,
-                     output: $stdout)
+      def initialize(question, options, key_reader: KeyReader.new, output: $stdout)
         @question = question
         @options = options
         @position = 0

data/lib/tomo/host.rb

@@ -13,8 +13,7 @@ module Tomo
       new(**{ user: user, address: address }.merge(kwargs))
     end
 
-    def initialize(address:, port: nil, log_prefix: nil, roles: nil,
-                   user: nil, privileged_user: "root")
+    def initialize(address:, port: nil, log_prefix: nil, roles: nil, user: nil, privileged_user: "root")
       @user = user.freeze
       @port = (port || 22).to_i.freeze
       @address = address.freeze

data/lib/tomo/paths.rb

@@ -20,7 +20,7 @@ module Tomo
       path(:"#{method}_path")
     end
 
-    def respond_to_missing?(method, include_private=false)
+    def respond_to_missing?(method, include_private)
       setting?(method) || super
     end
 

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

@@ -30,12 +30,7 @@ module Tomo::Plugin::Bundler
 
     def upgrade_bundler
       needed_bundler_ver = version_setting || extract_bundler_ver_from_lockfile
-
-      remote.run(
-        "gem", "install", "bundler",
-        "--conservative", "--no-document",
-        "-v", needed_bundler_ver
-      )
+      remote.run("gem", "install", "bundler", "--conservative", "--no-document", "-v", needed_bundler_ver)
     end
 
     private
@@ -61,7 +56,7 @@ module Tomo::Plugin::Bundler
         raise_on_error: false
       )
       version = lockfile_tail[/BUNDLED WITH\n   (\S+)$/, 1]
-      return version if version
+      return version if version || dry_run?
 
       die <<~REASON
         Could not guess bundler version from Gemfile.lock.

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

@@ -12,7 +12,7 @@ module Tomo::Plugin::Core
       result.success?
     end
 
-    def write(text: nil, template: nil, to:, append: false, **run_opts)
+    def write(to:, text: nil, template: nil, append: false, **run_opts)
       assert_text_or_template_required!(text, template)
       text = merge_template(template) unless template.nil?
       message = "Writing #{text.bytesize} bytes to #{to}"

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

@@ -34,8 +34,7 @@ module Tomo::Plugin::Core
       remote.run "mv", "-fT", tmp_link, paths.current
     end
 
-    # rubocop:disable Metrics/AbcSize
-    def clean_releases
+    def clean_releases # rubocop:disable Metrics/AbcSize
       desired_count = settings[:keep_releases].to_i
       return if desired_count < 1
 
@@ -49,15 +48,13 @@ module Tomo::Plugin::Core
         remote.rm_rf(*releases.take(releases.length - desired_count))
       end
     end
-    # rubocop:enable Metrics/AbcSize
 
     def write_release_json
       json = JSON.pretty_generate(remote.release)
       remote.write(text: "#{json}\n", to: paths.release_json)
     end
 
-    # rubocop:disable Metrics/AbcSize
-    def log_revision
+    def log_revision # rubocop:disable Metrics/AbcSize
       ref = remote.release[:ref]
       revision = remote.release[:revision]
 
@@ -69,7 +66,6 @@ module Tomo::Plugin::Core
 
       remote.write(text: message, to: paths.revision_log, append: true)
     end
-    # rubocop:enable Metrics/AbcSize
 
     private
 
@@ -123,12 +119,7 @@ module Tomo::Plugin::Core
     end
 
     def read_current_release
-      result = remote.run(
-        "readlink",
-        paths.current,
-        raise_on_error: false,
-        silent: true
-      )
+      result = remote.run("readlink", paths.current, raise_on_error: false, silent: true)
       return nil if result.failure?
 
       result.stdout.strip[%r{/(#{RELEASE_REGEXP})$}, 1]

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

@@ -1,7 +1,7 @@
 require "monitor"
 
 module Tomo::Plugin::Env
-  class Tasks < Tomo::TaskLibrary
+  class Tasks < Tomo::TaskLibrary # rubocop:disable Metrics/ClassLength
     include MonitorMixin
 
     def show
@@ -10,8 +10,8 @@ module Tomo::Plugin::Env
     end
 
     def setup
-      update
       modify_bashrc
+      update
     end
 
     def update
@@ -65,10 +65,7 @@ module Tomo::Plugin::Env
     end
 
     def read_existing
-      remote.capture(
-        "cat", paths.env,
-        raise_on_error: false, echo: false, silent: true
-      )
+      remote.capture("cat", paths.env, raise_on_error: false, echo: false, silent: true)
     end
 
     def replace_entry(text, name, value)
@@ -106,12 +103,37 @@ module Tomo::Plugin::Env
       existing_rc = remote.capture("cat", paths.bashrc, raise_on_error: false)
       return if existing_rc.include?(". #{env_path}")
 
+      fail_if_different_app_already_configured!(existing_rc)
+
       remote.write(text: <<~BASHRC + existing_rc, to: paths.bashrc)
-        if [ -f #{env_path} ]; then
-          . #{env_path}
-        fi
+        if [ -f #{env_path} ]; then  # DO NOT MODIFY THESE LINES
+          . #{env_path}              # ENV MAINTAINED BY TOMO
+        fi                #{' ' * env_path.to_s.length}# END TOMO ENV
 
       BASHRC
     end
+
+    def fail_if_different_app_already_configured!(bashrc)
+      existing_env_path = bashrc[/\s*\.\s+(.+)\s+# ENV MAINTAINED BY TOMO/, 1]
+      return if existing_env_path.nil?
+
+      die <<~REASON
+        Based on the contents of #{paths.bashrc}, it looks like another application
+        is already being deployed via tomo to this host, using the following envrc
+        path:
+
+          #{existing_env_path}
+
+        Tomo is designed such that only one application can be deployed to a given
+        user@host. To deploy multiple applications to the same host, use a separate
+        deployer user per app. Refer to the tomo FAQ for details:
+
+          https://tomo-deploy.com/#faq
+
+        You may be receiving this message in error if you recently renamed or
+        reconfigured your application. In this case, remove the references to the
+        old envrc path in the host's #{paths.bashrc} and re-run env:setup.
+      REASON
+    end
   end
 end

data/lib/tomo/plugin/git.rb

@@ -7,14 +7,11 @@ module Tomo::Plugin
 
     helpers Tomo::Plugin::Git::Helpers
     tasks Tomo::Plugin::Git::Tasks
-
-    # rubocop:disable Layout/LineLength
-    defaults git_branch:     "master",
+    defaults git_branch:     nil,
              git_repo_path:  "%{deploy_to}/git_repo",
              git_exclusions: [],
              git_env:        { GIT_SSH_COMMAND: "ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no" },
              git_ref:        nil,
              git_url:        nil
-    # rubocop:enable Layout/LineLength
   end
 end

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

@@ -3,7 +3,6 @@ require "time"
 
 module Tomo::Plugin::Git
   class Tasks < Tomo::TaskLibrary
-    # rubocop:disable Metrics/AbcSize
     def clone
       require_setting :git_url
 
@@ -15,7 +14,7 @@ module Tomo::Plugin::Git
       end
     end
 
-    def create_release
+    def create_release # rubocop:disable Metrics/AbcSize
       remote.chdir(paths.git_repo) do
         remote.git("remote update --prune")
       end
@@ -31,7 +30,6 @@ module Tomo::Plugin::Git
         )
       end
     end
-    # rubocop:enable Metrics/AbcSize
 
     private
 
@@ -64,19 +62,13 @@ module Tomo::Plugin::Git
       exclusions = settings[:git_exclusions] || []
       attributes = exclusions.map { |excl| "#{excl} export-ignore" }.join("\n")
 
-      remote.write(
-        text: attributes,
-        to: paths.git_repo.join("info/attributes")
-      )
+      remote.write(text: attributes, to: paths.git_repo.join("info/attributes"))
     end
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
-    def store_release_info
+    def store_release_info # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       log = remote.chdir(paths.git_repo) do
         remote.git(
-          'log -n1 --date=iso --pretty=format:"%H/%cd/%ae" '\
-          "#{ref.shellescape} --",
+          %Q(log -n1 --date=iso --pretty=format:"%H/%cd/%ae" #{ref.shellescape} --),
           silent: true
         ).stdout.strip
       end
@@ -90,7 +82,5 @@ module Tomo::Plugin::Git
       remote.release[:deploy_date] = Time.now.to_s
       remote.release[:deploy_user] = settings.fetch(:local_user)
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
   end
 end