pippi 0.0.4 → 0.0.5

data/lib/pippi/check_set_mapper.rb

@@ -1,7 +1,5 @@
 module Pippi
-
   class CheckSetMapper
-
     attr_reader :raw_check_specifier
     attr_accessor :predefined_sets
 
@@ -11,7 +9,7 @@ module Pippi
     end
 
     def check_names
-      raw_check_specifier.split(",").map do |specifier|
+      raw_check_specifier.split(',').map do |specifier|
         predefined_sets[specifier] || specifier
       end.flatten
     end
@@ -24,6 +22,7 @@ module Pippi
         "basic" => [
           "SelectFollowedByFirst",
           "SelectFollowedBySize",
+          "SelectFollowedByEmpty",
           "ReverseFollowedByEach",
         ],
         "training" => [

data/lib/pippi/checks/assert_with_nil.rb

@@ -1,7 +1,5 @@
 module Pippi::Checks
-
   class AssertWithNil < Check
-
     module MyAssertEqual
       def assert_equal(*args)
         if args.size > 1 && args[0].object_id == 8
@@ -19,7 +17,7 @@ module Pippi::Checks
             @_pippi_check_assert_with_nil
           end
           def self._pippi_check_assert_with_nil
-            self.ancestors.detect {|x| x == ActiveSupport::TestCase }._pippi_other_check_assert_with_nil
+            ancestors.find { |x| x == ActiveSupport::TestCase }._pippi_other_check_assert_with_nil
           end
         end
         ActiveSupport::TestCase.prepend Pippi::Checks::AssertWithNil::MyAssertEqual
@@ -30,13 +28,14 @@ module Pippi::Checks
       def description
         "Don't use assert_equal with nil as a first argument; use assert_nil instead"
       end
+
       def sample
-        "x = nil ; assert_equal(nil, x)"
+        'x = nil ; assert_equal(nil, x)'
       end
+
       def instead_use
-        "x = nil ; assert_nil(x)"
+        'x = nil ; assert_nil(x)'
       end
     end
   end
-
 end

data/lib/pippi/checks/check.rb

@@ -1,7 +1,5 @@
 module Pippi::Checks
-
   class Check
-
     attr_accessor :ctx
 
     def initialize(ctx)
@@ -12,14 +10,18 @@ module Pippi::Checks
       [:collect!, :compact!, :flatten!, :map!, :reject!, :reverse!, :rotate!, :select!, :shuffle!, :slice!, :sort!, :sort_by!, :uniq!]
     end
 
+    def method_names_that_indicate_this_is_being_used_as_a_collection
+      [:collect!, :compact!, :flatten!, :map!, :reject!, :reverse!, :rotate!, :select!, :shuffle!, :slice!, :sort!, :sort_by!, :uniq!, :collect, :compact, :flatten, :map, :reject, :reverse, :rotate, :select, :shuffle, :slice, :sort, :sort_by, :uniq]
+    end
+
     def add_problem
-      problem_location = caller_locations.detect {|c| c.to_s !~ /byebug|lib\/pippi\/checks/ }
-      ctx.report.add(Pippi::Problem.new(:line_number => problem_location.lineno, :file_path => problem_location.path, :check_class => self.class))
+      problem_location = caller_locations.find { |c| c.to_s !~ /byebug|lib\/pippi\/checks/ }
+      ctx.report.add(Pippi::Problem.new(line_number: problem_location.lineno, file_path: problem_location.path, check_class: self.class))
     end
 
     def clear_fault_proc(clz)
-      Proc.new do |*args, &blk|
-        problem_location = caller_locations.detect {|c| c.to_s !~ /byebug|lib\/pippi\/checks/ }
+      proc do |*args, &blk|
+        problem_location = caller_locations.find { |c| c.to_s !~ /byebug|lib\/pippi\/checks/ }
         clz.clear_fault(problem_location.lineno, problem_location.path)
         super(*args, &blk)
       end
@@ -30,9 +32,9 @@ module Pippi::Checks
     end
 
     def its_ok_watcher_proc(clazz, method_name)
-      Proc.new do |*args, &blk|
+      proc do |*args, &blk|
         begin
-          singleton_class.ancestors.detect {|x| x == clazz }.instance_eval { remove_method method_name }
+          singleton_class.ancestors.find { |x| x == clazz }.instance_eval { remove_method method_name }
         rescue NameError
           return super(*args, &blk)
         else

data/lib/pippi/checks/debug_check.rb

@@ -1,14 +1,11 @@
 module Pippi::Checks
-
   class DebugCheck < Check
-
-    ["line", "class", "end", "call", "return", "c_call", "c_return", "b_call", "b_return", "raise", "thread_begin", "thread_end"].each do |event_name|
+    %w(line class end call return c_call c_return b_call b_return raise thread_begin thread_end).each do |event_name|
       define_method "#{event_name}_event" do |tp|
         return if tp.path =~ %r{lib/pippi}
         ctx.debug_logger.warn "#{event_name}_event in #{tp.defined_class}##{tp.method_id} at line #{tp.lineno} of #{tp.path}"
         ctx.debug_logger.warn "  return_value #{tp.return_value}" rescue nil
       end
     end
-
   end
 end

data/lib/pippi/checks/map_followed_by_flatten.rb

@@ -1,9 +1,7 @@
 module Pippi::Checks
-
   class MapFollowedByFlatten < Check
-
     module MyFlatten
-      def flatten(depth=nil)
+      def flatten(depth = nil)
         if depth && depth == 1
           self.class._pippi_check_map_followed_by_flatten.add_problem
         end
@@ -34,8 +32,8 @@ module Pippi::Checks
       Array.class_exec(self) do |my_check|
         # How to do this without a class instance variable?
         @_pippi_check_map_followed_by_flatten = my_check
-        def self._pippi_check_map_followed_by_flatten
-          @_pippi_check_map_followed_by_flatten
+        class << self
+          attr_reader :_pippi_check_map_followed_by_flatten
         end
       end
       Array.prepend MyMap
@@ -45,14 +43,14 @@ module Pippi::Checks
       def description
         "Don't use map followed by flatten; use flat_map instead"
       end
+
       def sample
-        "[1,2,3].map {|x| [x,x+1] }.flatten"
+        '[1,2,3].map {|x| [x,x+1] }.flatten'
       end
+
       def instead_use
-        "[1,2,3].flat_map {|x| [x, x+1]}"
+        '[1,2,3].flat_map {|x| [x, x+1]}'
       end
     end
-
   end
-
 end

data/lib/pippi/checks/reverse_followed_by_each.rb

@@ -1,7 +1,5 @@
 module Pippi::Checks
-
   class ReverseFollowedByEach < Check
-
     module MyEach
       def each
         self.class._pippi_check_reverse_followed_by_each.add_problem
@@ -28,8 +26,8 @@ module Pippi::Checks
       Array.class_exec(self) do |my_check|
         # How to do this without a class instance variable?
         @_pippi_check_reverse_followed_by_each = my_check
-        def self._pippi_check_reverse_followed_by_each
-          @_pippi_check_reverse_followed_by_each
+        class << self
+          attr_reader :_pippi_check_reverse_followed_by_each
         end
       end
       Array.prepend MyReverse
@@ -39,14 +37,14 @@ module Pippi::Checks
       def description
         "Don't use each followed by reverse; use reverse_each instead"
       end
+
       def sample
-        "[1,2,3].reverse.each {|x| x+1 }"
+        '[1,2,3].reverse.each {|x| x+1 }'
       end
+
       def instead_use
-        "[1,2,3].reverse_each {|x| x+1 }"
+        '[1,2,3].reverse_each {|x| x+1 }'
       end
     end
-
   end
-
 end

data/lib/pippi/checks/select_followed_by_empty.rb

@@ -0,0 +1,55 @@
+module Pippi::Checks
+
+  class SelectFollowedByEmpty < Check
+
+    module MyEmpty
+      def empty?(&blk)
+        self.class._pippi_check_select_followed_by_empty.add_problem
+        self.class._pippi_check_select_followed_by_empty.method_names_that_indicate_this_is_being_used_as_a_collection.each do |this_means_its_ok_sym|
+          define_singleton_method(this_means_its_ok_sym, self.class._pippi_check_select_followed_by_empty.clear_fault_proc(self.class._pippi_check_select_followed_by_empty))
+        end
+        super
+      end
+    end
+
+    module MySelect
+      def select(&blk)
+        result = super
+        if self.class._pippi_check_select_followed_by_empty.nil?
+          # Ignore Array subclasses since select or empty may have difference meanings
+          # elsif defined?(ActiveRecord::Relation) && self.class.kind_of?(ActiveRecord::Relation) # maybe also this
+        else
+          result.extend MyEmpty
+          self.class._pippi_check_select_followed_by_empty.array_mutator_methods.each do |this_means_its_ok_sym|
+            result.define_singleton_method(this_means_its_ok_sym, self.class._pippi_check_select_followed_by_empty.its_ok_watcher_proc(MyEmpty, :empty?))
+          end
+        end
+        result
+      end
+    end
+
+    def decorate
+      Array.class_exec(self) do |my_check|
+        @_pippi_check_select_followed_by_empty = my_check
+        def self._pippi_check_select_followed_by_empty
+          @_pippi_check_select_followed_by_empty
+        end
+      end
+      Array.prepend MySelect
+    end
+
+    class Documentation
+      def description
+        "Don't use select followed by empty?; use none? instead"
+      end
+      def sample
+        "[1,2,3].select {|x| x > 1 }.empty?"
+      end
+      def instead_use
+        "[1,2,3].none? {|x| x > 1 }"
+      end
+    end
+
+  end
+
+end

data/lib/pippi/checks/select_followed_by_first.rb

@@ -1,9 +1,7 @@
 module Pippi::Checks
-
   class SelectFollowedByFirst < Check
-
     module MyFirst
-      def first(elements=nil)
+      def first(elements = nil)
         unless elements
           self.class._pippi_check_select_followed_by_first.add_problem
         end
@@ -33,8 +31,8 @@ module Pippi::Checks
     def decorate
       Array.class_exec(self) do |my_check|
         @_pippi_check_select_followed_by_first = my_check
-        def self._pippi_check_select_followed_by_first
-          @_pippi_check_select_followed_by_first
+        class << self
+          attr_reader :_pippi_check_select_followed_by_first
         end
       end
       Array.prepend MySelect
@@ -44,14 +42,14 @@ module Pippi::Checks
       def description
         "Don't use select followed by first; use detect instead"
       end
+
       def sample
-        "[1,2,3].select {|x| x > 1 }.first"
+        '[1,2,3].select {|x| x > 1 }.first'
       end
+
       def instead_use
-        "[1,2,3].detect {|x| x > 1 }"
+        '[1,2,3].detect {|x| x > 1 }'
       end
     end
-
   end
-
 end

data/lib/pippi/checks/select_followed_by_size.rb

@@ -1,7 +1,5 @@
 module Pippi::Checks
-
   class SelectFollowedBySize < Check
-
     module MySize
       def size
         self.class._pippi_check_select_followed_by_size.add_problem
@@ -27,15 +25,11 @@ module Pippi::Checks
       end
     end
 
-    def method_names_that_indicate_this_is_being_used_as_a_collection
-      [:collect!, :compact!, :flatten!, :map!, :reject!, :reverse!, :rotate!, :select!, :shuffle!, :slice!, :sort!, :sort_by!, :uniq!, :collect, :compact, :flatten, :map, :reject, :reverse, :rotate, :select, :shuffle, :slice, :sort, :sort_by, :uniq]
-    end
-
     def decorate
       Array.class_exec(self) do |my_check|
         @_pippi_check_select_followed_by_size = my_check
-        def self._pippi_check_select_followed_by_size
-          @_pippi_check_select_followed_by_size
+        class << self
+          attr_reader :_pippi_check_select_followed_by_size
         end
       end
       Array.prepend MySelect
@@ -45,14 +39,14 @@ module Pippi::Checks
       def description
         "Don't use select followed by size; use count instead"
       end
+
       def sample
-        "[1,2,3].select {|x| x > 1 }.size"
+        '[1,2,3].select {|x| x > 1 }.size'
       end
+
       def instead_use
-        "[1,2,3].count {|x| x > 1 }"
+        '[1,2,3].count {|x| x > 1 }'
       end
     end
-
   end
-
 end

data/lib/pippi/context.rb

@@ -1,17 +1,15 @@
 module Pippi
-
   class Context
-
     class DebugLogger
       def warn(str)
-        File.open("pippi_debug.log", "a") do |f|
+        File.open('pippi_debug.log', 'a') do |f|
           f.syswrite("#{str}\n")
         end
       end
     end
 
     class NullLogger
-      def warn(str)
+      def warn(_str)
       end
     end
 
@@ -20,12 +18,10 @@ module Pippi
     def initialize
       @report = Pippi::Report.new
       @debug_logger = if ENV['PIPPI_DEBUG']
-        Pippi::Context::DebugLogger.new
+                        Pippi::Context::DebugLogger.new
       else
         Pippi::Context::NullLogger.new
       end
     end
-
   end
-
 end

data/lib/pippi/exec_runner.rb

@@ -1,10 +1,9 @@
 module Pippi
-
   class ExecRunner
-
     attr_accessor :codefile, :check_name, :code_to_eval, :output_file_name
 
     def initialize(args)
+      check_args(args)
       @codefile = args[0]
       @check_name = args[1]
       @code_to_eval = args[2]
@@ -13,22 +12,28 @@ module Pippi
 
     def run
       ctx = Pippi::Context.new
-      CheckLoader.new(ctx, check_name).checks.each do |check|
-        check.decorate
-      end
+      CheckLoader.new(ctx, check_name).checks.each(&:decorate)
       load "#{codefile}"
       eval code_to_eval
       dump_report ctx
     end
 
     def dump_report(ctx)
-      File.open(output_file_name, "w") do |outfile|
+      File.open(output_file_name, 'w') do |outfile|
         ctx.report.problems.each do |problem|
           outfile.syswrite("#{problem.to_text}\n")
         end
       end
     end
 
-  end
+    private
 
+    def check_args(args)
+      fail ArgumentError if args.size != 4
+    rescue ArgumentError => e
+      puts 'ERROR: wrong number of arguments'
+      puts 'Use: pippi code_file check_name eval_string output_file'
+      exit 1
+    end
+  end
 end

data/lib/pippi/problem.rb

@@ -1,6 +1,5 @@
 module Pippi
   class Problem
-
     attr_accessor :file_path, :line_number, :check_class
 
     def initialize(opts)

data/lib/pippi/report.rb

@@ -1,7 +1,5 @@
 module Pippi
-
   class Report
-
     attr_reader :problems
 
     def initialize
@@ -13,15 +11,13 @@ module Pippi
     end
 
     def remove(lineno, path, clazz)
-      @problems.reject! {|p| p.line_number == lineno && p.file_path == path && p.check_class == clazz }
+      @problems.reject! { |p| p.line_number == lineno && p.file_path == path && p.check_class == clazz }
     end
 
     private
 
     def duplicate_report?(candidate)
-      !problems.detect {|existing| existing.eql?(candidate) }.nil?
+      !problems.find { |existing| existing.eql?(candidate) }.nil?
     end
-
   end
-
 end