task-list 0.1

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+.bundle
+pkg/*
+
+*.rbc
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+.*.sw[a-z]
+*.un~
+Session.vim
+NERD_tree*

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3-p0@task-list"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in task-list.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    task-list (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-minitest (0.4.0)
+      guard (~> 0.4)
+    rb-fsevent (0.4.3.1)
+    ruby_gntp (0.3.4)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-minitest
+  rb-fsevent
+  ruby_gntp
+  task-list!

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^lib/task-list/(.*)\.rb|)  { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Aziz Light
+
+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,54 @@
+TaskList
+========
+
+Code tasks are constructive comments in the code that are prefixed with a tag. Here are some examples of code tasks in ruby:
+
+    # TODO: This is a todo item that needs to be done urgently!
+    # BUG Something wrong is happening...
+    # NOTE - This method is used for a specific reason.
+
+Obviously real code tasks are a lot more constructive than the examples I gave above.
+
+TaskList parses code files and lists code tasks.
+
+Installation
+------------
+
+TaskList is provided as a gem, so the installation process is as simple as this:
+
+    % [sudo] gem install task-list
+
+> **Note**: `%` is the prompt and `sudo` (without the square brackets) is not needed if you use RVM.
+
+Features:
+---------
+
+As stated above, TaskList lists code tags that it finds in code passed to it. Here are the supported tags:
+
+- `TODO`
+- `FIXME`
+- `NOTE`
+- `BUG`
+- `CHANGED`
+- `OPTIMIZE`
+- `XXX`
+- `!!!`
+
+Also, TaskList will ignore the files that are under certain folders like `log` or `coverage`. Finally, TaskList will ignore files with certain extensions like images and SQLite databases.
+
+Usage:
+------
+
+The TaskList comes with a command-line script called `tl` which takes one argument and only one argument. This argument can be one of two things:
+
+- a file
+- a folder
+
+If a file is passed, TaskList will parse this file to find code tags. On the other hand, if a folder is passed, TaskList will recursively parse all the files under that folder to find code tags. Here are some examples:
+
+    % tl task-list.rb
+    % tl task-list/
+    % tl task-list/task-list.rb
+    % tl .
+
+All the calls to `tl` shown above are valid.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+task spec: :test
+
+# Run specs
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/bin/tl

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "benchmark"
+require_relative "../lib/task-list"
+
+parser = TaskList::Parser.new(*ARGV)
+parser.parse
+parser.print

data/config/excluded_extensions.yml

@@ -0,0 +1,11 @@
+---
+- '.jpg'
+- '.jpeg'
+- '.png'
+- '.gif'
+- '.svg'
+- '.sqlite3'
+- '.log'
+- '.rbc'
+- '.sassc'
+- '.gem'

data/config/excluded_folders.yml

@@ -0,0 +1,6 @@
+---
+- '\/coverage\/'
+- '\/config\/'
+- '\/tmp\/'
+- '\/cache\/'
+- '\/logs?\/'

data/config/valid_tasks.yml

@@ -0,0 +1,9 @@
+---
+- :TODO: 'TODO[\s,:-]+(\S.*)$'
+- :FIXME: 'FIX ?ME[\s,:-]+(\S.*)$'
+- :NOTE: 'NOTE[\s,:-]+(\S.*)$'
+- :BUG: 'BUG[\s,:-]+(\S.*)$'
+- :CHANGED: 'CHANGED[\s,:-]+(\S.*)$'
+- :OPTIMIZE: 'OPTIMIZE[\s,:-]+(\S.*)$'
+- :XXX: 'XXX[\s,:-]+(\S.*)$'
+- :!!!: '!!![\s,:-]+(\S.*)$'

data/lib/task-list.rb

@@ -0,0 +1,9 @@
+require "pp"
+require "yaml"
+
+require_relative "task-list/version"
+require_relative "task-list/parser"
+
+module TaskList
+  # Your code goes here...
+end

data/lib/task-list/parser.rb

@@ -0,0 +1,159 @@
+module TaskList
+  class Parser
+    attr_reader :files, :tasks
+
+    def initialize(*args)
+      validate args
+
+      # Get the list of files
+      @files = collect args
+
+      # Setup the absolute path to the config folder
+      @config_folder = File.realpath(File.dirname(__FILE__) + "/../../config")
+
+      # Get the list of valid tasks
+      @valid_tasks = get_valid_tasks
+
+      # Get excluded folders
+      @excluded_folders = get_excluded_folders
+
+      # Initialize the tasks hash
+      @tasks = initialize_tasks_hash
+    end
+
+    # Parse all the collected files to find tasks
+    # and populate the @tasks hash
+    def parse(type = nil)
+      unless type.nil? || (type.is_a?(Symbol) && @valid_tasks.has_key?(type))
+        raise ArgumentError
+      end
+
+      @files.each do |file|
+        parsef file, type
+      end
+    end
+
+    def print
+      @tasks.each do |type, tasks|
+        unless tasks.empty?
+          puts "\n#{type}:\n#{'-' * (type.length + 1)}\n"
+
+          tasks.each do |task|
+            puts task[:task]
+            # CHANGED: Colors are now always enabled.
+            # Without colors the output is unreadable.
+            puts "  \e[30m\e[1mline #{task[:line_number]} in #{task[:file]}\e[0m"
+          end
+        end
+      end
+    end
+
+    private
+
+    # Validate the argument passed to the parser's controller.
+    # The argument must be a String and a valid file/folder path (relative or absolute).
+    def validate(args)
+      raise ArgumentError unless args.is_a?(Array) && args.any?
+
+      args.each do |arg|
+        unless arg.is_a? String
+          raise ArgumentError, "The argument passed to the parser's constructor must be a String"
+        end
+
+        unless File.file?(arg) || File.directory?(arg)
+          raise ArgumentError, "The argument passed to the parse's constructor must be either a file or a folder"
+        end
+      end
+    end
+
+    # Take the args, which are files/folders list,
+    # and create a list of all the files to parse
+    def collect(args)
+      files = []
+      args.each do |arg|
+        %w[**/* **/*.* **/.*].each do |glob|
+          files << Dir.glob("#{arg}/#{glob}")
+        end
+      end
+
+      files.flatten.uniq.delete_if { |file| File.directory?(file) }
+    end
+
+    # Get the valid tasks and their regex
+    # from the config/valid_tasks.yml YAML file
+    def get_valid_tasks
+      tasks = {}
+
+      shit = YAML::load(File.open(@config_folder + "/valid_tasks.yml"))
+      shit.each do |crap|
+        crap.each do |task, regex|
+          tasks[task] = regex
+        end
+      end
+
+      tasks
+    end
+
+    # Get the list of excluded folders and their regex
+    # from the config/excluded_folders.yml YAML file
+    def get_excluded_folders
+      YAML::load(File.open(@config_folder + "/excluded_folders.yml"))
+    end
+
+    # Initialize the tasks hash
+    def initialize_tasks_hash
+      tasks = {}
+      @valid_tasks.each do |task, regex|
+        tasks[task] = []
+      end
+
+      tasks
+    end
+
+    # Parse a file to find tasks
+    def parsef(file, type = nil)
+      # Don't parse files that are in excluded folders!
+      @excluded_folders.each do |regex|
+        return if file =~ /#{regex}/
+      end
+
+      valid_tasks = (type.nil?) ? @valid_tasks : @valid_tasks.select { |k,v| k == type }
+
+      unless ignore?(file)
+        File.open(file, "r") do |f|
+          line_number = 1
+          while line = f.gets
+            valid_tasks.each do |type, regex|
+              begin
+                result = line.match regex
+              rescue ArgumentError
+                # NOTE: Some files like .DS_Store are not filtered by the ignore? method...
+                return
+              end
+
+              unless result.nil?
+                task = {
+                  file: file,
+                  line_number: line_number,
+                  task: result.to_a.last
+                }
+
+                @tasks[type] << task
+              end
+            end
+
+            line_number += 1
+          end
+        end
+      end
+    end
+
+    # Should a file be ignored?
+    # Some files, like images or SQLite databases, are not meant to be parsed
+    def ignore?(file)
+      # Get the list of file extensions to ignore
+      extensions = YAML::load(File.open(@config_folder + "/excluded_extensions.yml"))
+      extensions.include?(File.extname(file))
+    end
+  end
+end

data/lib/task-list/version.rb

@@ -0,0 +1,3 @@
+module TaskList
+  VERSION = "0.1"
+end

data/spec/parser_spec.rb

@@ -0,0 +1,17 @@
+require_relative "spec_helper"
+
+describe "Parser" do
+  it "must work" do
+    lambda do
+      TaskList::Parser
+    end.must_be_silent
+  end
+
+  describe "arguments" do
+    it "must require at least one argument" do
+      lambda do
+        TaskList::Parser.new
+      end.must_raise ArgumentError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/task-list"
+
+require "minitest/spec"
+require "minitest/pride"
+
+MiniTest::Unit.autorun

data/task-list.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "task-list/version"
+
+Gem::Specification.new do |s|
+  s.name        = "task-list"
+  s.version     = TaskList::VERSION
+  s.authors     = ["Aziz Light"]
+  s.email       = ["aziz@azizlight.me"]
+  s.homepage    = "https://github.com/AzizLight/TaskList"
+  s.summary     = %q{Code tasks parser and lister}
+  s.description = %q{TaskList parses source code to find code tags and list them in a terminal. See README.md for more info.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-minitest"
+  s.add_development_dependency "rb-fsevent"
+  s.add_development_dependency "ruby_gntp"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: task-list
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Aziz Light
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70291384857900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70291384857900
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &70291384857400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70291384857400
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70291384856820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70291384856820
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: &70291384856260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70291384856260
+description: TaskList parses source code to find code tags and list them in a terminal.
+  See README.md for more info.
+email:
+- aziz@azizlight.me
+executables:
+- tl
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/tl
+- config/excluded_extensions.yml
+- config/excluded_folders.yml
+- config/valid_tasks.yml
+- lib/task-list.rb
+- lib/task-list/parser.rb
+- lib/task-list/version.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+- task-list.gemspec
+homepage: https://github.com/AzizLight/TaskList
+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.10
+signing_key: 
+specification_version: 3
+summary: Code tasks parser and lister
+test_files:
+- spec/parser_spec.rb
+- spec/spec_helper.rb