jira-cards 0.2.0 → 0.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/Gemfile.lock +39 -39
- data/README.textile +49 -10
- data/VERSION +1 -1
- data/lib/application.rb +2 -1
- data/lib/commands.rb +1 -1
- data/lib/configuration.rb +13 -3
- metadata +22 -22
data/Gemfile.lock
CHANGED
@@ -1,39 +1,39 @@
|
|
1
|
-
GEM
|
2
|
-
remote: http://rubygems.org/
|
3
|
-
specs:
|
4
|
-
clint (0.2.7)
|
5
|
-
columnize (0.3.2)
|
6
|
-
git (1.2.5)
|
7
|
-
httpclient (2.1.6)
|
8
|
-
jeweler (1.5.2)
|
9
|
-
bundler (~> 1.0.0)
|
10
|
-
git (>= 1.2.5)
|
11
|
-
rake
|
12
|
-
jira4r-jh (0.4.0)
|
13
|
-
soap4r
|
14
|
-
soap4r
|
15
|
-
linecache (0.43)
|
16
|
-
pdfkit (0.5.0)
|
17
|
-
rake (0.8.7)
|
18
|
-
rspec (1.3.0)
|
19
|
-
ruby-debug (0.10.3)
|
20
|
-
columnize (>= 0.1)
|
21
|
-
ruby-debug-base (~> 0.10.3.0)
|
22
|
-
ruby-debug-base (0.10.3)
|
23
|
-
linecache (>= 0.3)
|
24
|
-
soap4r (1.5.8)
|
25
|
-
httpclient (>= 2.1.1)
|
26
|
-
|
27
|
-
PLATFORMS
|
28
|
-
x86-mingw32
|
29
|
-
|
30
|
-
DEPENDENCIES
|
31
|
-
bundler (~> 1.0.0)
|
32
|
-
clint
|
33
|
-
jeweler (~> 1.5.2)
|
34
|
-
jira4r-jh (> 0.3.0)
|
35
|
-
pdfkit
|
36
|
-
rake
|
37
|
-
rspec
|
38
|
-
ruby-debug (< 0.10.4)
|
39
|
-
soap4r
|
1
|
+
GEM
|
2
|
+
remote: http://rubygems.org/
|
3
|
+
specs:
|
4
|
+
clint (0.2.7)
|
5
|
+
columnize (0.3.2)
|
6
|
+
git (1.2.5)
|
7
|
+
httpclient (2.1.6)
|
8
|
+
jeweler (1.5.2)
|
9
|
+
bundler (~> 1.0.0)
|
10
|
+
git (>= 1.2.5)
|
11
|
+
rake
|
12
|
+
jira4r-jh (0.4.0)
|
13
|
+
soap4r
|
14
|
+
soap4r
|
15
|
+
linecache (0.43)
|
16
|
+
pdfkit (0.5.0)
|
17
|
+
rake (0.8.7)
|
18
|
+
rspec (1.3.0)
|
19
|
+
ruby-debug (0.10.3)
|
20
|
+
columnize (>= 0.1)
|
21
|
+
ruby-debug-base (~> 0.10.3.0)
|
22
|
+
ruby-debug-base (0.10.3)
|
23
|
+
linecache (>= 0.3)
|
24
|
+
soap4r (1.5.8)
|
25
|
+
httpclient (>= 2.1.1)
|
26
|
+
|
27
|
+
PLATFORMS
|
28
|
+
x86-mingw32
|
29
|
+
|
30
|
+
DEPENDENCIES
|
31
|
+
bundler (~> 1.0.0)
|
32
|
+
clint
|
33
|
+
jeweler (~> 1.5.2)
|
34
|
+
jira4r-jh (> 0.3.0)
|
35
|
+
pdfkit
|
36
|
+
rake
|
37
|
+
rspec
|
38
|
+
ruby-debug (< 0.10.4)
|
39
|
+
soap4r
|
data/README.textile
CHANGED
@@ -6,7 +6,7 @@ h1. Installation
|
|
6
6
|
|
7
7
|
You are going to need to
|
8
8
|
|
9
|
-
*
|
9
|
+
* Install the jira-cards gem <pre>gem install jira-cards</pre>
|
10
10
|
* "Enable the jira RPC-Plugin":http://confluence.atlassian.com/display/JIRA/JIRA+XML-RPC+Overview
|
11
11
|
* Install "wkhtmltopdf":http://code.google.com/p/wkhtmltopdf/
|
12
12
|
|
@@ -20,16 +20,31 @@ When you first run the tool it will ask you:
|
|
20
20
|
* If you want to use the default templates
|
21
21
|
** If no, the path to the template erb & css file
|
22
22
|
|
23
|
-
|
23
|
+
You can view the current configuration using the config command:
|
24
24
|
|
25
|
+
<pre>
|
26
|
+
jira-cards config
|
27
|
+
</pre>
|
25
28
|
|
26
|
-
|
29
|
+
If you want to change the config, you can use the reset flag:
|
30
|
+
|
31
|
+
<pre>
|
32
|
+
jira-cards config --reset
|
33
|
+
</pre>
|
27
34
|
|
28
|
-
|
35
|
+
h1. Commands
|
29
36
|
|
30
37
|
h2. Issues
|
31
38
|
|
32
|
-
|
39
|
+
For printing individual issues.
|
40
|
+
|
41
|
+
--output: The path you want the pdf written to
|
42
|
+
|
43
|
+
e.g. c:\foo\bar.pdf
|
44
|
+
|
45
|
+
--keys: The issue keys you want to print
|
46
|
+
|
47
|
+
You can specify individual keys (separated by comma), e.g.
|
33
48
|
|
34
49
|
<pre>
|
35
50
|
jira-cards issues --keys "foo-1, foo-4, foo-10" --output c:\temp\test.pdf
|
@@ -41,17 +56,41 @@ You can also specify ranges (a la "ruby ranges":http://www.ruby-doc.org/core/cla
|
|
41
56
|
jira-cards issues --keys foo-4..foo-10 --output c:\temp\test.pdf
|
42
57
|
</pre>
|
43
58
|
|
59
|
+
or you could go crazy and have both!
|
60
|
+
|
61
|
+
<pre>
|
62
|
+
jira-cards issues --keys foo-4..foo-10,foo-14,foo-21..foo-35 --output c:\temp\test.pdf
|
63
|
+
</pre>
|
64
|
+
|
44
65
|
h2. Iteration
|
45
66
|
|
46
|
-
|
67
|
+
For printing all issues for a team for a specific version.
|
68
|
+
|
69
|
+
--output: The path you want the pdf written to
|
47
70
|
|
48
|
-
|
49
|
-
|
71
|
+
e.g. c:\foo\bar.pdf
|
72
|
+
|
73
|
+
--project: The name of the team
|
74
|
+
|
75
|
+
e.g. "Foo Team"
|
76
|
+
|
77
|
+
--version: The version you want to print cards from
|
78
|
+
|
79
|
+
e.g. "Iteration 30"
|
50
80
|
|
51
81
|
<pre>
|
52
|
-
jira-cards iteration --project "
|
82
|
+
jira-cards iteration --project "Foo Team" --version "Iteration 30" --output c:\temp\test.pdf
|
53
83
|
</pre>
|
54
84
|
|
55
85
|
h1. Templates
|
56
86
|
|
57
|
-
The scrum cards are generated from an "erb":http://ruby-doc.org/stdlib/libdoc/erb/rdoc/ html template which is then converted to pdf using "pdfkit":https://github.com/jdpace/PDFKit.
|
87
|
+
The scrum cards are generated from an "erb":http://ruby-doc.org/stdlib/libdoc/erb/rdoc/ html template which is then converted to pdf using "pdfkit":https://github.com/jdpace/PDFKit. There is a default template however if wish to customize the look/fields you will need to set the path to the erb template and css stylesheet in the configuration (if you want to change the config: jira-cards config --reset). You can access all of the issues via the @issues variable (an array of issues). Common Properties:
|
88
|
+
|
89
|
+
* issue_type: e.g. Story, Bug, Epic
|
90
|
+
* summary
|
91
|
+
* key
|
92
|
+
* assignee
|
93
|
+
* points
|
94
|
+
* custom fields: all custom fields are available, e.g. "Business value" would be bussiness_value
|
95
|
+
|
96
|
+
Have a look at the "default template":https://github.com/jhollingworth/jira-cards/blob/master/lib/default_template.erb to see an example.
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.
|
1
|
+
0.3.0
|
data/lib/application.rb
CHANGED
@@ -10,6 +10,7 @@ end
|
|
10
10
|
c.help do
|
11
11
|
$stderr.puts "config: shows the current jira configuration\n\n\t" +
|
12
12
|
"[--r|--reset] if this flag is specified, it will reset the configuration\n\n"
|
13
|
+
"[--c|--config_path] if resetting the config, you can use this flag to specify the path to the config file rather than it asking the questions\n\n"
|
13
14
|
|
14
15
|
$stderr.puts "issues: print cards for specific issues\n\n\t" +
|
15
16
|
"[--k|--keys] issue keys. they can be csv, e.g. \"foo-1, foo-2\" or a range foo-2..foo-10\n\t" +
|
@@ -31,7 +32,7 @@ end
|
|
31
32
|
|
32
33
|
c.subcommand Commands do |subcommand|
|
33
34
|
if subcommand == :config
|
34
|
-
c.options :reset => true, :r => :reset
|
35
|
+
c.options :reset => true, :r => :reset, :config_path => String, :c => :config_path
|
35
36
|
end
|
36
37
|
|
37
38
|
if subcommand == :issues
|
data/lib/commands.rb
CHANGED
data/lib/configuration.rb
CHANGED
@@ -1,6 +1,7 @@
|
|
1
1
|
require 'yaml'
|
2
2
|
require 'net/http'
|
3
3
|
require 'uri'
|
4
|
+
require 'ftools'
|
4
5
|
require File.dirname(__FILE__) + '/meta'
|
5
6
|
|
6
7
|
class Configuration
|
@@ -17,9 +18,18 @@ class Configuration
|
|
17
18
|
|
18
19
|
class << self
|
19
20
|
|
20
|
-
def reset!()
|
21
|
-
|
22
|
-
|
21
|
+
def reset!(path)
|
22
|
+
if path != ""
|
23
|
+
if !File.exists?(path)
|
24
|
+
puts "Config file #{path} does not exist"
|
25
|
+
exit 1
|
26
|
+
end
|
27
|
+
File.delete(config_path) if File.exists?(config_path)
|
28
|
+
File.copy(path, config_path)
|
29
|
+
else
|
30
|
+
File.delete(config_path) if File.exists?(config_path)
|
31
|
+
Configuration.new
|
32
|
+
end
|
23
33
|
end
|
24
34
|
|
25
35
|
def config_path()
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jira-cards
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 19
|
5
5
|
prerelease: false
|
6
6
|
segments:
|
7
7
|
- 0
|
8
|
-
-
|
8
|
+
- 3
|
9
9
|
- 0
|
10
|
-
version: 0.
|
10
|
+
version: 0.3.0
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- James Hollingworth
|
@@ -15,11 +15,13 @@ autorequire:
|
|
15
15
|
bindir: bin
|
16
16
|
cert_chain: []
|
17
17
|
|
18
|
-
date: 2011-01-
|
18
|
+
date: 2011-01-04 00:00:00 +00:00
|
19
19
|
default_executable: jira-cards
|
20
20
|
dependencies:
|
21
21
|
- !ruby/object:Gem::Dependency
|
22
22
|
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
name: soap4r
|
23
25
|
version_requirements: &id001 !ruby/object:Gem::Requirement
|
24
26
|
none: false
|
25
27
|
requirements:
|
@@ -29,11 +31,11 @@ dependencies:
|
|
29
31
|
segments:
|
30
32
|
- 0
|
31
33
|
version: "0"
|
32
|
-
prerelease: false
|
33
|
-
name: soap4r
|
34
34
|
requirement: *id001
|
35
35
|
- !ruby/object:Gem::Dependency
|
36
36
|
type: :runtime
|
37
|
+
prerelease: false
|
38
|
+
name: jira4r-jh
|
37
39
|
version_requirements: &id002 !ruby/object:Gem::Requirement
|
38
40
|
none: false
|
39
41
|
requirements:
|
@@ -45,11 +47,11 @@ dependencies:
|
|
45
47
|
- 3
|
46
48
|
- 0
|
47
49
|
version: 0.3.0
|
48
|
-
prerelease: false
|
49
|
-
name: jira4r-jh
|
50
50
|
requirement: *id002
|
51
51
|
- !ruby/object:Gem::Dependency
|
52
52
|
type: :runtime
|
53
|
+
prerelease: false
|
54
|
+
name: pdfkit
|
53
55
|
version_requirements: &id003 !ruby/object:Gem::Requirement
|
54
56
|
none: false
|
55
57
|
requirements:
|
@@ -59,11 +61,11 @@ dependencies:
|
|
59
61
|
segments:
|
60
62
|
- 0
|
61
63
|
version: "0"
|
62
|
-
prerelease: false
|
63
|
-
name: pdfkit
|
64
64
|
requirement: *id003
|
65
65
|
- !ruby/object:Gem::Dependency
|
66
66
|
type: :runtime
|
67
|
+
prerelease: false
|
68
|
+
name: clint
|
67
69
|
version_requirements: &id004 !ruby/object:Gem::Requirement
|
68
70
|
none: false
|
69
71
|
requirements:
|
@@ -73,11 +75,11 @@ dependencies:
|
|
73
75
|
segments:
|
74
76
|
- 0
|
75
77
|
version: "0"
|
76
|
-
prerelease: false
|
77
|
-
name: clint
|
78
78
|
requirement: *id004
|
79
79
|
- !ruby/object:Gem::Dependency
|
80
80
|
type: :development
|
81
|
+
prerelease: false
|
82
|
+
name: bundler
|
81
83
|
version_requirements: &id005 !ruby/object:Gem::Requirement
|
82
84
|
none: false
|
83
85
|
requirements:
|
@@ -89,11 +91,11 @@ dependencies:
|
|
89
91
|
- 0
|
90
92
|
- 0
|
91
93
|
version: 1.0.0
|
92
|
-
prerelease: false
|
93
|
-
name: bundler
|
94
94
|
requirement: *id005
|
95
95
|
- !ruby/object:Gem::Dependency
|
96
96
|
type: :development
|
97
|
+
prerelease: false
|
98
|
+
name: jeweler
|
97
99
|
version_requirements: &id006 !ruby/object:Gem::Requirement
|
98
100
|
none: false
|
99
101
|
requirements:
|
@@ -105,11 +107,11 @@ dependencies:
|
|
105
107
|
- 5
|
106
108
|
- 2
|
107
109
|
version: 1.5.2
|
108
|
-
prerelease: false
|
109
|
-
name: jeweler
|
110
110
|
requirement: *id006
|
111
111
|
- !ruby/object:Gem::Dependency
|
112
112
|
type: :development
|
113
|
+
prerelease: false
|
114
|
+
name: rake
|
113
115
|
version_requirements: &id007 !ruby/object:Gem::Requirement
|
114
116
|
none: false
|
115
117
|
requirements:
|
@@ -119,11 +121,11 @@ dependencies:
|
|
119
121
|
segments:
|
120
122
|
- 0
|
121
123
|
version: "0"
|
122
|
-
prerelease: false
|
123
|
-
name: rake
|
124
124
|
requirement: *id007
|
125
125
|
- !ruby/object:Gem::Dependency
|
126
126
|
type: :development
|
127
|
+
prerelease: false
|
128
|
+
name: rspec
|
127
129
|
version_requirements: &id008 !ruby/object:Gem::Requirement
|
128
130
|
none: false
|
129
131
|
requirements:
|
@@ -133,11 +135,11 @@ dependencies:
|
|
133
135
|
segments:
|
134
136
|
- 0
|
135
137
|
version: "0"
|
136
|
-
prerelease: false
|
137
|
-
name: rspec
|
138
138
|
requirement: *id008
|
139
139
|
- !ruby/object:Gem::Dependency
|
140
140
|
type: :development
|
141
|
+
prerelease: false
|
142
|
+
name: ruby-debug
|
141
143
|
version_requirements: &id009 !ruby/object:Gem::Requirement
|
142
144
|
none: false
|
143
145
|
requirements:
|
@@ -149,8 +151,6 @@ dependencies:
|
|
149
151
|
- 10
|
150
152
|
- 4
|
151
153
|
version: 0.10.4
|
152
|
-
prerelease: false
|
153
|
-
name: ruby-debug
|
154
154
|
requirement: *id009
|
155
155
|
description: You can get individual issues or all issues for an iteration. see --h for more info
|
156
156
|
email: jamiehollingworth@gmail.com
|