skylight 3.1.5 → 4.0.0.alpha

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
@@ -33,8 +33,8 @@ to set it up as a new app in Skylight.
 
         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
@@ -79,64 +79,59 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
         say "Environment warning disabled", :green
       end
 
-    private
-
-      def app_name
-        @app_name ||=
-          begin
-            name = nil
-
-            if is_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')
-                # 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']
-                  puts e.class.name
-                  puts e.to_s
-                  puts e.backtrace.join("\n")
+      private
+
+        def app_name
+          @app_name ||=
+            begin
+              name = nil
+
+              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")
+                  # 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"]
+                    puts e.class.name
+                    puts e.to_s
+                    puts e.backtrace.join("\n")
+                  end
+                ensure
+                  namefile.close
+                  namefile.unlink
                 end
-              ensure
-                namefile.close
-                namefile.unlink
-              end
 
-              unless name
-                warn "Unable to determine Rails application name. Using directory name."
+                unless name
+                  warn "Unable to determine Rails application name. Using directory name."
+                end
               end
-            end
 
-            unless name
-              name = File.basename(File.expand_path('.')).titleize
+              name || File.basename(File.expand_path(".")).titleize
             end
+        end
 
-            name
-          end
-      end
-
-      # Is this duplicated?
-      def relative_config_path
-        'config/skylight.yml'
-      end
-
-      def config_path
-        File.expand_path(relative_config_path)
-      end
+        # Is this duplicated?
+        def relative_config_path
+          "config/skylight.yml"
+        end
 
-      def api
-        @api ||= Api.new(config)
-      end
+        def config_path
+          File.expand_path(relative_config_path)
+        end
 
-      def user_config
-        config.user_config
-      end
+        def api
+          @api ||= Api.new(config)
+        end
 
+        def user_config
+          config.user_config
+        end
     end
   end
 end

data/lib/skylight/cli/doctor.rb

@@ -1,4 +1,4 @@
-require 'skylight/util/http'
+require "skylight/util/http"
 
 module Skylight
   module CLI
@@ -20,7 +20,7 @@ module Skylight
               say "Failed to verify SSL certificate.", :red
               if Util::SSL.ca_cert_file?
                 say "Certificates located at #{Util::SSL.ca_cert_file_or_default} may be out of date.", :yellow
-                if is_mac? && has_rvm?
+                if mac? && rvm_present?
                   say "Please update your certificates with RVM by running `rvm osx-ssl-certs update all`.", :yellow
                   say "Alternatively, try setting `SKYLIGHT_FORCE_OWN_CERTS=1` in your environment.", :yellow
                 else
@@ -39,7 +39,7 @@ module Skylight
         say "Checking for Rails"
 
         indent do
-          if is_rails?
+          if rails?
             say "Rails application detected", :green
           else
             say "No Rails application detected", :yellow
@@ -63,7 +63,7 @@ module Skylight
             say "Unable to load native extension", :yellow
 
             indent do
-              install_log = File.expand_path("../../../ext/install.log", __FILE__)
+              install_log = File.expand_path("../../ext/install.log", __dir__)
               if File.exist?(install_log)
                 File.readlines(install_log).each do |line|
                   say line, :red
@@ -112,8 +112,8 @@ module Skylight
           # Log everything
           logger.level = Logger::DEBUG
           # Remove excess formatting
-          logger.formatter = proc { |severity, datetime, progname, msg|
-            msg = msg.sub("[SKYLIGHT] [#{Skylight::VERSION}] ", '')
+          logger.formatter = proc { |severity, _datetime, _progname, msg|
+            msg = msg.sub("[SKYLIGHT] [#{Skylight::VERSION}] ", "")
             say "#{severity} - #{msg}" # Definitely non-standard
           }
           config.logger = logger
@@ -139,7 +139,7 @@ module Skylight
           daemon_running = false
           while tries < 5
             `ps cax | grep skylightd`
-            if $?.success?
+            if $CHILD_STATUS.success?
               daemon_running = true
               break
             end
@@ -171,9 +171,9 @@ module Skylight
           return @config if @config
 
           # MEGAHAX
-          if is_rails?
+          if rails?
             # Normally auto-loaded, but we haven't loaded Rails by the time Skylight is loaded
-            require 'skylight/railtie'
+            require "skylight/railtie"
             require rails_rb
 
             railtie = Skylight::Railtie.send(:new)
@@ -183,14 +183,14 @@ module Skylight
           end
         end
 
-        def is_mac?
-          Core::Util::Platform::OS == 'darwin'
+        def mac?
+          Core::Util::Platform::OS == "darwin"
         end
 
         # NOTE: This check won't work correctly on Windows
-        def has_rvm?
+        def rvm_present?
           if @has_rvm.nil?
-            @has_rvm = system("which rvm > /dev/null");
+            @has_rvm = system("which rvm > /dev/null")
           end
           @has_rvm
         end
@@ -217,7 +217,6 @@ module Skylight
             exit 0
           end
         end
-
     end
   end
 end

data/lib/skylight/cli/helpers.rb

@@ -1,32 +1,30 @@
 module Skylight
   module CLI
     module Helpers
-
       private
 
-      # Duplicated below
-      def rails_rb
-        File.expand_path("config/application.rb")
-      end
-
-      def is_rails?
-        File.exist?(rails_rb)
-      end
+        # Duplicated below
+        def rails_rb
+          File.expand_path("config/application.rb")
+        end
 
-      def config
-        # Calling .load checks ENV variables
-        @config ||= Config.load
-      end
+        def rails?
+          File.exist?(rails_rb)
+        end
 
-      # Sets the output padding while executing a block and resets it.
-      #
-      def indent(count = 1, &block)
-        orig_padding = shell.padding
-        shell.padding += count
-        yield
-        shell.padding = orig_padding
-      end
+        def config
+          # Calling .load checks ENV variables
+          @config ||= Config.load
+        end
 
+        # Sets the output padding while executing a block and resets it.
+        #
+        def indent(count = 1)
+          orig_padding = shell.padding
+          shell.padding += count
+          yield
+          shell.padding = orig_padding
+        end
     end
   end
-end
+end

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]
 
@@ -86,8 +86,8 @@ module Skylight
         i = ask("\nWhich number?").chomp.to_i
 
         @child_env = case i
-                     when 1 then 'development'
-                     when 2 then 'staging'
+                     when 1 then "development"
+                     when 2 then "staging"
                      when 3
                        specify_child_env
                      else
@@ -130,15 +130,15 @@ module Skylight
         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" \
+        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
+          "#{@parent_app.name} #{@child_env} environment.\n", :yellow
 
-        say "If you're running in Rails and your Rails environment exactly matches `#@child_env`,\n" \
+        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" \
+          "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" \
@@ -151,14 +151,14 @@ module Skylight
 
         say "Deploy the latest agent before updating your environment variables.\n", :yellow
 
-        say "The #@child_env environment for the #{@parent_app.name} app\n" \
+        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" \
+          "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" \
+        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
+          "Otherwise, you should set `SKYLIGHT_ENV=#{@child_env}` when running in this environment.\n", :yellow
 
         say "=======================================================", :yellow
 
@@ -167,131 +167,134 @@ module Skylight
 
       private
 
-      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
-        say("Something went wrong. Please contact support@skylight.io for more information.", :red)
-        done!(message: e.message, success: false)
-      end
-
-      def done!(message: nil, success: true)
-        shell.padding = 0
-        say "\n"
+        def do_merge
+          say "Merging..."
 
-        if success
-          say(message, :green) if message
-          say "If you have any questions, please contact support@skylight.io.", :green
-          exit 0
-        else
-          say message || "Skylight wasn't able to merge your apps.", :red
-          say "If you have any questions, please contact support@skylight.io.", :yellow
-          exit 1
+          api.merge_apps!(@merge_token,
+                          app_guid: @parent_app.guid,
+                          component_guid: @child_app.guid,
+                          environment: @child_env)
+        rescue => e
+          say("Something went wrong. Please contact support@skylight.io for more information.", :red)
+          done!(message: e.message, success: false)
         end
-      end
 
-      def ask_for_app(app_list, &formatter)
-        formatter ||= :name.to_proc
-        app_list.each do |index, app|
-          say("\t#{index}. #{formatter.(app)}")
+        def done!(message: nil, success: true)
+          shell.padding = 0
+          say "\n"
+
+          if success
+            say(message, :green) if message
+            say "If you have any questions, please contact support@skylight.io.", :green
+            exit 0
+          else
+            say message || "Skylight wasn't able to merge your apps.", :red
+            say "If you have any questions, please contact support@skylight.io.", :yellow
+            exit 1
+          end
         end
 
-        n = ask("\nWhich number?").chomp.to_i
-
-        if !app_list.key?(n)
-          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."
-          )
-        else
-          app_list[n]
-        end
-      end
+        def ask_for_app(app_list, &formatter)
+          formatter ||= :name.to_proc
+          app_list.each do |index, app|
+            say("\t#{index}. #{formatter.call(app)}")
+          end
 
-      def api
-        @api ||= Skylight::Api.new(config)
-      end
+          n = ask("\nWhich number?").chomp.to_i
 
-      def format_component(component)
-        parts = [].tap do |ary|
-          ary << component.name unless component.name == 'web'
-          ary << component.environment unless component.environment == 'production'
+          if !app_list.key?(n)
+            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."
+            )
+          else
+            app_list[n]
+          end
         end
 
-        str = ''
-        str << component.app_name
-        str << Thor::Shell::Color.new.set_color(" (#{parts.join(':')})", :yellow) if parts.any?
-        str
-      end
+        def api
+          @api ||= Skylight::Api.new(config)
+        end
 
-      def validate_mergeability(child_app, child_env)
-        errors = []
+        def format_component(component)
+          parts = [].tap do |ary|
+            ary << component.name unless component.name == "web"
+            ary << component.environment unless component.environment == "production"
+          end
 
-        unless valid_component?(child_app.name, child_env)
-          errors << "Environment can only contain letters, numbers, and hyphens."
+          str = ""
+          str << component.app_name
+          str << Thor::Shell::Color.new.set_color(" (#{parts.join(':')})", :yellow) if parts.any?
+          str
         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."
-        end
+        def validate_mergeability(child_app, child_env)
+          errors = []
 
-        return child_env unless errors.any?
+          unless valid_component?(child_app.name, child_env)
+            errors << "Environment can only contain letters, numbers, and hyphens."
+          end
 
-        say errors.join("\n"), :red
+          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."
+          end
 
-        yield
-      end
+          return child_env unless errors.any?
 
-      def valid_component?(component_name, env)
-        return false unless env
-        Skylight::Util::Component.new(env, component_name) && true
-      rescue ArgumentError
-        false
-      end
+          say errors.join("\n"), :red
 
-      def parent_component_fingerprints
-        @parent_app.components.map { |x| x.values_at('name', 'environment') }
-      end
+          yield
+        end
+
+        def valid_component?(component_name, env)
+          return false unless env
+          Skylight::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") }
+        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))
+        def children
+          ret = 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))
+              end
             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|
-          if result.values.all?(&:unlisted)
-            done!(
-              success: false,
-              message: "Sorry, you do not have any apps that can be merged into `#{@parent_app.name}`"
-            )
+          ret = ret.each_with_object({}).with_index do |(c, r), i|
+            r[i + 1] = c
+          end
+
+          ret.tap do |result|
+            if result.values.all?(&:unlisted)
+              done!(
+                success: false,
+                message: "Sorry, you do not have any apps that can be merged into `#{@parent_app.name}`"
+              )
+            end
           end
         end
-      end
 
-      def specify_child_env
-        validate_mergeability(
-          @child_app,
-          ask("Please enter your environment name (only lowercase letters, numbers, or hyphens): ", :green).chomp
-        ) do
-          specify_child_env
+        def specify_child_env
+          validate_mergeability(
+            @child_app,
+            ask("Please enter your environment name (only lowercase letters, numbers, or hyphens): ", :green).chomp
+          ) do
+            specify_child_env
+          end
         end
-      end
     end
   end
 end