ctodo 0.1.0 → 0.1.1

data/README.md

@@ -1,8 +1,20 @@
-todo
-====
+ctodo
+=====
+
+ctodo provides *combined* listing of "issues" or "todos" from different Issue
+Providers (like a Github or Google Code project) with color output support.
+
+The intended use case is that *you* as e.g. a developer have the source code of
+a software project (maybe under version control with Mercurial or Git) located
+in a single root directory and that you want to have an quick overview from
+the command line which issues you have to face in your software.
+
+Another example would be somebody with some documents that belong to a larger
+(maybe academic) project with some "issues" in these documents that he wants
+an overview of via cli.
+
+ctodo is written in Ruby.
 
-todo provides combined listing of "issues" or "todos" from different Issue
-Providers with color support.
 
 Provider
 --------
@@ -10,17 +22,62 @@ Provider
 - LocalFS -- grep-like local file system provider
 - Github -- issues from identically named github.com/<gh_user> repo
 - Google Project Hosting -- issues from identically named code.google.com/p/ project
-- Redmine -- issues from identically named project on your.redmine.com server
+- Redmine -- issues from identically named project on your.redmine.com instance
+
 
 Setup
 -----
 
 	gem install ctodo
 
+
+Basic Usage
+-----------
+
+You are supposed to run ctodo from cli simply via `ctodo`.
+
+Now ctodo will search and list all found issues for your current project.
+
+### How ctodo knows what your "current project" is
+
+There are several automatisms currently built in:
+
+If from the current working directory on any of the parent directories
+contains a *.git* or *.hg* directory this is taken as an indicator that
+this containing directory is the root directory of your project.
+
+If you're not in a Mercurial or Git repository, the current working
+directory is assumed to be the root directory of your project.
+
+The name of the root directory is assumed to be your project's name
+or an appropriate identifier for your project.
+
+### Issue Providers
+
+Without further configuration ctodo will simply search all files and directories
+beneath the root directory recursively line by line for strings like
+
+	TODO: something
+
+or
+
+	XXX fix bug
+
+etc. by using the most basic Issue Provider called `localfs`.
+
+If you decide to give ctodo some hints about where you usually share your
+project's (version controlled) files like your Github account name or the
+credentials to some Redmine instance ctodo will be capable to locate and display
+more issues than from local files: e.g. when you have created a Github
+repository "blub" with attached issues ctodo will assume that these issues
+belong to a project "blub" (located in the root directory "blub") on your
+hard disk and display them accordingly.
+
+
 Template for ~/.todo
 --------------------
 
-	# config for todo
+	# config for ctodo
 	#
 	# If you don't want to use some of these services just
 	# remove the corresponding lines below:
@@ -31,6 +88,7 @@ Template for ~/.todo
 	:red2_uri: <another-redmine-base-uri>
 	:red2_key: <another-redmine-api-key>
 
+
 Links
 -----
 

data/lib/ctodo/localfs.rb

@@ -30,7 +30,12 @@ module CTodo
 				if File.directory?(path) and not File.symlink?(path)
 					traverse(path, issues)
 				elsif File.file?(path)
-					grep_for_todo(path, issues)
+					begin
+						grep_for_todo(path, issues)
+					rescue => e
+						# ignore errors silently
+						#puts "#{path}: #{e}"
+					end
 				end
 			end
 		end
@@ -47,7 +52,7 @@ module CTodo
 					m = line.match("[\\W](#{@todo_labels})\\(([\\w]+)\\):[\\W]+(.*)$")
 					if not m.nil?
 						loc = "#{spath}:#{linenr}"
-						tags = [Tag.new(m[1], tag_color(m[1])), Tag.new(m[2], rgb4string(m[2]))]
+						tags = [Tag.new(m[1], tag_color(m[1])), Tag.new(m[2], ColorUtils.rgb4string(m[2]))]
 						issues << Issue.new(m[3], loc, nil, tags)
 						next
 					end

metadata

@@ -1,73 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ctodo
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70253283514520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: inifile
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70253283514520
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: &70253283513460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70253283513460
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70253283512540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-description: Searches for issues on Github/Google Code/custom Redmine instances/local files for current project or folder.
+  prerelease: false
+  version_requirements: *70253283512540
+description: Searches for issues on Github/Google Code/custom Redmine instances/local
+  files for current project or folder.
 email: chrnicolai@gmail.com
-executables: 
+executables:
 - todo
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - bin/todo
 - lib/ctodo/color.rb
 - lib/ctodo/gcode.rb
@@ -79,36 +63,26 @@ files:
 - .todo
 homepage: https://github.com/cmur2/todo
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: ctodo
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Combined Todo
 test_files: []
-