Use Ruby's callable pattern

Rather than bespoke and inconsistent "action" methods for these
execution objects, rely on a norm.

Author: stevenharman

exe/git-tracker

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require "git_tracker"
-GitTracker::Runner.execute(*ARGV)
+GitTracker::Runner.call(*ARGV)

lib/git_tracker/prepare_commit_message.rb

@@ -5,8 +5,8 @@ module GitTracker
   class PrepareCommitMessage
     attr_reader :file, :source, :commit_sha
 
-    def self.run(file, source = nil, commit_sha = nil)
-      new(file, source, commit_sha).run
+    def self.call(file, source = nil, commit_sha = nil)
+      new(file, source, commit_sha).call
     end
 
     def initialize(file, source = nil, commit_sha = nil)
@@ -15,7 +15,7 @@ def initialize(file, source = nil, commit_sha = nil)
       @commit_sha = commit_sha
     end
 
-    def run
+    def call
       exit_when_commit_exists
 
       story = story_number_from_branch

lib/git_tracker/runner.rb

@@ -5,7 +5,7 @@
 
 module GitTracker
   module Runner
-    def self.execute(cmd_arg = "help", *args)
+    def self.call(cmd_arg = "help", *args)
       command = cmd_arg.tr("-", "_")
 
       abort("[git_tracker] command: '#{cmd_arg}' does not exist.") unless respond_to?(command)
@@ -14,7 +14,7 @@ def self.execute(cmd_arg = "help", *args)
     end
 
     def self.prepare_commit_msg(*args)
-      PrepareCommitMessage.run(*args)
+      PrepareCommitMessage.call(*args)
     end
 
     def self.init

lib/git_tracker/standalone.rb

@@ -22,7 +22,7 @@ def build(io)
         end
       end
 
-      io.puts("GitTracker::Runner.execute(*ARGV)")
+      io.puts("GitTracker::Runner.call(*ARGV)")
       io
     end
 

spec/git_tracker/prepare_commit_message_spec.rb

@@ -1,43 +1,29 @@
 require "git_tracker/prepare_commit_message"
 
 RSpec.describe GitTracker::PrepareCommitMessage do
-  subject(:prepare_commit_message) { GitTracker::PrepareCommitMessage }
-
-  describe ".run" do
-    let(:hook) { double("PrepareCommitMessage") }
-    before do
-      allow(prepare_commit_message).to receive(:new) { hook }
-    end
-
-    it "runs the hook" do
-      expect(hook).to receive(:run)
-      prepare_commit_message.run("FILE1", "hook_source", "sha1234")
-    end
-  end
-
-  describe ".new" do
+  describe "initialization" do
     it "requires the name of the commit message file" do
-      expect { prepare_commit_message.new }.to raise_error(ArgumentError)
+      expect { described_class.new }.to raise_error(ArgumentError)
     end
 
     it "remembers the name of the commit message file" do
-      expect(prepare_commit_message.new("FILE1").file).to eq("FILE1")
+      expect(described_class.new("FILE1").file).to eq("FILE1")
     end
 
     it "optionally accepts a message source" do
-      hook = prepare_commit_message.new("FILE1", "merge").source
+      hook = described_class.new("FILE1", "merge").source
 
       expect(hook).to eq("merge")
     end
 
     it "optionally accepts the SHA-1 of a commit" do
-      hook = prepare_commit_message.new("FILE1", "commit", "abc1234").commit_sha
+      hook = described_class.new("FILE1", "commit", "abc1234").commit_sha
 
       expect(hook).to eq("abc1234")
     end
   end
 
-  describe "#run" do
+  describe "#call" do
     let(:hook) { GitTracker::PrepareCommitMessage.new("FILE1") }
     let(:commit_message) { double("CommitMessage", append: nil) }
 
@@ -50,15 +36,15 @@
       let(:hook) { described_class.new("FILE2", "commit", "60a086f3") }
 
       it "exits with status code 0" do
-        expect { hook.run }.to succeed
+        expect { hook.call }.to succeed
       end
     end
 
     context "branch name without a Pivotal Tracker story number" do
       let(:story) { nil }
 
       it "exits without updating the commit message" do
-        expect { hook.run }.to succeed
+        expect { hook.call }.to succeed
         expect(commit_message).to_not have_received(:append)
       end
     end
@@ -71,7 +57,7 @@
       end
 
       it "appends the number to the commit message" do
-        hook.run
+        hook.call
         expect(commit_message).to have_received(:append).with("[#8675309]")
       end
 
@@ -81,7 +67,7 @@
         end
 
         it "appends the keyword and the story number" do
-          hook.run
+          hook.call
           expect(commit_message).to have_received(:append).with("[Delivers #8675309]")
         end
       end
@@ -92,7 +78,7 @@
         end
 
         it "exits without updating the commit message" do
-          expect { hook.run }.to succeed
+          expect { hook.call }.to succeed
           expect(commit_message).to_not have_received(:append)
         end
       end

spec/git_tracker/runner_spec.rb

@@ -4,7 +4,7 @@
   subject(:runner) { described_class }
   let(:args) { ["a_file", "the_source", "sha1234"] }
 
-  describe ".execute" do
+  describe "::call" do
     include OutputHelper
 
     before do
@@ -13,20 +13,20 @@
 
     it "runs the hook, passing the args" do
       expect(runner).to receive(:prepare_commit_msg).with(*args)
-      runner.execute("prepare-commit-msg", *args)
+      runner.call("prepare-commit-msg", *args)
     end
 
     it "does not run hooks we do not know about" do
       errors = capture_stderr {
-        expect { runner.execute("non-existent-hook", *args) }.to_not succeed
+        expect { runner.call("non-existent-hook", *args) }.to_not succeed
       }
       expect(errors.chomp).to eq("[git_tracker] command: 'non-existent-hook' does not exist.")
     end
   end
 
   describe ".prepare_commit_msg" do
     it "runs the hook, passing the args" do
-      expect(GitTracker::PrepareCommitMessage).to receive(:run).with(*args)
+      expect(GitTracker::PrepareCommitMessage).to receive(:call).with(*args)
       runner.prepare_commit_msg(*args)
     end
   end
@@ -43,6 +43,6 @@
 
   it ".help reports that it was run" do
     expect(runner).to receive(:puts).with(/git-tracker #{GitTracker::VERSION} is installed\./)
-    runner.execute("help")
+    runner.call("help")
   end
 end

spec/git_tracker/standalone_spec.rb

@@ -55,8 +55,8 @@
       expect(standalone_script).to_not include("module Standalone")
     end
 
-    it "includes the call to execute the hook" do
-      expect(standalone_script).to include("GitTracker::Runner.execute(*ARGV)")
+    it "includes the call to call the hook" do
+      expect(standalone_script).to include("GitTracker::Runner.call(*ARGV)")
     end
 
     it "excludes requiring git_tracker code" do