notes-cli 1.0.0

data/bin/notes

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+
+require 'notes-cli'
+
+if ARGV.any? { |arg| ["-h", "--help"].include?(arg) }
+  puts %Q{\
+Usage: notes [DIRECTORY=.] [-f FILES] [-e EXCLUDES]
+
+Options:
+  -f, --flags    # List of custom annotations, ex: '-f broken refactor' (case insensitive)
+  -e, --exclude  # List of directories to ignore, ex: '-e tmp/ log/'
+  -h, --help     # Display this menu
+
+Examples:
+  notes                 # Show default annotations for all files in current directory (default)
+  notes app/ -f broken  # Only examine files in the app/ directory and add the 'broken' flag
+
+}
+  exit(0)
+end
+
+Notes.build_options(ARGV)
+Notes.find_all

data/lib/notes-cli.rb

@@ -0,0 +1,103 @@
+class Notes
+  attr_accessor :options
+
+  class << self
+
+    # Parse ARGV into a directory and list of argument groups
+    # For example, given ['app/', -f', 'refactor', 'broken', '--exclude', 'tmp', 'log']:
+    # => [ 'app/', ['-f', 'refactor', 'broken'], ['--exclude', 'tmp', 'log'] ]
+    def parse_argv(args)
+      result = []
+      buf    = []
+      dir    = args.first
+
+      if args.empty? || dir.start_with?("-")
+        # No dir was passed, use current dir
+        result << Dir.pwd
+      else
+        # Dir was passed in
+        dir = Dir.pwd if dir == '.'
+        result << dir
+        args = args.drop(1)
+      end
+
+      args.each do |arg|
+        if arg.start_with?('-')
+          result << buf unless buf.empty?
+          buf = []
+        end
+        buf << arg
+      end
+
+      result << buf
+    end
+
+    # Append any command line arguments to a default set of arguments
+    # arg_list is a directory and argument groups parsed from ARGV. For example:
+    # [ "app/", ['-f', 'refactor', 'broken'], ['--exclude', 'tmp', 'log'] ]
+    def build_options(argv)
+      arg_list = Notes.parse_argv(argv)
+      options  = {
+        :flags   => %w(TODO FIXME OPTIMIZE),
+        :exclude => []
+      }
+
+      options[:dir] = arg_list.shift
+
+      arg_list.reject(&:empty?).each do |set|
+        flag, *args = set
+        args.map! { |arg| arg.delete("/") } #{ }"log/" => "log"
+
+        case flag
+        when '-f', '--flags'   then options[:flags].concat(args)
+        when '-e', '--exclude' then options[:exclude].concat(args)
+        else puts "Unknown argument: #{flag}"
+        end
+      end
+
+      @options = options
+    end
+
+    # List of files to scan for notes as specified in the options
+    def files
+      pattern = File.join(@options[:dir], "**/*")
+      Dir[pattern].reject do |f|
+        File.directory?(f) || @options[:exclude].any? { |dir| File.dirname(f).include?(dir) }
+      end
+    end
+
+    # Read and parse all files as specified in the options
+    def find_all
+      Notes.files.each do |filename|
+        name = filename.gsub(Dir.pwd, '')
+        File.open(filename, "r") { |file| Notes.parse_file(name, file) }
+      end
+    end
+
+    # Scan a file for annotations and output numbered lines for each
+    def parse_file(name, file)
+      counter = 1
+      tasks   = []
+
+      file.each_line do |line|
+        if @options[:flags].any? { |flag| line.include?(flag) || line.include?(flag.downcase) }
+          tasks << {
+            :line_num => counter,
+            :line     => line.strip
+          }
+        end
+        counter += 1
+      end
+
+      if !tasks.empty?
+        name.slice!(0) if name.start_with?("/")
+        puts "#{name}:"
+        tasks.each { |task| puts "  ln #{task[:line_num]}: #{task[:line]}" }
+        puts ""
+      end
+    end
+
+  end
+
+end
+

data/lib/notes-cli/version.rb

@@ -0,0 +1,3 @@
+class Notes
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: notes-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Berls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: andrew.berls@gmail.com
+executables:
+- notes
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/notes-cli.rb
+- lib/notes-cli/version.rb
+- bin/notes
+homepage: https://github.com/andrewberls/notes-cli
+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.24
+signing_key: 
+specification_version: 3
+summary: A tool for managing source code annotations
+test_files: []
+has_rdoc: