ops_team 1.13.0 → 1.16.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c5f694faa0c40cbd2f850fe45fb7eb35012d3359bf815e95984198366ddac6d
-  data.tar.gz: 4d9e6178368112d8a55869162b4371ec715a9168bfb9c0b2fca08e0025d7d1e6
+  metadata.gz: e5aa70e4e711e46c9e7661013c62fc3f40db454caeee504c0ff3c49258ea3951
+  data.tar.gz: c1a491887c6629b419b3397aed7b0ad0e1b74a19bcfda45fc79fb15d481f517c
 SHA512:
-  metadata.gz: 1bf4567b067db9a9041628384e3b09c096b6ece2caada9749c449a29e2e772197e52f5ee8413155e47a8faeb3bc68134f9f4ef86d7aa1f26d4b3111cbe21b0c1
-  data.tar.gz: 59eb6746612f1f7209ea93b086be4556274fbda04d2e7372b2ce8583bc1eea9d86b7a0c795d6d137a6278c3c4a716faa67ee3c69ab2ab1cd155d2b7ec5c097b5
+  metadata.gz: b92b2d6583d86f2a0fccf7d17d6d713aaf062eed7837836fb0904c7bafee5ded631a9d26b22c96eb429e629f54d7a9e06f5f2ace0411743e57005ec410086808
+  data.tar.gz: f8199c0e807ed8fa7e1d3bfba3928c51fa32dca844bdaa103d3d18afb35b8ef017ddae71a8371a3d5fbb1a3ec3b9bd475105754e6e5f0b7b439b90279171c28c

data/Gemfile

@@ -14,6 +14,7 @@ gem "io-console"
 gem "json", ">= 2.3.0"
 gem "net-ssh"
 gem "require_all"
+gem "zeitwerk"
 
 group :test do
 	gem "fuubar"

data/bin/benchmark

@@ -0,0 +1,185 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'json'
+require 'colorize'
+
+COMMANDS = [
+	"version",
+	"env",
+	"help",
+	"exec echo hi",
+	"env OPS_AUTO_COMPLETE=true"
+].freeze
+
+class Runner
+	RUNS = 10
+	WARMUPS = 3
+
+	attr_reader :command, :version
+
+	def initialize(command, version)
+		@command = command
+		@version = version
+	end
+
+	def run
+		unless File.exist?(json_file)
+			system(
+				"hyperfine -m #{RUNS} \
+				--export-json #{json_file} \
+				--export-markdown #{markdown_file} \
+				--warmup #{WARMUPS} \
+				'#{@command}'"
+			)
+		end
+
+		results
+	end
+
+	def results
+		# for now, only ever one result, since we're not having hyperfine vary params
+		@results ||= JSON.parse(results_data)["results"].first
+	end
+
+	def method_missing(method, *_, &_)
+		results[method.to_s]
+	end
+
+	def respond_to_missing?(method, _ = false)
+		results&.keys&.include?(method.to_s)
+	end
+
+	def json_file
+		@json_file ||= "#{output_file}.json"
+	end
+
+	def markdown_file
+		@markdown_file ||= "#{output_file}.md"
+	end
+
+	private
+
+	def output_file
+		"benchmark/#{@version}-#{@command.gsub(" ", "_").gsub("/", "-")}"
+	end
+
+	def results_data
+		File.read(json_file)
+	end
+end
+
+class Benchmark
+	attr_reader :executable
+
+	def initialize(executable)
+		@executable = executable
+	end
+
+	def run
+		runners.map(&:run)
+
+		runners.map(&:mean)
+	end
+
+	def version
+		@version ||= `#{@executable} version`.chomp
+	end
+
+	def runners
+		@runners ||= COMMANDS.map do |cmd|
+			Runner.new("#{@executable} #{cmd}", version)
+		end
+	end
+end
+
+class Benchmarker
+	CLR_THRESHOLD = 0.1
+	CLR_WIDTH = 14
+	COL_WIDTH = 24
+	CMD_WIDTH = 30
+
+	def initialize(*executables)
+		@executables = executables
+	end
+
+	def summary
+		result_pairs = results.first.zip(results.last)
+
+		output = header
+		COMMANDS.length.times do |index|
+			output << format(
+				"%#{CMD_WIDTH + CLR_WIDTH}s %#{COL_WIDTH}s %#{COL_WIDTH + CLR_WIDTH}s",
+				COMMANDS[index].white,
+				*result_strings(result_pairs[index])
+			)
+		end
+		output << summary_numbers
+
+		output.join("\n")
+	end
+
+	def benchmarks
+		@benchmarks ||= @executables.map do |executable|
+			Benchmark.new(executable)
+		end
+	end
+
+	def results
+		@results ||= benchmarks.map(&:run)
+	end
+
+	private
+
+	def result_pairs
+		@result_pairs ||= results.first.zip(results.last)
+	end
+
+	def header
+		[
+			format(
+				"%#{CMD_WIDTH}s %#{COL_WIDTH + CLR_WIDTH}s %#{COL_WIDTH + CLR_WIDTH}s",
+				"", *benchmarks.map { |b| b.executable.white }
+			),
+			format(
+				"%#{CMD_WIDTH}s %#{COL_WIDTH + CLR_WIDTH}s %#{COL_WIDTH + CLR_WIDTH}s",
+				"", *benchmarks.map { |b| b.version.white }
+			)
+		]
+	end
+
+	def result_strings(pair)
+		colour = :blue
+		if pair.last < (pair.first * (1 - CLR_THRESHOLD))
+			colour = :green
+		elsif pair.last < (pair.first * CLR_THRESHOLD)
+			colour = :red
+		end
+
+		outputs = pair.map { |number| format("%02.3f", number) }
+
+		outputs[1] = outputs.last.send(colour)
+
+		outputs
+	end
+
+	def summary_numbers
+		format(
+			"%#{CMD_WIDTH + CLR_WIDTH}s %#{COL_WIDTH}s %#{COL_WIDTH + CLR_WIDTH}s",
+			"Avg difference".white, "-", avg_diff_string.white
+		)
+	end
+
+	def avg_diff_string
+		format("%02.3f", avg_diff)
+	end
+
+	def avg_diff
+		result_pairs.each_with_object([]) do |pair, diff|
+			diff << pair.first - pair.last
+		end.sum / result_pairs.length
+	end
+end
+
+`rm -f benchmark/*.json benchmark/*.md` unless %w[--skip -s].include?(ARGV[0])
+puts Benchmarker.new("ops", "bin/ops").summary

data/bin/ops

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+require_relative '../lib/profiler'
 require 'optparse'
 
 def usage
@@ -12,6 +15,8 @@ def usage
 end
 
 options = {}
+status = -1
+
 while ARGV[0]&.match(/^-/)
 	opt = ARGV.shift
 	case opt
@@ -24,7 +29,14 @@ while ARGV[0]&.match(/^-/)
 	end
 end
 
-require_relative "../loader"
-require 'ops'
+Profiler.measure("bin:require") do
+	require_relative "../loader"
+end
+
+Profiler.measure("bin:run") do
+	status = Ops.new(ARGV, config_file: options[:file]).run
+end
 
-exit Ops.new(ARGV, config_file: options[:file]).run
+Profiler.add_measurement("bin:all", Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time)
+Output.error(Profiler.summary) if Profiler.summary
+exit status

data/lib/action.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'secrets'
-
 # represents one action to be performed in the shell
 # can assemble a command line from a command and args
 class Action
@@ -9,11 +7,13 @@ class Action
 
 	def initialize(name, config, args)
 		@name = name
-		@config = config
+		@config = config || {}
 		@args = args
 	end
 
 	def run
+		Output.error(Profiler.summary) if Profiler.summary
+
 		if perform_shell_expansion?
 			Kernel.exec(to_s)
 		else

data/lib/action_list.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'action'
-
 class ActionList
 	class UnknownActionError < StandardError; end
 

data/lib/builtin.rb

@@ -6,16 +6,35 @@ class Builtin
 	attr_reader :args, :config
 
 	class << self
+		BUILTIN_DIR = "builtins"
+
 		def description
 			"no description"
 		end
 
 		def class_for(name:)
-			Builtins.const_get(builtin_class_name_for(name: name), false)
+			file = file_for(name: name)
+			unless File.exist?(file)
+				require 'require_all'
+				require_rel "builtins"
+			end
+
+			get_const(name: builtin_class_name_for(name: name))
 		end
 
 		private
 
+		def get_const(name:)
+			Builtins.const_get(name)
+		rescue NameError
+			# no such constant
+			nil
+		end
+
+		def file_for(name:)
+			File.join(File.dirname(__FILE__), BUILTIN_DIR, "#{name}.rb")
+		end
+
 		def builtin_class_name_for(name:)
 			name.capitalize.to_sym
 		end

data/lib/builtins/background.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'builtin'
-
 module Builtins
-	class Background < Builtin
+	class Background < ::Builtin
 		DEFAULT_LOG_FILE_PREFIX = "/tmp/ops_bglog_"
 
 		class << self

data/lib/builtins/background_log.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'builtin'
-require 'builtins/background'
-
 module Builtins
 	class BackgroundLog < Builtin
 		class << self

data/lib/builtins/common/up_down.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require 'require_all'
-require_rel "../../dependencies"
-
-require 'builtin'
-require 'builtins/helpers/dependency_handler'
-require 'output'
-
 module Builtins
 	module Common
 		class UpDown < Builtin

data/lib/builtins/countdown.rb

@@ -2,9 +2,6 @@
 
 require 'concurrent'
 
-require 'builtin'
-require 'output'
-
 module Builtins
 	class Countdown < Builtin
 		USAGE_STRING = "Usage: ops countdown <seconds>"

data/lib/builtins/down.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'require_all'
-require_rel "../dependencies"
-
-require 'builtins/common/up_down'
-
 module Builtins
 	class Down < Common::UpDown
 		def handle_dependency(dependency)

data/lib/builtins/env.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'builtin'
-require 'output'
-
 module Builtins
 	class Env < Builtin
 		class << self

data/lib/builtins/envdiff.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'builtin'
-
 module Builtins
-	class EnvDiff < Builtin
+	class Envdiff < Builtin
 		class << self
 			def description
 				"compares keys present in config and secrets between different environments"
@@ -126,6 +124,4 @@ module Builtins
 			Options.get("envdiff.ignored_keys") || []
 		end
 	end
-
-	Envdiff = EnvDiff
 end

data/lib/builtins/exec.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'builtin'
-require 'output'
-require 'secrets'
-require 'options'
-
 module Builtins
 	class Exec < Builtin
 		class << self
@@ -17,9 +12,11 @@ module Builtins
 			Secrets.load if Options.get("exec.load_secrets")
 
 			if args.any?
+				Output.error(Profiler.summary) if Profiler.summary
 				Kernel.exec(args.join(" "))
 			else
 				Output.error("Usage: ops exec '<command>'")
+
 				false
 			end
 		end

data/lib/builtins/help.rb

@@ -2,10 +2,6 @@
 
 require 'colorize'
 
-require 'builtin'
-require 'forwards'
-require 'builtins/helpers/enumerator'
-
 module Builtins
 	class Help < Builtin
 		NAME_WIDTH = 40

data/lib/builtins/helpers/dependency_handler.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'builtin'
-require 'output'
-
-require 'require_all'
-require_rel "../../dependencies"
-
 module Builtins
 	module Helpers
 		class DependencyHandler

data/lib/builtins/helpers/enumerator.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'require_all'
+require_rel '..'
+
 module Builtins
 	module Helpers
 		class Enumerator

data/lib/builtins/init.rb

@@ -2,9 +2,6 @@
 
 require 'fileutils'
 
-require 'builtin'
-require 'output'
-
 module Builtins
 	class Init < Builtin
 		OPS_YML = "ops.yml"

data/lib/builtins/up.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'require_all'
-require_rel "../dependencies"
-
-require 'builtins/common/up_down'
-require 'output'
-
 module Builtins
 	class Up < Common::UpDown
 		def handle_dependency(dependency)

data/lib/builtins/version.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "output"
-require "version"
-
 module Builtins
 	class Version < Builtin
 		class << self

data/lib/dependencies/apk.rb

@@ -2,8 +2,6 @@
 
 require 'English'
 
-require 'dependency'
-
 module Dependencies
 	class Apk < Dependency
 		def met?

data/lib/dependencies/apt.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependencies/versioned_dependency'
-require 'dependencies/helpers/apt_cache_policy'
-
 module Dependencies
 	class Apt < VersionedDependency
 		def met?

data/lib/dependencies/brew.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependency'
-
 module Dependencies
 	class Brew < Dependency
 		def met?

data/lib/dependencies/cask.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependencies/brew'
-
 module Dependencies
 	class Cask < Brew
 		def met?

data/lib/dependencies/custom.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependency'
-
 module Dependencies
 	class Custom < Dependency
 		class CustomConfigError < StandardError; end

data/lib/dependencies/dir.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependency'
-
 module Dependencies
 	class Dir < Dependency
 		def met?

data/lib/dependencies/docker.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependency'
-
 module Dependencies
 	class Docker < Dependency
 		def met?

data/lib/dependencies/gem.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'dependency'
-require 'options'
-
 module Dependencies
 	class Gem < VersionedDependency
 		def met?

data/lib/dependencies/pip.rb

@@ -2,9 +2,6 @@
 
 require 'English'
 
-require 'dependency'
-require 'options'
-
 module Dependencies
 	class Pip < Dependency
 		DEFAULT_PIP = "python3 -m pip"

data/lib/dependencies/sshkey.rb

@@ -2,8 +2,6 @@
 
 require 'net/ssh'
 
-require 'dependency'
-
 module Dependencies
 	class Sshkey < Dependency
 		DEFAULT_KEY_SIZE = 4096

data/lib/dependency.rb

@@ -3,9 +3,6 @@
 require 'open3'
 require 'English'
 
-require 'output'
-require 'executor'
-
 class Dependency
 	DESCRIPTION_TYPE_WIDTH = 8
 

data/lib/environment.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'version'
-require 'secrets'
-require 'app_config'
-
 class Environment
 	class << self
 		def environment

data/lib/forward.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'output'
-
 class Forward
 	def initialize(dir, args)
 		@dir = dir

data/lib/forwards.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'forward'
-
 class Forwards
 	def initialize(config, args = [])
 		@config = config

data/lib/hook_handler.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'output'
-
 class HookHandler
 	class HookConfigError < StandardError; end
 

data/lib/ops.rb

@@ -1,16 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'yaml'
-require 'require_all'
-require "rubygems"
-
-require 'output'
-require 'options'
-require 'version'
-require 'runner'
+Profiler.measure("ops:requires_external") do
+	require 'yaml'
+	require "rubygems"
+end
 
-require_rel "builtins"
+Profiler.measure("ops:requires_internal") do
+end
 
 # executes commands based on local `ops.yml`
 class Ops
@@ -45,7 +42,9 @@ class Ops
 		return exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
 		return exit(MIN_VERSION_NOT_MET_EXIT_CODE) unless min_version_met?
 
-		runner.run
+		Profiler.measure("runner:run") do
+			runner.run
+		end
 	rescue Runner::UnknownActionError => e
 		Output.error(e.to_s)
 		Output.out(RECOMMEND_HELP_TEXT) unless print_did_you_mean

data/lib/profiler.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class Profiler
+	INDENT = "  "
+
+	@measurements = {}
+
+	class << self
+		attr_reader :measurements
+
+		def measure(tag)
+			start = time_now
+			result = yield
+			add_measurement(tag, time_now - start)
+
+			result
+		end
+
+		def add_measurement(tag, seconds)
+			return unless profiling?
+
+			@measurements[tag] ||= []
+
+			@measurements[tag] << seconds
+		end
+
+		def summary
+			return unless profiling?
+
+			@summary ||= measurements.reverse_each.each_with_object([]) do |(tag, values), output|
+				output << "#{tag}:\n"
+				values.sort.reverse.each do |value|
+					value_str = format("%.3f", value * 1000)
+					output << format("%<indent>s%9<value>sms\n", indent: INDENT, value: value_str)
+				end
+			end.join
+		end
+
+		def profiling?
+			!ENV["OPS_PROFILE"].nil?
+		end
+
+		def time_now
+			Process.clock_gettime(Process::CLOCK_MONOTONIC)
+		end
+	end
+end

data/lib/runner.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
-require 'hook_handler'
-require 'action'
-require 'action_list'
-require 'action_suggester'
-require 'forwards'
-require 'environment'
+module Builtins
+end
 
 class Runner
 	class UnknownActionError < StandardError; end
@@ -61,7 +57,9 @@ class Runner
 	end
 
 	def builtin
-		@builtin ||= Builtin.class_for(name: @action_name).new(@args, @config)
+		Profiler.measure("runner:require_builtin") do
+			@builtin ||= Builtin.class_for(name: @action_name)&.new(@args, @config)
+		end
 	rescue NameError
 		# this means there isn't a builtin with that name in that module
 		nil

data/lib/secrets.rb

@@ -3,10 +3,6 @@
 require 'json'
 require 'open3'
 
-require 'output'
-require 'app_config'
-require 'options'
-
 class Secrets < AppConfig
 	class << self
 		def default_filename

data/loader.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 
 # for convenience, add "lib" to the load path
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/lib"))
+# $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/lib"))
+
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.new
+loader.push_dir(File.expand_path("#{__dir__}/lib"))
+loader.setup

data/ops_team.gemspec

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.16.0.pre.rc1
 platform: ruby
 authors:
 - nickthecook@gmail.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2021-10-25 00:00:00.000000000 Z
@@ -150,14 +150,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.6
-description: 
-email: 
+description:
+email:
 executables:
 - ops
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- bin/benchmark
 - bin/ops
 - bin/print_config
 - bin/print_secrets
@@ -205,6 +206,7 @@ files:
 - lib/ops.rb
 - lib/options.rb
 - lib/output.rb
+- lib/profiler.rb
 - lib/runner.rb
 - lib/secrets.rb
 - lib/version.rb
@@ -214,7 +216,7 @@ homepage: https://github.com/nickthecook/ops
 licenses:
 - GPL-3.0-only
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,12 +227,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.15
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ops_team handles basic automation for your project, driven by self-documenting
   YAML config