kettle-dev 1.0.9 → 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/.envrc +4 -3
  4. data/.github/workflows/coverage.yml +3 -3
  5. data/.junie/guidelines.md +4 -3
  6. data/.simplecov +5 -1
  7. data/Appraisals +3 -0
  8. data/CHANGELOG.md +22 -1
  9. data/CONTRIBUTING.md +6 -0
  10. data/README.md +18 -5
  11. data/Rakefile +7 -11
  12. data/exe/kettle-commit-msg +9 -143
  13. data/exe/kettle-readme-backers +7 -353
  14. data/exe/kettle-release +8 -702
  15. data/lib/kettle/dev/ci_helpers.rb +1 -0
  16. data/lib/kettle/dev/commit_msg.rb +39 -0
  17. data/lib/kettle/dev/exit_adapter.rb +36 -0
  18. data/lib/kettle/dev/git_adapter.rb +120 -0
  19. data/lib/kettle/dev/git_commit_footer.rb +130 -0
  20. data/lib/kettle/dev/rakelib/appraisal.rake +8 -9
  21. data/lib/kettle/dev/rakelib/bench.rake +2 -7
  22. data/lib/kettle/dev/rakelib/bundle_audit.rake +2 -0
  23. data/lib/kettle/dev/rakelib/ci.rake +4 -396
  24. data/lib/kettle/dev/rakelib/install.rake +1 -295
  25. data/lib/kettle/dev/rakelib/reek.rake +2 -0
  26. data/lib/kettle/dev/rakelib/rubocop_gradual.rake +2 -0
  27. data/lib/kettle/dev/rakelib/spec_test.rake +2 -0
  28. data/lib/kettle/dev/rakelib/template.rake +3 -465
  29. data/lib/kettle/dev/readme_backers.rb +340 -0
  30. data/lib/kettle/dev/release_cli.rb +672 -0
  31. data/lib/kettle/dev/tasks/ci_task.rb +334 -0
  32. data/lib/kettle/dev/tasks/install_task.rb +298 -0
  33. data/lib/kettle/dev/tasks/template_task.rb +491 -0
  34. data/lib/kettle/dev/template_helpers.rb +4 -4
  35. data/lib/kettle/dev/version.rb +1 -1
  36. data/lib/kettle/dev.rb +30 -1
  37. data/lib/kettle-dev.rb +2 -3
  38. data/sig/kettle/dev/ci_helpers.rbs +8 -17
  39. data/sig/kettle/dev/commit_msg.rbs +8 -0
  40. data/sig/kettle/dev/exit_adapter.rbs +8 -0
  41. data/sig/kettle/dev/git_adapter.rbs +15 -0
  42. data/sig/kettle/dev/git_commit_footer.rbs +16 -0
  43. data/sig/kettle/dev/readme_backers.rbs +20 -0
  44. data/sig/kettle/dev/release_cli.rbs +8 -0
  45. data/sig/kettle/dev/tasks/ci_task.rbs +9 -0
  46. data/sig/kettle/dev/tasks/install_task.rbs +10 -0
  47. data/sig/kettle/dev/tasks/template_task.rbs +10 -0
  48. data/sig/kettle/dev/tasks.rbs +0 -0
  49. data/sig/kettle/dev/version.rbs +0 -0
  50. data/sig/kettle/emoji_regex.rbs +5 -0
  51. data/sig/kettle-dev.rbs +0 -0
  52. data.tar.gz.sig +0 -0
  53. metadata +55 -5
  54. metadata.gz.sig +0 -0
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # External stdlib
3
4
  require "open3"
4
5
  require "net/http"
5
6
  require "json"
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Branch rule enforcement and commit message footer support for commit-msg hook.
4
+ # Provides a lib entrypoint so the exe wrapper can be minimal.
5
+
6
+ module Kettle
7
+ module Dev
8
+ module CommitMsg
9
+ module_function
10
+
11
+ BRANCH_RULES = {
12
+ "jira" => /^(?<story_type>(hotfix)|(bug)|(feature)|(candy))\/(?<story_id>\d{8,})-.+\Z/,
13
+ }.freeze
14
+
15
+ # Enforce branch rule by appending [type][id] to the commit message when missing.
16
+ # @param path [String] path to commit message file (ARGV[0] from git)
17
+ def enforce_branch_rule!(path)
18
+ validate = ENV.fetch("GIT_HOOK_BRANCH_VALIDATE", "false")
19
+ branch_rule_type = (!validate.casecmp("false").zero? && validate) || nil
20
+ return unless branch_rule_type
21
+ branch_rule = BRANCH_RULES[branch_rule_type]
22
+ return unless branch_rule
23
+
24
+ branch = %x(git branch 2> /dev/null | grep -e ^* | awk '{print $2}')
25
+ match_data = branch.match(branch_rule)
26
+ return unless match_data
27
+
28
+ commit_msg = File.read(path)
29
+ unless commit_msg.include?(match_data[:story_id])
30
+ commit_msg = <<~EOS
31
+ #{commit_msg.strip}
32
+ [#{match_data[:story_type]}][#{match_data[:story_id]}]
33
+ EOS
34
+ File.open(path, "w") { |file| file.print(commit_msg) }
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Kettle
4
+ module Dev
5
+ # Exit/abort indirection layer to allow controllable behavior in tests.
6
+ #
7
+ # Production/default behavior delegates to Kernel.abort / Kernel.exit,
8
+ # which raise SystemExit. Specs can stub these methods to avoid terminating
9
+ # the process or to assert on arguments without coupling to Kernel.
10
+ #
11
+ # Example (RSpec):
12
+ # allow(Kettle::Dev::ExitAdapter).to receive(:abort).and_raise(SystemExit.new(1))
13
+ #
14
+ # This adapter mirrors the "mockable adapter" approach used for GitAdapter.
15
+ module ExitAdapter
16
+ module_function
17
+
18
+ # Abort the current execution with a message. By default this calls Kernel.abort,
19
+ # which raises SystemExit after printing the message to STDERR.
20
+ #
21
+ # @param msg [String]
22
+ # @return [void]
23
+ def abort(msg)
24
+ Kernel.abort(msg)
25
+ end
26
+
27
+ # Exit the current process with a given status code. By default this calls Kernel.exit.
28
+ #
29
+ # @param status [Integer]
30
+ # @return [void]
31
+ def exit(status = 0)
32
+ Kernel.exit(status)
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,120 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Kettle
4
+ module Dev
5
+ # Minimal Git adapter used by kettle-dev to avoid invoking live shell commands
6
+ # directly from the library code. In tests, mock this adapter's methods to
7
+ # prevent any real network or repository mutations.
8
+ #
9
+ # This adapter requires the 'git' gem at runtime and does not shell out to
10
+ # the system git. Specs should stub the git gem API to avoid real pushes.
11
+ #
12
+ # Public API is intentionally small and only includes what we need right now.
13
+ class GitAdapter
14
+ # Create a new adapter rooted at the current working directory.
15
+ # @return [void]
16
+ def initialize
17
+ begin
18
+ require "git"
19
+ @git = ::Git.open(Dir.pwd)
20
+ rescue LoadError
21
+ raise Kettle::Dev::Error, "The 'git' gem is required at runtime. Please add it as a dependency."
22
+ rescue StandardError => e
23
+ raise Kettle::Dev::Error, "Failed to open git repository: #{e.message}"
24
+ end
25
+ end
26
+
27
+ # Push a branch to a remote.
28
+ # @param remote [String, nil] remote name (nil means default remote)
29
+ # @param branch [String] branch name (required)
30
+ # @param force [Boolean] whether to force push
31
+ # @return [Boolean] true when the push is reported successful
32
+ def push(remote, branch, force: false)
33
+ # git gem supports force: true option on push
34
+ begin
35
+ if remote
36
+ @git.push(remote, branch, force: force)
37
+ else
38
+ # Default remote according to repo config
39
+ @git.push(nil, branch, force: force)
40
+ end
41
+ true
42
+ rescue StandardError
43
+ false
44
+ end
45
+ end
46
+
47
+ # @return [String, nil] current branch name, or nil on error
48
+ def current_branch
49
+ @git.current_branch
50
+ rescue StandardError
51
+ nil
52
+ end
53
+
54
+ # @return [Array<String>] list of remote names
55
+ def remotes
56
+ @git.remotes.map(&:name)
57
+ rescue StandardError
58
+ []
59
+ end
60
+
61
+ # @return [Hash{String=>String}] remote name => fetch URL
62
+ def remotes_with_urls
63
+ @git.remotes.each_with_object({}) do |r, h|
64
+ begin
65
+ h[r.name] = r.url
66
+ rescue StandardError
67
+ # ignore
68
+ end
69
+ end
70
+ rescue StandardError
71
+ {}
72
+ end
73
+
74
+ # @param name [String]
75
+ # @return [String, nil]
76
+ def remote_url(name)
77
+ r = @git.remotes.find { |x| x.name == name }
78
+ r&.url
79
+ rescue StandardError
80
+ nil
81
+ end
82
+
83
+ # Checkout the given branch
84
+ # @param branch [String]
85
+ # @return [Boolean]
86
+ def checkout(branch)
87
+ @git.checkout(branch)
88
+ true
89
+ rescue StandardError
90
+ false
91
+ end
92
+
93
+ # Pull from a remote/branch
94
+ # @param remote [String]
95
+ # @param branch [String]
96
+ # @return [Boolean]
97
+ def pull(remote, branch)
98
+ @git.pull(remote, branch)
99
+ true
100
+ rescue StandardError
101
+ false
102
+ end
103
+
104
+ # Fetch a ref from a remote (or everything if ref is nil)
105
+ # @param remote [String]
106
+ # @param ref [String, nil]
107
+ # @return [Boolean]
108
+ def fetch(remote, ref = nil)
109
+ if ref
110
+ @git.fetch(remote, ref)
111
+ else
112
+ @git.fetch(remote)
113
+ end
114
+ true
115
+ rescue StandardError
116
+ false
117
+ end
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,130 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Exposed from lib/ so that exe/kettle-commit-msg can be a minimal wrapper.
4
+
5
+ module Kettle
6
+ module Dev
7
+ class GitCommitFooter
8
+ # Regex to extract `name = "value"` assignments from a gemspec.
9
+ # @return [Regexp]
10
+ NAME_ASSIGNMENT_REGEX = /\bname\s*=\s*(["'])([^"']+)\1/.freeze
11
+
12
+ # Whether footer appending is enabled (via GIT_HOOK_FOOTER_APPEND=true)
13
+ # @return [Boolean]
14
+ FOOTER_APPEND = ENV.fetch("GIT_HOOK_FOOTER_APPEND", "false").casecmp("true").zero?
15
+ # The sentinel string that must be present to avoid duplicate footers
16
+ # @return [String, nil]
17
+ SENTINEL = ENV["GIT_HOOK_FOOTER_SENTINEL"]
18
+
19
+ class << self
20
+ # Resolve git repository top-level dir, or nil outside a repo.
21
+ # @return [String, nil]
22
+ def git_toplevel
23
+ toplevel = nil
24
+ begin
25
+ out = %x(git rev-parse --show-toplevel 2>/dev/null)
26
+ toplevel = out.strip unless out.nil? || out.empty?
27
+ rescue StandardError
28
+ end
29
+ toplevel
30
+ end
31
+
32
+ def local_hooks_dir
33
+ top = git_toplevel
34
+ return unless top && !top.empty?
35
+ File.join(top, ".git-hooks")
36
+ end
37
+
38
+ def global_hooks_dir
39
+ File.join(ENV["HOME"], ".git-hooks")
40
+ end
41
+
42
+ def hooks_path_for(filename)
43
+ local_dir = local_hooks_dir
44
+ if local_dir
45
+ local_path = File.join(local_dir, filename)
46
+ return local_path if File.file?(local_path)
47
+ end
48
+ File.join(global_hooks_dir, filename)
49
+ end
50
+
51
+ def commit_goalie_path
52
+ hooks_path_for("commit-subjects-goalie.txt")
53
+ end
54
+
55
+ def goalie_allows_footer?(subject_line)
56
+ goalie_path = commit_goalie_path
57
+ return false unless File.file?(goalie_path)
58
+
59
+ prefixes = File.read(goalie_path).lines.map { |l| l.strip }.reject { |l| l.empty? || l.start_with?("#") }
60
+ return false if prefixes.empty?
61
+
62
+ subj = subject_line.to_s.strip
63
+ prefixes.any? { |prefix| subj.start_with?(prefix) }
64
+ end
65
+
66
+ def render(*argv)
67
+ commit_msg = File.read(argv[0])
68
+ subject_line = commit_msg.lines.first.to_s
69
+
70
+ # Evaluate configuration at runtime to respect ENV set during tests/CI
71
+ footer_append = ENV.fetch("GIT_HOOK_FOOTER_APPEND", "false").casecmp("true").zero?
72
+ sentinel = ENV["GIT_HOOK_FOOTER_SENTINEL"]
73
+
74
+ if footer_append && (sentinel.nil? || sentinel.to_s.empty?)
75
+ raise "Set GIT_HOOK_FOOTER_SENTINEL=<footer sentinel> in .env.local (e.g., '⚡️ A message from a fellow meat-based-AI ⚡️')"
76
+ end
77
+
78
+ if footer_append && goalie_allows_footer?(subject_line)
79
+ if commit_msg.include?(sentinel)
80
+ exit(0)
81
+ else
82
+ footer_binding = GitCommitFooter.new
83
+ File.open(argv[0], "w") do |file|
84
+ file.print(commit_msg)
85
+ file.print("\n")
86
+ file.print(footer_binding.render)
87
+ end
88
+ end
89
+ else
90
+ # Skipping footer append
91
+ end
92
+ end
93
+ end
94
+
95
+ def initialize
96
+ @pwd = Dir.pwd
97
+ @gemspecs = Dir["*.gemspec"]
98
+ @spec = @gemspecs.first
99
+ @gemspec_path = File.expand_path(@spec, @pwd)
100
+ @gem_name = parse_gemspec_name || derive_gem_name
101
+ end
102
+
103
+ def render
104
+ ERB.new(template).result(binding)
105
+ end
106
+
107
+ private
108
+
109
+ def parse_gemspec_name
110
+ begin
111
+ content = File.read(@gemspec_path)
112
+ @name_index = content =~ NAME_ASSIGNMENT_REGEX
113
+ if @name_index
114
+ return $2
115
+ end
116
+ rescue StandardError
117
+ end
118
+ nil
119
+ end
120
+
121
+ def derive_gem_name
122
+ File.basename(@gemspec_path, ".*") if @gemspec_path
123
+ end
124
+
125
+ def template
126
+ File.read(self.class.hooks_path_for("footer-template.erb.txt"))
127
+ end
128
+ end
129
+ end
130
+ end
@@ -1,9 +1,4 @@
1
- begin
2
- require "bundler"
3
- rescue LoadError
4
- warn("[kettle-dev][appraisal.rake] failed to load bundler") if Kettle::Dev::DEBUGGING
5
- # ok, might still work
6
- end
1
+ # frozen_string_literal: true
7
2
 
8
3
  # --- Appraisals (dev-only) ---
9
4
  begin
@@ -16,15 +11,19 @@ begin
16
11
  run_in_unbundled = proc do
17
12
  env = {"BUNDLE_GEMFILE" => "Appraisal.root.gemfile"}
18
13
 
19
- # 1) BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
14
+ # 1) BUNDLE_GEMFILE=Appraisal.root.gemfile bundle update --bundler
15
+ ok = system(env, bundle, "update", "--bundler")
16
+ abort("appraisal:update failed: bundle update --bundler under Appraisal.root.gemfile") unless ok
17
+
18
+ # 2) BUNDLE_GEMFILE=Appraisal.root.gemfile bundle (install)
20
19
  ok = system(env, bundle)
21
20
  abort("appraisal:update failed: bundler install under Appraisal.root.gemfile") unless ok
22
21
 
23
- # 2) BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
22
+ # 3) BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
24
23
  ok = system(env, bundle, "exec", "appraisal", "update")
25
24
  abort("appraisal:update failed: bundle exec appraisal update") unless ok
26
25
 
27
- # 3) bundle exec rake rubocop_gradual:autocorrect
26
+ # 4) bundle exec rake rubocop_gradual:autocorrect
28
27
  ok = system(bundle, "exec", "rake", "rubocop_gradual:autocorrect")
29
28
  abort("appraisal:update failed: rubocop_gradual:autocorrect") unless ok
30
29
  end
@@ -1,11 +1,6 @@
1
- require "rbconfig" if !Dir[File.join(__dir__, "benchmarks")].empty? # Used by `rake bench:run`
1
+ # frozen_string_literal: true
2
2
 
3
- begin
4
- require "bundler"
5
- rescue LoadError
6
- warn("[kettle-dev][bench.rake] failed to load bundler") if Kettle::Dev::DEBUGGING
7
- # ok, might still work
8
- end
3
+ require "rbconfig" if !Dir[File.join(__dir__, "benchmarks")].empty? # Used by `rake bench:run`
9
4
 
10
5
  # --- Benchmarks (dev-only) ---
11
6
  namespace :bench do
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Setup Bundle Audit
2
4
  begin
3
5
  require "bundler/audit/task"