skylight 3.1.4 → 5.3.4

data/lib/skylight/cli/merger.rb

@@ -1,7 +1,7 @@
-require 'ostruct'
-require 'skylight/util/http'
-require 'thor'
-require 'highline'
+require "ostruct"
+require "skylight/util/http"
+require "thor"
+require "highline"
 
 module Skylight
   module CLI
@@ -13,9 +13,9 @@ module Skylight
       end
 
       STRINGS = {
-        get_token: 'get your merge token from `https://www.skylight.io/merging`',
+        get_token: "get your merge token from `https://www.skylight.io/merging`",
         unlisted: "My app isn't listed here :("
-      }
+      }.freeze
 
       argument :merge_token, type: :string, desc: STRINGS[:get_token]
 
@@ -23,8 +23,8 @@ module Skylight
         say "\nHello! Welcome to the `skylight merge` CLI!\n", :green
 
         say "This CLI is for Skylight users who already have Skylight Environments set up\n" \
-          "using the legacy method of creating a separate Skylight app per environment.\n" \
-          "Use this CLI to merge legacy environment apps into their parent apps as Environments."
+              "using the legacy method of creating a separate Skylight app per environment.\n" \
+              "Use this CLI to merge legacy environment apps into their parent apps as Environments."
       end
 
       def fetch_apps
@@ -40,23 +40,24 @@ module Skylight
       rescue Skylight::Api::Unauthorized
         done!(
           success: false,
-          message: "Provided merge token is invalid.\n" \
-            "Please #{STRINGS[:get_token]}" \
-            "and run `skylight merge <merge token>` again."
+          message:
+            "Provided merge token is invalid.\n" \
+              "Please #{STRINGS[:get_token]}" \
+              "and run `skylight merge <merge token>` again."
         )
       end
 
       def ask_for_parent_app
-        @parents ||= begin
-          a = (@apps + [{ name: STRINGS[:unlisted], components: [], unlisted: true }])
-          a.each_with_object({}).with_index do |(app, h), i|
-            h[i + 1] = OpenStruct.new(app)
+        @parents ||=
+          begin
+            a = (@apps + [{ name: STRINGS[:unlisted], components: [], unlisted: true }])
+            a.each_with_object({}).with_index { |(app, h), i| h[i + 1] = OpenStruct.new(app) }
           end
-        end
 
         say "\nLet's begin!\n\n" \
-          "Please specify the \"parent\" app.\n" \
-          "In most cases, this will be the production app handling web requests.", :green
+              "Please specify the \"parent\" app.\n" \
+              "In most cases, this will be the production app handling web requests.",
+            :green
 
         @parent_app = ask_for_app(@parents)
       end
@@ -76,8 +77,9 @@ module Skylight
 
       def ask_for_child_env
         say "\nWhat environment is the child app?\n" \
-          "In many cases, this will be equivalent to the Rails " \
-          "environment, i.e., `development`.", :green
+              "In many cases, this will be equivalent to the Rails " \
+              "environment, i.e., `development`.",
+            :green
 
         say "1. development"
         say "2. staging"
@@ -85,15 +87,18 @@ module Skylight
 
         i = ask("\nWhich number?").chomp.to_i
 
-        @child_env = case i
-                     when 1 then 'development'
-                     when 2 then 'staging'
-                     when 3
-                       specify_child_env
-                     else
-                       say("\nEh? Please enter 1, 2, or 3.", :red)
-                       ask_for_child_env
-                     end
+        @child_env =
+          case i
+          when 1
+            "development"
+          when 2
+            "staging"
+          when 3
+            specify_child_env
+          else
+            say("\nEh? Please enter 1, 2, or 3.", :red)
+            ask_for_child_env
+          end
       end
 
       def confirm_child_env
@@ -102,7 +107,7 @@ module Skylight
 
       def confirm_everything
         say "\nOk! Now we're going to merge `#{set_color(format_component(@child_app), :yellow)}` " \
-          "into `#{set_color(@parent_app.name, :green)}` as `#{set_color(@child_env, :yellow)}`."
+              "into `#{set_color(@parent_app.name, :green)}` as `#{set_color(@child_env, :yellow)}`."
       end
 
       def do_confirm
@@ -112,10 +117,7 @@ module Skylight
         when "Y", ""
           do_merge
         when "N"
-          done!(
-            success: true,
-            message: "Ok, come back any time."
-          )
+          done!(success: true, message: "Ok, come back any time.")
         else
           say("Please respond 'Y' to merge or 'n' to cancel.", :red)
           do_confirm
@@ -128,37 +130,43 @@ module Skylight
         say "=======================================================\n", :yellow
 
         say "IMPORTANT!\n" \
-          "If you use a config/skylight.yml file to configure Skylight:\n", :yellow
-
-        say "The #@child_env environment for the #{@parent_app.name} app\n" \
-          "will now connect using the default authentication token for the app.\n" \
-          "Remove any environment-specific `authentication` configs from the\n" \
-          "#{@parent_app.name} #@child_env environment.\n", :yellow
-
-        say "If you're running in Rails and your Rails environment exactly matches `#@child_env`,\n" \
-          "we will automatically detect and report that environment when your agent connects.\n" \
-          "Otherwise, you should set `env: '#@child_env'` as environment-specific configuration for\n" \
-          "#@child_env's Rails environment. For example:\n" \
-          "```yml\n" \
-          "staging:\n" \
-          "  env: staging-42\n" \
-          "```\n", :yellow
+              "If you use a config/skylight.yml file to configure Skylight:\n",
+            :yellow
+
+        say "The #{@child_env} environment for the #{@parent_app.name} app\n" \
+              "will now connect using the default authentication token for the app.\n" \
+              "Remove any environment-specific `authentication` configs from the\n" \
+              "#{@parent_app.name} #{@child_env} environment.\n",
+            :yellow
+
+        say "If you're running in Rails and your Rails environment exactly matches `#{@child_env}`,\n" \
+              "we will automatically detect and report that environment when your agent connects.\n" \
+              "Otherwise, you should set `env: '#{@child_env}'` as environment-specific configuration for\n" \
+              "#{@child_env}'s Rails environment. For example:\n" \
+              "```yml\n" \
+              "staging:\n" \
+              "  env: staging-42\n" \
+              "```\n",
+            :yellow
 
         say "=======================================================\n", :yellow
 
         say "IMPORTANT!\n" \
-            "If you configure Skylight using environment variables:\n", :yellow
+              "If you configure Skylight using environment variables:\n",
+            :yellow
 
         say "Deploy the latest agent before updating your environment variables.\n", :yellow
 
-        say "The #@child_env environment for the #{@parent_app.name} app\n" \
-          "will now connect using the default authentication token for the app.\n" \
-          "Set `SKYLIGHT_AUTHENTICATION` in the #@child_env environment to the\n" \
-          "#{@parent_app.name} app's authentication token.\n", :yellow
+        say "The #{@child_env} environment for the #{@parent_app.name} app\n" \
+              "will now connect using the default authentication token for the app.\n" \
+              "Set `SKYLIGHT_AUTHENTICATION` in the #{@child_env} environment to the\n" \
+              "#{@parent_app.name} app's authentication token.\n",
+            :yellow
 
-        say "If you're running in Rails and your Rails environment exactly matches `#@child_env`,\n" \
-          "we will automatically detect and report that environment when your agent connects.\n" \
-          "Otherwise, you should set `SKYLIGHT_ENV=#@child_env` when running in this environment.\n", :yellow
+        say "If you're running in Rails and your Rails environment exactly matches `#{@child_env}`,\n" \
+              "we will automatically detect and report that environment when your agent connects.\n" \
+              "Otherwise, you should set `SKYLIGHT_ENV=#{@child_env}` when running in this environment.\n",
+            :yellow
 
         say "=======================================================", :yellow
 
@@ -170,12 +178,13 @@ module Skylight
       def do_merge
         say "Merging..."
 
-        api.merge_apps!(@merge_token,
-                        app_guid: @parent_app.guid,
-                        component_guid: @child_app.guid,
-                        environment: @child_env
-                       )
-      rescue => e
+        api.merge_apps!(
+          @merge_token,
+          app_guid: @parent_app.guid,
+          component_guid: @child_app.guid,
+          environment: @child_env
+        )
+      rescue StandardError => e
         say("Something went wrong. Please contact support@skylight.io for more information.", :red)
         done!(message: e.message, success: false)
       end
@@ -197,9 +206,7 @@ module Skylight
 
       def ask_for_app(app_list, &formatter)
         formatter ||= :name.to_proc
-        app_list.each do |index, app|
-          say("\t#{index}. #{formatter.(app)}")
-        end
+        app_list.each { |index, app| say("\t#{index}. #{formatter.call(app)}") }
 
         n = ask("\nWhich number?").chomp.to_i
 
@@ -207,10 +214,7 @@ module Skylight
           say "\nHmm?"
           ask_for_app(app_list, &formatter)
         elsif app_list[n].unlisted
-          done!(
-            success: false,
-            message: "Sorry, `skylight merge` is only able to merge apps that you own."
-          )
+          done!(success: false, message: "Sorry, `skylight merge` is only able to merge apps that you own.")
         else
           app_list[n]
         end
@@ -221,14 +225,15 @@ module Skylight
       end
 
       def format_component(component)
-        parts = [].tap do |ary|
-          ary << component.name unless component.name == 'web'
-          ary << component.environment unless component.environment == 'production'
-        end
+        parts =
+          [].tap do |ary|
+            ary << component.name unless component.name == "web"
+            ary << component.environment unless component.environment == "production"
+          end
 
-        str = ''
+        str = ""
         str << component.app_name
-        str << Thor::Shell::Color.new.set_color(" (#{parts.join(':')})", :yellow) if parts.any?
+        str << Thor::Shell::Color.new.set_color(" (#{parts.join(":")})", :yellow) if parts.any?
         str
       end
 
@@ -240,8 +245,9 @@ module Skylight
         end
 
         if @parent_app && parent_component_fingerprints.include?([child_app.name, child_env])
-          errors << "Sorry, `#{@parent_app.name}` already has a `#{child_env}` " \
-            "component that conflicts with this merge request. Please choose a new environment."
+          errors <<
+            "Sorry, `#{@parent_app.name}` already has a `#{child_env}` " \
+              "component that conflicts with this merge request. Please choose a new environment."
         end
 
         return child_env unless errors.any?
@@ -253,28 +259,31 @@ module Skylight
 
       def valid_component?(component_name, env)
         return false unless env
-        Skylight::Util::Component.new(env, component_name) && true
+
+        Util::Component.new(env, component_name) && true
       rescue ArgumentError
         false
       end
 
       def parent_component_fingerprints
-        @parent_app.components.map { |x| x.values_at('name', 'environment') }
+        @parent_app.components.map { |x| x.values_at("name", "environment") }
       end
 
       def children
-        Enumerator.new do |yielder|
-          @parents.each do |_, app|
-            next if app == @parent_app
-            app.components.each do |component|
-              yielder << OpenStruct.new({ app_name: app.name }.merge(component))
+        ret =
+          Enumerator.new do |yielder|
+            @parents.each do |_, app|
+              next if app == @parent_app
+
+              app.components.each { |component| yielder << OpenStruct.new({ app_name: app.name }.merge(component)) }
             end
+
+            yielder << OpenStruct.new(app_name: STRINGS[:unlisted], unlisted: true)
           end
 
-          yielder << OpenStruct.new({ app_name: STRINGS[:unlisted], unlisted: true })
-        end.each_with_object({}).with_index do |(c, r), i|
-          r[i + 1] = c
-        end.tap do |result|
+        ret = ret.each_with_object({}).with_index { |(c, r), i| r[i + 1] = c }
+
+        ret.tap do |result|
           if result.values.all?(&:unlisted)
             done!(
               success: false,
@@ -288,9 +297,7 @@ module Skylight
         validate_mergeability(
           @child_app,
           ask("Please enter your environment name (only lowercase letters, numbers, or hyphens): ", :green).chomp
-        ) do
-          specify_child_env
-        end
+        ) { specify_child_env }
       end
     end
   end

data/lib/skylight/cli.rb

@@ -1,14 +1,14 @@
-$:.unshift File.expand_path('../vendor/cli', __FILE__)
+$LOAD_PATH.unshift File.expand_path("vendor/cli", __dir__)
 
-require 'skylight'
-require 'thor'
-require 'yaml'
-require 'highline'
-require 'active_support/inflector'
+require "skylight"
+require "thor"
+require "yaml"
+require "highline"
+require "active_support/inflector"
 
-require 'skylight/cli/helpers'
-require 'skylight/cli/doctor'
-require 'skylight/cli/merger'
+require "skylight/cli/helpers"
+require "skylight/cli/doctor"
+require "skylight/cli/merger"
 
 module Skylight
   module CLI
@@ -22,45 +22,46 @@ module Skylight
       desc "setup TOKEN", "Sets up a new app using the provided token"
       def setup(token)
         if File.exist?(config_path)
-          say <<-OUT, :green
-A config/skylight.yml already exists for your application.
+          say <<~OUT, :green
+            A config/skylight.yml already exists for your application.
 
-Visit your app at https://www.skylight.io/app or remove config/skylight.yml
-to set it up as a new app in Skylight.
+            Visit your app at https://www.skylight.io/app or remove config/skylight.yml
+            to set it up as a new app in Skylight.
           OUT
+
           return
         end
 
         res = api.create_app(app_name, token)
 
-        config[:application]    = res.get('app.id')
-        config[:authentication] = res.get('app.token')
+        config[:application] = res.get("app.id")
+        config[:authentication] = res.get("app.token")
         config.write(config_path)
 
         say "Congratulations. Your application is on Skylight! https://www.skylight.io", :green
-        say <<-OUT
+        say <<~OUT
 
-The application was registered for you and we generated a config file
-containing your API token at:
+          The application was registered for you and we generated a config file
+          containing your API token at:
 
-  #{relative_config_path}
+            #{relative_config_path}
 
-The next step is for you to deploy your application to production. The
-easiest way is to just commit the config file to your source control
-repository and deploy from there. You can learn more about the process at:
+          The next step is for you to deploy your application to production. The
+          easiest way is to just commit the config file to your source control
+          repository and deploy from there. You can learn more about the process at:
 
-  https://docs.skylight.io/getting-set-up/#deployment
+            https://docs.skylight.io/getting-set-up/#deployment
 
-If you want to specify the authentication token as an environment variable,
-you should set the `SKYLIGHT_AUTHENTICATION` variable to:
+          If you want to specify the authentication token as an environment variable,
+          you should set the `SKYLIGHT_AUTHENTICATION` variable to:
 
-  #{config[:authentication]}
+            #{config[:authentication]}
 
         OUT
       rescue Api::CreateFailed => e
         say "Could not create the application. Please run `bundle exec skylight doctor` for diagnostics.", :red
         say e.to_s, :yellow
-      rescue Interrupt
+      rescue Interrupt # rubocop:disable Lint/SuppressedException
       end
 
       desc "disable_dev_warning", "Disables warning about running Skylight in development mode for all local apps"
@@ -71,7 +72,9 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
         say "Development mode warning disabled", :green
       end
 
-      desc "disable_env_warning", "Disables warning about running Skylight in environments not defined in config.skylight.environments"
+      desc "disable_env_warning",
+           "Disables warning about running Skylight in environments not defined in " \
+             "config.skylight.environments"
       def disable_env_warning
         user_config.disable_env_warning = true
         user_config.save
@@ -79,25 +82,26 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
         say "Environment warning disabled", :green
       end
 
-    private
+      private
 
       def app_name
         @app_name ||=
           begin
             name = nil
 
-            if is_rails?
+            if rails?
               # Get the name in a process so that we don't pollute our environment here
               # This is especially important since users may have things like WebMock that
               # will prevent us from communicating with the Skylight API
               begin
-                namefile = Tempfile.new('skylight-app-name')
+                namefile = Tempfile.new("skylight-app-name")
+
                 # Windows appears to need double quotes for `rails runner`
                 `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"`
                 name = namefile.read.split("::").first.underscore.titleize
                 name = nil if name.empty?
-              rescue => e
-                if ENV['DEBUG']
+              rescue StandardError => e
+                if ENV["DEBUG"]
                   puts e.class.name
                   puts e.to_s
                   puts e.backtrace.join("\n")
@@ -107,22 +111,16 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
                 namefile.unlink
               end
 
-              unless name
-                warn "Unable to determine Rails application name. Using directory name."
-              end
-            end
-
-            unless name
-              name = File.basename(File.expand_path('.')).titleize
+              warn "Unable to determine Rails application name. Using directory name." unless name
             end
 
-            name
+            name || File.basename(File.expand_path(".")).titleize
           end
       end
 
       # Is this duplicated?
       def relative_config_path
-        'config/skylight.yml'
+        "config/skylight.yml"
       end
 
       def config_path
@@ -136,7 +134,6 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
       def user_config
         config.user_config
       end
-
     end
   end
 end