whatToDo 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pike.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    whatToDo (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  colored
+  rake
+  whatToDo!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Benjamin Kammerl aka phortx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# WhatToDo
+
+As a developer you probably know that situation: You've been hacking in a project for some weeks and suddenly you're stuck or don't have any time to complete or have to stop developing for some other reason. The project stays untouched in the git repository and is idling. Dome weeks or months or even years later you want to get back in the project and finish it or fix a bug or somethine like that. But you don't know were the fuck you have quit the work in the project and have no idea what to do next.
+
+The same issue occurs if you're joining a new project or want to start to contribute to an OpenSource project. You have no idea where to start.
+
+WhatToDo is a tool which aims to help you over that obstacle, by analysing your project and telling you what you can do. It gives you concrete todos to help you to get startet with the project and get back into it.
+
+Works for ruby projects only currently.
+
+![screenshot](https://raw.github.com/phortx/WhatToDo/master/screenshot.png)
+
+
+(And this gem is under heavy development currently. Contributions are welcome.)
+
+
+# Dependencies
+You just need at least ruby 1.9.3 installed.
+
+
+# Installation
+	gem install WhatToDo
+
+
+# Usage
+Just run <code>whatToDo</code> in your project root.
+
+
+# License
+The MIT License (MIT)
+
+Copyright (c) 2013 Benjamin Kammerl aka phortx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/whatToDo

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'whatToDo'

data/lib/whatToDo.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'optparse'
+require 'colored'
+require 'whatToDo/util'
+require 'whatToDo/check_manager'
+require 'whatToDo/facet_analyzer'
+
+
+# Command line options
+options = {
+	debug: true,
+}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = 'Usage: whatToDo [OPTIONS]'
+  opt.separator ''
+  opt.separator 'Options'
+
+  opt.on('-d', '--debug', 'Enable stacktrace output.') do
+    options[:debug] = true
+  end
+
+  opt.on('-h', '--help', 'help') do
+    puts opt_parser
+  end
+end
+
+opt_parser.parse!
+
+
+# Init the facet analyser and run it so we know what project we have here.
+facet_analyzer = WhatToDo::FacetAnalyzer.new
+facets = facet_analyzer.facets
+
+
+# Init the check manager and run all checks
+check_manager = WhatToDo::CheckManager.new(facets)
+check_results = check_manager.run_checks(10)
+
+
+# Show the facets
+puts
+puts 'Project facets: '.bold.white
+puts '  ' + facets.map{ |f| f.to_s }.join(', ')
+puts
+
+
+# If it's a git project, display the last commit messages and the last changed files
+if facets.include?(:git)
+  puts 'Last commits:'.bold.white
+  puts indent(`git log -5 --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative`, 2)
+  puts
+
+  puts 'Last changed files:'.bold.white
+  puts indent(`git diff $(git log -5 --format=%H | tail -n1).. --stat`, 1)
+  puts
+end
+
+
+# Print the result
+if check_results.length > 0
+  puts 'Suggested todo:'.bold.white
+  puts '  ' + check_results.sample
+else
+  puts 'Nothing to do here!'.green
+end

data/lib/whatToDo/check/bootstrap.rb

@@ -0,0 +1,7 @@
+check do
+  if File.file?('script/bootstrap')
+    nil
+  else
+    "There is no script/bootstrap file in that project. Create one!"
+  end
+end

data/lib/whatToDo/check/readme.rb

@@ -0,0 +1,17 @@
+check do
+  re = nil
+  found = false
+
+  ['README', 'README.md', 'README.txt', 'README.html'].each do |fileName|
+    if File.file?(fileName)
+      found = true
+      break
+    end
+  end
+
+  unless found
+    re = "There is no readme file in that project. Create one!"
+  end
+
+  re
+end

data/lib/whatToDo/check/todo.rb

@@ -0,0 +1,104 @@
+##
+## Executes a recursive grep in the current directory to find all todos,
+## and the respecitve filename and linenumber. If there's a .gitignore
+## that function will ignore all directories and files from .gitignore
+##
+
+def get_lines
+  exclude = ''
+
+  if File.file?(".gitignore")
+    exclude = `cat .gitignore`.split("\n").map { |l| " | grep -v '^#{l}'" }
+    exclude = exclude.join
+  end
+
+  `egrep -rnH 'TODO|FIXME|XXX' * | grep -v '^Binary file' #{exclude}`.split("\n")
+end
+
+
+
+##
+## Builds a code sample from the given file and linenumber. Will display
+## the 4 lines above and below the relevant line and will highlight the
+## relevant line.
+##
+
+def code_sample(file, line)
+  line = line.to_i
+
+  from = line - 4
+  from = 0 if from < 0
+
+  result = "\n\n"
+
+  snippet(file, from, line + 4).split("\n").each do |code_line|
+    active = (line == from)
+    spaces = " " * (8 - from.to_s.length - (active ? 3 : 0))
+    result << spaces + (active ? '>> '.bold.red : '')
+    result << from.to_s.bold.yellow + ": ".bold.yellow
+
+    first = true
+
+    if code_line.length > 0
+      scan = code_line.scan(/^ +/)[0]
+      ident = scan ? scan.length + 12 : 12
+      code_line.scan(/.{1,80}/m).each do |l|
+        result << (first ? '' : ' ' * ident) + (active ? l.bold.red : l) + "\n"
+        first = false
+      end
+    else
+      result << "\n"
+    end
+
+    from += 1
+  end
+
+  result
+end
+
+
+
+##
+## Extracs a code snippet from a file and reduced the identation to the minimum
+##
+
+def snippet(file, from, to)
+  code = ""
+  current_line = 0
+
+  File.open(file, 'r') do |f|
+    while read_line = f.gets
+      current_line += 1
+      code << read_line.gsub(/\t/m, '  ') if current_line >= from && current_line <= to
+    end
+  end
+
+  code.gsub(/^#{code.scan(/^ +/).min}/, '')
+end
+
+
+
+##
+## Reduces the identation of a given string to the minimum
+##
+
+def unindent(code)
+  code.gsub(/^#{scan(/^\s+/).min}/, "")
+end
+
+
+
+##
+## Register the check script
+##
+
+check do
+  todos = get_lines.map do |line|
+    splitted = line.split(':', 3)
+    result = "Found a ToDo in #{splitted[0]} at line #{splitted[1]}:\n"
+	result << code_sample(splitted[0], splitted[1])
+    result
+  end
+
+  todos.sample
+end

data/lib/whatToDo/check_manager.rb

@@ -0,0 +1,37 @@
+require 'pathname'
+
+module WhatToDo
+  class CheckManager
+    def initialize(facets = [])
+      @checks = []
+      @facets = facets
+
+      # Require all check scripts
+      dir = Pathname.new(File.dirname(__FILE__) + '/check').cleanpath
+      Dir["#{dir}/*.rb"].each do |file|
+        instance_eval(File.open(File.expand_path(file)).read)
+      end
+    end
+
+    def check(facets = [], &block)
+      if !facets.any? || (facets & @facets).any?
+        @checks << block
+      end
+    end
+
+    def run_checks(count)
+      results = []
+
+      @checks.each do |check|
+        result = instance_eval(&check)
+
+        unless result == nil || result == false
+          results << result
+          break if results.length >= count
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/whatToDo/facet/git.rb

@@ -0,0 +1,3 @@
+facet(:git) do
+  File.directory?('.git')
+end

data/lib/whatToDo/facet/ruby.rb

@@ -0,0 +1,3 @@
+facet(:ruby) do
+  File.file?('Gemfile')
+end

data/lib/whatToDo/facet_analyzer.rb

@@ -0,0 +1,24 @@
+module WhatToDo
+  class FacetAnalyzer
+    attr_reader :facets
+
+    def initialize
+      @facets = []
+
+      # Require all facet scripts
+      dir = Pathname.new(File.dirname(__FILE__) + '/facet').cleanpath
+      Dir["#{dir}/*.rb"].each do |file|
+        instance_eval(File.open(File.expand_path(file)).read)
+      end
+    end
+
+    def facet(facets)
+      unless facets.is_a?(Array)
+        facets = [facets]
+      end
+
+      @facets += facets if yield
+      @facets.flatten
+    end
+  end
+end

data/lib/whatToDo/util.rb

@@ -0,0 +1,11 @@
+# Helper method to ident a string
+def indent(str, count, char = ' ')
+  str.gsub(/([^\n]*)(\n|$)/) do |match|
+    last_iteration = ($1 == '' && $2 == '')
+    line = ''
+    line << (char * count) unless last_iteration
+    line << $1
+    line << $2
+    line
+  end
+end

data/lib/whatToDo/version.rb

@@ -0,0 +1,3 @@
+module WhatToDo
+  VERSION = "0.0.1"
+end

data/whatToDo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'whatToDo/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'whatToDo'
+  s.version       = WhatToDo::VERSION.to_s
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Benjamin Kammerl']
+  s.email         = ['benny@itws.de']
+  s.description   = 'Helps you to get back in a project after some idle time or to contribute to a OpenSource project by telling you what you can do on the project.'
+  s.summary       = s.description
+  s.homepage      = 'https://github.com/phortx/WhatToDo'
+  s.license       = 'MIT'
+
+  s.required_ruby_version     = '>= 1.9.3'
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+  s.executables   = ['whatToDo']
+  s.extra_rdoc_files = ['README.md']
+
+  s.add_runtime_dependency 'colored'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: whatToDo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Kammerl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helps you to get back in a project after some idle time or to contribute
+  to a OpenSource project by telling you what you can do on the project.
+email:
+- benny@itws.de
+executables:
+- whatToDo
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/whatToDo
+- lib/whatToDo.rb
+- lib/whatToDo/check/bootstrap.rb
+- lib/whatToDo/check/readme.rb
+- lib/whatToDo/check/todo.rb
+- lib/whatToDo/check_manager.rb
+- lib/whatToDo/facet/git.rb
+- lib/whatToDo/facet/ruby.rb
+- lib/whatToDo/facet_analyzer.rb
+- lib/whatToDo/util.rb
+- lib/whatToDo/version.rb
+- screenshot.png
+- whatToDo.gemspec
+homepage: https://github.com/phortx/WhatToDo
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Helps you to get back in a project after some idle time or to contribute
+  to a OpenSource project by telling you what you can do on the project.
+test_files: []