tomo 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ad1c87df7e8fad626e90eb0606c0bb2899a3acf57eb2b9df969bd53c33332de
-  data.tar.gz: 49ce5c513dfccbe4db1269e0c9385e39aa9940690cd7a6e86c561d54eeb89b54
+  metadata.gz: '098582c6866a637c63527b1bf1fecd347686cf1472ddf4e93b11002180b4e0c3'
+  data.tar.gz: 74ea3479cd90f9d3cf038d7b8e6cffa0200a98a51562798ba1b852ca66866f4e
 SHA512:
-  metadata.gz: 1f2459465ef849c4dc012f594bcb672317909945c1061cb54a9f8e94acb07e91ed04334d28347f1dd4d708e10903ab168a142b4632289e5e9c375aa882c8bdc9
-  data.tar.gz: 3946a734793b215eb57296eb602ac9bdaf68791c9df541d381b41bd89ee0bc9681fff27a506dd72e5d427bee757727f613f8db7624216eefaf808062740ba9a8
+  metadata.gz: 7ddd09600b3eae9914c7641b08f169f7f802297cf76170b7faffc0d0cb75cd0af22071c5e8d358c244464efe00672d4573054f30a2947b258aaef3af98e9ed74
+  data.tar.gz: 78c334db75ce535dd00c434fb3a4a927af4369d7f747cc3776334146c9c41bbae785ddb15e4ec42bdea59a66223a3836644f6bf0ec74e42f57c6de85fc822025

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/tomo.svg)](https://rubygems.org/gems/tomo)
 [![Travis](https://img.shields.io/travis/mattbrictson/tomo.svg?label=travis)](https://travis-ci.org/mattbrictson/tomo)
-[![Circle](https://circleci.com/gh/mattbrictson/tomo.svg?style=shield)](https://app.circleci.com/pipelines/github/mattbrictson/tomo?branch=master)
+[![Circle](https://circleci.com/gh/mattbrictson/tomo/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/mattbrictson/tomo?branch=main)
 [![Code Climate](https://codeclimate.com/github/mattbrictson/tomo/badges/gpa.svg)](https://codeclimate.com/github/mattbrictson/tomo)
 
 Tomo is a friendly command-line tool for deploying Rails apps. It is a new alternative to Capistrano, Mina, and Shipit that aims for simplicity and developer happiness.
@@ -64,7 +64,7 @@ host "user@hostname.or.ip.address"
 set application: "my-rails-app"
 set deploy_to: "/var/www/%{application}"
 set git_url: "git@github.com:my-username/my-rails-app.git"
-set git_branch: "master"
+set git_branch: "main"
 # ...
 
 setup do
@@ -191,7 +191,6 @@ Read the [Writing Custom Tasks](https://tomo-deploy.com/tutorials/writing-custom
   - [Result](https://tomo-deploy.com/api/Result/)
   - [TaskLibrary](https://tomo-deploy.com/api/TaskLibrary/)
   - [Testing::MockPluginTester](https://tomo-deploy.com/api/testing/MockPluginTester/)
-  - [Testing::DockerPluginTester](https://tomo-deploy.com/api/testing/DockerPluginTester/)
 
 ## FAQ
 
@@ -226,7 +225,7 @@ Next run `tomo setup` for _both_ apps; this will set everything up for both user
 
 ## Support
 
-This project is a labor of love and I can only spend a few hours a week maintaining it, at most. If you'd like to help by submitting a pull request, or if you've discovered a bug that needs my attention, please let me know. Check out [CONTRIBUTING.md](https://github.com/mattbrictson/tomo/blob/master/CONTRIBUTING.md) to get started. Happy hacking! —Matt
+This project is a labor of love and I can only spend a few hours a week maintaining it, at most. If you'd like to help by submitting a pull request, or if you've discovered a bug that needs my attention, please let me know. Check out [CONTRIBUTING.md](https://github.com/mattbrictson/tomo/blob/main/CONTRIBUTING.md) to get started. Happy hacking! —Matt
 
 ## License
 
@@ -234,8 +233,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of conduct
 
-Everyone interacting in the Tomo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattbrictson/tomo/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Tomo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattbrictson/tomo/blob/main/CODE_OF_CONDUCT.md).
 
 ## Contribution guide
 
-Interested in filing a bug report, feature request, or opening a PR? Excellent! Please read the short [CONTRIBUTING.md](https://github.com/mattbrictson/tomo/blob/master/CONTRIBUTING.md) guidelines before you dive in.
+Interested in filing a bug report, feature request, or opening a PR? Excellent! Please read the short [CONTRIBUTING.md](https://github.com/mattbrictson/tomo/blob/main/CONTRIBUTING.md) guidelines before you dive in.

data/lib/tomo/cli.rb

@@ -55,7 +55,6 @@ module Tomo
       argv << "" if argv.shift == "--complete"
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def lookup_command(argv)
       command_name = argv.first unless Completions.active? && argv.length == 1
       command_name = Abbrev.abbrev(COMMANDS.keys)[command_name]
@@ -65,7 +64,6 @@ module Tomo
       command = COMMANDS[command_name] || Tomo::Commands::Default
       [command, command_name]
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def task_format?(arg)
       arg.to_s.match?(/\A\S+:\S*\z/)

data/lib/tomo/cli/common_options.rb

@@ -1,22 +1,15 @@
 module Tomo
   class CLI
     module CommonOptions
-      # rubocop:disable Metrics/MethodLength
-      def self.included(mod)
+      def self.included(mod) # rubocop:disable Metrics/MethodLength
         mod.class_eval do
-          option :color,
-                 "--[no-]color",
-                 "Enable/disable color output" do |color|
+          option :color, "--[no-]color", "Enable/disable color output" do |color|
             Colors.enabled = color
           end
-          option :debug,
-                 "--[no-]debug",
-                 "Enable/disable verbose debug logging" do |debug|
+          option :debug, "--[no-]debug", "Enable/disable verbose debug logging" do |debug|
             Tomo.debug = debug
           end
-          option :trace,
-                 "--[no-]trace",
-                 "Display full backtrace on error" do |trace|
+          option :trace, "--[no-]trace", "Display full backtrace on error" do |trace|
             CLI.show_backtrace = trace
           end
           option :help, "-h, --help", "Print this documentation" do |_help|
@@ -27,7 +20,6 @@ module Tomo
           after_parse :dump_runtime_info
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/tomo/cli/deploy_options.rb

@@ -1,8 +1,7 @@
 module Tomo
   class CLI
     module DeployOptions
-      # rubocop:disable Metrics/MethodLength
-      def self.included(mod)
+      def self.included(mod) # rubocop:disable Metrics/MethodLength
         mod.class_eval do
           option :environment,
                  "-e, --environment ENVIRONMENT",
@@ -23,7 +22,6 @@ module Tomo
           after_parse :prompt_for_environment
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 
@@ -49,10 +47,7 @@ module Tomo
         return if envs.empty?
         return unless Console.interactive?
 
-        options[:environment] = Console.menu(
-          "Choose an environment:",
-          choices: envs
-        )
+        options[:environment] = Console.menu("Choose an environment:", choices: envs)
       end
     end
   end

data/lib/tomo/cli/parser.rb

@@ -46,12 +46,7 @@ module Tomo
       attr_reader :rules, :usage, :after_parse_methods
 
       def evaluate(argv, state, literal:)
-        RulesEvaluator.evaluate(
-          rules: rules.to_a,
-          argv: argv,
-          state: state,
-          literal: literal
-        )
+        RulesEvaluator.evaluate(rules: rules.to_a, argv: argv, state: state, literal: literal)
       end
 
       def check_required_rules(state)

data/lib/tomo/cli/project_options.rb

@@ -3,9 +3,7 @@ module Tomo
     module ProjectOptions
       def self.included(mod)
         mod.class_eval do
-          option :project,
-                 "-c, --config PATH",
-                 "Location of project config (default: #{DEFAULT_CONFIG_PATH})"
+          option :project, "-c, --config PATH", "Location of project config (default: #{DEFAULT_CONFIG_PATH})"
         end
       end
 

data/lib/tomo/cli/rules.rb

@@ -51,21 +51,11 @@ module Tomo
       attr_reader :rules
 
       def optional_arg_rule(spec, values_proc)
-        Rules::Argument.new(
-          spec,
-          values_proc: values_proc,
-          required: false,
-          multiple: false
-        )
+        Rules::Argument.new(spec, values_proc: values_proc, required: false, multiple: false)
       end
 
       def required_arg_rule(spec, values_proc)
-        Rules::Argument.new(
-          spec,
-          values_proc: values_proc,
-          required: true,
-          multiple: false
-        )
+        Rules::Argument.new(spec, values_proc: values_proc, required: true, multiple: false)
       end
 
       def mutiple_optional_args_rule(spec, values_proc)
@@ -73,10 +63,7 @@ module Tomo
       end
 
       def on_off_switch_rule(key, name, _values_proc, callback_proc)
-        Rules::Switch.new(key,
-                          "--#{name}",
-                          "--no-#{name}",
-                          callback_proc: callback_proc) do |arg|
+        Rules::Switch.new(key, "--#{name}", "--no-#{name}", callback_proc: callback_proc) do |arg|
           arg == "--#{name}"
         end
       end
@@ -86,12 +73,7 @@ module Tomo
       end
 
       def value_switch_rule(key, *switches, values_proc, callback_proc)
-        Rules::ValueSwitch.new(
-          key,
-          *switches,
-          values_proc: values_proc,
-          callback_proc: callback_proc
-        )
+        Rules::ValueSwitch.new(key, *switches, values_proc: values_proc, callback_proc: callback_proc)
       end
     end
   end

data/lib/tomo/cli/rules/switch.rb

@@ -1,10 +1,6 @@
 class Tomo::CLI::Rules
   class Switch
-    def initialize(key,
-                   *switches,
-                   required: false,
-                   callback_proc:,
-                   &convert_proc)
+    def initialize(key, *switches, required: false, callback_proc:, &convert_proc)
       @key = key
       @switches = switches
       @callback_proc = callback_proc

data/lib/tomo/cli/rules/value_switch.rb

@@ -51,8 +51,7 @@ class Tomo::CLI::Rules
     end
 
     def raise_missing_value(switch)
-      raise Tomo::CLI::Error,
-            "Please specify a value for the #{yellow(switch)} option."
+      raise Tomo::CLI::Error, "Please specify a value for the #{yellow(switch)} option."
     end
   end
 end

data/lib/tomo/cli/rules_evaluator.rb

@@ -41,11 +41,7 @@ module Tomo
       def complete_if_needed(matched_rules, *matched_args)
         return unless Completions.active?
 
-        completions.print_completions_and_exit(
-          matched_rules,
-          *matched_args,
-          state: state
-        )
+        completions.print_completions_and_exit(matched_rules, *matched_args, state: state)
       end
 
       def remaining_rules
@@ -56,15 +52,9 @@ module Tomo
 
       def raise_unrecognized_args
         problem_arg = argv.first
-        type = if literal || !problem_arg.start_with?("-")
-                 "arg"
-               else
-                 "option"
-               end
+        type = literal || !problem_arg.start_with?("-") ? "arg" : "option"
 
-        raise CLI::Error,
-              "#{Colors.yellow(problem_arg)} is not a recognized #{type} "\
-              "for this tomo command."
+        raise CLI::Error, "#{Colors.yellow(problem_arg)} is not a recognized #{type} for this tomo command."
       end
     end
   end

data/lib/tomo/cli/usage.rb

@@ -18,9 +18,7 @@ module Tomo
       end
 
       def to_s
-        indent([
-          "", banner_proc.call, "Options:", "", indent(options_help), "\n"
-        ].join("\n"))
+        indent(["", banner_proc.call, "Options:", "", indent(options_help), "\n"].join("\n"))
       end
 
       private

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,25 @@ 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 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 = {}
@@ -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/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/plugin_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/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