punchlist 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e83dc434aafca7c85c72221ac0a8327b3ec19ea
-  data.tar.gz: 575957e7f721877fce24d8366d09e42c97e63d5b
+  metadata.gz: 6b24e5a71761e3b922d69c22ecc75f783b5a1e52
+  data.tar.gz: 774499da75a38f680a5b8576ae46a89ed33c9f33
 SHA512:
-  metadata.gz: 7d59c636e7382621dc0ff81e94faec5262c8ccc53d660132e79cf0b7969a30d4f07d2382a881092e028baa6696d7cee4d74025a637b3fc2aaf9ad90f088d8775
-  data.tar.gz: 6564e53503c64110055c93d8cfffe7c97a3f86d29d83c0aafa865d770c4b97de565c638e99c8632d1f2b3a26709f04a84295fe8d4337f99cfcbef6b0deb73559
+  metadata.gz: 0464696dabb58e2936812720133e0287a5ffa13c806c44ba946860c48f8fec76176ba57db05f2265003945039345c003850dbd260de919074c2163e375701ebe
+  data.tar.gz: f56075dc8576ae3121bb4263545bb46aac9d8a4c128df19c28f47f3a7f37b71f89186fa6c9e760c15969d8d57871fb5aea99409e31a2714a71368c596b385e61

data/bin/punchlist

@@ -2,4 +2,4 @@
 
 require_relative '../lib/punchlist'
 
-Punchlist::Punchlist.new(ARGV).run
+Punchlist::Punchlist.new.run

data/lib/punchlist.rb

@@ -1,26 +1,23 @@
+require_relative 'punchlist/options'
+
 # XXX: need to include BUG in list
 # XXX: need to include BUG in my rubocop config
 # BUG need to fix the fact that we create blank lines on files with no issues
 module Punchlist
   # Counts the number of 'todo' comments in your code.
   class Punchlist
-    def initialize(args,
-                   outputter: STDOUT,
+    def initialize(outputter: STDOUT,
                    globber: Dir,
-                   file_opener: File)
-      @args = args
+                   file_opener: File,
+                   options_parser: Options.new(default_punchlist_line_regexp))
       @outputter = outputter
       @globber = globber
       @file_opener = file_opener
+      @options_parser = options_parser
     end
 
     def run
-      if @args[0] == '--glob'
-        @source_files_glob = @args[1]
-      elsif @args[0]
-        @outputter.puts "USAGE: punchlist\n"
-        return 0 # XXX: need to vary return based on good or bad arguments
-      end
+      @options = @options_parser.parse_options
 
       analyze_files
 
@@ -28,7 +25,7 @@ module Punchlist
     end
 
     def source_files_glob
-      @source_files_glob ||=
+      @options[:glob] ||
         '{app,lib,test,spec,feature}/**/*.{rb,swift,scala,js,cpp,c,java,py}'
     end
 
@@ -44,10 +41,21 @@ module Punchlist
       @globber.glob(source_files_glob)
     end
 
-    def punchlist_line_regexp
+    def default_punchlist_line_regexp
       /XXX|TODO/
     end
 
+    def punchlist_line_regexp
+      return @regexp if @regexp
+
+      regexp_string = @options[:regexp]
+      if regexp_string
+        @regexp = Regexp.new(regexp_string)
+      else
+        default_punchlist_line_regexp
+      end
+    end
+
     def look_for_punchlist_items(filename)
       lines = []
       line_num = 0

data/lib/punchlist/options.rb

@@ -0,0 +1,33 @@
+require 'optparse'
+
+module Punchlist
+  class Options
+    attr_reader :default_punchlist_line_regexp
+
+    def initialize(default_punchlist_line_regexp)
+      @default_punchlist_line_regexp = default_punchlist_line_regexp
+    end
+
+    def setup_options(opts)
+      options = {}
+      opts.banner = 'Usage: punchlist [options]'
+      opts.on('-g', '--glob g', 'Filename glob to identify source files') do |v|
+        options[:glob] = v
+      end
+      opts.on('-r', '--regexp r',
+              'Regexp to trigger on - ' \
+              'default is XXX|TODO') do |v|
+        options[:regexp] = v
+      end
+      options
+    end
+
+    def parse_options
+      options = nil
+      OptionParser.new do |opts|
+        options = setup_options(opts)
+      end.parse!
+      options
+    end
+  end
+end

data/lib/punchlist/version.rb

@@ -1,5 +1,5 @@
 # Counts the number of 'todo' comments in your code ('Comment
 # annotations').
 module Punchlist
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: punchlist
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +93,7 @@ files:
 - Rakefile
 - bin/punchlist
 - lib/punchlist.rb
+- lib/punchlist/options.rb
 - lib/punchlist/version.rb
 - punchlist.gemspec
 homepage: http://github.com/apiology/punchlist