ctodo 0.0.1

data/README.md

@@ -0,0 +1,24 @@
+todo
+====
+
+todo provides combined listing of "issues" or "todos" from different Issue
+Providers with color support.
+
+Provider
+--------
+
+- LocalFS -- grep-like local file system provider
+- Github -- issues from identically named github.com/user repo
+- Redmine -- issues from identically named your.redmine.com server
+
+Setup
+-----
+
+	gem install ctodo
+
+Links
+-----
+
+- [Github API](http://developer.github.com/v3/)
+- [Redmine API](http://www.redmine.org/projects/redmine/wiki/Rest_api)
+- [HSV color space](https://secure.wikimedia.org/wikipedia/de/wiki/HSV-Farbraum)

data/bin/todo

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'ctodo'
+
+CTodo::Prog.new.run!

data/lib/ctodo/color.rb

@@ -0,0 +1,112 @@
+
+module CTodo
+
+	COLOR_SETS = ['Fg', 'Bg', 'None']
+
+	class ColorSet
+		def rst; "\e[0m" end
+		
+		def demo
+			[:white, :cyan, :magenta, :blue, :yellow, :green, :red, :black].each do |color|
+				puts [self.send(color), color.to_s[0,1].upcase*3, rst].join
+			end
+		end
+	end
+
+	class FgColorSet < ColorSet
+		# only use bold colors (1;) for those on black on white screens
+		def white;  "\e[1;37m" end
+		def cyan;   "\e[1;36m" end
+		def magenta;"\e[1;35m" end
+		def blue;   "\e[1;34m" end
+		def yellow; "\e[1;33m" end
+		def green;  "\e[1;32m" end
+		def red;    "\e[1;31m" end
+		def black;  "\e[1;30m" end
+	end
+
+	class BgColorSet < ColorSet
+		def white;  "\e[47m\e[1;37m" end
+		def cyan;   "\e[46m\e[1;37m" end
+		def magenta;"\e[45m\e[1;37m" end
+		def blue;   "\e[44m\e[1;37m" end
+		def yellow; "\e[43m\e[1;37m" end
+		def green;  "\e[42m\e[1;37m" end
+		def red;    "\e[41m\e[1;37m" end
+		def black;  "\e[40m\e[1;37m" end
+	end
+
+	class NoneColorSet < ColorSet
+		def white; "" end
+		def cyan; "" end
+		def magenta; "" end
+		def blue; "" end
+		def yellow; "" end
+		def green; "" end
+		def red; "" end
+		def black; "" end
+	end
+
+	class ColorUtils
+		
+		def self.func4rgb(rgb, cs)
+			h,s,v = rgb_to_hsv(rgb)
+			
+			if h.nan?
+				return proc { cs.white } if v > 0.5
+				return proc { cs.black }
+			end
+			
+			assoc = [
+				[proc { cs.red }, 0.0],
+				[proc { cs.yellow }, 60.0],
+				[proc { cs.green }, 120.0],
+				[proc { cs.cyan }, 180.0],
+				[proc { cs.blue }, 240.0],
+				[proc { cs.magenta }, 300.0],
+				[proc { cs.red }, 360.0]
+			]
+			
+			dist = 360.0; callee = assoc[0][0]
+			assoc.each do |pair|
+				d = (pair[1]-h).abs
+				if d < dist
+					dist = d
+					callee = pair[0]
+				end
+			end
+			
+			callee
+		end
+		
+		def self.rgb_to_hsv(rgb)
+			r = (rgb & 0xff0000) >> 16
+			g = (rgb & 0xff00) >> 8
+			b = rgb & 0xff
+			r /= 255.0; g /= 255.0; b /= 255.0
+			max = [r,g,b].max; min = [r,g,b].min
+			
+			h = 0 if max == min
+			h = 60*(0+(g-b)/(max-min)) if max == r
+			h = 60*(2+(b-r)/(max-min)) if max == g
+			h = 60*(4+(r-g)/(max-min)) if max == b
+			h += 360 if h < 0
+			
+			s = 0 if max == 0
+			s = (max-min)/max if max != 0
+			
+			[h,s,max]
+		end
+
+		# cyan, magenta, blue, yellow, green, red
+		RAND_COLORS = ['ffffff', '00ffff', 'ff00ff', '0000ff', 'ffff00', '00ff00']
+
+		def self.rgb4string(string)
+			sum = 0
+			string.each_char do |c|
+				sum += c[0] % RAND_COLORS.length
+			end	
+			RAND_COLORS[sum % RAND_COLORS.length]
+		end
+	end
+end

data/lib/ctodo/github.rb

@@ -0,0 +1,93 @@
+
+module CTodo
+	class Github
+		include HTTParty
+		base_uri "https://api.github.com"
+		
+		def initialize(conf)
+			@enabled = (!conf[:gh_user].nil? and !conf[:gh_pass].nil? and !conf[:git_repo_dir].nil?)
+			if @enabled
+				self.class.basic_auth(conf[:gh_user], conf[:gh_pass])
+				@repo_dir = Pathname.new(conf[:git_repo_dir])
+				@repo_name = File.basename(conf[:git_repo_dir])
+			end
+		end
+		
+		def get_issues(issues)
+			return if not @enabled
+			
+			status_msgs = []
+			
+			# try current user first
+			r = self.class.get "/user"
+			login = r['login']
+			
+			gh_issues = get_issues_for(login, @repo_name)
+			if !gh_issues.nil?
+				#status_msgs << "User: #{login}"
+				parse_issues(gh_issues, issues)
+			else
+				# find alternative login from "remote origin" config entry
+				alt_login = remote_login("origin")
+				if !alt_login.nil? and alt_login != login
+					alt_gh_issues = get_issues_for(alt_login, @repo_name)
+					if !alt_gh_issues.nil?
+						status_msgs << "User: #{alt_login}"
+						parse_issues(alt_gh_issues, issues)
+					end
+				end
+			end
+			
+			# optional "upstream"
+			up_login = remote_login("upstream")
+			if !up_login.nil?
+				up_gh_issues = get_issues_for(up_login, @repo_name)
+				if !up_gh_issues.nil?
+					status_msgs << "Up: #{up_login}"
+					parse_issues(up_gh_issues, issues)
+				end
+			end
+			
+			puts status_msgs.join(', ') if not status_msgs.empty?
+		end
+		
+		def get_issues_for(login, repo_name)
+			r = self.class.get "/repos/#{login}/#{repo_name}/issues"
+			return r if r.code == 200
+			nil
+		end
+		
+		def parse_issues(gh_issues, issues)
+			gh_issues.each do |i|
+				loc = i['html_url']
+				assig = (i['assignee'].nil? ? i['user']['login'] : i['assignee']['login'])
+				tags = i['labels'].collect { |lab| Tag.new(lab['name'], lab['color']) }
+				tags << Tag.new(i['milestone']['title'], "000000") if not i['milestone'].nil?
+				issues << Issue.new(i['title'], loc, assig, tags)
+			end
+		end
+		
+		# .git/config parsing
+		
+		def remote_login(name)
+			git_dir = Pathname.new(!ENV['GIT_DIR'].nil? ? ENV['GIT_DIR'] : '.git')
+			# parse ini file
+			git_config = IniFile.new(@repo_dir + git_dir + 'config')
+			origin = find_remote(git_config.sections, name)
+			return nil if origin.nil?
+			origin_url = git_config[origin]['url']
+			return nil if origin_url.nil?
+			m = origin_url.match(/github.com\/([a-zA-Z0-9_-]+)\//)
+			return nil if m.nil?
+			# should be user login
+			m[1]
+		end
+		
+		def find_remote(ini_sections, name)
+			ini_sections.each do |s|
+				return s if s.start_with?("remote") and s.include?(name)
+			end
+			nil
+		end
+	end
+end

data/lib/ctodo/localfs.rb

@@ -0,0 +1,103 @@
+
+module CTodo
+
+	ALL_LABELS = ['BUG', 'FIXME', 'HACK', 'TODO', 'XXX']
+	IMP_LABELS = ['FIXME', 'TODO']
+
+	TRAVERSE_EXCLUDE = ['.', '..', '.git', '.svn', '.hg']
+	GREP_EXT_EXCLUDE = ['.tar']
+
+	class LocalFS
+		def initialize(conf)
+			@enabled = true
+			if @enabled
+				@parent_dir = conf[:git_repo_dir].nil? ? conf[:cur_dir] : conf[:git_repo_dir]
+				@todo_labels = (conf[:all] ? ALL_LABELS : IMP_LABELS).join('|')
+			end
+		end
+
+		def get_issues(issues)
+			return if not @enabled
+			traverse(@parent_dir, issues)  
+		end
+		
+		def traverse(dir, issues)
+			Dir.entries(dir).each do |e|
+				next if TRAVERSE_EXCLUDE.include?(e)
+				path = File.join(dir, e)
+				# grep symlinked files but don't follow symlinked
+				# directories
+				if File.directory?(path) and not File.symlink?(path)
+					traverse(path, issues)
+				elsif File.file?(path)
+					grep_for_todo(path, issues)
+				end
+			end
+		end
+		
+		def grep_for_todo(path, issues)
+			GREP_EXT_EXCLUDE.each do |e|
+				return if path.end_with?(e)
+			end
+			cf = CommentFilter.new(path)
+			spath = remove_common_path(path)
+			File.open(path, 'r') do |f|
+				linenr = 1
+				f.readlines.map {|line| cf.filter(line)}.each do |line|
+					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]))]
+						issues << Issue.new(m[3], loc, nil, tags)
+						next
+					end
+					m = line.match("[\\W](#{@todo_labels}):[\\W]+(.*)$")
+					if not m.nil?
+						loc = "#{spath}:#{linenr}"
+						issues << Issue.new(m[2], loc, nil, Tag.new(m[1], tag_color(m[1])))
+						next
+					end
+					m = line.match("[\\W](#{@todo_labels})[\\W]+(.*)$")
+					if not m.nil?
+						loc = "#{spath}:#{linenr}"
+						issues << Issue.new(m[2], loc, nil, Tag.new(m[1], tag_color(m[1])))
+					end
+					linenr += 1
+				end
+			end
+		end
+		
+		def remove_common_path(file)
+			begin
+				return Pathname.new(file).relative_path_from(Pathname.new(Dir.getwd))
+			rescue ArgumentError => e
+				return file
+			end
+		end
+		
+		def tag_color(title)
+			case title
+			when 'BUG'
+				color = "ff0000"
+			else
+				color = "ffffff"
+			end
+		end
+	end
+
+	class CommentFilter
+		def initialize(path)
+			@comment_char = '#' if path.end_with?('.rb')
+		end
+		
+		# TODO: build comment filter
+		def filter(line)
+			# disable it for now
+			line
+#			return line if @comment_char.nil? or line.nil?
+#			i = line.index(@comment_char)
+#			return '' if i.nil?
+#			line[i, line.length-i]
+		end
+	end
+end

data/lib/ctodo/redmine.rb

@@ -0,0 +1,60 @@
+
+module CTodo
+	# needs Redmine 1.1 at least
+	class Redmine
+		include HTTParty
+
+		def initialize(conf, prefix = 'red')
+			red_uri = conf[:"#{prefix}_uri"]
+			red_key = conf[:"#{prefix}_key"]
+			@enabled = (!red_uri.nil? and !red_key.nil? and !conf[:git_repo_dir].nil?)
+			if @enabled
+				self.class.base_uri(red_uri)
+				rand_pwd = (0...8).map {65.+(rand(25)).chr}.join
+				self.class.basic_auth(red_key, rand_pwd)
+				@repo = File.basename(conf[:git_repo_dir])
+				# HACK: 1000 should really be enough
+				@limit = (conf[:all] ? 1000 : 25)
+			end
+		end
+		
+		def get_issues(issues)
+			return if not @enabled
+			
+			# all projects
+			r = self.class.get "/projects.json"
+			return if r.code != 200
+			
+			# get id for matching project identifier (not name!)
+			p_id = find_id_for_identifier(r['projects'], @repo)
+			return if p_id == nil
+			
+			r = self.class.get "/issues.json?project_id=#{p_id}&offset=0&limit=#{@limit}"
+			
+			r['issues'].each do |i|
+				loc = "#{self.class.base_uri}/issues/#{i['id']}"
+				if i['assigned_to'].nil?
+					assig = nil
+				else
+					assig = i['assigned_to']['name']
+					# BUG: missing login attribute in API, http://www.redmine.org/projects/redmine/wiki/Rest_Users
+					#u_id = i['assigned_to']['id']
+					#r2 = self.class.get "/users/#{u_id}.xml"
+					#assig = r2['user']['login']
+				end
+				tags = []
+				tags << Tag.new(i['tracker']['name'], "ffffff") if not i['tracker'].nil?
+				tags << Tag.new(i['category']['name'], ColorUtils.rgb4string(i['category']['name'])) if not i['category'].nil?
+				tags << Tag.new(i['fixed_version']['name'], "000000") if not i['fixed_version'].nil?
+				issues << Issue.new(i['subject'], loc, assig, tags)
+			end
+		end
+		
+		def find_id_for_identifier(projects, ident)
+			projects.each do |p|
+				return p['id'] if ident == p['identifier']
+			end
+			nil
+		end
+	end
+end

data/lib/ctodo.rb

@@ -0,0 +1,161 @@
+
+require 'optparse'
+require 'pathname'
+
+# ruby gem dependencies
+require 'httparty'
+require 'inifile'
+require 'json'
+
+# ctodo
+require 'ctodo/color'
+require 'ctodo/localfs'
+require 'ctodo/github'
+require 'ctodo/redmine'
+
+class Integer
+	def clamp(min, max)
+		return min if self < min
+		return max if self > max
+		self
+	end
+end
+
+module Enumerable
+	def median
+		sorted = self.sort
+		sorted[self.length/2]
+	end
+	
+	def sum
+		self.inject(0) { |sum,v| sum + v }
+	end
+	
+	def avg
+		(length == 0) ? 0 : (sum * 1.0 / length)
+	end
+end
+
+module CTodo
+	class Tag
+		attr_reader :title, :color
+		
+		def initialize(title, color)
+			@title = title
+			@color = color.to_i(16)
+		end
+	end
+
+	class Issue
+		attr_reader :title, :source, :assignee, :tags
+		
+		def initialize(title, source, assignee, tags)
+			@title = title
+			@source = source
+			@assignee = assignee
+			@tags = tags.is_a?(Array) ? tags : [tags]
+		end
+	end
+
+	class Prog
+		TPAD_FAC = 7
+		MIN_TPAD = TPAD_FAC*3
+		MAX_TPAD = TPAD_FAC*8
+		
+		def run!
+			@options = {
+				:cs => COLOR_SETS[0],
+				:limit_text => false,
+				:show_source => false,
+				:show_assignee => false
+			}
+			
+			@opts = OptionParser.new do |opts|
+				opts.banner =  "Usage: todo.rb [options]"
+				opts.banner += "\nOptions:\n"
+				
+				opts.on('--all', 'Show all todos (some providers limit to a reasonable number)') do @options[:all] = true end
+				opts.on('-l', '--limit-text', 'Limit todo text to fixed width') do @options[:limit_text] = true end
+				opts.on('-s', '--source', 'Show source of todos') do @options[:show_source] = true end
+				opts.on('-a', '--assignee', 'Show assignee of todos (when present)') do @options[:show_assignee] = true end
+				opts.on('-u CREDS', '--gh-user CREDS', 'Specify github credentials as USER:PASS') do |u| @options[:gh_creds] = u end
+				opts.on('-c CS', '--color-set CS', COLOR_SETS, "There are: #{COLOR_SETS.join(', ')}") do |cs|
+					@options[:cs] = cs if ['Fg', 'Bg', 'None'].include?(cs)
+				end
+				opts.on('-h', '-?', '--help', 'Display this screen') do
+					puts opts
+					exit
+				end
+			end
+			@opts.parse!
+			
+			conf = load_config(File.join(ENV['HOME'], '.todo'))
+			
+			conf[:cur_dir] = Dir.getwd
+			conf[:git_repo_dir] = find_git_repo(Dir.getwd)
+			conf[:all] = @options[:all]
+			conf[:cs] = CTodo.const_get("#{@options[:cs]}ColorSet").new
+			
+			ip = [LocalFS.new(conf), Github.new(conf), Redmine.new(conf), Redmine.new(conf, 'red2')]
+			
+			issues = []
+			ip.each do |ip| ip.get_issues(issues) end
+			
+			# calculate text spacing
+			if @options[:limit_text]
+				title_padding = MAX_TPAD
+			elsif issues.empty?
+				title_padding = MIN_TPAD
+			else
+				title_lens = issues.map { |i| i.title.length }
+				max_title_len = [title_lens.avg, title_lens.median].max
+				title_padding = (((max_title_len/TPAD_FAC.to_f).ceil)*TPAD_FAC).to_i.clamp(MIN_TPAD,MAX_TPAD)
+			end
+			
+			issues.each do |i|
+				if @options[:limit_text] and i.title.length > title_padding
+					title = i.title[0,title_padding-3] + '...'
+				else
+					title = i.title
+				end
+				
+				tag_list = i.tags.map { |t|
+					[ColorUtils.func4rgb(t.color, conf[:cs]).call, t.title, conf[:cs].rst].join
+				}
+				tag_list.push "@#{i.assignee}" if @options[:show_assignee] and not i.assignee.nil?
+				tag_list = (tag_list.empty? ? '' : format('(%s) ', tag_list.join(', ')))
+				
+				if @options[:show_source]
+					puts format("- %-#{title_padding}s %sin %s",
+						title, tag_list, i.source)
+				else
+					puts format("- %-#{title_padding}s %s",
+						title, tag_list)
+				end
+			end
+		end
+		
+		def load_config(config_file)
+			conf = {}
+			if File.exists?(config_file)
+				conf.merge!(YAML.load_file(config_file))
+			end
+			if @options.key?(:gh_creds)
+				u,p = @options[:gh_creds].split(':')
+				conf.merge!({:gh_user => u, :gh_pass => p})
+			end
+			conf
+		end
+		
+		def find_git_repo(path)
+			git_dir = Pathname.new(!ENV['GIT_DIR'].nil? ? ENV['GIT_DIR'] : '.git')
+			p = Pathname.new(path)
+			until p.root?
+				git_dir = p + git_dir
+				return p.to_s if git_dir.exist? and git_dir.directory?
+				p = p.parent
+			end
+			nil
+		end
+	end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: ctodo
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Christian Nicolai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: inifile
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: ""
+email: chrnicolai@gmail.com
+executables: 
+- todo
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/todo
+- lib/ctodo/color.rb
+- lib/ctodo/github.rb
+- lib/ctodo/localfs.rb
+- lib/ctodo/redmine.rb
+- lib/ctodo.rb
+- README.md
+homepage: https://github.com/cmur2/todo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ctodo
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Combined Todo
+test_files: []
+