task-list 0.2 → 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60d92ec2193240ec457f321e2442d2bd3477b0ea
+  data.tar.gz: f6f89aa6e24bed0ab8877644d175fb6cd0627051
+SHA512:
+  metadata.gz: 996b8959b3fcce9b2c2ae4920451053fc7a1a128f4401313d7896554e2ef0c8761d41158160c2ac20567adf72bddfca6303db745c860210b91d4a1685cd1254e
+  data.tar.gz: afdbff8b9f781a1379192a34f98ec8c5b031f0ab7f23493c4aab363551f2ba21889d810160c38e3f4edabf3c1a3b5f671306174775796f4167641e3bd3471859

data/bin/tl

@@ -1,24 +1,28 @@
 #!/usr/bin/env ruby
 
+require "optparse"
 require_relative "../lib/task-list"
 
-args = []
-if ARGV.empty?
-  puts "Do you want to list the tasks that are under the current directory?"
-  print "[Yes|No] "
-  answer = $stdin.gets.chomp
+options = {}
 
-  answer = answer.split(//)
-  answer = answer.empty? ? [""] : [answer.fetch(0).downcase]
-  if answer.fetch(0) == "y"
-    args = ["."]
-  else
+OptionParser.new do |opts|
+  opts.banner = "Usage: tl [<query>] [<option> ...]"
+
+  opts.on("-t", "--type", "Type of tasks to list") do |o|
+    options[:type] = o
+  end
+
+  opts.on("-v", "--version", "Show TaskList's version") do |o|
+    puts "tl version #{TaskList::VERSION}"
+    exit
+  end
+
+  opts.on("-h", "--help", "Show this help message") do |o|
+    puts opts
     exit
   end
-else
-  args = ARGV
-end
+end.parse!
 
-parser = TaskList::Parser.new(*args)
-parser.parse
-parser.print
+parser = TaskList::Parser.new(arguments: ARGV, options: options)
+parser.parse!
+parser.print!

data/lib/task-list.rb

@@ -1,8 +1,64 @@
-require "yaml"
-
-require_relative "task-list/version"
-require_relative "task-list/parser"
+require_relative "./task-list/exceptions"
+require_relative "./task-list/version"
+require_relative "./task-list/parser"
 
 module TaskList
-  # Your code goes here...
+  EXCLUDED_EXTENSIONS = [
+    ".jpg",
+    ".jpeg",
+    ".png",
+    ".gif",
+    ".svg",
+    ".sqlite3",
+    ".log",
+    ".rbc",
+    ".sassc",
+    ".gem"
+  ]
+
+  EXCLUDED_DIRECTORIES = [
+    ".git",
+    "coverage",
+    "config",
+    "tmp",
+    "cache",
+    "log",
+    "logs"
+  ]
+
+  EXCLUDED_GLOBS = [
+    "*~",
+    ".DS_Store",
+    ".AppleDouble",
+    ".LSOverride",
+    "Icon",
+    "._*",
+    ".Spotlight-V100",
+    ".Trashes",
+    "Thumbs.db",
+    "ehthumbs.db",
+    "Desktop.ini",
+    "$RECYCLE.BIN/",
+    "*.cab",
+    "*.msi",
+    "*.msm",
+    "*.msp",
+    ".svn/",
+    "/CVS/*",
+    "*/CVS/*",
+    ".cvsignore",
+    "*/.cvsignore"
+  ]
+
+  VALID_TASKS = [
+    "TODO",
+    "FIXME",
+    "NOTE",
+    "BUG",
+    "CHANGED",
+    "OPTIMIZE",
+    "XXX",
+    "!!!",
+    "???"
+  ]
 end

data/lib/task-list/exceptions.rb

@@ -0,0 +1,8 @@
+module TaskList
+  module Exceptions
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/exceptions/*.rb"].each do |file|
+  require file
+end

data/lib/task-list/exceptions/invalid_task_type.rb

@@ -0,0 +1,17 @@
+module TaskList
+  module Exceptions
+    class InvalidTaskTypeError < NameError
+      def initialize(type: "", message: "")
+        if message.empty?
+          message = "tl: Invalid task type"
+
+          unless type.empty?
+            message << ": #{type}"
+          end
+        end
+
+        super message
+      end
+    end
+  end
+end

data/lib/task-list/parser.rb

@@ -1,159 +1,194 @@
+require "find"
+
 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
+    def initialize(arguments: [], options: {})
+      @type = options[:type].upcase if options[:type]
+      # @files = fuzzy_find_files queries: arguments unless arguments.empty?
+      @files = fuzzy_find_files queries: arguments
+      @tasks = {}
+      VALID_TASKS.each { |t| @tasks[t.to_sym] = [] }
     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
+    # and populate the tasks hash
+    def parse!
+      unless @type.nil? || VALID_TASKS.include?(@type)
+        raise TaskList::Exceptions::InvalidTaskTypeError.new type: @type
       end
 
-      @files.each do |file|
-        parsef file, type
-      end
+      @files.each { |f| parsef! file: f }
     end
 
-    def print
+    def print!
       @tasks.each do |type, tasks|
         unless tasks.empty?
-          puts "\n#{type}:\n#{'-' * (type.length + 1)}\n"
+          puts "#{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
+
+          puts
         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?
+    def fuzzy_find_files(queries: [])
+      patterns = regexify queries
 
-      args.each do |arg|
-        unless arg.is_a? String
-          raise ArgumentError, "The argument passed to the parser's constructor must be a String"
-        end
+      paths = []
+      # FIXME: Search in the root of a project if in a git repo
+      Find.find('.') do |path|
+        paths << path unless FileTest.directory?(path)
+      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
+      paths.map! { |p| p.gsub /\A\.\//, "" }
+
+      EXCLUDED_DIRECTORIES.each do |d|
+        paths.delete_if { |p| p =~ /\A#{Regexp.escape(d)}/ }
       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
+      EXCLUDED_EXTENSIONS.each do |e|
+        paths.delete_if { |p| File.file?(p) && File.extname(p) =~ /\A#{Regexp.escape(e)}/ }
       end
 
-      files.flatten.uniq.delete_if { |file| File.directory?(file) }
-    end
+      EXCLUDED_GLOBS.each do |g|
+        paths.delete_if { |p| p =~ /#{unglobify(g)}/ }
+      end
+
+      if queries.empty?
+        paths
+      else
+        results = []
 
-    # Get the valid tasks and their regex
-    # from the config/valid_tasks.yml YAML file
-    def get_valid_tasks
-      tasks = {}
+        patterns.each do |pattern|
+          paths.each do |path|
+            matches = path.match(/#{pattern}/).to_a
 
-      shit = YAML::load(File.open(@config_folder + "/valid_tasks.yml"))
-      shit.each do |crap|
-        crap.each do |task, regex|
-          tasks[task] = regex
+            results << path unless matches.empty?
+          end
         end
-      end
 
-      tasks
+        results
+      end
     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
+    def regexify(queries)
+      patterns = []
+
+      queries.each do |query|
+        if query.include?("/")
+          pattern = query.split("/").map { |p| p.split("").join(")[^\/]*?(").prepend("[^\/]*?(") + ")[^\/]*?" }.join("\/")
+          pattern << "\/" if query[-1] == "/"
+        else
+          pattern = query.split("").join(").*?(").prepend(".*?(") + ").*?"
+        end
 
-    # Initialize the tasks hash
-    def initialize_tasks_hash
-      tasks = {}
-      @valid_tasks.each do |task, regex|
-        tasks[task] = []
+        patterns << pattern
       end
 
-      tasks
+      patterns
     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}/
+    # NOTE: This is actually a glob-to-regex method
+    def unglobify(glob)
+      chars = glob.split("")
+
+      chars = smoosh(chars)
+
+      curlies = 0
+      escaping = false
+      string = chars.map do |char|
+        if escaping
+          escaping = false
+          char
+        else
+          case char
+            when "**"
+              "([^/]+/)*"
+            when '*'
+              ".*"
+            when "?"
+              "."
+            when "."
+              "\."
+
+            when "{"
+              curlies += 1
+              "("
+            when "}"
+              if curlies > 0
+                curlies -= 1
+                ")"
+              else
+                char
+              end
+            when ","
+              if curlies > 0
+                "|"
+              else
+                char
+              end
+            when "\\"
+              escaping = true
+              "\\"
+            else
+              char
+          end
+        end
       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
+      '(\A|\/)' + string.join + '\Z'
+    end
 
-              unless result.nil?
-                task = {
-                  file: file,
-                  line_number: line_number,
-                  task: result.to_a.last
-                }
+    def smoosh(chars)
+      out = []
 
-                @tasks[type] << task
-              end
-            end
+      until chars.empty?
+        char = chars.shift
 
-            line_number += 1
-          end
+        if char == "*" && chars.first == "*"
+          chars.shift
+          chars.shift if chars.first == "/"
+          out.push("**")
+        else
+          out.push(char)
         end
       end
+
+      out
     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))
+    # Parse a file to find tasks
+    def parsef!(file: "")
+      types = @type ? [@type] : VALID_TASKS
+
+      File.open(file, "r") do |f|
+        line_number = 1
+        while line = f.gets
+          types.each do |type|
+            result = line.match /#{Regexp.escape(type)}[\s,:-]+(\S.*)\Z/
+
+            unless result.nil?
+              task = {
+                file: file,
+                line_number: line_number,
+                task: result.to_a.last
+              }
+
+              @tasks[type.to_sym] << task
+            end
+          end
+
+          line_number += 1
+        end
+      end
     end
   end
 end

data/lib/task-list/version.rb

@@ -1,3 +1,3 @@
 module TaskList
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/task-list.gemspec

@@ -15,9 +15,4 @@ Gem::Specification.new do |s|
   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

@@ -1,60 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: task-list
 version: !ruby/object:Gem::Version
-  version: '0.2'
-  prerelease: 
+  version: '0.3'
 platform: ruby
 authors:
 - Aziz Light
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: &70204542044480 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70204542044480
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: &70204542043500 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70204542043500
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: &70204542041860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70204542041860
-- !ruby/object:Gem::Dependency
-  name: ruby_gntp
-  requirement: &70204542041380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70204542041380
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies: []
 description: TaskList parses source code to find code tags and list them in a terminal.
   See README.md for more info.
 email:
@@ -65,47 +20,39 @@ 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/exceptions.rb
+- lib/task-list/exceptions/invalid_task_type.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: []
+metadata: {}
 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
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Code tasks parser and lister
-test_files:
-- spec/parser_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.rvmrc

@@ -1,55 +0,0 @@
-#!/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/Guardfile

@@ -1,6 +0,0 @@
-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/config/excluded_extensions.yml

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

data/config/excluded_folders.yml

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

data/config/valid_tasks.yml

@@ -1,9 +0,0 @@
----
-- :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/spec/parser_spec.rb

@@ -1,17 +0,0 @@
-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

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