rubytodo 0.0.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2012 Katsuya Noguchi
+
+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,32 @@
+## RubyTodo
+
+How do you manage todos in your code base? Usually people use comments like `# TODO` to specify todos in the code base and then use `grep '# TODO'` to grab them.
+
+With rubytodo gem you can specify your todo anywhere in your code with `todo "todo description"` and then you can list all todos with a command `rubytodo`.
+
+## Installation
+
+```ruby
+gem install 'rubytodo'
+```
+
+## Quick Start
+
+Add todo in your ruby file:
+```ruby
+require 'rubytodo'
+
+class MyClass
+  def my_method
+    todo "implement my_method"
+  end
+end
+```
+
+Then list todos in all ruby files under a given root folder:
+```
+$ rubytodo lib
+Scanning todos in lib ...
+lib/my_class.rb
+* implement my_method
+```

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rdoc/task'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :rspec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.rspec_opts = ['--color']
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+spec = Gem::Specification.load(File.join(File.dirname(__FILE__), "/rubytodo.gemspec"))
+
+desc "Package gem."
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/bin/rubytodo

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'rubytodo'
+
+root = ARGV[0] || "."
+
+RubyTodo.list :root => root

data/lib/object.rb

@@ -0,0 +1,13 @@
+class Object
+  def todo msg
+    unless msg and msg.is_a?(String)
+      raise "todo method requires you to pass a todo description as a first argument"
+    end
+  end
+
+  def self.todo msg
+    unless msg and msg.is_a?(String)
+      raise "todo method requires you to pass a todo description as a first argument"
+    end
+  end
+end

data/lib/rubytodo/version.rb

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

data/lib/rubytodo.rb

@@ -0,0 +1,34 @@
+require 'object'
+require 'ruby_parser'
+
+class RubyTodo
+  def self.list options
+    root = options[:root]
+    puts "Scanning todos in #{root} ..."
+    files = Dir.glob File.join(root, "**", "*")
+    files.reject { |f| f !~ /\.rb\Z/ }.each do |f|
+      todos = scan_todos f
+      puts f unless todos.nil? || todos.empty?
+      todos.each { |todo| puts "* #{todo}" }
+    end
+  end
+
+  def self.scan_todos file_path
+    ptree = RubyParser.new.parse File.open(file_path, 'r').read
+    extract_todos ptree
+  end
+
+  protected
+
+  def self.extract_todos node
+    return nil unless node.is_a? Sexp
+    todos = node.find_nodes(:call).map { |n| extract_todo_msg_from_args(n[3]) if n[2] == :todo }
+    (todos | node.collect { |n| extract_todos n }).flatten.compact
+  end
+
+  def self.extract_todo_msg_from_args node
+    return nil unless node.node_type && node.node_type == :arglist
+    return nil unless node[1] && node[1].node_type == :str
+    node[1].value
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rubytodo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Katsuya Noguchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: RubyTodo allows you to have in-code todos and scan them to view the todos
+  as a list
+email:
+- katsuya.noguchi@gmail.com
+executables:
+- rubytodo
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/rubytodo
+- lib/object.rb
+- lib/rubytodo/version.rb
+- lib/rubytodo.rb
+homepage: https://github.com/kn/rubytodo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RubyTodo allows you to have in-code todos and scan them to view the todos
+  as a list
+test_files: []