ops_team 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e74fe375694383d5cf99385e04c314e804a2ab1aae6b03558b811e78874c65e
-  data.tar.gz: 4c9f31d818c8bc456c4c9c37d40d42491dde28ef6e038eee77ff0e7c42e7a6da
+  metadata.gz: bf2a309a88bc396994795bca23a308043e8e8ec6c16a5e7b85baf0b66e15ed83
+  data.tar.gz: 526857c4d776fddf9d20d96c81cf4ab6905a364601d32fb5989467439f366aea
 SHA512:
-  metadata.gz: 87320ca1362f2691ad4808bca8b7733b2d1be4bc70b4ca06b650267bf5c50c7d69e64a554fc91d246c821e17454794ae0aadb9cca27ea747f7092f5f636a6492
-  data.tar.gz: 6b6bee1687f1858a1097931e336ddcf28fe4f50a9b8802cded747a034f4fefddbcab0fd4331bd961a269811384eb574bfca4e4cc69c5cca576a709bcb2cb59e0
+  metadata.gz: 815571122a732fcc85046f386ae9918c961033dc1c6141ad8d32334b2beb09ee9775b83640dad88d100d67a463468667a9dd9bbc5875e2b8612dc64fcc0d53e0
+  data.tar.gz: 6c4146afc51d45f1f80f91c57093750160589d0d6bf89cd6df2c2f79f6d58e30525edee2a122e3b0059d7bfd2a2f0f2a1b0e3f4ceefe4f1373ad0c1892fead77

data/lib/ops.rb

@@ -5,23 +5,15 @@ require 'yaml'
 require 'require_all'
 require "rubygems"
 
-require 'hook_handler'
-require 'action'
 require 'output'
 require 'options'
-require 'environment'
 require 'version'
-require 'action_list'
-require 'action_suggester'
-require 'forwards'
+require 'runner'
 
 require_rel "builtins"
 
 # executes commands based on local `ops.yml`
 class Ops
-	class UnknownActionError < StandardError; end
-	class ActionConfigError < StandardError; end
-
 	CONFIG_FILE = "ops.yml"
 
 	INVALID_SYNTAX_EXIT_CODE = 64
@@ -47,43 +39,47 @@ class Ops
 		Options.set(config["options"] || {})
 	end
 
+	# rubocop:disable Metrics/MethodLength
+	# better to have all the rescues in one place
 	def run
 		# "return" is here to allow specs to stub "exit" without executing everything after it
 		return exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
 		return exit(MIN_VERSION_NOT_MET_EXIT_CODE) unless min_version_met?
 
-		run_action
-	rescue UnknownActionError => e
+		runner.run
+	rescue Runner::UnknownActionError => e
 		Output.error(e.to_s)
 		Output.out(RECOMMEND_HELP_TEXT) unless print_did_you_mean
 		exit(UNKNOWN_ACTION_EXIT_CODE)
-	rescue ActionConfigError => e
+	rescue Runner::ActionConfigError => e
 		Output.error("Error(s) running action '#{@action_name}': #{e}")
 		exit(ACTION_CONFIG_ERROR_EXIT_CODE)
+	rescue Builtin::ArgumentError => e
+		Output.error("Error running builtin '#{@action_name}': #{e}")
+		exit(BUILTIN_SYNTAX_ERROR_EXIT_CODE)
+	rescue AppConfig::ParsingError => e
+		Output.error("Error parsing app config: #{e}")
+		exit(ERROR_LOADING_APP_CONFIG_EXIT_CODE)
+	rescue Action::NotAllowedInEnvError => e
+		Output.error("Error running action #{@action_name}: #{e}")
+		exit(ACTION_NOT_ALLOWED_IN_ENV_EXIT_CODE)
 	end
+	# rubocop:enable Metrics/MethodLength
 
 	private
 
 	def syntax_valid?
-		if @action_name.nil?
-			Output.error("Usage: ops <action>")
-			Output.out(RECOMMEND_HELP_TEXT)
-			false
-		else
-			true
-		end
+		return true unless @action_name.nil?
+
+		Output.error("Usage: ops <action>")
+		Output.out(RECOMMEND_HELP_TEXT)
+		false
 	end
 
 	def print_did_you_mean
-		suggestions = did_you_mean.check(@action_name)
-
-		Output.out("Did you mean '#{suggestions.join(", ")}'?") if suggestions.any?
+		Output.out("Did you mean '#{runner.suggestions.join(", ")}'?") if runner.suggestions.any?
 
-		suggestions.any?
-	end
-
-	def did_you_mean
-		ActionSuggester.new(action_list.names + action_list.aliases + builtin_names)
+		runner.suggestions.any?
 	end
 
 	def min_version_met?
@@ -101,96 +97,30 @@ class Ops
 		config["min_version"]
 	end
 
-	def run_action
-		return forward.run if forward
-
-		do_before_all
-
-		return builtin.run if builtin
-
-		raise UnknownActionError, "Unknown action: #{@action_name}" unless action
-		raise ActionConfigError, action.config_errors.join("; ") unless action.config_valid?
-
-		do_before_action
-		Output.notice("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
-		action.run
-	rescue Builtin::ArgumentError => e
-		Output.error("Error running builtin '#{@action_name}': #{e}")
-		exit(BUILTIN_SYNTAX_ERROR_EXIT_CODE)
-	rescue AppConfig::ParsingError => e
-		Output.error("Error parsing app config: #{e}")
-		exit(ERROR_LOADING_APP_CONFIG_EXIT_CODE)
-	rescue Action::NotAllowedInEnvError => e
-		Output.error("Error running action #{@action_name}: #{e}")
-		exit(ACTION_NOT_ALLOWED_IN_ENV_EXIT_CODE)
-	end
-
-	def do_before_all
-		AppConfig.load
-		Secrets.load if action && action.load_secrets?
-		environment.set_variables
-	end
-
-	def do_before_action
-		return if ENV["OPS_RUNNING"] || action.skip_hooks?("before")
-
-		# this prevents before hooks from running in ops executed by ops
-		ENV["OPS_RUNNING"] = "1"
-		hook_handler.do_hooks("before")
-	end
-
-	def hook_handler
-		@hook_handler ||= HookHandler.new(config)
-	end
-
-	def builtin
-		@builtin ||= Builtin.class_for(name: @action_name).new(@args, config)
-	rescue NameError
-		# this means there isn't a builtin with that name in that module
-		nil
-	end
-
-	def builtin_names
-		Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }.map(&:downcase)
-	end
-
-	def forward
-		@forward ||= Forwards.new(@config, @args).get(@action_name)
-	end
-
-	def action
-		return action_list.get(@action_name) if action_list.get(@action_name)
-		return action_list.get_by_alias(@action_name) if action_list.get_by_alias(@action_name)
-	end
-
-	def action_list
-		@action_list ||= begin
-			Output.warn("'ops.yml' has no 'actions' defined.") if config.any? && config["actions"].nil?
-
-			ActionList.new(config["actions"], @args)
-		end
+	def runner
+		@runner ||= Runner.new(@action_name, @args, config)
 	end
 
 	def config
 		@config ||= begin
-			if File.exist?(CONFIG_FILE)
-				YAML.load_file(CONFIG_FILE)
+			if config_file_exists?
+				parsed_config_contents
 			else
 				Output.warn("File '#{CONFIG_FILE}' does not exist.") unless @action_name == "init"
 				{}
 			end
-		rescue StandardError => e
-			Output.warn("Error parsing '#{CONFIG_FILE}': #{e}")
-			{}
 		end
 	end
 
-	def env_vars
-		config.dig("options", "environment") || {}
+	def parsed_config_contents
+		YAML.load_file(CONFIG_FILE)
+	rescue StandardError => e
+		Output.warn("Error parsing '#{CONFIG_FILE}': #{e}")
+		{}
 	end
 
-	def environment
-		@environment ||= Environment.new(env_vars)
+	def config_file_exists?
+		File.exist?(CONFIG_FILE)
 	end
 end
 

data/lib/runner.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'hook_handler'
+require 'action'
+require 'action_list'
+require 'action_suggester'
+require 'forwards'
+require 'environment'
+
+class Runner
+	class UnknownActionError < StandardError; end
+	class ActionConfigError < StandardError; end
+
+	def initialize(action_name, args, config)
+		@action_name = action_name
+		@args = args
+		@config = config
+	end
+
+	def run
+		return forward.run if forward
+
+		do_before_all
+
+		return builtin.run if builtin
+
+		raise UnknownActionError, "Unknown action: #{@action_name}" unless action
+		raise ActionConfigError, action.config_errors.join("; ") unless action.config_valid?
+
+		do_before_action
+		Output.notice("Running '#{action}' in environment '#{ENV['environment']}'...")
+		action.run
+	end
+
+	def suggestions
+		@suggestions ||= ActionSuggester.new(action_list.names + action_list.aliases + builtin_names).check(@action_name)
+	end
+
+	private
+
+	def do_before_all
+		AppConfig.load
+		Secrets.load if action&.load_secrets?
+		environment.set_variables
+	end
+
+	def do_before_action
+		return if ENV["OPS_RUNNING"] || action.skip_hooks?("before")
+
+		# this prevents before hooks from running in ops executed by ops
+		ENV["OPS_RUNNING"] = "1"
+		hook_handler.do_hooks("before")
+	end
+
+	def hook_handler
+		@hook_handler ||= HookHandler.new(@config)
+	end
+
+	def builtin
+		@builtin ||= Builtin.class_for(name: @action_name).new(@args, @config)
+	rescue NameError
+		# this means there isn't a builtin with that name in that module
+		nil
+	end
+
+	def builtin_names
+		Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }.map(&:downcase)
+	end
+
+	def forward
+		@forward ||= Forwards.new(@config, @args).get(@action_name)
+	end
+
+	def action
+		return action_list.get(@action_name) if action_list.get(@action_name)
+		return action_list.get_by_alias(@action_name) if action_list.get_by_alias(@action_name)
+	end
+
+	def action_list
+		@action_list ||= begin
+			Output.warn("'ops.yml' has no 'actions' defined.") if @config.any? && @config["actions"].nil?
+
+			ActionList.new(@config["actions"], @args)
+		end
+	end
+
+	def env_vars
+		@config.dig("options", "environment") || {}
+	end
+
+	def environment
+		@environment ||= Environment.new(env_vars)
+	end
+end

data/ops_team.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
 	s.name = 'ops_team'
-	s.version = '1.0.0'
+	s.version = '1.0.1'
 	s.authors = [
 		'nickthecook@gmail.com'
 	]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -181,6 +181,7 @@ files:
 - lib/ops.rb
 - lib/options.rb
 - lib/output.rb
+- lib/runner.rb
 - lib/secrets.rb
 - lib/version.rb
 - loader.rb