ops_team 0.12.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444384ee0931455838357c9bc2f720534e8fbda90d5d27a15c35b313cf676b4e
-  data.tar.gz: 03ff8c264a9083987aac65d9a7ba78fdb8d118e757599c66267725178b8fc809
+  metadata.gz: 9656333af7b4f103645f9f27af758b4cc11e749c0e9770474ec249af8db85983
+  data.tar.gz: d1a69bbc44b1626bbcd754fa8484547f2bfa3beede615d8ebcd951e00432008a
 SHA512:
-  metadata.gz: f596c660d5b7943258c3615a603f36f74ea5d98488d9171562c75593f3e5d5cbe93a349d687a417649dcb0be40de13c9c7d3c33c94b3d7686a43c3f2c94ea2cb
-  data.tar.gz: 486531d3b6c027986cde18d88f3d43e6ffc7db44b4688a8528ccd33b1b0dcb0b883ff6b8048f0b168d3b9fa3d58d8f018722c12a95cdb3edf3e8820c5c3e4b02
+  metadata.gz: 73e177e194c2f3e7415612bd23aea779502182929fbb5264c00a1516a52869056bb045e75ff5aaca4c546b92f03481f5346eb24958f4a6ccdd247d0d3cdc06dc
+  data.tar.gz: 53c224dd9162d269c0154c842ec36d4e748dd59b401efb1a959199332e3ee99489a1de4cf88d3e2d2bff7c04a37906c687d542ac2bc4852d7fa38a0f4e0ad9c6

data/bin/ops

@@ -5,4 +5,6 @@ require_relative "../loader"
 
 require 'ops'
 
+require 'pry-byebug' if ENV['environment'] == 'dev' || ENV['environment'].nil?
+
 Ops.new(ARGV).run

data/lib/action_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class ActionList
+	class UnknownActionError < StandardError; end
+
+	def initialize(actions_list, args)
+		@actions_list = actions_list
+		@args = args
+
+		process_action_list
+	end
+
+	def get(name)
+		@actions[name]
+	end
+
+	def get_by_alias(name)
+		@aliases[name]
+	end
+
+	def names
+		@actions.keys
+	end
+
+	def aliases
+		@aliases.keys
+	end
+
+	private
+
+	def process_action_list
+		@actions = {}
+		@aliases = {}
+
+		@actions_list.each do |name, config|
+			action = Action.new(config, @args)
+
+			@actions[name] = action
+			@aliases[action.alias] = action
+		end
+	end
+end

data/lib/action_suggester.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class ActionSuggester
+	def initialize(dictionary)
+		@dictionary = dictionary
+	end
+
+	def check(word)
+		spellchecker.correct(word)
+	end
+
+	def spellchecker
+		@spellchecker ||= DidYouMean::SpellChecker.new(dictionary: @dictionary)
+	end
+end

data/lib/ops.rb

@@ -11,6 +11,9 @@ require 'output'
 require 'options'
 require 'environment'
 require 'version'
+require 'action_list'
+require 'action_suggester'
+
 require_rel "builtins"
 
 # executes commands based on local `ops.yml`
@@ -38,13 +41,14 @@ class Ops
 	end
 
 	def run
-		# "return" is here to allow specs to stub "exit"
+		# "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
-		Output.error("Error: #{e}")
+		Output.error(e.to_s)
+		print_did_you_mean
 		exit(UNKNOWN_ACTION_EXIT_CODE)
 	end
 
@@ -59,6 +63,16 @@ class Ops
 		end
 	end
 
+	def print_did_you_mean
+		suggestions = did_you_mean.check(@action_name)
+
+		Output.out("Did you mean '#{suggestions.join(", ")}'?") if suggestions.any?
+	end
+
+	def did_you_mean
+		ActionSuggester.new(action_list.names + action_list.aliases + builtin_names)
+	end
+
 	def min_version_met?
 		return true unless min_version
 
@@ -80,7 +94,6 @@ class Ops
 		return builtin.run if builtin
 
 		do_before_action
-
 		Output.notice("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
 		action.run
 	rescue AppConfig::ParsingError => e
@@ -111,24 +124,22 @@ class Ops
 		nil
 	end
 
+	def builtin_names
+		Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }.map(&:downcase)
+	end
+
 	def action
-		return actions[@action_name] if actions[@action_name]
-		return aliases[@action_name] if aliases[@action_name]
+		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 actions
-		@actions ||= begin
-			if config["actions"]
-				config["actions"]&.transform_values do |config|
-					Action.new(config, @args)
-				end
-			else
-				# only print this error if ops.yml had something in it
-				Output.warn("'ops.yml' has no 'actions' defined.") if config.any?
-				{}
-			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
 
@@ -142,14 +153,6 @@ class Ops
 		end
 	end
 
-	def aliases
-		@aliases ||= begin
-			actions.each_with_object({}) do |(_name, action), alias_hash|
-				alias_hash[action.alias] = action if action.alias
-			end
-		end
-	end
-
 	def env_vars
 		@config.dig("options", "environment") || {}
 	end
@@ -157,10 +160,6 @@ class Ops
 	def environment
 		@environment ||= Environment.new(env_vars)
 	end
-
-	def app_config
-		@app_config ||= AppConfig.new
-	end
 end
 
 Ops.new(ARGV).run if $PROGRAM_NAME == __FILE__

data/ops_team.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.13.0
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -146,6 +146,8 @@ files:
 - etc/ruby.template.yml
 - etc/terraform.template.yml
 - lib/action.rb
+- lib/action_list.rb
+- lib/action_suggester.rb
 - lib/app_config.rb
 - lib/builtin.rb
 - lib/builtins/background.rb