ops_team 0.12.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444384ee0931455838357c9bc2f720534e8fbda90d5d27a15c35b313cf676b4e
-  data.tar.gz: 03ff8c264a9083987aac65d9a7ba78fdb8d118e757599c66267725178b8fc809
+  metadata.gz: 158077a8d8c025f32b231991165c500b93000422bfc411ff88124a86dad7af05
+  data.tar.gz: db0c44533b58f0a65b9d25921b77a5eb41f1a058f8ecae444c175a635d9f455d
 SHA512:
-  metadata.gz: f596c660d5b7943258c3615a603f36f74ea5d98488d9171562c75593f3e5d5cbe93a349d687a417649dcb0be40de13c9c7d3c33c94b3d7686a43c3f2c94ea2cb
-  data.tar.gz: 486531d3b6c027986cde18d88f3d43e6ffc7db44b4688a8528ccd33b1b0dcb0b883ff6b8048f0b168d3b9fa3d58d8f018722c12a95cdb3edf3e8820c5c3e4b02
+  metadata.gz: a5a7026cbb1b3eee2e16128d5f1f3d36f54197327bbe5562eb28ac2c7eb74a29feb5cc743cae4f4afaef40a9e5dabc5cf4cdc17eab5dd373ed826b87e1b6744f
+  data.tar.gz: 540a77c3f21b3c015bd45300bd50c0a42b6d467607b77869b141f3a03a15399e0f3d74a59aeef8a6b6781b6538783ce874dc00d6f0811c442bc36a88923d3602

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/dependencies/apt.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'dependency'
+require 'dependencies/versioned_dependency'
 require 'dependencies/helpers/apt_cache_policy'
 
 module Dependencies
-	class Apt < Dependency
-		PACKAGE_NAME_SEPARATOR = "/"
-
+	class Apt < VersionedDependency
 		def met?
-			return apt_cache_policy.installed_version == package_version if package_version
+			return apt_cache_policy.installed_version == dep_version if dep_version
 
 			apt_cache_policy.installed?
 		end
@@ -28,20 +26,8 @@ module Dependencies
 
 		private
 
-		def package_name
-			name_components[0]
-		end
-
-		def package_version
-			name_components[1]
-		end
-
-		def name_components
-			name.split(PACKAGE_NAME_SEPARATOR, 2)
-		end
-
 		def apt_cache_policy
-			@apt_cache_policy ||= Dependencies::Helpers::AptCachePolicy.new(package_name)
+			@apt_cache_policy ||= Dependencies::Helpers::AptCachePolicy.new(dep_name)
 		end
 
 		def sudo_string

data/lib/dependencies/gem.rb

@@ -4,18 +4,20 @@ require 'dependency'
 require 'options'
 
 module Dependencies
-	class Gem < Dependency
+	class Gem < VersionedDependency
 		def met?
-			execute("gem list -i '^#{name}$'")
+			if versioned?
+				execute("gem list -i '^#{dep_name}$' -v '#{dep_version}'") if versioned?
+			else
+				execute("gem list -i '^#{name}$'")
+			end
 		end
 
 		def meet
-			if Options.get("gem.use_sudo")
-				execute("sudo gem install #{name}")
-			elsif Options.get("gem.user_install")
-				execute("gem install --user-install #{name}")
+			if versioned?
+				execute("#{sudo_string}gem install #{user_install_string}'#{dep_name}' -v '#{dep_version}'")
 			else
-				execute("gem install #{name}")
+				execute("#{sudo_string}gem install #{user_install_string}'#{name}'")
 			end
 		end
 
@@ -23,5 +25,15 @@ module Dependencies
 			# do nothing; we don't want to uninstall packages and reinstall them every time
 			true
 		end
+
+		private
+
+		def sudo_string
+			Options.get("gem.use_sudo") ? "sudo " : ""
+		end
+
+		def user_install_string
+			Options.get("gem.user_install") ? "--user-install " : ""
+		end
 	end
 end

data/lib/dependencies/versioned_dependency.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dependencies
+	class VersionedDependency < Dependency
+		VERSION_SEPARATOR = " "
+
+		def dep_name
+			name_components[0]
+		end
+
+		def dep_version
+			name_components[1]
+		end
+
+		def versioned?
+			!!dep_version
+		end
+
+		private
+
+		def name_components
+			name.split(VERSION_SEPARATOR, 2)
+		end
+	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`
@@ -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/lib/output.rb

@@ -40,7 +40,7 @@ class Output
 			@err.puts(msg.yellow)
 		end
 
-		alias_method :notice, :warn
+		alias notice warn
 
 		def error(msg)
 			@err.puts(msg.red)

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.14.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.14.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
@@ -168,6 +170,7 @@ files:
 - lib/dependencies/gem.rb
 - lib/dependencies/helpers/apt_cache_policy.rb
 - lib/dependencies/sshkey.rb
+- lib/dependencies/versioned_dependency.rb
 - lib/dependency.rb
 - lib/environment.rb
 - lib/executor.rb