ops_team 0.18.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d591b58dad032824721105b4ce3e45c63ef40078273d77fbb85ddf50c3224f27
-  data.tar.gz: f3f72de653d0ad2d3b87ef1ac6c75bfe0543b6030b37954fae1ddf4dd2981e17
+  metadata.gz: bf2a309a88bc396994795bca23a308043e8e8ec6c16a5e7b85baf0b66e15ed83
+  data.tar.gz: 526857c4d776fddf9d20d96c81cf4ab6905a364601d32fb5989467439f366aea
 SHA512:
-  metadata.gz: 42df63cce2068a86cbe127da74fdf4af2dfb33f3bb4d7ed176354566b11adc1ba3adbbc941b0df8440bcdc1cfaf76f4e9e7182c41618cee1ca9695d8fa1bdca7
-  data.tar.gz: 451205a2bde8e20689f2b5b1b76d60f3cf3d2db5d74d18c2f71cc21219863bc4a87373c5980833e90d647314eb937b4dc02f13ad940636603d7dd37faf4764e4
+  metadata.gz: 815571122a732fcc85046f386ae9918c961033dc1c6141ad8d32334b2beb09ee9775b83640dad88d100d67a463468667a9dd9bbc5875e2b8612dc64fcc0d53e0
+  data.tar.gz: 6c4146afc51d45f1f80f91c57093750160589d0d6bf89cd6df2c2f79f6d58e30525edee2a122e3b0059d7bfd2a2f0f2a1b0e3f4ceefe4f1373ad0c1892fead77

data/lib/action.rb

@@ -17,8 +17,6 @@ class Action
 			raise NotAllowedInEnvError, "Action not allowed in #{Environment.environment} environment."
 		end
 
-		Secrets.load if load_secrets?
-
 		Kernel.exec(to_s)
 	end
 
@@ -56,12 +54,12 @@ class Action
 		end
 	end
 
-	private
-
 	def load_secrets?
-		@config["load_secrets"]
+		@config["load_secrets"].nil? ? false : @config["load_secrets"]
 	end
 
+	private
+
 	def not_in_envs
 		@config["not_in_envs"] || []
 	end

data/lib/builtins/help.rb

@@ -3,12 +3,15 @@
 require 'colorize'
 
 require 'builtin'
+require 'forwards'
 
 module Builtins
 	class Help < Builtin
+		NAME_WIDTH = 35
+
 		class << self
 			def description
-				"displays available builtins and actions"
+				"displays available builtins, actions, and forwards"
 			end
 		end
 
@@ -16,15 +19,24 @@ module Builtins
 			Output.out("Builtins:")
 			Output.out("  #{builtins.join("\n  ")}")
 			Output.out("")
+			Output.out("Forwards:")
+			Output.out("  #{forwards.join("\n  ")}")
+			Output.out("")
 			Output.out("Actions:")
 			Output.out("  #{actions.join("\n  ")}")
 		end
 
 		private
 
+		def forwards
+			Forwards.new(@config).forwards.map do |name, dir|
+				format("%<name>-#{NAME_WIDTH}s %<desc>s" , name: name.yellow, desc: "#{dir}")
+			end
+		end
+
 		def builtins
 			builtin_class_map.map do |klass, name|
-				format("%<name>-35s %<desc>s", name: name.downcase.to_s.yellow, desc: klass.description)
+				format("%<name>-#{NAME_WIDTH}s %<desc>s", name: name.downcase.to_s.yellow, desc: klass.description)
 			end
 		end
 
@@ -55,7 +67,7 @@ module Builtins
 			return [] unless @config["actions"]
 
 			@config["actions"].map do |name, action_config|
-				format("%<name>-40s %<desc>s",
+				format("%<name>-#{NAME_WIDTH}s %<desc>s",
 					name: "#{name.yellow} #{alias_string_for(action_config)}",
 					desc: action_config["description"] || action_config["command"]
 				)

data/lib/forward.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'output'
+
+class Forward
+	def initialize(dir, args)
+		@dir = dir
+		@args = args
+	end
+
+	def run
+		Output.notice("Forwarding 'ops #{@args.join(" ")}' to '#{@dir}/'...")
+
+		Dir.chdir(@dir)
+		Ops.new(@args).run
+	end
+end

data/lib/forwards.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'forward'
+
+class Forwards
+	def initialize(config, args = [])
+		@config = config
+		@args = args
+	end
+
+	def get(name)
+		Forward.new(forwards[name], @args) if forwards[name]
+	end
+
+	def forwards
+		@forwards ||= @config["forwards"] || {}
+	end
+end

data/lib/ops.rb

@@ -5,22 +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 '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
@@ -46,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?
-
-		suggestions.any?
-	end
+		Output.out("Did you mean '#{runner.suggestions.join(", ")}'?") if runner.suggestions.any?
 
-	def did_you_mean
-		ActionSuggester.new(action_list.names + action_list.aliases + builtin_names)
+		runner.suggestions.any?
 	end
 
 	def min_version_met?
@@ -100,90 +97,30 @@ class Ops
 		config["min_version"]
 	end
 
-	def run_action
-		do_before_all
-
-		return builtin.run if builtin
-
-		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
-		environment.set_variables
-		AppConfig.load
-	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 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)
-
-		raise UnknownActionError, "Unknown action: #{@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 = '0.18.1'
+	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: 0.18.1
+  version: 1.0.1
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -175,10 +175,13 @@ files:
 - lib/dependency.rb
 - lib/environment.rb
 - lib/executor.rb
+- lib/forward.rb
+- lib/forwards.rb
 - lib/hook_handler.rb
 - lib/ops.rb
 - lib/options.rb
 - lib/output.rb
+- lib/runner.rb
 - lib/secrets.rb
 - lib/version.rb
 - loader.rb