ops_team 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f947ab7c489798b9868dde0124578cfbc747baee9017edab35ddeed55328e27
-  data.tar.gz: 49e885e7155a06c8960dadd505713a2da32081537a7998a4b6fc6c0aa6cb916b
+  metadata.gz: ffbfe47eb5ac6fd8b908604cb1409e4b90f5e03761d6f111b53dfd93ecb2d9fe
+  data.tar.gz: ce01d34fcab6f08a8b07a41cf7cfe99d3ed96c6ac9a3353f48ebbb65d2c03694
 SHA512:
-  metadata.gz: fe7fd8380653accb913cccc03b22b1a5463b9da28305df09587f9c2c21c9adf2c43f11217fadf4746a65e3f685ff88e258735f5e34a338846dea77f492f2919e
-  data.tar.gz: 7ceea9ca0c2ced123f2afa57a6d33901546fbaff1b91fee357e66b9a85d1e91c3fb64dac9206552010bca2033f18fe285156320bae422d468b68c60b91de4234
+  metadata.gz: fd14eed08cc7eb9e38e1bc8c995142b197d27ef8789718a0c8daea0af57f45704c5720fed3e15b7a8f6d0a0021d21e098bd02cd234cfde3ba822804a532bbec5
+  data.tar.gz: 27b74a7306b5577f38b1864be03a13fd3eeababf2447a37f317b0a55c5f59c94d648f957f93b010ce981fbb3b161e1889d1b841509d0cd638e7850d143558939

data/lib/action.rb

@@ -29,6 +29,12 @@ class Action
 		@config["command"]
 	end
 
+	def description
+		@config["description"]
+	end
+
+	private
+
 	def load_secrets?
 		@config["load_secrets"]
 	end

data/lib/builtin.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 class Builtin
+	class << self
+		def description
+			"no description"
+		end
+	end
+
 	def initialize(args, config)
 		@args = args
 		@config = config

data/lib/builtins/down.rb

@@ -8,7 +8,13 @@ require 'builtins/helpers/dependency_handler'
 
 module Builtins
 	class Down < Builtin
-		def run
+		class << self
+			def description
+				"Stops dependent services listed in ops.yml"
+			end
+		end
+
+			def run
 			# TODO: return a success/failure status to the caller
 			unmeet_dependencies
 		end

data/lib/builtins/env.rb

@@ -5,6 +5,12 @@ require 'output'
 
 module Builtins
 	class Env < Builtin
+		class << self
+			def description
+				"Prints the current environment, e.g. 'dev', 'production', 'staging', etc."
+			end
+		end
+
 		def run
 			Output.print(environment)
 		end

data/lib/builtins/help.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+require 'builtin'
+
+module Builtins
+	class Help < Builtin
+		class << self
+			def description
+				"Displays available builtins and actions"
+			end
+		end
+
+		def run
+			Output.out("Builtins:")
+			Output.out("  #{builtins.join("\n  ")}")
+			Output.out("")
+			Output.out("Actions:")
+			Output.out("  #{actions.join("\n  ")}")
+		end
+
+		private
+
+		def builtins
+			builtin_class_names.map do |class_name|
+				description = Builtins.const_get(class_name).description
+				format("%<name>-35s %<desc>s", name: class_name.downcase.to_s.yellow, desc: description)
+			end
+		end
+
+		def builtin_class_names
+			Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }
+		end
+
+		def actions
+			@config["actions"].map do |name, value|
+				format("%<name>-35s %<desc>s", name: name.yellow, desc: value["description"] || value["command"])
+			end
+		end
+	end
+end

data/lib/builtins/init.rb

@@ -12,6 +12,12 @@ module Builtins
 		OPS_YML_TEMPLATE = File.join(TEMPLATE_DIR, "%<template_name>s.template.yml")
 		DEFAULT_TEMPLATE_NAME = "ops"
 
+		class << self
+			def description
+				"Creates an ops.yml file from a template"
+			end
+		end
+
 		def run
 			if File.exist?(OPS_YML)
 				Output.error("File '#{OPS_YML} exists; not initializing.")

data/lib/builtins/up.rb

@@ -9,6 +9,12 @@ require 'output'
 
 module Builtins
 	class Up < Builtin
+		class << self
+			def description
+				"Attempts to meet dependencies listed in ops.yml"
+			end
+		end
+
 		def run
 			# TODO: return a success/failure status to the caller
 			meet_dependencies

data/lib/builtins/version.rb

@@ -8,7 +8,13 @@ module Builtins
 	class Version < Builtin
 		GEMSPEC_FILE = "#{__dir__}/../../ops_team.gemspec"
 
-		def run
+		class << self
+			def description
+				"Prints the version of ops that is running"
+			end
+		end
+
+			def run
 			unless gemspec
 				Output.error("Unable to load gemspec at '#{GEMSPEC_FILE}")
 				return false

data/ops_team.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -68,6 +68,7 @@ files:
 - lib/builtin.rb
 - lib/builtins/down.rb
 - lib/builtins/env.rb
+- lib/builtins/help.rb
 - lib/builtins/helpers/dependency_handler.rb
 - lib/builtins/init.rb
 - lib/builtins/up.rb