toadie 0.0.5 → 0.0.6

data/README.md

@@ -33,9 +33,11 @@ It will produce the html output into a folder called 'toadie', having a index.ht
 
     $ open toadie/index.html
 
-## Configure team members
+## Configuration
 
-By default you will not need to configure anything. Toadie will detect authors by using git and display TODOs accordingly.
+### Configure team members
+
+By default you will not need to configure any team members. Toadie will detect authors by using git and display TODOs accordingly.
 
 However, to have multiple mail addresses or assignment tags for each team member create a `.toadie.json` file.
 
@@ -66,6 +68,17 @@ The given nicknames will be used to find TODOs assigned to this person. For exam
 
 The TODO will be assigned to Riker.
 
+### Configure file extensions
+
+By default toadie will try to find any TODOs in the given directory. Sometimes it might be helpful to reduce this search to files with a specific file ending. This can be done by setting the `file_extensions` configuration option:
+
+```json
+{
+  "file_extensions": ["rb", "js", "py"]
+}
+```
+
+This example will only search for ruby, python and javascript files and skips e.g. log files.
 
 ## Contributing
 
@@ -77,10 +90,9 @@ The TODO will be assigned to Riker.
 
 ## Todos (haha)
 
-1. Add customizable file endings to the configuration
-2. Make output directory/format configurable
-3. Do a little benchmarking and profiling
-4. Refine descriptions and texts
-5. Detect multiline TODOs
-6. Support more languages
-7. Link source to github
+1. Make output directory/format configurable
+2. Do a little benchmarking and profiling
+3. Refine descriptions and texts
+4. Detect multiline TODOs
+5. Support more languages
+6. Link source to github

data/bin/toadie

@@ -19,10 +19,13 @@ end
 
 config_file = opts[:config] || File.join(Toadie.root, '.toadie.json')
 if File.exist?(config_file)
-  config = JSON.parse(File.read(config_file))
+  config                 = JSON.parse(File.read(config_file))
+  Toadie.file_extensions = config["file_extensions"]
+  Toadie.todo_markers    = config["todo_markers"]
+
   Array(config["authors"]).each do |attributes|
     Toadie::Author.create(attributes)
   end
 end
 
-Toadie::Run.new.start
+Toadie::Run.new.start

data/spec/configuration_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Toadie::Configuration do
+  let(:config) { 'foo'.extend(Toadie::Configuration) }
+
+  describe "#todo_markers" do
+    it "returns default todo markers if nothing was provided" do
+      config.todo_markers.should eq Toadie.default_todo_markers
+    end
+
+    it "returns custom todo markers if provided" do
+      config.todo_markers = [:foo, :bar]
+      config.todo_markers.should eq [:foo, :bar]
+    end
+  end
+end

data/views/CHANGES.md

@@ -0,0 +1,2 @@
+2013-03-09
+  Added file type extension configuration option.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toadie
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -125,10 +125,12 @@ files:
 - lib/toadie/version.rb
 - spec/author_spec.rb
 - spec/blame_spec.rb
+- spec/configuration_spec.rb
 - spec/spec_helper.rb
 - spec/todo_spec.rb
 - spec/todolist_spec.rb
 - toadie.gemspec
+- views/CHANGES.md
 - views/report.slim
 homepage: http://github.com/xijo/toadie
 licenses: []
@@ -144,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 24252476223764722
+      hash: 2154824783258185228
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 24252476223764722
+      hash: 2154824783258185228
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -163,6 +165,7 @@ summary: Analyze your source code, find open todos and output a nice html report
 test_files:
 - spec/author_spec.rb
 - spec/blame_spec.rb
+- spec/configuration_spec.rb
 - spec/spec_helper.rb
 - spec/todo_spec.rb
 - spec/todolist_spec.rb