pippi 0.0.4 → 0.0.5

data/lib/pippi/tasks.rb

@@ -3,16 +3,13 @@ require 'pippi'
 module Pippi
   class Documentation
     def generate
-      str = ""
-      [Pippi::Checks::SelectFollowedBySize::Documentation,
-       Pippi::Checks::SelectFollowedByFirst::Documentation,
-       Pippi::Checks::ReverseFollowedByEach::Documentation,
-       Pippi::Checks::MapFollowedByFlatten::Documentation,
-       Pippi::Checks::AssertWithNil::Documentation,
-      ].sort {|a,b| a.name <=> b.name }.each do |clz|
-        obj = clz.new
-        str << %Q{
-### #{clz.name.to_s.split('::')[2]}
+      str = ''
+      Pippi::CheckSetMapper.new("").predefined_sets.sort.select {|k,v| v.any? }.each do |checkset_name, checks|
+        str << "### #{checkset_name}\n"
+        checks.sort.each do |check|
+          obj = Object.const_get("Pippi::Checks::#{check}::Documentation").new
+          str << %(
+#### #{check}
 
 #{obj.description}
 
@@ -27,15 +24,16 @@ Instead, consider doing this:
 \`\`\`ruby
 #{obj.instead_use}
 \`\`\`
-}
+)
+        end
       end
-      File.open("doc/docs.md", "w") {|f| f.syswrite(str) }
+      File.open('doc/docs.md', 'w') { |f| f.syswrite(str) }
     end
   end
 end
 
 namespace :pippi do
-  desc "Generate check documentation"
+  desc 'Generate check documentation'
   task :generate_docs do
     Pippi::Documentation.new.generate
   end

data/lib/pippi/version.rb

@@ -1,3 +1,3 @@
 module Pippi
-  VERSION = "0.0.4"
-end
+  VERSION = '0.0.5'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pippi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tom Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -60,13 +60,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - README.md
-- Rakefile
 - bin/pippi
 - doc/README
 - doc/docs.md
@@ -79,6 +74,7 @@ files:
 - lib/pippi/checks/debug_check.rb
 - lib/pippi/checks/map_followed_by_flatten.rb
 - lib/pippi/checks/reverse_followed_by_each.rb
+- lib/pippi/checks/select_followed_by_empty.rb
 - lib/pippi/checks/select_followed_by_first.rb
 - lib/pippi/checks/select_followed_by_size.rb
 - lib/pippi/context.rb
@@ -87,24 +83,6 @@ files:
 - lib/pippi/report.rb
 - lib/pippi/tasks.rb
 - lib/pippi/version.rb
-- pippi.gemspec
-- sample/map_followed_by_flatten.rb
-- test/check_test.rb
-- test/rails_core_extensions.rb
-- test/test_helper.rb
-- test/unit/assert_with_nil_test.rb
-- test/unit/check_set_mapper_test.rb
-- test/unit/map_followed_by_flatten_test.rb
-- test/unit/problem_test.rb
-- test/unit/report_test.rb
-- test/unit/reverse_followed_by_each_test.rb
-- test/unit/select_followed_by_first_test.rb
-- test/unit/select_followed_by_size_test.rb
-- vendor/cache/byebug-2.7.0.gem
-- vendor/cache/columnize-0.8.9.gem
-- vendor/cache/debugger-linecache-1.2.0.gem
-- vendor/cache/minitest-5.4.2.gem
-- vendor/cache/rake-10.1.0.gem
 homepage: https://github.com/tcopeland/pippi
 licenses:
 - MIT
@@ -129,15 +107,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby runtime code analyzer
-test_files:
-- test/check_test.rb
-- test/rails_core_extensions.rb
-- test/test_helper.rb
-- test/unit/assert_with_nil_test.rb
-- test/unit/check_set_mapper_test.rb
-- test/unit/map_followed_by_flatten_test.rb
-- test/unit/problem_test.rb
-- test/unit/report_test.rb
-- test/unit/reverse_followed_by_each_test.rb
-- test/unit/select_followed_by_first_test.rb
-- test/unit/select_followed_by_size_test.rb
+test_files: []

data/.gitignore

@@ -1,6 +0,0 @@
-tmp/*
-!tmp/baz.rb
-pippi.log
-pippi_debug.log
-pippi*.gem
-out.txt

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.2

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Gemfile.lock

@@ -1,24 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pippi (0.0.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (2.7.0)
-      columnize (~> 0.3)
-      debugger-linecache (~> 1.2)
-    columnize (0.8.9)
-    debugger-linecache (1.2.0)
-    minitest (5.4.2)
-    rake (10.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (~> 2.7)
-  minitest (~> 5.0)
-  pippi!
-  rake (~> 10.1)

data/Rakefile

@@ -1,11 +0,0 @@
-require 'rake/testtask'
-require 'rubygems'
-require 'bundler/setup'
-require 'pippi/tasks'
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/unit/**_test.rb"
-end
-
-task :default => [:test]

data/pippi.gemspec

@@ -1,23 +0,0 @@
-$:.push File.expand_path("../lib", __FILE__)
-
-require 'pippi/version'
-
-Gem::Specification.new do |s|
-  s.name = 'pippi'
-  s.version = Pippi::VERSION
-  s.authors = ["Tom Copeland"]
-  s.email = ["tom@thomasleecopeland.com"]
-  s.homepage = "https://github.com/tcopeland/pippi"
-  s.summary = "A Ruby runtime code analyzer"
-  s.description = "Pippi is a utility for locating suboptimal Ruby class API usage."
-  s.license = "MIT"
-  s.rubyforge_project = "none"
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files test/*`.split("\n")
-  s.executables = "pippi"
-  s.require_paths = ["lib"]
-  s.add_development_dependency 'rake', '~> 10.1'
-  s.add_development_dependency 'minitest', '~> 5.0'
-  s.add_development_dependency 'byebug', '~> 2.7'
-  s.required_ruby_version = '>= 2.0.0'
-end

data/sample/map_followed_by_flatten.rb

@@ -1,6 +0,0 @@
-class Foo
-  def bar
-    x = [1,2,3]
-    x.map {|y| [y, y+1] }.flatten
-  end
-end

data/test/check_test.rb

@@ -1,41 +0,0 @@
-require 'tempfile'
-
-class CheckTest < MiniTest::Test
-
-  CodeSample = Struct.new(:code_text, :eval_to_execute)
-
-  def assert_no_problems(str, opts={})
-    assert execute_pippi_on(foo_bar_code_sample(str, opts[:subclass] || ""), opts).empty?
-  end
-
-  def assert_problems(str, opts={})
-    assert_equal opts[:count] || 1, execute_pippi_on(foo_bar_code_sample(str, opts[:subclass] || ""), opts).size
-  end
-
-  def output_file_name
-    @output_file_name ||= Tempfile.new("pippi_output").path
-  end
-
-  def tmp_code_sample_file_name
-    @tmp_code_sample_file_name ||= Tempfile.new("pippi_codesample").path
-  end
-
-  def foo_bar_code_sample(code, subclass="")
-    CodeSample.new.tap {|c| c.code_text = "class Foo #{subclass.size > 0 ? "< #{subclass}" : ""}; def bar ; #{code} ; end ; end" ; c.eval_to_execute = "Foo.new.bar" }
-  end
-
-  def execute_pippi_on(code, opts={})
-    File.open(tmp_code_sample_file_name, "w") {|f| f.syswrite(code.code_text) }
-    maybe_extensions = opts[:include_rails_core_extensions].nil? ? "" : "-r#{Dir.pwd}/test/rails_core_extensions.rb"
-    cmd = "bundle exec ruby #{maybe_extensions} bin/pippi #{tmp_code_sample_file_name} #{check_for_test} #{code.eval_to_execute} #{output_file_name}"
-    IO.popen(cmd).close
-    report = File.read(output_file_name).split
-    FileUtils.rm_f(output_file_name) if File.exists?(output_file_name)
-    report
-  end
-
-  def check_for_test
-    self.class.name.sub(/Test/, "")
-  end
-
-end

data/test/rails_core_extensions.rb

@@ -1,13 +0,0 @@
-class Object
-  def present?
-    self.nil? || self.size == 0
-  end
-end
-
-
-module ActiveSupport
-  class TestCase
-    def assert_equal(*args)
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'minitest/autorun'
-require 'check_test'
-require 'byebug'
-
-require 'pippi'

data/test/unit/assert_with_nil_test.rb

@@ -1,50 +0,0 @@
-require "test_helper"
-
-class AssertWithNilTest < CheckTest
-
-  def test_canonical_case_is_found
-    assert_problems "x = 42 ; assert_equal(nil, x)", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
-  end
-
-  def test_non_nil_first_arg_doesnt_flag
-    assert_no_problems "x = 42 ; assert_equal(42, x)", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
-  end
-
-  # Seems like there's some way to do this, but maybe not... anyhow, moving this rule to "buggy" for now
-  # pippi> $ echo "foo(nil)" | ruby --dump insns
-  # == disasm: <RubyVM::InstructionSequence:<main>@->=======================
-  # 0000 trace            1                                               (   1)
-  # 0002 putself
-  # 0003 putnil
-  # 0004 opt_send_simple  <callinfo!mid:foo, argc:1, FCALL|ARGS_SKIP>
-  # 0006 leave
-  # pippi> $ echo "foo(x)" | ruby --dump insns
-  # == disasm: <RubyVM::InstructionSequence:<main>@->=======================
-  # 0000 trace            1                                               (   1)
-  # 0002 putself
-  # 0003 putself
-  # 0004 opt_send_simple  <callinfo!mid:x, argc:0, FCALL|VCALL|ARGS_SKIP>
-  # 0006 opt_send_simple  <callinfo!mid:foo, argc:1, FCALL|ARGS_SKIP>
-  # 0008 leave
-  # also consider
-=begin
-class Bar
-  def buz(x)
-  end
-  def foo
-    y = nil
-    buz(y)
-    RubyVM::InstructionSequence.of(method(__method__)).disasm.split("\n").each {|x| puts x }
-  end
-end
-Bar.new.foo
-=end
-  def test_nil_reference_first_arg_doesnt_flag
-    assert_no_problems "x = 42 ; y = nil ; assert_equal(nil, x)", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
-  end
-
-  def test_three_arg_is_flagged
-    assert_problems "x = 42 ; assert_equal(nil, x, 'whatevs')", :include_rails_core_extensions => true, :subclass => "ActiveSupport::TestCase"
-  end
-
-end

data/test/unit/check_set_mapper_test.rb

@@ -1,17 +0,0 @@
-require "test_helper"
-
-class CheckSetMapperTest < Minitest::Test
-
-  def test_should_find_predefined_sets
-    csm = Pippi::CheckSetMapper.new("basic")
-    assert csm.check_names.include?("SelectFollowedByFirst")
-  end
-
-  def test_should_allow_comma_separated_checkset_names
-    csm = Pippi::CheckSetMapper.new("a,b")
-    csm.predefined_sets = {"a" => ["foo"], "b" => ["bar"]}
-    assert csm.check_names.include?("foo")
-    assert csm.check_names.include?("bar")
-  end
-
-end

data/test/unit/map_followed_by_flatten_test.rb

@@ -1,38 +0,0 @@
-require 'test_helper'
-
-class MapFollowedByFlattenTest < CheckTest
-
-  def test_canonical_case_is_found
-    assert_problems "[1,2,3].map {|x| [x,x+1] }.flatten(1)"
-  end
-
-  def test_requires_first_call_be_to_map
-    assert_no_problems "[1,2,3].select {|x| [x,x+1] }.flatten(1)"
-  end
-
-  def test_requires_last_call_be_to_flatten
-    assert_no_problems "[1,2,3].map {|x| [x] }.first"
-  end
-
-  def test_works_across_statements
-    assert_problems "tmp = [1,2,3].map {|x| [x] } ; tmp.flatten(1)"
-  end
-
-  def test_requires_arg_to_flatten_to_be_one
-    assert_no_problems "[1,2,3].map {|x| [x] }.flatten"
-  end
-
-  def test_will_not_flag_if_theres_an_intervening_method
-    assert_no_problems "[1,2,3].map {|x| [x] }.select {|x| x.to_s > '1' }.flatten(1)"
-  end
-
-  def test_will_not_flag_if_mutator_invoked
-    assert_no_problems "t = [1,2,3].map {|x| [x] } ; t.select! {|x| rand > 0.5 } ; t.flatten(1)"
-  end
-
-=begin
-  def test_dfa_issue
-    assert_no_problems "t = [1,2,3].map {|x| [x] } ; if (rand > 0.5) ; t.sort! ; end ; t.flatten(1)"
-  end
-=end
-end

data/test/unit/problem_test.rb

@@ -1,23 +0,0 @@
-require "test_helper"
-
-class ProblemTest < MiniTest::Test
-
-  def test_eql_should_say_equal_things_are_equal
-    p1 = Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => "String")
-    p2 = Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => "String")
-    assert p1.eql?(p2)
-    assert p2.eql?(p1)
-  end
-
-  def test_eql_should_say_unequal_things_are_unequal
-    p1 = Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => "String")
-    p2 = Pippi::Problem.new(:file_path => "foo", :line_number => 43, :check_class => "String")
-    assert !p1.eql?(p2)
-    assert !p2.eql?(p1)
-    p3 = Pippi::Problem.new(:file_path => "foo2", :line_number => 42, :check_class => "String")
-    assert !p1.eql?(p3)
-    p4 = Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => "Array")
-    assert !p1.eql?(p4)
-  end
-
-end

data/test/unit/report_test.rb

@@ -1,25 +0,0 @@
-require "test_helper"
-
-class ReportTest < MiniTest::Test
-
-  def test_can_add_a_problem
-    report = Pippi::Report.new
-    report.add(Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => Pippi::Checks::SelectFollowedByFirst))
-    assert_equal 1, report.problems.size
-  end
-  
-  def test_filters_duplicates
-    report = Pippi::Report.new
-    report.add(Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => Pippi::Checks::SelectFollowedByFirst))
-    report.add(Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => Pippi::Checks::SelectFollowedByFirst))
-    assert_equal 1, report.problems.size
-  end
-  
-  def test_can_remove_problem
-    report = Pippi::Report.new
-    report.add(Pippi::Problem.new(:file_path => "foo", :line_number => 42, :check_class => Pippi::Checks::SelectFollowedByFirst))
-    report.remove 42, "foo", Pippi::Checks::SelectFollowedByFirst
-    assert report.problems.empty?
-  end
-  
-end

data/test/unit/reverse_followed_by_each_test.rb

@@ -1,29 +0,0 @@
-require "test_helper"
-
-class ReverseFollowedByEachTest < CheckTest
-
-  def test_reverse_still_works
-    assert_no_problems "raise 'bang' unless [1,2,3].reverse == [3,2,1]"
-  end
-
-  def test_canonical_case_is_found
-    assert_problems "[1,2,3].reverse.each {|x| x }"
-  end
-
-  def test_requires_first_call_be_to_reverse
-    assert_no_problems "[1,2,3].sort.each{|x| [x,x+1] }"
-  end
-
-  def test_requires_last_call_be_to_each
-    assert_no_problems "[1,2,3].reverse.select {|x| [x] }"
-  end
-
-  def test_works_across_statements
-    assert_problems "tmp = [1,2,3].reverse ; tmp.each {|x| [x] }"
-  end
-
-  def test_will_not_flag_if_mutator_invoked
-    assert_no_problems "t = [1,2,3].reverse ;  t.sort! ; t.each {|x| x }"
-  end
-
-end