git_tracker 1.2.0 → 1.3.0

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.
data/README.md CHANGED
@@ -68,40 +68,8 @@ the top)*
68
68
 
69
69
  ```
70
70
 
71
- ## Keywords
72
- You can use the custom keywords that Pivotal Tracker provide with the API.
73
-
74
- The keywords are [Delivers] and [Fixes]
75
-
76
- If you use those keywords in your commit message, the keyword will be prepended to the story ID in the commit message.
77
-
78
- For example:
79
-
80
- ```bash
81
- # on branch named `bug/redis_connection_not_initializing_#8675309`
82
- $ git commit -am "changed the redis connection string [Fixes]"
83
- ```
84
-
85
- Will result in a this being appended to the commit message
86
-
87
- ```bash
88
- [Fixes #8675309]
89
- ```
90
-
91
71
  You should then add a [useful and responsible commit message][tpope]. :heart:
92
72
 
93
- ### Valid branch names
94
-
95
- *git_tracker* allows you to include the story number any where in the branch
96
- name, optionally prefixing it with a hash (`#`). Examples:
97
-
98
- - `best_feature_ever_#8675309`
99
- - `best_feature_ever_8675309`
100
- - `8675309_best_feature_ever`
101
- - `#8675309_best_feature_ever`
102
- - `your_name/8675309_best_feature_ever`
103
- - `your_name/#8675309_best_feature_ever`
104
-
105
73
  ### Passing commit messages via command line
106
74
 
107
75
  If you pass a commit message on the command line the hook will still add the
@@ -135,6 +103,42 @@ Results in this commit message:
135
103
  [#12356] Look at this rad code, yo!
136
104
  ```
137
105
 
106
+ ### Keywords
107
+ You can use the custom keywords that Pivotal Tracker provide with the API.
108
+
109
+ The keywords are `fixed`, `completed`, and `finshed` in square brackets. You
110
+ may also use different cases forms of these verbs, such as `Fix` or `FIXES`.
111
+
112
+ If you use those keywords in your commit message, the keyword will be prepended
113
+ to the story ID in the commit message.
114
+
115
+ For example:
116
+
117
+ ```bash
118
+ # on branch named `bug/redis_connection_not_initializing_#8675309`
119
+ $ git commit -am "Change the redis connection string [Fixes]"
120
+ ```
121
+
122
+ Results in this commit message:
123
+
124
+ ```bash
125
+ Change the redis connection string [Fixes]
126
+
127
+ [Fixes #8675309]
128
+ ```
129
+
130
+ ### Valid branch names
131
+
132
+ *git_tracker* allows you to include the story number any where in the branch
133
+ name, optionally prefixing it with a hash (`#`). Examples:
134
+
135
+ - `best_feature_ever_#8675309`
136
+ - `best_feature_ever_8675309`
137
+ - `8675309_best_feature_ever`
138
+ - `#8675309_best_feature_ever`
139
+ - `your_name/8675309_best_feature_ever`
140
+ - `your_name/#8675309_best_feature_ever`
141
+
138
142
  ## Contributing :octocat:
139
143
 
140
144
  1. Fork it
@@ -11,7 +11,7 @@ module GitTracker
11
11
  end
12
12
 
13
13
  def keyword
14
- @message =~ /\[(Delivers|Fixes)\]/
14
+ @message =~ /\[(fix|fixes|fixed|complete|completes|completed|finish|finishes|finished)\]/io
15
15
  $1
16
16
  end
17
17
 
@@ -1,3 +1,3 @@
1
1
  module GitTracker
2
- VERSION = '1.2.0'
2
+ VERSION = '1.3.0'
3
3
  end
@@ -17,14 +17,16 @@ describe GitTracker::CommitMessage do
17
17
  end
18
18
 
19
19
  describe '#keyword' do
20
- it 'should return the correct keyword' do
21
- stub_commit_message('[Delivers]')
22
- subject.keyword.should == 'Delivers'
20
+ %w[fix Fixed FIXES Complete completed completes FINISH finished Finishes].each do |keyword|
21
+ it "detects the #{keyword} keyword" do
22
+ stub_commit_message("Did the darn thing. [#{keyword}]")
23
+ subject.keyword.should == keyword
24
+ end
23
25
  end
24
26
 
25
- it 'should return nil when there no keyword matching' do
26
- stub_commit_message('[Something]')
27
- subject.keyword.should be_nil
27
+ it 'does not find the keyword when it does not exist' do
28
+ stub_commit_message('Did the darn thing. [Something]')
29
+ subject.keyword.should_not be
28
30
  end
29
31
  end
30
32
 
@@ -80,7 +80,7 @@ describe GitTracker::PrepareCommitMessage do
80
80
 
81
81
  it 'appends the keyword and the story number' do
82
82
  commit_message.should_receive(:append).with('[Delivers #8675309]')
83
- hook.run
83
+ hook.run
84
84
  end
85
85
  end
86
86
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: git_tracker
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.3.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-04-21 00:00:00.000000000 Z
12
+ date: 2012-04-23 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rspec