punchlist 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3a91cd04e344a758a88d1892086339492be3306
-  data.tar.gz: cea784b35403f68c784694e64101b342fc0328b5
+  metadata.gz: 417c0f1b1739e879b670660d5965b2de9983ebd6
+  data.tar.gz: cd161e7cbf434e7011cc6f6a52ca16fc9d2816aa
 SHA512:
-  metadata.gz: c5327b956982854e55f5b4e620ab0060825cd39e70838cccb818490e9f48dca889ccbc7329b94c416c2fd0465b815caa15f1004718a526321992bad392319419
-  data.tar.gz: c7663708ff7dc748f159db4adb607e6267334396551abe8d74d82eb53bcfdf1c43852e73d027d249953cce532d2a681d722bd25ac960b537b2b69d1139852392
+  metadata.gz: 634f25dc315d1b0f78b75924b824a5bf495d4214194d49bee2b3a04fe6de3e11afd61e4d19001dac3adabe458a6a0e05ecaf3329f44af87feff9daa2e3672fcc
+  data.tar.gz: bf6b12e411662a479591c668a661bd75ad1b712881085130a2bd5edb3d182681498695b92a3ea961bae3707fed05356e07c52e7b8c4ef5806694f07473328a44

data/Rakefile

@@ -1,12 +1,32 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'quality/rake/task'
 
+task :pronto do
+  formatter = '-f github_pr' if ENV.key? 'PRONTO_GITHUB_ACCESS_TOKEN'
+  if ENV.key? 'TRAVIS_PULL_REQUEST'
+    ENV['PRONTO_PULL_REQUEST_ID'] = ENV['TRAVIS_PULL_REQUEST']
+  elsif ENV.key? 'CIRCLE_PULL_REQUEST'
+    ENV['PRONTO_PULL_REQUEST_ID'] = ENV['CIRCLE_PULL_REQUEST'].split('/').last
+  end
+  puts "PRONTO_PULL_REQUEST_ID is #{ENV['PRONTO_PULL_REQUEST_ID']}"
+  sh "pronto run #{formatter} -c origin/master --no-exit-code --unstaged "\
+     '|| true'
+  sh "pronto run #{formatter} -c origin/master --no-exit-code --staged || true"
+  sh "pronto run #{formatter} -c origin/master --no-exit-code || true"
+end
+
 Quality::Rake::Task.new do |task|
-  task.skip_tools = ['reek']
+  task.skip_tools = %w[reek shellcheck]
   task.output_dir = 'metrics'
+  # Add 'xit ' to the standard list, finding disabled tests
+  task.punchlist_regexp = 'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT|xit '
 end
 
+task quality: %i[pronto]
+
 desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = 'spec/**/*_spec.rb'
@@ -22,9 +42,10 @@ end
 task :clear_metrics do |_t|
   ret =
     system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
-  fail unless ret
+  raise unless ret
 end
 
 desc 'Default: Run specs and check quality.'
-task localtest: [:clear_metrics, :spec, :feature, :quality]
+task localtest: %i[clear_metrics spec feature quality]
+task test: %i[spec feature]
 task default: [:localtest]

data/bin/punchlist

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/punchlist'
 

data/lib/punchlist.rb

@@ -1,26 +1,24 @@
-require_relative 'punchlist/options'
+# frozen_string_literal: true
+
+require_relative 'punchlist/option_parser'
+require_relative 'punchlist/inspector'
+require_relative 'punchlist/renderer'
 
 # 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,
-                   file_opener: File,
-                   options_parser: Options.new(args),
+                   option_parser_class: OptionParser,
                    source_file_globber: SourceFinder::SourceFileGlobber.new)
-      @args = args
+      option_parser = option_parser_class.new(args)
+      @config = option_parser.generate_config(source_file_globber)
       @outputter = outputter
-      @file_opener = file_opener
-      @options_parser = options_parser
-      @source_file_globber = source_file_globber
     end
 
     def run
-      @options = @options_parser.parse_options
-
       analyze_files
 
       0
@@ -28,50 +26,18 @@ module Punchlist
 
     def analyze_files
       all_output = []
-      source_files.each do |filename|
+      @config.source_files.each do |filename|
         all_output.concat(look_for_punchlist_items(filename))
       end
       @outputter.print render(all_output)
     end
 
-    def source_files
-      if @options[:glob]
-        @source_file_globber.source_files_glob = @options[:glob]
-      end
-      if @options[:exclude]
-        @source_file_globber.source_files_exclude_glob = @options[:exclude]
-      end
-      @source_file_globber.source_files_arr
-    end
-
-    def punchlist_line_regexp
-      return @regexp if @regexp
-
-      regexp_string = @options[:regexp]
-      if regexp_string
-        @regexp = Regexp.new(regexp_string)
-      else
-        Options.default_punchlist_line_regexp
-      end
-    end
-
     def look_for_punchlist_items(filename)
-      lines = []
-      line_num = 0
-      @file_opener.open(filename, 'r') do |file|
-        file.each_line do |line|
-          line_num += 1
-          lines << [filename, line_num, line] if line =~ punchlist_line_regexp
-        end
-      end
-      lines
+      Inspector.new(@config.regexp, filename).run
     end
 
     def render(output)
-      lines = output.map do |filename, line_num, line|
-        "#{filename}:#{line_num}: #{line}"
-      end
-      lines.join
+      CliRenderer.new.render(output)
     end
   end
 end

data/lib/punchlist/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Punchlist
+  # Configuration for punchlist gem
+  class Config
+    attr_reader :regexp, :glob, :exclude
+
+    def self.default_punchlist_line_regexp_string
+      'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
+    end
+
+    def source_files
+      @source_file_globber.source_files_glob = glob if glob
+      @source_file_globber.source_files_exclude_glob = exclude if exclude
+      @source_file_globber.source_files_arr
+    end
+
+    def initialize(regexp: nil, glob: nil, exclude: nil,
+                   source_file_globber:)
+      @regexp = Regexp.new(regexp ||
+                           Config.default_punchlist_line_regexp_string)
+      @glob = glob
+      @exclude = exclude
+      @source_file_globber = source_file_globber
+    end
+  end
+end

data/lib/punchlist/inspector.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'offense'
+
+module Punchlist
+  # Inspects files for punchlist items
+  class Inspector
+    attr_reader :punchlist_line_regexp, :filename
+    def initialize(punchlist_line_regexp, filename, file_opener: File)
+      @file_opener = file_opener
+      @punchlist_line_regexp = punchlist_line_regexp
+      @filename = filename
+      @lines = []
+      @line_num = 0
+    end
+
+    def inspect_line(line)
+      @line_num += 1
+      return unless line =~ punchlist_line_regexp
+
+      @lines << Offense.new(filename, @line_num, line.chomp)
+    end
+
+    def run
+      @file_opener.open(filename, 'r') do |file|
+        file.each_line { |line| inspect_line(line) }
+      end
+      @lines
+    end
+  end
+end

data/lib/punchlist/offense.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Punchlist
+  # Represents a discovered punchlist item in code
+  class Offense
+    attr_reader :filename, :line_num, :line
+    def initialize(filename, line_num, line)
+      @filename = filename
+      @line_num = line_num
+      @line = line
+    end
+
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+
+    protected
+
+    def state
+      [@filename, @line_num, @line]
+    end
+  end
+end

data/lib/punchlist/{options.rb → option_parser.rb}

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require 'source_finder/option_parser'
+require_relative 'config'
 
 module Punchlist
   # Parse command line options
-  class Options
+  class OptionParser
     attr_reader :default_punchlist_line_regexp
 
     def initialize(args,
@@ -12,18 +15,10 @@ module Punchlist
       @source_finder_option_parser = source_finder_option_parser
     end
 
-    def self.default_punchlist_line_regexp_string
-      'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
-    end
-
-    def self.default_punchlist_line_regexp
-      Regexp.new(default_punchlist_line_regexp_string)
-    end
-
     def parse_regexp(opts, options)
       opts.on('-r', '--regexp r',
-              'Regexp to trigger opon - default is ' \
-              "#{self.class.default_punchlist_line_regexp_string}") do |v|
+              'Regexp to trigger upon - default is ' \
+              "#{Config.default_punchlist_line_regexp_string}") do |v|
         options[:regexp] = v
       end
     end
@@ -36,12 +31,12 @@ module Punchlist
       options
     end
 
-    def parse_options
+    def generate_config(source_file_globber)
       options = nil
-      OptionParser.new do |opts|
+      ::OptionParser.new do |opts|
         options = setup_options(opts)
       end.parse!(@args)
-      options
+      Config.new(**options, source_file_globber: source_file_globber)
     end
   end
 end

data/lib/punchlist/renderer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Punchlist
+  # Render a text format of offenses
+  class CliRenderer
+    def render(output)
+      lines = output.map do |offense|
+        "#{offense.filename}:#{offense.line_num}: #{offense.line}"
+      end
+      out = lines.join("\n")
+      if out.empty?
+        out
+      else
+        out + "\n"
+      end
+    end
+  end
+end

data/lib/punchlist/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Counts the number of 'todo' comments in your code ('Comment
 # annotations').
 module Punchlist
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/punchlist.gemspec

@@ -1,5 +1,6 @@
 # ; -*-Ruby-*-
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
 require 'punchlist/version'
 
@@ -29,8 +30,10 @@ Gem::Specification.new do |s|
   s.add_dependency('source_finder', ['>=2'])
 
   s.add_development_dependency('bundler')
+  s.add_development_dependency('pronto')
+  s.add_development_dependency('pronto-rubocop')
+  s.add_development_dependency('quality', ['~> 36'])
   s.add_development_dependency('rake')
-  s.add_development_dependency('quality', ['>=16'])
   s.add_development_dependency('rspec')
   s.add_development_dependency('simplecov')
 end

metadata

@@ -1,97 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: punchlist
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2019-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: source_finder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   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'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pronto
+  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'
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
   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'
 - !ruby/object:Gem::Dependency
   name: quality
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '16'
+        version: '36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '16'
+        version: '36'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: punchlist lists your annotation comments--things like 'LATER/HACK/FIXIT'
@@ -106,7 +134,11 @@ files:
 - Rakefile
 - bin/punchlist
 - lib/punchlist.rb
-- lib/punchlist/options.rb
+- lib/punchlist/config.rb
+- lib/punchlist/inspector.rb
+- lib/punchlist/offense.rb
+- lib/punchlist/option_parser.rb
+- lib/punchlist/renderer.rb
 - lib/punchlist/version.rb
 - punchlist.gemspec
 homepage: http://github.com/apiology/punchlist
@@ -119,17 +151,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Finds largest source files in a project