ops_team 0.8.10 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caa9b859d0dac66be5cc981ed872b591a6c174a5c70dabdf145d415681960831
-  data.tar.gz: '08beac67a93906cb88db284977d1a10863820de5fd73369fb782f530cc8ec601'
+  metadata.gz: eba253171a96866401be036ddbe987211414bd7f0ab1547efacc14880440effc
+  data.tar.gz: c223d51872392ffa6850af158c6c7611e737c9f346ea7f04f10236ea4548febe
 SHA512:
-  metadata.gz: 472f261d6d94bc4024576b2a322fe69bd10b53b5892efbcc89027a825723901c9a1aede0cc393cd8fae372dba49bdeb95c703b912f4d83ecf6711de8f3541caa
-  data.tar.gz: 2a3a3ae0d383b40bec9cfaa79d705520f46b885f510aaab3833e763114a9c10a8b90af5a6c6285942e53057508643da93ad32f629fc4812819e24e44969ba750
+  metadata.gz: 438fe1576dc499d1474a47f38fb47a27206c6337b0f98dfc446c8605789e61b0987dc028f78626213a6ac6df3693a7ec41a6d7cef9e04a3db0ededb11cc25982
+  data.tar.gz: b67faeea77ceea232adcadb7361d2070b2156e6a361d328c9981b5bbaf2aff61b78236d82ed6e719e98eff359fec20a83c7bbb796b2f4f5fe06494e147d76b82

data/lib/builtin.rb

@@ -1,10 +1,22 @@
 # frozen_string_literal: true
 
 class Builtin
+	attr_reader :args, :config
+
 	class << self
 		def description
 			"no description"
 		end
+
+		def class_for(name:)
+			Builtins.const_get(builtin_class_name_for(name: name), false)
+		end
+
+		private
+
+		def builtin_class_name_for(name:)
+			name.capitalize.to_sym
+		end
 	end
 
 	def initialize(args, config)

data/lib/builtins/background.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'builtin'
+
+module Builtins
+	class Background < Builtin
+		DEFAULT_LOG_FILE_PREFIX = "/tmp/ops_bglog_"
+
+		class << self
+			def description
+				"runs the given command in a background session"
+			end
+
+			def log_filename
+				Options.get("background.log_filename") || "#{DEFAULT_LOG_FILE_PREFIX}#{Ops.project_name}"
+			end
+		end
+
+		def run
+			subprocess = fork do
+				run_ops(args)
+			end
+
+			Process.detach(subprocess)
+		end
+
+		private
+
+		def run_ops(args)
+			Output.notice("Running '#{args.join(' ')}' with stderr and stdout redirected to '#{Background.log_filename}'")
+			$stdout.sync = $stderr.sync = true
+			$stdout.reopen(Background.log_filename, "w")
+			$stderr.reopen($stdout)
+
+			Ops.new(args).run
+		end
+	end
+
+	# set an alias
+	Bg = Background
+end

data/lib/builtins/background_log.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'builtin'
+require 'builtins/background'
+
+module Builtins
+	class BackgroundLog < Builtin
+		class << self
+			def description
+				"displays the log from the current or most recent background task from this project"
+			end
+		end
+
+		def run
+			unless File.exist?(Background.log_filename)
+				Output.warn("No background log found at '#{Background.log_filename}'.")
+				return 0
+			end
+
+			Output.notice("Displaying background log '#{Background.log_filename}'...")
+			display_file
+		end
+
+		private
+
+		def display_file
+			if args.any?
+				exec("tail #{args.join(' ')} '#{Background.log_filename}'")
+			else
+				exec("cat '#{Background.log_filename}'")
+			end
+		end
+	end
+
+	# set an alias
+	Bglog = BackgroundLog
+end

data/lib/builtins/help.rb

@@ -23,14 +23,32 @@ module Builtins
 		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)
+			builtin_class_map.map do |klass, name|
+				format("%<name>-35s %<desc>s", name: name.downcase.to_s.yellow, desc: klass.description)
+			end
+		end
+
+		def builtin_class_map
+			builtin_class_names.each_with_object({}) do |name, hash|
+				# get the class reference for this name
+				constant = const_for(name)
+				# check hash for an existing entry for the same class
+				existing_name = hash[constant]
+
+				# if there is an existing key for the same class, and it's longer than the one we just found,
+				# skip adding this one one to avoid duplicates, leaving the shortest name for each class
+				next if existing_name && existing_name.length <= name.length
+
+				hash[constant] = name
 			end
 		end
 
 		def builtin_class_names
-			Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }
+			@builtin_class_names ||= Builtins.constants.select { |c| const_for(c).is_a?(Class) }.sort
+		end
+
+		def const_for(name)
+			Builtins.const_get(name, false)
 		end
 
 		def actions
@@ -39,7 +57,7 @@ module Builtins
 					name: name.yellow,
 					desc: value["description"] || value["command"]
 				)
-			end
+			end.sort
 		end
 	end
 end

data/lib/dependencies/sshkey.rb

@@ -57,8 +57,7 @@ module Dependencies
 		end
 
 		def key_comment
-			# the current directory is usually named for the project
-			File.basename(::Dir.pwd)
+			Ops.project_name
 		end
 
 		def dir_name

data/lib/ops.rb

@@ -19,6 +19,12 @@ class Ops
 	INVALID_SYNTAX_EXIT_CODE = 64
 	UNKNOWN_ACTION_EXIT_CODE = 65
 
+	class << self
+		def project_name
+			File.basename(::Dir.pwd)
+		end
+	end
+
 	def initialize(argv)
 		@action_name = argv[0]
 		@args = argv[1..-1]
@@ -27,7 +33,7 @@ class Ops
 	end
 
 	def run
-		exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
+		return exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
 
 		run_action
 	rescue UnknownActionError => e
@@ -39,8 +45,7 @@ class Ops
 
 	def syntax_valid?
 		if @action_name.nil?
-			# TODO: output to stderr
-			puts "Usage: ops <action>"
+			Output.error("Usage: ops <action>")
 			false
 		else
 			true
@@ -53,21 +58,17 @@ class Ops
 
 		return builtin.run if builtin
 
-		Output.warn("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
+		Output.notice("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
 		action.run
 	end
 
 	def builtin
-		@builtin ||= Builtins.const_get(builtin_class_name, false).new(@args, config)
+		@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_class_name
-		@action_name.capitalize.to_sym
-	end
-
 	def action
 		return actions[@action_name] if actions[@action_name]
 		return aliases[@action_name] if aliases[@action_name]

data/lib/output.rb

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

data/ops_team.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
 	s.name = 'ops_team'
-	s.version = '0.8.10'
+	s.version = '0.9.4'
 	s.authors = [
 		'nickthecook@gmail.com'
 	]
-	s.date = '2020-08-11'
+	s.date = '2020-08-12'
 	s.summary = 'ops_team handles basic operations tasks for your project, driven by YAML config'
 	s.homepage = 'https://github.com/nickthecook/ops'
 	s.files = Dir[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.9.4
 platform: ruby
 authors:
 - nickthecook@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -148,6 +148,8 @@ files:
 - lib/action.rb
 - lib/app_config.rb
 - lib/builtin.rb
+- lib/builtins/background.rb
+- lib/builtins/background_log.rb
 - lib/builtins/down.rb
 - lib/builtins/env.rb
 - lib/builtins/exec.rb