Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
dcdcbfa4
Commit
dcdcbfa4
authored
Jun 25, 2018
by
Jacob Vosmaer (GitLab)
Committed by
Robert Speicher
Jun 25, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve shelling out in bin/changelog
parent
2ee1913f
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
41 additions
and
19 deletions
+41
-19
bin/changelog
bin/changelog
+35
-14
spec/bin/changelog_spec.rb
spec/bin/changelog_spec.rb
+6
-5
No files found.
bin/changelog
View file @
dcdcbfa4
...
@@ -19,7 +19,24 @@ Options = Struct.new(
...
@@ -19,7 +19,24 @@ Options = Struct.new(
)
)
INVALID_TYPE
=
-
1
INVALID_TYPE
=
-
1
module
ChangelogHelpers
Abort
=
Class
.
new
(
StandardError
)
Done
=
Class
.
new
(
StandardError
)
def
capture_stdout
(
cmd
)
output
=
IO
.
popen
(
cmd
,
&
:read
)
fail_with
"command failed:
#{
cmd
.
join
(
' '
)
}
"
unless
$?
.
success?
output
end
def
fail_with
(
message
)
raise
Abort
,
"
\e
[31merror
\e
[0m
#{
message
}
"
end
end
class
ChangelogOptionParser
class
ChangelogOptionParser
extend
ChangelogHelpers
Type
=
Struct
.
new
(
:name
,
:description
)
Type
=
Struct
.
new
(
:name
,
:description
)
TYPES
=
[
TYPES
=
[
Type
.
new
(
'added'
,
'New feature'
),
Type
.
new
(
'added'
,
'New feature'
),
...
@@ -68,7 +85,7 @@ class ChangelogOptionParser
...
@@ -68,7 +85,7 @@ class ChangelogOptionParser
opts
.
on
(
'-h'
,
'--help'
,
'Print help message'
)
do
opts
.
on
(
'-h'
,
'--help'
,
'Print help message'
)
do
$stdout
.
puts
opts
$stdout
.
puts
opts
exit
raise
Done
.
new
end
end
end
end
...
@@ -108,18 +125,19 @@ class ChangelogOptionParser
...
@@ -108,18 +125,19 @@ class ChangelogOptionParser
def
assert_valid_type!
(
type
)
def
assert_valid_type!
(
type
)
unless
type
unless
type
$stderr
.
puts
"Invalid category index, please select an index between 1 and
#{
TYPES
.
length
}
"
raise
Abort
,
"Invalid category index, please select an index between 1 and
#{
TYPES
.
length
}
"
exit
1
end
end
end
end
def
git_user_name
def
git_user_name
%x{git config user.name}
.
strip
capture_stdout
(
%w[git config user.name]
)
.
strip
end
end
end
end
end
end
class
ChangelogEntry
class
ChangelogEntry
include
ChangelogHelpers
attr_reader
:options
attr_reader
:options
def
initialize
(
options
)
def
initialize
(
options
)
...
@@ -159,13 +177,9 @@ class ChangelogEntry
...
@@ -159,13 +177,9 @@ class ChangelogEntry
end
end
def
amend_commit
def
amend_commit
%x{git add
#{
file_path
}
}
fail_with
"git add failed"
unless
system
(
*
%W[git add
#{
file_path
}
]
)
exec
(
"git commit --amend"
)
end
def
fail_with
(
message
)
Kernel
.
exec
(
*
%w[git commit --amend]
)
$stderr
.
puts
"
\e
[31merror
\e
[0m
#{
message
}
"
exit
1
end
end
def
assert_feature_branch!
def
assert_feature_branch!
...
@@ -203,7 +217,7 @@ class ChangelogEntry
...
@@ -203,7 +217,7 @@ class ChangelogEntry
end
end
def
last_commit_subject
def
last_commit_subject
%x{git log --format="%s" -1}
.
strip
capture_stdout
(
%w[git log --format=%s -1]
)
.
strip
end
end
def
file_path
def
file_path
...
@@ -225,7 +239,7 @@ class ChangelogEntry
...
@@ -225,7 +239,7 @@ class ChangelogEntry
end
end
def
branch_name
def
branch_name
@branch_name
||=
%x{git symbolic-ref --short HEAD}
.
strip
@branch_name
||=
capture_stdout
(
%w[git symbolic-ref --short HEAD]
)
.
strip
end
end
def
remove_trailing_whitespace
(
yaml_content
)
def
remove_trailing_whitespace
(
yaml_content
)
...
@@ -234,8 +248,15 @@ class ChangelogEntry
...
@@ -234,8 +248,15 @@ class ChangelogEntry
end
end
if
$0
==
__FILE__
if
$0
==
__FILE__
options
=
ChangelogOptionParser
.
parse
(
ARGV
)
begin
ChangelogEntry
.
new
(
options
)
options
=
ChangelogOptionParser
.
parse
(
ARGV
)
ChangelogEntry
.
new
(
options
)
rescue
ChangelogHelpers
::
Abort
=>
ex
$stderr
.
puts
ex
.
message
exit
1
rescue
ChangelogHelpers
::
Done
exit
end
end
end
# vim: ft=ruby
# vim: ft=ruby
spec/bin/changelog_spec.rb
View file @
dcdcbfa4
...
@@ -56,11 +56,11 @@ describe 'bin/changelog' do
...
@@ -56,11 +56,11 @@ describe 'bin/changelog' do
it
'parses -h'
do
it
'parses -h'
do
expect
do
expect
do
expect
{
described_class
.
parse
(
%w[foo -h bar]
)
}.
to
output
.
to_stdout
expect
{
described_class
.
parse
(
%w[foo -h bar]
)
}.
to
output
.
to_stdout
end
.
to
raise_error
(
SystemExit
)
end
.
to
raise_error
(
ChangelogHelpers
::
Done
)
end
end
it
'assigns title'
do
it
'assigns title'
do
options
=
described_class
.
parse
(
%W[foo -m 1 bar
\n
-u
baz
\r\n
--amend]
)
options
=
described_class
.
parse
(
%W[foo -m 1 bar
\n
baz
\r\n
--amend]
)
expect
(
options
.
title
).
to
eq
'foo bar baz'
expect
(
options
.
title
).
to
eq
'foo bar baz'
end
end
...
@@ -82,9 +82,10 @@ describe 'bin/changelog' do
...
@@ -82,9 +82,10 @@ describe 'bin/changelog' do
it
'shows error message and exits the program'
do
it
'shows error message and exits the program'
do
allow
(
$stdin
).
to
receive
(
:getc
).
and_return
(
type
)
allow
(
$stdin
).
to
receive
(
:getc
).
and_return
(
type
)
expect
do
expect
do
expect
do
expect
{
described_class
.
read_type
}.
to
raise_error
(
expect
{
described_class
.
read_type
}.
to
raise_error
(
SystemExit
)
ChangelogHelpers
::
Abort
,
end
.
to
output
(
"Invalid category index, please select an index between 1 and 8
\n
"
).
to_stderr
'Invalid category index, please select an index between 1 and 8'
)
end
.
to
output
.
to_stdout
end
.
to
output
.
to_stdout
end
end
end
end
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment