watnow 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Etienne Lemay
+
+MIT License
+
+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,93 @@
+# Watnow
+
+<b>Watnow</b> finds and lists your project TODOs and FIXMEs.<br>
+It basically does what the Rails’ `rake notes` does, but in a more generic way.
+
+## Installation
+```sh
+$ gem install watnow
+```
+
+## Usage
+
+```sh
+$ watnow
+```
+
+### Help
+```sh
+$ watnow --help
+
+Usage: watnow [options]
+
+-h, --help               show this message
+-v, --version            display version
+-d, --directory DIR      directory DIR to scan (defaults: ./)
+
+watnow commands:
+open <ID>    open annotation ID in your editor
+remove <ID>  remove annotation ID
+```
+
+## Commands
+### open
+Opens an annotation in your $EDITOR focused on the annotation line.
+```sh
+$ watnow open 13
+```
+
+### remove
+Removes the annotation line from its file.<br>
+(Make sure there is nothing else on that line)
+```sh
+$ watnow remove 13
+```
+
+## Features
+### Mentions
+```rb
+# TODO @rafBM: Update user form
+# TODO Update user controller @rafBM
+```
+```sh
+[ 2 ] TODO: Update user form [ @rafBM ]
+[ 1 ] TODO: Update user controller [ @rafBM ]
+```
+
+### Priority
+Exclamation mark (!) preceded by a whitespace. (`/\s(!+)\s?/`)
+
+```rb
+# TODO !!!: This is level 3 urgent
+# TODO @rafBM: Just do it !
+# TODO: This is not a priority!!
+# TODO !!!!!!!!!!!!! @EtienneLem: This is a nicolas-cage-level urgent task
+```
+```sh
+[ 3 ]  TODO: This is not a priority!!
+[ 2 ]  TODO: Just do it [ @rafBM - ! ]
+[ 1 ]  TODO: This is level 3 urgent [ !!! ]
+[ 4 ]  TODO: This is a nicolas-cage-level urgent task [ @EtienneLem - !!!!!!!!!!!!! ]
+```
+
+### Super color-friendly
+(Seriously, I’m open to color suggestions…)
+![color-friendly](https://s3.amazonaws.com/watnow/colors.png)
+
+## Watnow config
+Override defaults in `~/.watnowconfig`. Supported options are:
+```
+username  (String)    | A username so that you can be mentioned in TODOs  | Default: ''
+color     (Boolean)   | Enable/disable colored output                     | Default: true
+patterns  (Array)     | An array of string/regex that you want to monitor | Default: []
+```
+
+Use YAML syntax:
+```
+username: EtienneLem
+color: false
+patterns: [potato, ba(na)+]
+```
+
+## Contribution
+My Ruby skills are far from exemplary, please teach me.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/watnow

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'watnow'
+Watnow::Extractor.new

data/lib/watnow/annotation/annotation.rb

@@ -0,0 +1,41 @@
+module Watnow
+  # An Annotation is basically a group of AnnotationLine
+  class Annotation
+
+    @@id = 0
+    @@instances = []
+
+    attr_accessor :id, :file, :lines, :priority
+
+    # An ORM-like method that returns all Annotation instances
+    def self.all
+      @@instances
+    end
+
+    def initialize(opts)
+      @priority = 0
+      @file = opts[:file]
+      @lines = set_lines(opts[:lines])
+
+      # Auto increment instances id
+      # Push instance into a class array
+      @id = @@id += 1
+      @@instances << self
+    end
+
+    private
+
+    # Loop through lines data and create AnnotationLine instance
+    # Send self so that an AnnotationLine knows its Annotation and vice versa
+    def set_lines(lines)
+      results = []
+
+      lines.each do |line|
+        results << AnnotationLine.new(line, self)
+      end
+
+      results
+    end
+
+  end
+end

data/lib/watnow/annotation/annotation_line.rb

@@ -0,0 +1,54 @@
+module Watnow
+  class AnnotationLine
+
+    @@id = 0
+    @@instances = []
+    @@tag_length = 0
+
+    attr_accessor :id, :lineno, :tag, :priority, :mention, :message, :annotation
+
+    # An ORM-like find method that returns an AnnotationLine instance
+    def self.find(id)
+      @@instances.each do |instance|
+        return instance if instance.id == id
+      end
+
+      nil
+    end
+
+    # Returns longest tag length
+    # Used to format output
+    def self.tag_length
+      @@tag_length
+    end
+
+    def initialize(opts, annotation)
+      @lineno = opts[:lineno]
+      @tag = opts[:tag]
+      @priority = opts[:priority] || 0
+      @mention = opts[:mention] || ''
+      @message = opts[:message]
+      @annotation = annotation
+
+      @annotation.priority = @priority if @priority > @annotation.priority
+
+      # Auto increment instances id
+      # Push instance into a class array
+      @id = @@id += 1
+      @@instances << self
+
+      # Update class’ tag_length to the longest tag
+      @@tag_length = @tag.length if @tag.length > @@tag_length
+    end
+
+    # Returns an array of "meta data"
+    # Namely: The AnnotationLine mention and priority
+    def meta_data
+      data = []
+      data << "@#{@mention}" unless @mention.empty?
+      data << Array.new(@priority + 1).join('!') if @priority > 0
+      data
+    end
+
+  end
+end

data/lib/watnow/config.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+
+module Watnow::Config
+
+  # Default constants
+  FOLDER_IGNORE = %w(tmp node_modules db public log)
+  FILE_EXTENSION_IGNORE = %w(tmproj markdown md txt)
+  PATTERNS = %w(TODO FIXME)
+
+  def self.included(base)
+    defaults = {
+      'color' => true,
+      'folder_ignore' => [],
+      'file_extension_ignore' => [],
+      'patterns' => [],
+      'username' => ''
+    }
+
+    # Parse YAML config file (~/.watnowconfig)
+    parser = YamlParser.new
+    custom_options = parser.parse
+
+    # Merge defaults with custom options
+    # Add default constants
+    options = defaults.merge(custom_options)
+    options['folder_ignore'].concat(FOLDER_IGNORE)
+    options['file_extension_ignore'].concat(FILE_EXTENSION_IGNORE)
+    options['patterns'].concat(PATTERNS)
+
+    # Generate singleton methods with options keys for quick access
+    # i.e. self.color, self.patterns, self.username, etc
+    options.each do |option|
+      define_singleton_method option[0] do
+        option[1]
+      end
+    end
+  end
+
+  # Simple YAML parser
+  # Returns empty object if no file found
+  class YamlParser
+    def parse
+      begin
+        YAML.load_file("#{ENV['HOME']}/.watnowconfig")
+      rescue
+        {}
+      end
+    end
+  end
+
+end

data/lib/watnow/option_parser.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+
+module Watnow
+  # Home made Option parser built on top of Ruby’s optparse
+  class OptParser
+
+    def self.parse(args)
+      # Defaults
+      options = {}
+      options[:directory] = '.'
+
+      opts = OptionParser.new('', 24, '  ') do |opts|
+        opts.separator '  Usage: watnow [options]'
+        opts.separator ''
+
+        # Help
+        opts.on('-h', '--help', 'show this message') do
+          puts opts
+          exit
+        end
+
+        # Version
+        opts.on('-v', '--version', 'display version') do
+          puts VERSION
+          exit
+        end
+
+        # Directory
+        opts.on('-d', '--directory DIR', 'directory DIR to scan (defaults: ./)') do |d|
+          options[:directory] = d
+        end
+
+        # Commands
+        opts.separator ''
+        opts.separator '  watnow commands:'
+        opts.separator '  open <ID>    open annotation ID in your editor'
+        opts.separator '  remove <ID>  remove annotation ID'
+
+        options[:open] = get_option_value('open', args)
+        options[:remove] = get_option_value('remove', args)
+
+      end
+
+      opts.parse!(args)
+      options
+    end
+
+    def self.get_option_value(option, args)
+      args.include?(option) ? args[args.index(option) + 1] : nil
+    end
+
+  end
+end

data/lib/watnow/version.rb

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

data/lib/watnow.rb

@@ -0,0 +1,171 @@
+require 'watnow/version'
+require 'watnow/config'
+require 'watnow/option_parser'
+require 'watnow/annotation/annotation'
+require 'watnow/annotation/annotation_line'
+require 'colored'
+
+module Watnow
+  class Extractor
+    include Watnow::Config
+
+    def initialize
+      # Parse options and scan given directory
+      options = OptParser.parse(ARGV)
+      scan(options[:directory])
+
+      # If open command is parsed (`watnow open 13`)
+      if options[:open]
+        id = Integer(options[:open])
+        annotation_line = AnnotationLine.find(id)
+        open_file_at_line(annotation_line.annotation.file, annotation_line.lineno)
+
+      # If remove command is parsed (`watnow remove 13`)
+      elsif options[:remove]
+        id = Integer(options[:remove])
+        annotation_line = AnnotationLine.find(id)
+        remove_line_of_file(annotation_line.annotation.file, annotation_line.lineno)
+
+      # No specific command parsed. Output the annotations list
+      else
+        output(Annotation.all)
+      end
+    end
+
+    private
+
+    # Recursively scan given directory
+    # Ignore folders and files from Config
+    # Create a new Annotation when data si found
+    def scan(dir, annotations=[])
+      Dir.glob("#{dir}/*") do |path|
+        next if File.basename(path) =~ /(#{Config.folder_ignore.join('|')})$/
+
+        if File.directory? path
+          scan(path, annotations)
+        else
+          begin
+            next if File.extname(path) =~ /(#{Config.file_extension_ignore.join('|')})$/
+            content = read_file(path, /(#{Config.patterns.join('|')})/i)
+            Annotation.new(content) if content
+          rescue
+            nil
+          end
+        end
+      end
+    end
+
+    # Read a file line by line and look for given patterns
+    def read_file(file, patterns)
+      lineno = 0
+
+      result = File.readlines(file).inject([]) do |list, line|
+        lineno += 1
+        next list unless line =~ patterns
+
+        # Pattern is found, save the tag
+        tag = line.slice!($1)
+
+        # Look for priority
+        # Exclamation mark (!) preceded by a whitespace
+        priority = line.slice!(/\s(!+)\s?/)
+        priority = $1 ? $1.length : 0
+
+        # Look for mention
+        # Any word character preceded by @
+        mention = line.slice!(/\s@(\w+)\s*/)
+        mention = $1
+
+        # We assume the message starts with any word character
+        message = line.slice!(/(\w.*)/)
+        message = $1
+
+        # Push data into result
+        # Remove closing comment characters that we didn’t extract from regexs
+        list << {
+          :lineno => lineno,
+          :tag => tag,
+          :priority => priority,
+          :mention => mention,
+          :message => message.gsub(/\s*(\*\/|-->|%>)$/, '')
+        }
+      end
+
+      # Returns content that is sent to Annotation
+      result.empty? ? nil : { :file => file, :lines => result }
+    end
+
+    # Open a file with the user’s $EDITOR
+    # Automatically focus the annotation line number
+    # Supported editors are TextMate, Vim & Sublime Text
+    def open_file_at_line(filename, line)
+      command = filename
+
+      if ENV['EDITOR'] =~ /mate/
+        command = "#{filename} --line #{line}"
+      elsif ENV['EDITOR'] =~ /vi|vim/
+        command = "+#{line} #{filename}"
+      elsif ENV['EDITOR'] =~ /subl/
+        command = "#{filename}:#{line}"
+      end
+
+      Kernel.system("$EDITOR #{command}")
+    end
+
+    # Remove line from given file
+    def remove_line_of_file(filename, line)
+      file = File.readlines(filename)
+      file.delete_at(line - 1)
+      File.open(filename, 'w+') {|f| f.write file.join() }
+    end
+
+    def output(annotations)
+      # Sort annotations (file) by priority then by id
+      annotations.sort_by! { |a| [a.priority, -a.id] }
+
+      annotations.each do |annotation|
+        # Remove './' prefix in filenames
+        filename = annotation.file.gsub(/^\.\//, '')
+
+        # Display the filename
+        display_line "\n#{filename}", 'magenta'
+
+        # Sort annotation lines by priority DESC
+        # Higher priority is lower in the list
+        annotation.lines.sort! { |a,b| a.priority <=> b.priority }
+        annotation.lines.each do |annotation_line|
+          # Make sure all tags use the same (white)space
+          tag_spaces_count = AnnotationLine.tag_length - annotation_line.tag.length
+          tag_spaces = Array.new(tag_spaces_count + 1).join(' ')
+
+          # Boolean. True if current user is being mentioned in the annotation line
+          is_mentioned = (annotation_line.mention.downcase == Config.username.downcase)
+
+          # The actual outputting
+          display_text '[ ', 'green', is_mentioned
+          display_text annotation_line.id, 'cyan'
+          display_text " ] #{' ' if annotation_line.id < 10}", 'green', is_mentioned
+          display_text "#{annotation_line.tag}: #{tag_spaces}#{annotation_line.message}", 'green', is_mentioned
+          if annotation_line.meta_data.size > 0
+            display_text ' [ ', 'green', is_mentioned
+            display_text annotation_line.meta_data.join(' - '), 'cyan'
+            display_text ' ]', 'green', is_mentioned
+          end
+          display_line ""
+        end
+      end
+    end
+
+    # display_text followed by a newline
+    def display_line(msg, color=nil, color_condition=true)
+      display_text "#{msg}\n", color, color_condition
+    end
+
+    # Output helper. Print text in color if color_condition is truthy
+    def display_text(msg, color=nil, color_condition=true)
+      output = color && color_condition && Config.color ? "#{msg}".send(color) : msg
+      STDOUT.write "#{output}"
+    end
+
+  end
+end

data/watnow.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/watnow/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Etienne Lemay"]
+  gem.email         = ["etienne@heliom.ca"]
+  gem.homepage      = "https://github.com/etiennelem/watnow"
+
+  gem.description   = "Watnow finds and lists your project todo and fixme"
+  gem.summary       = gem.description
+  gem.version       = Watnow::VERSION
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "watnow"
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("colored", "~> 1.2")
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: watnow
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Etienne Lemay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 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: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Watnow finds and lists your project todo and fixme
+email:
+- etienne@heliom.ca
+executables:
+- watnow
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/watnow
+- lib/watnow.rb
+- lib/watnow/annotation/annotation.rb
+- lib/watnow/annotation/annotation_line.rb
+- lib/watnow/config.rb
+- lib/watnow/option_parser.rb
+- lib/watnow/version.rb
+- watnow.gemspec
+homepage: https://github.com/etiennelem/watnow
+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: Watnow finds and lists your project todo and fixme
+test_files: []