notes-cli 1.0.5 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDVlYWYwYTAwMGM0ZDVmMTlkMTYzOTFkZGM4NDk2NDRkYTgxMzIwMQ==
+  data.tar.gz: !binary |-
+    ZTY5ZGIxZjFhNDYxMzYxNmJlYTZjMWI2YWYxNDFkNjZkOTc3OGY1Yw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGQ4NTExODhiZmYwYTk1NjI5N2JmMzRmYTFjMGI1YzdmOWVhZTQwYTg1NDMz
+    ZjgyMTI4ZTgxN2U5MTY4NzNkOWMyODMwODkwYTM2NDkyYjcyZjYzZGU2YjUx
+    MTgxZTEzZjk4YzI0MTUzY2Y1NzcxOGQyMDgxMTBlMTgyYTUyYzY=
+  data.tar.gz: !binary |-
+    YTIwZjcwOGZjYTQyZTlhYjBkNGVlNmZlOTcwZDZhZDU3NmJhZjlhNmY5Y2Ri
+    MzQ5YzE0Y2U4ZmQ0YjU2YWEwYzQ1ZWUxYTUzNDU5NTQzOWY5YjYwNDA2ZWZm
+    ZjI2MzVkYzNlMWQ5MzQ5YWVkMGMzNWFjMDc5MjdjN2M2NWExZTk=

data/bin/notes

@@ -6,7 +6,7 @@ if ARGV.any? { |arg| ["-h", "--help"].include?(arg) }
   puts %Q{\
 Recursively search source files for annotations. Default annotations are TODO, OPTIMIZE, and FIXME.
 
-Usage: notes [DIRECTORY=.] [-f FILES] [-e EXCLUDES]
+Usage: notes [DIRECTORY=. | FILENAMES] [-f FLAGS] [-e EXCLUDES]
 
 Options:
   -f, --flags    # List of custom annotations, ex: '-f broken refactor' (case insensitive)
@@ -16,10 +16,11 @@ Options:
 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
+  notes app/ -e logs/   # Show default annotations for files in app/ directory, excluding files in logs/
+  notes one.rb two.rb   # Show default annotations for one.rb and two.rb
 
 }
   exit(0)
 end
 
-Notes.build_options(ARGV)
-Notes.find_all
+Notes::CLI.new.find_all

data/lib/notes-cli.rb

@@ -1,114 +1,2 @@
-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
-
-    # Scan a file for annotations and output numbered lines for each
-    def parse_file(filename)
-      name    = filename.gsub(Dir.pwd, '')
-      counter = 1
-      tasks   = []
-
-      begin
-        File.read(filename).each_line do |line|
-          if @options[:flags].any? { |flag| line =~ /#{flag}/i }
-            tasks << {
-              :line_num => counter,
-              :line     => line.strip
-            }
-          end
-          counter += 1
-        end
-      rescue
-        # Error occurred reading the file (ex. invalid byte sequence in UTF-8)
-        # Move on quietly
-      end
-
-      if !tasks.empty?
-        name.slice!(0) if name.start_with?("/")
-        puts "#{name}:"
-
-        tasks.each do |task|
-          flag_regex = Regexp.new(@options[:flags].join('|'), true)
-          color = 33 # yellow
-          line  = task[:line].gsub(flag_regex) do |flag|
-            "\e[#{color};1m#{flag}\033[0m"
-          end
-          puts "  ln #{task[:line_num]}: #{line}"
-        end
-
-        puts ""
-      end
-    end
-
-    # Read and parse all files as specified in the options
-    def find_all
-      Notes.files.each { |f| Notes.parse_file(f) }
-    end
-
-  end
-end
-
+require 'notes-cli/opts'
+require 'notes-cli/cli'

data/lib/notes-cli/cli.rb

@@ -0,0 +1,65 @@
+
+module Notes
+  class CLI
+    attr_accessor :options
+
+    def initialize
+      @options = Opts.parse(ARGV)
+    end
+
+    # Print a formatted task, with highlighting
+    def print_task(task)
+      flag_regex = Regexp.new(@options[:flags].join('|'), true)
+      color = 33 # yellow
+      line  = task[:line].gsub(flag_regex) do |flag|
+        "\e[#{color};1m#{flag}\033[0m"
+      end
+
+      puts "  ln #{task[:line_num]}: #{line}"
+    end
+
+    # Scan a file for annotations and output numbered lines for each
+    def parse_file(filename)
+      name    = filename.gsub(Dir.pwd, '')
+      counter = 1
+      tasks   = []
+
+      begin
+        File.read(filename).each_line do |line|
+          if @options[:flags].any? { |flag| line =~ /#{flag}/i }
+            tasks << {
+              :line_num => counter,
+              :line     => line.strip
+            }
+          end
+          counter += 1
+        end
+      rescue
+        # Error occurred reading the file (ex. invalid byte sequence in UTF-8)
+        # Move on quietly
+      end
+
+      if !tasks.empty?
+        name.slice!(0) if name.start_with?("/")
+        puts "#{name}:"
+        tasks.each { |t| print_task(t) }
+        puts ""
+      end
+    end
+
+    # Read and parse all files as specified in the options
+    def find_all
+      @options[:locations].each do |loc|
+        if File.directory?(loc)
+          Dir[ File.join(loc, "**/*") ].reject do |f|
+            File.directory?(f) || @options[:exclude].any? { |dir| File.dirname(f).include?(dir) }
+          end.each { |f| parse_file(f) }
+        else
+          parse_file(loc)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/notes-cli/opts.rb

@@ -0,0 +1,61 @@
+module Notes
+  module Opts
+
+    DEFAULT_OPTIONS = {
+      :flags     => %w(TODO FIXME OPTIMIZE),
+      :exclude   => [],
+      :files     => [],
+      :directory => '',
+    }
+
+    FLAG_FLAGS    = ['-f', '--flags']
+    EXCLUDE_FLAGS = ['-e', '--exclude']
+    ALL_FLAGS     = FLAG_FLAGS + EXCLUDE_FLAGS
+
+    # 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 self.arg_groups(args)
+      result = []
+      buf    = []
+
+      # No dir was passed, use current dir
+      if args.empty? || args.first.start_with?('-')
+        result << [ Dir.pwd ]
+      end
+
+      args.each do |arg|
+        if ALL_FLAGS.include?(arg)
+          result << buf unless buf.empty?
+          buf = []
+        end
+        buf << arg
+      end
+
+      result << buf
+    end
+
+    # Append any command line arguments to a default set of arguments
+    def self.parse(args)
+      arg_list = arg_groups(args)
+      options  = DEFAULT_OPTIONS
+
+      options[:locations] = 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
+    end
+
+  end
+end

data/lib/notes-cli/version.rb

@@ -1,3 +1,3 @@
-class Notes
-  VERSION = "1.0.5"
+module Notes
+  VERSION = "1.1.0"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notes-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.5
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Berls
@@ -10,7 +9,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-01-13 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: andrew.berls@gmail.com
 executables:
@@ -18,32 +31,33 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/notes-cli.rb
+- lib/notes-cli/cli.rb
+- lib/notes-cli/opts.rb
 - lib/notes-cli/version.rb
+- lib/notes-cli.rb
 - bin/notes
 homepage: https://github.com/andrewberls/notes-cli
 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.17
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A tool for managing source code annotations
 test_files: []
 has_rdoc: