schubert-minglr 0.1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/README.rdoc +102 -0
  2. data/Rakefile +29 -0
  3. data/minglr.gemspec +11 -0
  4. data/minglrconfig.sample +18 -0
  5. metadata +58 -0
data/README.rdoc ADDED
@@ -0,0 +1,102 @@
1
+ = minglr
2
+
3
+ * http://github.com/stephenchu/minglr/tree/master
4
+
5
+ == DESCRIPTION:
6
+
7
+ * This gem provides two executable binaries to interact with Mingle (http://mingle.thoughtworks.com/mingle-agile-project-management) through its API. It also has sample interactive Rake task on how to facilitate easy card movements when a card enters/exits the development queue.
8
+
9
+ * mtx is a binary that facilities transition changes for use on rake tasks
10
+ * minglr is a more interactive tool that provides a quick interface for many common uses
11
+
12
+ == MINGLR FEATURES:
13
+ * lists cards
14
+ $ minglr cards
15
+ 266 - Task - Development Complete - Investigate new tool
16
+ 265 - Defect - New - The background is the wrong color
17
+
18
+ * list users
19
+ $ minglr users
20
+ schubert - Michael Schubert - michael@yourcompany.com
21
+
22
+ * list all cards with the word "foo"
23
+ $ minglr cards foo
24
+
25
+ * list details for card 215
26
+ $ minglr card 215
27
+ Number: 215
28
+ Name: Add the frobble to the bobble
29
+ Type: Story
30
+ Status: In Development
31
+ Description: Lorem Ipsum
32
+
33
+ * create new story card
34
+ $ minglr create -t Story -n "My New Story" -d "Story Description"
35
+ Created story card 271
36
+
37
+ * update a card
38
+ $ minglr update 271 -d "Bettter Description"
39
+ Card 271 updated
40
+
41
+ Number: 271
42
+ Name: Add the frobble to the bobble
43
+ Type: Task
44
+ Status: Ready for Development
45
+ Description: Better Description
46
+
47
+ * move card based on defined transitions
48
+ $ minglr move 266 -c "All done with development"
49
+ Moved card from In Development to Dev Complete
50
+
51
+ == MTX FEATURES:
52
+
53
+ * Executes a card transition through the Mingle API.
54
+ * Caches user-entered information during Rake task execution.
55
+ * SVN Rake tasks to perform update, remove, add, and conflict check.
56
+ * Sample Rake tasks to illustrate a single Rake command line that will grab latest changes, check for conflicts, run tests, check-in, and finally move card on Mingle.
57
+
58
+ == SYNOPSIS:
59
+
60
+ Do you forget to update a story card on Mingle when the card has moved into developers' hands? How about forgetting to update the story card to kick-off its sign off process when story is completed? If we let these sloppiness happen too often, communication flow will be hindered, and the time it takes to provide business value through story completions will be lengthened. Fortunately, Minglr can help.
61
+
62
+ Minglr allows you to write Rake tasks to execute Mingle card transitions as part of your build process. For example, for a developer to check-in new code, s/he could run the following Rake task:
63
+
64
+ $ rake check_in
65
+
66
+ At the end of this Rake task, it can execute a Mingle API call through the help of Minglr to execute the appropriate transition for the card being worked on, be it to move a card into 'In Development', or mark it as 'Story Completed'.
67
+
68
+ Of course, frequently additional user inputs are required to transition a card. For example, a card number and a comment. Minglr also provides Rake helpers to easily prompt users for inputs as part of their Rake runs, as well as caching them to save future typings.
69
+
70
+ Minglr can be used regardless your application is a Ruby on Rails web application or a simple Ruby application. In fact, it can even be used as a command line tool to transition cards on Mingle.
71
+
72
+ == INSTALL:
73
+
74
+ * sudo gem install stephenchu-minglr
75
+ * Preferably install rb-password (http://www.caliban.org/ruby/ruby-password.shtml), through Macports (sudo port install rb-password)
76
+ * Enable Mingle API basic authentication in auth_config.yml, then restart it.
77
+ * Copy over the "path-to-minglr/tasks/*.sample.rake" files and start customizing for your check-in needs.
78
+
79
+ == LICENSE:
80
+
81
+ (The MIT License)
82
+
83
+ Copyright (c) 2009 Stephen Chu
84
+
85
+ Permission is hereby granted, free of charge, to any person obtaining
86
+ a copy of this software and associated documentation files (the
87
+ 'Software'), to deal in the Software without restriction, including
88
+ without limitation the rights to use, copy, modify, merge, publish,
89
+ distribute, sublicense, and/or sell copies of the Software, and to
90
+ permit persons to whom the Software is furnished to do so, subject to
91
+ the following conditions:
92
+
93
+ The above copyright notice and this permission notice shall be
94
+ included in all copies or substantial portions of the Software.
95
+
96
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
97
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
98
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
99
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
100
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
101
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
102
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/Rakefile ADDED
@@ -0,0 +1,29 @@
1
+ %w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
2
+ require File.dirname(__FILE__) + '/lib/minglr'
3
+
4
+ # Generate all the Rake tasks
5
+ # Run 'rake -T' to see list of generated tasks (from gem root directory)
6
+ $hoe = Hoe.new('minglr', Minglr::VERSION) do |p|
7
+ p.developer('Stephen Chu', 'minglr@stephenchu.com')
8
+ p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
9
+ p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
10
+ p.rubyforge_name = p.name # TODO this is default value
11
+ p.extra_deps = [
12
+ ['activesupport','>= 2.1.0'],
13
+ ['activeresource', '>= 2.1.0']
14
+ ]
15
+ p.extra_dev_deps = [
16
+ ['newgem', ">= #{::Newgem::VERSION}"]
17
+ ]
18
+
19
+ p.clean_globs |= %w[**/.DS_Store tmp *.log]
20
+ path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
21
+ p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
22
+ p.rsync_args = '-av --delete --ignore-errors'
23
+ end
24
+
25
+ require 'newgem/tasks' # load /tasks/*.rake
26
+ Dir['tasks/**/*.rake'].each { |t| load t }
27
+
28
+ # TODO - want other tests/tasks run by default? Add them to the list
29
+ # task :default => [:spec, :features]
data/minglr.gemspec ADDED
@@ -0,0 +1,11 @@
1
+ Gem::Specification.new do |s|
2
+ s.name = "minglr"
3
+ s.version = "0.1.0.2"
4
+ s.date = "2009-05-20"
5
+ s.summary = "Consists of Rake task helpers and a command line utility to help transitioning story cards on Mingle through the Mingle API. Plugs right into your routine \"test > code > check-in > move card\" build process."
6
+ s.email = "github@stephenchu.com"
7
+ s.homepage = "http://github.com/stephenchu/minglr/tree/master"
8
+ s.description = "Do you forget to update a story card on Mingle when the card has moved into developers' hands? How about forgetting to update the story card to kick-off its sign off process when story is completed? If we let these sloppiness happen too often, communication flow will be hindered, and the time it takes to provide business value through story completions will be lengthened. Fortunately, Minglr can help."
9
+ s.authors = ["Stephen Chu", "Chris O'Meara", "Michael Schubert"]
10
+ s.files = Dir["bin/*"] + Dir["*.txt"] + Dir["lib/minglr/*.rb"] + Dir["lib/*.rb"] + ["minglr.gemspec", "Rakefile", "README.rdoc", "minglrconfig.sample"] + Dir["tasks/*"]
11
+ end
@@ -0,0 +1,18 @@
1
+ [global]
2
+ default = someproject
3
+ username = yourusername
4
+
5
+ [someproject]
6
+ url = http://your.mingle.host.com/mingle/projects/someproject
7
+ username = yourusername
8
+ password = YOURMINGLEPASSWORD
9
+ delete_property = cp_story_status
10
+ delete_state = Deleted
11
+ status_property = cp_story_status
12
+ story_state_1 = Ready For Development > Sign Up for Story
13
+ story_state_2 = Dev In Progress > Dev Complete
14
+ task_state_1 = New > New to ready for Dev for Task
15
+ task_state_2 = Ready for Development > Dev in Progress
16
+ task_state_3 = Dev In Progress > Story from Dev in Progress to Dev Complete
17
+ story_checkout = story_state_1
18
+ task_checkout = story_state_2
metadata ADDED
@@ -0,0 +1,58 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: schubert-minglr
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0.2
5
+ platform: ruby
6
+ authors:
7
+ - Stephen Chu
8
+ - Chris O'Meara
9
+ - Michael Schubert
10
+ autorequire:
11
+ bindir: bin
12
+ cert_chain: []
13
+
14
+ date: 2009-05-20 00:00:00 -07:00
15
+ default_executable:
16
+ dependencies: []
17
+
18
+ description: Do you forget to update a story card on Mingle when the card has moved into developers' hands? How about forgetting to update the story card to kick-off its sign off process when story is completed? If we let these sloppiness happen too often, communication flow will be hindered, and the time it takes to provide business value through story completions will be lengthened. Fortunately, Minglr can help.
19
+ email: github@stephenchu.com
20
+ executables: []
21
+
22
+ extensions: []
23
+
24
+ extra_rdoc_files: []
25
+
26
+ files:
27
+ - minglr.gemspec
28
+ - Rakefile
29
+ - README.rdoc
30
+ - minglrconfig.sample
31
+ has_rdoc: false
32
+ homepage: http://github.com/stephenchu/minglr/tree/master
33
+ post_install_message:
34
+ rdoc_options: []
35
+
36
+ require_paths:
37
+ - lib
38
+ required_ruby_version: !ruby/object:Gem::Requirement
39
+ requirements:
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: "0"
43
+ version:
44
+ required_rubygems_version: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: "0"
49
+ version:
50
+ requirements: []
51
+
52
+ rubyforge_project:
53
+ rubygems_version: 1.2.0
54
+ signing_key:
55
+ specification_version: 2
56
+ summary: Consists of Rake task helpers and a command line utility to help transitioning story cards on Mingle through the Mingle API. Plugs right into your routine "test > code > check-in > move card" build process.
57
+ test_files: []
58
+