toadie 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +18 -0
- data/.rvmrc +1 -0
- data/.travis.yml +10 -0
- data/Gemfile +4 -0
- data/LICENSE +22 -0
- data/README.md +83 -0
- data/Rakefile +10 -0
- data/assets/bootstrap.min.css +558 -0
- data/assets/bootstrap.min.js +7 -0
- data/assets/jquery-1.8.2.min.js +2 -0
- data/assets/toadie.css +3 -0
- data/bin/toadie +28 -0
- data/lib/toadie/blame.rb +27 -0
- data/lib/toadie/configuration.rb +33 -0
- data/lib/toadie/report.rb +18 -0
- data/lib/toadie/todo.rb +37 -0
- data/lib/toadie/todolist.rb +17 -0
- data/lib/toadie/version.rb +3 -0
- data/lib/toadie.rb +19 -0
- data/spec/author_spec.rb +88 -0
- data/spec/blame_spec.rb +25 -0
- data/spec/spec_helper.rb +18 -0
- data/spec/todo_spec.rb +39 -0
- data/spec/todolist_spec.rb +26 -0
- data/toadie.gemspec +24 -0
- data/views/report.slim +93 -0
- metadata +163 -0
data/.gitignore
ADDED
data/.rvmrc
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
rvm 1.9.3@toadie --create
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2012 Johannes Opper
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
# Toadie
|
2
|
+
|
3
|
+
Toadie greps your (ruby) source code for TODO tags and associate them with your team members.
|
4
|
+
|
5
|
+
It's meant to be part of a CI process, so everyone should be able to find her/his open TODOs.
|
6
|
+
|
7
|
+
![toadie build status][1]
|
8
|
+
|
9
|
+
[1]:http://travis-ci.org/xijo/toadie.png
|
10
|
+
|
11
|
+
## Features
|
12
|
+
|
13
|
+
- grep rb, erb, haml, slim and feature files
|
14
|
+
- uses git blame to find the author
|
15
|
+
- configurable author tags associate TODO with persons in duty
|
16
|
+
- provides html report
|
17
|
+
|
18
|
+
## Installation
|
19
|
+
|
20
|
+
Add this line to your application's Gemfile:
|
21
|
+
|
22
|
+
gem 'toadie', require: false
|
23
|
+
|
24
|
+
And then execute:
|
25
|
+
|
26
|
+
$ bundle
|
27
|
+
|
28
|
+
## Usage
|
29
|
+
|
30
|
+
Just run toadie in the root of your application:
|
31
|
+
|
32
|
+
$ toadie
|
33
|
+
|
34
|
+
It will produce the html output into a folder called 'toadie', having a index.html file in there:
|
35
|
+
|
36
|
+
$ open toadie/index.html
|
37
|
+
|
38
|
+
## Configure team members
|
39
|
+
|
40
|
+
By default you will not need to configure anything. Toadie will detect authors by using git and display TODOs accordingly.
|
41
|
+
|
42
|
+
However, to have multiple mail addresses or assignment tags for each team member create a `.toadie.json` file.
|
43
|
+
|
44
|
+
You can specify team members like this:
|
45
|
+
|
46
|
+
```json
|
47
|
+
{
|
48
|
+
"authors": [
|
49
|
+
{
|
50
|
+
"name": "Jean-Luc Picard",
|
51
|
+
"emails": ["jean-luc@tenforward.com", "picard@uss-enterprise.com"],
|
52
|
+
"nicknames": ["captain", "picard", "jean-luc"]
|
53
|
+
},
|
54
|
+
{
|
55
|
+
"name": "William T. Riker",
|
56
|
+
"emails": ["riker@uss-enterprise.com"],
|
57
|
+
"nicknames": ["riker", "will", "no1"]
|
58
|
+
}
|
59
|
+
]
|
60
|
+
}
|
61
|
+
```
|
62
|
+
|
63
|
+
The given nicknames will be used to find TODOs assigned to this person. For example Picard writes:
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
# TODO no1 meet me in my room
|
67
|
+
```
|
68
|
+
|
69
|
+
The TODO will be assigned to Riker.
|
70
|
+
|
71
|
+
|
72
|
+
## Contributing
|
73
|
+
|
74
|
+
1. Fork it
|
75
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
76
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
77
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
78
|
+
5. Create new Pull Request
|
79
|
+
|
80
|
+
## Todos (haha)
|
81
|
+
|
82
|
+
1. Add customizable file endings to the configuration
|
83
|
+
2. Make output directory/format configurable
|
data/Rakefile
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
require "bundler/gem_tasks"
|
3
|
+
require 'rspec/core/rake_task'
|
4
|
+
RSpec::Core::RakeTask.new(:spec)
|
5
|
+
task :default => :spec
|
6
|
+
|
7
|
+
desc "Open an irb session preloaded with this library"
|
8
|
+
task :console do
|
9
|
+
sh "irb -rubygems -I lib -r toadie.rb"
|
10
|
+
end
|