punchlist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 568d844bdbe03811439d0da0a9771692dac2d6a4
+  data.tar.gz: 53e847e4a97b8e7e98738627ddc17e2fd1ab32d5
+SHA512:
+  metadata.gz: c661539cc917dce77c885d8b4b2910500335800fd6e993b82c26c85b1ad6830e766149f23e6de3458956e57ccd87dd7709de7f6df8762ad78f2df1f7041323d1
+  data.tar.gz: f4a407e49ae8708bd1323a0d6460d2543b3372f3e7b6d3cb8c4e98880b84971fd4a97d799d1c75b509060d7a3d8747fa9f641a0d0b3b8d821a3a911c87fba540

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Vincent Broz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'quality/rake/task'
+
+Quality::Rake::Task.new do |task|
+  task.skip_tools = ['reek']
+  task.output_dir = 'metrics'
+end
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end
+
+desc 'Run features'
+RSpec::Core::RakeTask.new(:feature) do |task|
+  task.pattern = 'feature/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end
+
+task :clear_metrics do |_t|
+  ret =
+    system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
+  fail unless ret
+end
+
+desc 'Default: Run specs and check quality.'
+task localtest: [:clear_metrics, :spec, :feature, :quality]
+task default: [:localtest]

data/bin/punchlist

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/punchlist'
+
+Punchlist::Punchlist.new(ARGV).run

data/lib/punchlist/version.rb

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

data/lib/punchlist.rb

@@ -0,0 +1,65 @@
+module Punchlist
+  # Counts the number of 'todo' comments in your code.
+  class Punchlist
+    def initialize(args,
+                   outputter: STDOUT,
+                   globber: Dir,
+                   file_opener: File)
+      @args = args
+      @outputter = outputter
+      @globber = globber
+      @file_opener = file_opener
+    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
+
+      analyze_files
+
+      0
+    end
+
+    def source_files_glob
+      @source_files_glob ||=
+        '{app,lib,test,spec,feature}/**/*.{rb,swift,scala,js,cpp,c,java,py}'
+    end
+
+    def analyze_files
+      source_files.each do |filename|
+        output = look_for_punchlist_items(filename)
+        @outputter.puts render(output)
+      end
+    end
+
+    def source_files
+      @globber.glob(source_files_glob)
+    end
+
+    def punchlist_line_regexp
+      /XXX|TODO/
+    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
+    end
+
+    def render(output)
+      output.map do |filename, line_num, line|
+        "#{filename}:#{line_num}: #{line}"
+      end.join("\n")
+    end
+  end
+end

data/punchlist.gemspec

@@ -0,0 +1,34 @@
+# ; -*-Ruby-*-
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
+require 'punchlist/version'
+
+Gem::Specification.new do |s|
+  s.name = 'punchlist'
+  s.version = Punchlist::VERSION
+
+  s.authors = ['Vince Broz']
+  s.description = 'punchlist finds the largest source files in your project ' \
+                  'and reports on them'
+  s.email = ['vince@broz.cc']
+  s.executables = ['punchlist']
+  # s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
+  s.license = 'MIT'
+  s.files = Dir['License.txt', 'README.md',
+                'Rakefile',
+                'bin/punchlist',
+                '{lib}/**/*',
+                'punchlist.gemspec'] & `git ls-files -z`.split("\0")
+  # s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/apiology/punchlist'
+  # s.rubyforge_project = %q{punchlist}
+  s.rubygems_version = '1.3.6'
+  s.summary = 'Finds largest source files in a project'
+
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('quality')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('simplecov')
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: punchlist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vince Broz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !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
+  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: '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 finds the largest source files in your project and reports
+  on them
+email:
+- vince@broz.cc
+executables:
+- punchlist
+extensions: []
+extra_rdoc_files: []
+files:
+- License.txt
+- Rakefile
+- bin/punchlist
+- lib/punchlist.rb
+- lib/punchlist/version.rb
+- punchlist.gemspec
+homepage: http://github.com/apiology/punchlist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Finds largest source files in a project
+test_files: []