codetip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 932c7adb27dfce4b897e89aa2f9cceb52f53b0b63081097b503e59e24dce949d10fa3ea6d6309f0722d7625ebd4f493e2330d2423c8a4c09d64e26febd838511
+  data.tar.gz: 137dc195207ec6f2d7aa1f37934eaf5ceb7687cc6bc87fdc117158ec111dbd3f5b144db995f4dd5b9130680ec5787e247b2ec1fc87145b3c360d5fc1164c2090
+SHA1: 
+  metadata.gz: ce4611e3690f82ba65441a14886b869e3c8906d2
+  data.tar.gz: 504664439222ee8c48b3f01042cefd5fc1d01e41

data/bin/codetip

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# for testing from bin
+def fallback_load_path(path)
+	retried = false
+	begin
+		yield
+	rescue LoadError
+		unless retried
+			$: << path
+			retried = true
+			retry
+		end
+		raise
+	end
+end
+fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
+	require 'codetip/app/commander'
+end
+
+com = Codetip::Commander.new
+com.run(ARGV);

data/lib/codetip/app.rb

@@ -0,0 +1,32 @@
+module Codetip
+	class App
+		def parse(path, restrict = '*', user = nil)
+			result = {}
+			Dir.glob(path + '/**/' + restrict) do |filename|
+				if File.file?(filename)
+					comments = {}
+					lineNumber = 1
+					File.readlines(filename).each do |line|
+						if line.match(/\[(todo|warning|review)\](\s*[:-]+\s*(.+))$/i)
+							type = $1.downcase
+							message = $3
+							next if (!user.nil? && !line.downcase.match(Regexp.new('@('+user.downcase + '|all)')))
+							(comments[type] ||= []) << {
+								:line => lineNumber,
+								:message => message
+							}
+						end
+						lineNumber += 1
+					end
+					if (comments.count > 0)
+						result[filename] = comments
+					end
+				end
+			end
+			return result
+		end
+	end
+end
+
+
+

data/lib/codetip/app/commander.rb

@@ -0,0 +1,87 @@
+require 'codetip/app'
+
+class String
+	def black;          "\033[30m#{self}\033[0m" end
+	def red;            "\033[31m#{self}\033[0m" end
+	def green;          "\033[32m#{self}\033[0m" end
+	def blue;           "\033[34m#{self}\033[0m" end
+	def gray;           "\033[37m#{self}\033[0m" end
+	def bold;           "\033[1m#{self}\033[22m" end
+	def highlightMessage
+		self.gsub(/(@\w+)/, '\1'.bold)
+	end
+end
+
+module Codetip
+	class Commander < App
+		def run(argv = ARGV)
+			begin
+				opts = {}
+				if argv.length > 0
+					loop {
+						case argv[0]
+							# -h or --help
+							when /^-(h|-help)$/i then
+								argv.shift
+								
+								puts "Usage: codetip [options] <location>"
+								puts
+								puts "Options:"
+								puts "\t-h, --help\tDisplays what you are looking at"
+								puts "\t-r, --restrict\tRestrict file search. e.g, '.js' or '*.{js,cpp}'"
+								puts "\t-u, --username\tOnly display comments mentioning username"
+								puts
+								puts "Example:"
+								puts "\tcodetip --user='kurt_wagner' -r '*.{js,pl}' ~/path/to/project"
+								puts
+								
+								return
+								
+							# -r or --restrict
+							when /^-(r|-opts[:restrict])(=(.+))?$/i then
+								if !$3.nil?
+									opts[:restrict] = $3
+									argv.shift
+								else
+									argv.shift
+									opts[:restrict] = argv.shift
+								end
+							# -u or --username
+							when /^-(u|-username)(=(.+))?$/i then
+								if !$3.nil?
+									opts[:username] = $3
+									argv.shift
+								else
+									argv.shift
+									opts[:username] = argv.shift
+								end
+							# other unknown options
+							when /^-/ then
+								puts "Unknown option: #{argv.shift}"
+							else
+								# remove any trailing forward slashes from directory
+								directory = argv.shift
+								opts[:path] = directory.gsub(/\/+$/, '') if !directory.nil?
+								break
+						end
+					}
+				end
+				
+				parse(opts[:path] || '.', opts[:restrict] || "*", opts[:username]).each do |filename, types|
+					puts filename.red.bold;
+					types.each do |type, comments|
+						if comments.count > 0
+							puts "[ #{type.upcase} ]".blue.bold
+							comments.each do |comment|
+								puts "  Line #{comment[:line]} - ".gray + comment[:message].highlightMessage
+							end
+							puts
+						end
+					end
+				end
+			rescue Exception => e  
+				puts e.message
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: codetip
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kurt Wagner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-11-24 00:00:00 Z
+dependencies: []
+
+description: Generate a summary of a projects comments.
+email: krw521@uowmail.edu.au
+executables: 
+- codetip
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/codetip/app.rb
+- lib/codetip/app/commander.rb
+- bin/codetip
+homepage: http://rubygems.org/gems/codetip
+licenses: 
+- GPL-2
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id001 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id001
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Code Summary Generator
+test_files: []
+