punchlist 1.2.0 → 1.3.1

data/bin/overcommit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'overcommit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("overcommit", "overcommit")

data/bin/punchlist

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

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/solargraph

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'solargraph' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("solargraph", "solargraph")

data/bin/yard

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/docs/.gitignore

@@ -0,0 +1,3 @@
+*.html
+/css
+/js

data/docs/cookiecutter_input.json

@@ -0,0 +1,16 @@
+{
+    "_checkout": null,
+    "_output_dir": "/Users/broz/src/punchlist/.git/cookiecutter",
+    "_repo_dir": "/Users/broz/src/cookiecutter-gem",
+    "_template": "https://github.com/apiology/cookiecutter-gem",
+    "email": "vince@broz.cc",
+    "full_name": "Vince Broz",
+    "github_username": "apiology",
+    "module_name": "Punchlist",
+    "open_source_license": "MIT license",
+    "project_name": "Punchlist",
+    "project_short_description": "Counts the number of 'todo' comments in your code",
+    "project_slug": "punchlist",
+    "type_of_github_repo": "public",
+    "version": "1.3.6"
+}

data/feature/expected/mixed_types_of_source_files_results.txt

@@ -0,0 +1,2 @@
+lib/bar.scala:1: println('something') // TODO: mix styles
+lib/foo.rb:3: # XXX: need to frob the lub

data/feature/expected/one_source_file_with_cis_results.txt

@@ -0,0 +1 @@
+app/foo.rb:4: puts 'foo' # XXX: change to bar

data/feature/expected/scala_file_to_be_ignored_results.txt

@@ -0,0 +1 @@
+lib/foo.rb:3: # XXX: need to frob the lub

data/feature/feature_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'punchlist'
+require 'rspec'
+
+# Add the bin directory, to allow testing of gem executables as if the gem is
+# already installed.
+root_dir = RSpec::Core::RubyProject.root
+exec_dir = File.join(File::SEPARATOR, root_dir, 'bin')
+# @sg-ignore
+ENV['PATH'] = [exec_dir, ENV.fetch('PATH')].join(File::PATH_SEPARATOR)
+
+# Courtesy of:
+# https://raw.github.com/cupakromer/tao-of-tdd/master/adder/spec/support/
+#    capture_exec.rb
+
+# @sg-ignore
+# @param cmd [Array<String>]
+# @return [String]
+def exec_io(*cmd)
+  cmd = cmd.flatten
+  # @sg-ignore
+  all_out, _exit_code = Open3.capture2e(*cmd)
+
+  all_out
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+  config.alias_it_should_behave_like_to :has_behavior
+  config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+end
+
+def let_double(*doubles)
+  doubles.each do |double_sym|
+    # @sg-ignore
+    let(double_sym) { double(double_sym.to_s) }
+  end
+end

data/feature/pronto_punchlist_use_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'punchlist'
+require 'punchlist/offense'
+
+# Example use from https://github.com/apiology/pronto-punchlist
+
+describe Punchlist do
+  subject(:offenses) do
+    ::Punchlist::Inspector.new(punchlist_line_regexp, path).run
+  end
+
+  let(:punchlist_line_regexp) do
+    Regexp.new(::Punchlist::Config.default_punchlist_line_regexp_string)
+  end
+  let(:path) { 'feature/samples/mixed_types_of_source_files/lib/bar.scala' }
+
+  it 'stays compatible with use by pronto-spec' do
+    expect(offenses.length).to eq(1)
+    offenses.each do |offense|
+      expect(offense.filename).to eq(path)
+      expect(offense.line_num).to eq(1)
+    end
+  end
+end

data/feature/punchlist_cli_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'feature_helper'
+require 'punchlist'
+
+describe Punchlist do
+  # "pis" are "punchlist items"
+
+  %w[mixed_types_of_source_files
+     one_source_file_with_cis
+     no_files
+     source_file_with_no_items
+     non_source_file_with_pis].each do |type|
+    it "handles #{type} case" do
+      expect(exec_io("cd feature/samples/#{type} &&" \
+                     'RUBYLIB=`pwd`/../../lib:"$RUBYLIB" punchlist'))
+        .to eq(IO.read("feature/expected/#{type}_results.txt"))
+    end
+  end
+
+  %w[scala_file_to_be_ignored].each do |type|
+    it "handles #{type} case with a special glob" do
+      expect(exec_io("cd feature/samples/#{type} &&" \
+                     'RUBYLIB=`pwd`/../../lib:"$RUBYLIB" ' \
+                     "punchlist --glob '{app,lib,test,spec,feature}/**/*." \
+                     "{rb,swift,cpp,c,java,py}'"))
+        .to eq(IO.read("feature/expected/#{type}_results.txt"))
+    end
+  end
+
+  let(:expected_usage) do
+    "Usage: punchlist [options]\n"\
+    '    -g, --glob glob here             ' \
+    'Which files to parse - default is ' \
+    '{Dockerfile,Rakefile,{*,.*}.{c,clj,cljs,cpp,gemspec,groovy,html,java,' \
+    'js,json,py,rake,rb,scala,sh,swift,yml},{app,config,db,feature,lib,spec,' \
+    'src,test,tests,vars,www}/**/{*,.*}.{c,clj,cljs,cpp,gemspec,groovy,html,' \
+    'java,js,json,py,rake,rb,scala,sh,swift,yml}}' \
+    "\n" \
+    '    -e, --exclude-glob glob here     ' \
+    "Files to exclude - default is none\n" \
+    '    -r, --regexp r                   ' \
+    'Regexp to trigger upon - default is ' \
+    "XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT\n"
+  end
+
+  it 'starts up with short help argument' do
+    expect(exec_io('punchlist -h'))
+      .to eq(expected_usage)
+  end
+
+  it 'starts up with long help argument' do
+    expect(exec_io('punchlist --help'))
+      .to eq(expected_usage)
+  end
+
+  it 'starts up with invalid argument' do
+    expect(exec_io('punchlist --blah'))
+      .to match(/invalid option/)
+  end
+
+  xit 'handles passing in different annotation comments'
+end

data/feature/samples/mixed_types_of_source_files/lib/bar.scala

@@ -0,0 +1 @@
+println('something') // TODO: mix styles

data/feature/samples/mixed_types_of_source_files/lib/foo.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# XXX: need to frob the lub
+puts 'hi'

data/feature/samples/non_source_file_with_pis/foo.doc

@@ -0,0 +1,5 @@
+XXX
+TODO
+FUTURE
+FIXIT
+FIX

data/feature/samples/one_source_file_with_cis/app/foo.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+puts 'foo' # XXX: change to bar

data/feature/samples/scala_file_to_be_ignored/lib/bar.scala

@@ -0,0 +1 @@
+println('something') // TODO: mix styles

data/feature/samples/scala_file_to_be_ignored/lib/foo.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# XXX: need to frob the lub
+puts 'hi'

data/feature/samples/source_file_with_no_items/foo.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+puts 'hi'