ops_team 0.12.2 → 0.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 684c6b13e7c5440f067ed372f28f592fc24616aaeb42284ec30465166bd1ce79
-  data.tar.gz: 67ba1850a8f28e7025bc3d179bdb33d6506dffa0c5a94b2aa50fce20e0c20dce
+  metadata.gz: ea3bc79f136cc22e2710bba983cb23d14ed332d7f9a4e14e1bf94b53f17e5a1b
+  data.tar.gz: 404cc0d081d9d1bbe4082fd4e24532322f5a1324d8063a6e6eaaea615a7a0321
 SHA512:
-  metadata.gz: 747a3dfac949e43f25f3ee19b31bb60d9824b25265b5c8d09c0af9f298a514b2fec0fd48cace35c4ebc553847ebd9bf9b6ea246433a5efb51b7c4918bbc39628
-  data.tar.gz: 32d665f336d2d31d7189b5bc9569155c00c4d27ba8b2260d282295c3e2664d0ead0729454996275a2d189f446a2afebc9ae6f9f66303d38245e511978ee58b88
+  metadata.gz: 1df25521312cd853043220089fed8b33b0bd3bbaa192ac3720e17528a14615ecd74ac3a17d69d3c87209f571149ef8d6d9adc4ce877cad9ef8fd0bf0b36fe0ef
+  data.tar.gz: 261a40eac02451b42d6c331bb2281647f687c04e2aafba7523d42a70bcc37e486904cf58993869452641f50d1ce07c2ea417054013c726b28cc75c6b6f6ee7f6

data/Gemfile

@@ -6,8 +6,12 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem "bcrypt_pbkdf"
 gem "colorize"
+gem "e2mmap"
 gem "ed25519"
 gem "ejson"
+gem "etc"
+gem "io-console"
+gem "json", ">= 2.3.0"
 gem "net-ssh"
 gem "require_all"
 
@@ -17,6 +21,7 @@ group :test do
 end
 
 group :development do
+	gem "irb"
 	gem "pry"
 	gem "pry-byebug"
 	gem "rerun"

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,17 @@
+# frozen_string_literal: true
+
+class ActionSuggester
+	def initialize(dictionary)
+		@dictionary = dictionary
+	end
+
+	def check(word)
+		spellchecker.correct(word)
+	end
+
+	private
+
+	def spellchecker
+		@spellchecker ||= DidYouMean::SpellChecker.new(dictionary: @dictionary)
+	end
+end

data/lib/environment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'version'
+
 class Environment
 	def initialize(env_hash)
 		@env_hash = env_hash
@@ -21,6 +23,7 @@ class Environment
 
 	def set_ops_variables
 		ENV["OPS_YML_DIR"] = Dir.pwd
+		ENV["OPS_VERSION"] = Version.version.to_s
 	end
 
 	def set_environment_aliases

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`
@@ -24,6 +27,8 @@ class Ops
 	ERROR_LOADING_APP_CONFIG_EXIT_CODE = 66
 	MIN_VERSION_NOT_MET_EXIT_CODE = 67
 
+	RECOMMEND_HELP_TEXT = "Run 'ops help' for a list of builtins and actions."
+
 	class << self
 		def project_name
 			File.basename(::Dir.pwd)
@@ -38,13 +43,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)
+		Output.out(RECOMMEND_HELP_TEXT) unless print_did_you_mean
 		exit(UNKNOWN_ACTION_EXIT_CODE)
 	end
 
@@ -53,12 +59,25 @@ class Ops
 	def syntax_valid?
 		if @action_name.nil?
 			Output.error("Usage: ops <action>")
+			Output.out(RECOMMEND_HELP_TEXT)
 			false
 		else
 			true
 		end
 	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
+
+	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 +99,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 +129,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 +158,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 +165,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.2'
+	s.version = '0.13.3'
 	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.2
+  version: 0.13.3
 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