jira-cards 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,39 +1,39 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    clint (0.2.7)
-    columnize (0.3.2)
-    git (1.2.5)
-    httpclient (2.1.6)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    jira4r-jh (0.4.0)
-      soap4r
-      soap4r
-    linecache (0.43)
-    pdfkit (0.5.0)
-    rake (0.8.7)
-    rspec (1.3.0)
-    ruby-debug (0.10.3)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
-      linecache (>= 0.3)
-    soap4r (1.5.8)
-      httpclient (>= 2.1.1)
-
-PLATFORMS
-  x86-mingw32
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  clint
-  jeweler (~> 1.5.2)
-  jira4r-jh (> 0.3.0)
-  pdfkit
-  rake
-  rspec
-  ruby-debug (< 0.10.4)
-  soap4r
+GEM
+  remote: http://rubygems.org/
+  specs:
+    clint (0.2.7)
+    columnize (0.3.2)
+    git (1.2.5)
+    httpclient (2.1.6)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    jira4r-jh (0.4.0)
+      soap4r
+      soap4r
+    linecache (0.43)
+    pdfkit (0.5.0)
+    rake (0.8.7)
+    rspec (1.3.0)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    soap4r (1.5.8)
+      httpclient (>= 2.1.1)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  clint
+  jeweler (~> 1.5.2)
+  jira4r-jh (> 0.3.0)
+  pdfkit
+  rake
+  rspec
+  ruby-debug (< 0.10.4)
+  soap4r

data/README.textile

@@ -6,7 +6,7 @@ h1. Installation
 
 You are going to need to
 
-* install the jira-cards gem <pre>gem install jira-cards</pre>
+* Install the jira-cards gem <pre>gem install jira-cards</pre>
 * "Enable the jira RPC-Plugin":http://confluence.atlassian.com/display/JIRA/JIRA+XML-RPC+Overview
 * Install "wkhtmltopdf":http://code.google.com/p/wkhtmltopdf/ 
 
@@ -20,16 +20,31 @@ When you first run the tool it will ask you:
 * If you want to use the default templates
 ** If no, the path to the template erb & css file
 
-These values are then written to a config.yml file. If you run the command it will tell you where the config file is if you want to change it. 
+You can view the current configuration using the config command:
 
+<pre>
+jira-cards config 
+</pre>
 
-h1. Commands
+If you want to change the config, you can use the reset flag:
+
+<pre>
+jira-cards config --reset
+</pre>
 
-The two commands are issues and iteration. For both commands you need to specify the output flag which is the path where you want the output pdf file to go to. 
+h1. Commands
 
 h2. Issues 
 
-You want this command if you want to print specific issues. The only flag is --keys which are the key's of the issues you want. e.g. 
+For printing individual issues.
+
+--output:  The path you want the pdf written to
+
+e.g. c:\foo\bar.pdf
+ 
+--keys: The issue keys you want to print
+
+You can specify individual keys (separated by comma), e.g. 
 
 <pre>
 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
 jira-cards issues --keys foo-4..foo-10 --output c:\temp\test.pdf
 </pre> 
 
+or you could go crazy and have both!
+
+<pre>
+jira-cards issues --keys foo-4..foo-10,foo-14,foo-21..foo-35 --output c:\temp\test.pdf
+</pre> 
+
 h2. Iteration
 
-You want this if you want to get all of the cards for an iteration (or version in jira-speak). The flags are:
+For printing all issues for a team for a specific version.
+
+--output:  The path you want the pdf written to
 
-* --project
-* --version
+e.g. c:\foo\bar.pdf
+ 
+--project: The name of the team
+
+e.g. "Foo Team"
+
+--version: The version you want to print cards from
+
+e.g. "Iteration 30"
 
 <pre>
-jira-cards iteration --project "Some project" --version "Iteration 30" --output c:\temp\test.pdf
+jira-cards iteration --project "Foo Team" --version "Iteration 30" --output c:\temp\test.pdf
 </pre>
 
 h1. Templates
 
-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. If you want to use your own template you can specify the path to your erb template & css file in the initial config. 
+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:
+
+* issue_type: e.g. Story, Bug, Epic
+* summary 
+* key 
+* assignee
+* points 
+* custom fields: all custom fields are available, e.g. "Business value" would be bussiness_value
+
+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

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/application.rb

@@ -10,6 +10,7 @@ end
 c.help do
   $stderr.puts "config: shows the current jira configuration\n\n\t" +
                "[--r|--reset] if this flag is specified, it will reset the configuration\n\n"
+               "[--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"
 
   $stderr.puts "issues: print cards for specific issues\n\n\t" +
                "[--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
 
 c.subcommand Commands do |subcommand|
   if subcommand == :config
-    c.options :reset => true, :r => :reset
+    c.options :reset => true, :r => :reset, :config_path => String, :c => :config_path
   end
   
   if subcommand == :issues

data/lib/commands.rb

@@ -10,7 +10,7 @@ class Commands
 
     def config(options = {})
       if options[:reset] == false
-        Configuration.reset!
+        Configuration.reset!(options[:config_path])
       else
         Configuration.print
       end

data/lib/configuration.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'net/http'
 require 'uri'
+require 'ftools'
 require File.dirname(__FILE__) + '/meta'
 
 class Configuration
@@ -17,9 +18,18 @@ class Configuration
 
   class << self
 
-    def reset!()
-      File.delete(config_path) if File.exists?(config_path)
-      Configuration.new
+    def reset!(path)
+      if path != ""
+        if !File.exists?(path)
+          puts "Config file #{path} does not exist"
+          exit 1
+        end
+        File.delete(config_path) if File.exists?(config_path)
+        File.copy(path, config_path)
+      else
+        File.delete(config_path) if File.exists?(config_path)
+        Configuration.new
+      end
     end
 
     def config_path()

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jira-cards
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - James Hollingworth
@@ -15,11 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-02 00:00:00 +00:00
+date: 2011-01-04 00:00:00 +00:00
 default_executable: jira-cards
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
+  prerelease: false
+  name: soap4r
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,11 +31,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  name: soap4r
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   type: :runtime
+  prerelease: false
+  name: jira4r-jh
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,11 +47,11 @@ dependencies:
         - 3
         - 0
         version: 0.3.0
-  prerelease: false
-  name: jira4r-jh
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   type: :runtime
+  prerelease: false
+  name: pdfkit
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -59,11 +61,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  name: pdfkit
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   type: :runtime
+  prerelease: false
+  name: clint
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -73,11 +75,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  name: clint
   requirement: *id004
 - !ruby/object:Gem::Dependency 
   type: :development
+  prerelease: false
+  name: bundler
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -89,11 +91,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  prerelease: false
-  name: bundler
   requirement: *id005
 - !ruby/object:Gem::Dependency 
   type: :development
+  prerelease: false
+  name: jeweler
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -105,11 +107,11 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  prerelease: false
-  name: jeweler
   requirement: *id006
 - !ruby/object:Gem::Dependency 
   type: :development
+  prerelease: false
+  name: rake
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -119,11 +121,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  name: rake
   requirement: *id007
 - !ruby/object:Gem::Dependency 
   type: :development
+  prerelease: false
+  name: rspec
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -133,11 +135,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  name: rspec
   requirement: *id008
 - !ruby/object:Gem::Dependency 
   type: :development
+  prerelease: false
+  name: ruby-debug
   version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -149,8 +151,6 @@ dependencies:
         - 10
         - 4
         version: 0.10.4
-  prerelease: false
-  name: ruby-debug
   requirement: *id009
 description: You can get individual issues or all issues for an iteration. see --h for more info
 email: jamiehollingworth@gmail.com