pippi 0.0.1

data/test/check_test.rb

@@ -0,0 +1,41 @@
+require 'tempfile'
+
+class CheckTest < MiniTest::Test
+
+  CodeSample = Struct.new(:code_text, :eval_to_execute)
+
+  def assert_no_problems(str)
+    assert execute_pippi_on(foo_bar_code_sample(str)).empty?
+  end
+
+  def assert_problems(str, opts={})
+    assert_equal opts[:count] || 1, execute_pippi_on(foo_bar_code_sample(str), 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)
+    CodeSample.new.tap {|c| c.code_text = "class Foo ; 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

@@ -0,0 +1,5 @@
+class Object
+  def present?
+    self.nil? || self.size == 0
+  end
+end

data/test/test_helper.rb

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

data/test/unit/map_followed_by_flatten_test.rb

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,29 @@
+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

data/test/unit/select_followed_by_first_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class SelectFollowedByFirstTest < CheckTest
+
+  def test_canonical_case_is_found
+    assert_problems "[1,2,3].select {|x| x > 1 }.first"
+  end
+
+  def test_requires_first_call_be_to_select
+    assert_no_problems "[1,2,3].map {|x| x > 1 }.first"
+  end
+
+  def test_requires_last_call_be_to_first
+    assert_no_problems "[1,2,3].select {|x| x > 1 }.sort"
+  end
+
+  def test_works_across_statements
+    assert_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.first"
+  end
+
+  def test_will_not_flag_if_theres_an_intervening_method
+    assert_no_problems "[1,2,3].select {|x| x > 1 }.map {|x| x+1 }.first"
+  end
+
+  def test_will_not_flag_if_other_method_invoked_on_select_result
+    assert_no_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.reject! {|x| x } ; tmp.first"
+  end
+
+  def test_will_not_flag_if_arg_passed
+    assert_no_problems "[1,2,3].select {|x| x > 1 }.first(1)"
+  end
+
+end

data/test/unit/select_followed_by_size_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class SelectFollowedBySizeTest < CheckTest
+
+  def test_canonical_case_is_found
+    assert_problems "[1,2,3].select {|x| x > 1 }.size"
+  end
+
+  def test_requires_first_call_be_to_select
+    assert_no_problems "[1,2,3].map {|x| x > 1 }.size"
+  end
+
+  def test_requires_last_call_be_to_size
+    assert_no_problems "[1,2,3].select {|x| x > 1 }.sort"
+  end
+
+  def test_works_across_statements
+    assert_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.size"
+  end
+
+  def test_will_not_flag_if_theres_an_intervening_method
+    assert_no_problems "[1,2,3].select {|x| x > 1 }.map {|x| x+1 }.size"
+  end
+
+  def test_will_not_flag_if_other_method_invoked_on_select_result
+    assert_no_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.reject! {|x| x } ; tmp.size"
+  end
+
+  def test_will_not_flag_if_method_subsequently_invokedzz
+    assert_no_problems "tmp = [1,2,3].select {|x| x > 1 } ; tmp.size ; y = tmp.sort!"
+  end
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: pippi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Pippi is a utility for locating suboptimal Ruby class API usage.
+email:
+- tom@thomasleecopeland.com
+executables:
+- pippi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/pippi
+- doc/README
+- doc/docs.md
+- lib/pippi.rb
+- lib/pippi/auto_runner.rb
+- lib/pippi/check_loader.rb
+- lib/pippi/check_set_mapper.rb
+- lib/pippi/checks/check.rb
+- 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_first.rb
+- lib/pippi/checks/select_followed_by_size.rb
+- lib/pippi/context.rb
+- lib/pippi/exec_runner.rb
+- lib/pippi/problem.rb
+- 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/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
+- tmp/.gitignore
+- 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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: none
+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/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