private_please 0.0.3 → 0.0.4

data/lib/private_please/{report/reporter.rb → reporter/simple_text.rb}

@@ -1,24 +1,14 @@
+require File.dirname(__FILE__) + '/base'
 require 'erb'
-module  PrivatePlease ; module Report
-  class Reporter
+require File.dirname(__FILE__) + '/helpers/options_helpers'
+require File.dirname(__FILE__) + '/helpers/text_table_helpers'
+module  PrivatePlease ; module Reporter
 
-    TEMPLATE_PATH     = File.expand_path(File.dirname(__FILE__) + '/templates/simple.txt.erb')
-
-    attr_reader :candidates_store, :calls_store,
-                :good_candidates, :bad_candidates,
-                :good_candidates_c, :bad_candidates_c,
-                :never_called_candidates, :never_called_candidates_c,
-                :building_time
-
-
-    def initialize(candidates_store, calls_store)
-      @candidates_store = candidates_store
-      @calls_store      = calls_store
+  class SimpleText < Base
 
-      prepare_report_data
-    end
+    TEMPLATE_PATH     = File.expand_path(File.dirname(__FILE__) + '/templates/simple.txt.erb')
 
-    def to_s
+    def text
       erb = ERB.new(File.read(TEMPLATE_PATH), 0,  "%<>")
       erb.result(binding)
     end
@@ -29,7 +19,7 @@ module  PrivatePlease ; module Report
       start_time = Time.now
       @bad_candidates   = calls_store.external_calls      .clone
       @bad_candidates_c = calls_store.class_external_calls.clone
-      # TODO : optimize
+      # TODO : optimize (with Hamster?)
       @good_candidates  = calls_store.internal_calls      .clone.remove(@bad_candidates)
       @good_candidates_c= calls_store.class_internal_calls.clone.remove(@bad_candidates_c)
 
@@ -40,6 +30,9 @@ module  PrivatePlease ; module Report
       @never_called_candidates_c = candidates_store.class_methods.clone.
           remove(@good_candidates_c).
           remove(@bad_candidates_c )
+      [
+          @bad_candidates, @bad_candidates_c, @good_candidates, @good_candidates_c, @never_called_candidates, @never_called_candidates_c
+      ].each {|arr| arr.reject!{|k, v| v.empty?}}
       @building_time = Time.now - start_time
 
       @candidates_classes_names      = (candidates_store.instance_methods.classes_names +
@@ -49,4 +42,5 @@ module  PrivatePlease ; module Report
       @never_called_candidates_classes_names = (@never_called_candidates_c .classes_names + @never_called_candidates.classes_names).uniq.sort
     end
   end
+
 end end

data/lib/private_please/reporter/templates/simple.txt.erb

@@ -0,0 +1,77 @@
+====================================================================================
+=                               PrivatePlease report :                             =
+====================================================================================
+% @candidates_classes_names .sort.each do |class_name|
+%
+%   show_good_candidates_section    = true
+%   show_bad_candidates_section     = show_bad_candidates_section?
+%   show_never_candidates_section   = show_never_called_candidates_section?
+%
+%   if show_good_candidates_section
+%     good_candidates_table = table_for(
+%                             names_from(class_name, good_candidates  , prefix = "#"),
+%                             names_from(class_name, good_candidates_c, prefix = "."))
+%   end
+%   if show_bad_candidates_section
+%     bad_candidates_table = table_for(
+%                             names_from(class_name, bad_candidates  , prefix = "#"),
+%                             names_from(class_name, bad_candidates_c, prefix = "."))
+%   end
+%   if show_never_candidates_section
+%     never_called_candidates_table = table_for(
+%                             names_from(class_name, never_called_candidates  , prefix = "#"),
+%                             names_from(class_name, never_called_candidates_c, prefix = "."))
+%   end
+%
+% # Always hide empty tables :
+% ###########################
+%   show_good_candidates_section    &&= !good_candidates_table.empty?
+%   show_bad_candidates_section     &&= !bad_candidates_table.empty?
+%   show_never_candidates_section   &&= !never_called_candidates_table.empty?
+%
+% nothing_to_show = !(show_good_candidates_section || show_bad_candidates_section || show_never_candidates_section)
+% next if nothing_to_show && !show_empty_classes?
+%
+<%= class_name
+%>
+%
+% if show_good_candidates_section
+%   t = good_candidates_table
+
+    * Good candidates : can be made private :
+    ------------------------------------------
+%   cell_width = 3 + [38, t.longest_value_length].max
+%   t.rows.each do |inst_m, class_m|
+      <%= inst_m && inst_m.ljust(cell_width) %><%= class_m && class_m.ljust(cell_width) %>
+%   end
+% end
+%
+% if show_bad_candidates_section
+%   t = bad_candidates_table
+
+    * Bad candidates : must stay public/protected:
+    . . . . . . . . . . . . . . . . . . . . .
+%  cell_width = 3 + [38, t.longest_value_length].max
+%   t.rows.each do |inst_m, class_m|
+      <%= inst_m && inst_m.ljust(cell_width) %><%= class_m && class_m.ljust(cell_width) %>
+%   end
+% end
+%
+% if show_never_candidates_section
+%   t = never_called_candidates_table
+
+    * Methods that were never called :
+    . . . . . . . . . . . . . . . . . . . . .
+%  cell_width = 3 + [38, t.longest_value_length].max
+%   t.rows.each do |inst_m, class_m|
+      <%= inst_m && inst_m.ljust(cell_width) %><%= class_m && class_m.ljust(cell_width) %>
+%   end
+% end
+%
+% end
+
+====================================================================================
+% if ENV['PP_OPTIONS']
+Default display overriden :
+ $PP_OPTIONS = <%= ENV['PP_OPTIONS'].inspect %>
+% end

data/lib/private_please/reporter.rb

@@ -0,0 +1,8 @@
+module PrivatePlease
+  module Reporter
+
+  end
+end
+
+require File.dirname(__FILE__) + '/reporter/base'
+require File.dirname(__FILE__) + '/reporter/simple_text'

data/lib/private_please/storage/methods_names.rb

@@ -1,3 +1,4 @@
+require 'set'
 module PrivatePlease
   module Storage
 

data/lib/private_please/storage.rb

@@ -0,0 +1,8 @@
+module PrivatePlease
+  module Storage
+  end
+end
+require File.dirname(__FILE__) + '/storage/calls_store'
+require File.dirname(__FILE__) + '/storage/candidates_store'
+require File.dirname(__FILE__) + '/storage/methods_names'
+require File.dirname(__FILE__) + '/storage/methods_names_bucket'

data/lib/private_please/tracking/extension.rb

@@ -2,16 +2,9 @@ module PrivatePlease ; module Tracking
 
   module Extension
 
-    def private_please(*methods_to_observe)
-      parameterless_call = methods_to_observe.empty?
-      klass = self
-
-      if parameterless_call
-        klass.send :include, PrivatePlease::Tracking::InstrumentsAllBelow
-
-      else
-        Instrumentor.instrument_instance_methods_for_pp_observation(klass, methods_to_observe)
-      end
+    def private_please
+      include PrivatePlease::Tracking::InstrumentsAllMethodsBelow
+      set_trace_func PrivatePlease::Tracking::LineChangeTracker::MY_TRACE_FUN
     end
 
   end

data/lib/private_please/tracking/instrumentor.rb

@@ -1,71 +1,49 @@
 module PrivatePlease ; module Tracking
 
   module Instrumentor
+  class << self
 
-    def self.instrument_instance_methods_for_pp_observation(klass, methods_to_observe)
-      class_instance_methods = klass.instance_methods.collect(&:to_sym)
-      methods_to_observe = methods_to_observe.collect(&:to_sym)
-      # reject invalid methods names
-      methods_to_observe.reject! do |m|
-        already_defined_instance_method = class_instance_methods.include?(m)
-        invalid = !already_defined_instance_method
-      end
-
-      methods_to_observe.each do |method_name|
-        candidate = Candidate.for_instance_method(klass, method_name)
-        instrument_candidate_for_pp_observation(candidate) # end
-      end
-    end
-
-
-    def self.instrument_candidate_for_pp_observation(candidate)
+    def add_call_tracking_code_to(candidate)
       return if candidate.already_instrumented?
-      PrivatePlease.remember_candidate(candidate)
+      candidate.mark_as_instrumented
 
       klass, method_name = candidate.klass, candidate.method_name
       candidate.instance_method? ?
-        instrument_instance_method_with_pp_observation(klass, method_name) :
-        instrument_class_method_with_pp_observation(   klass, method_name)
+        add_call_tracking_code_to_instance_method(klass, method_name) :
+        add_call_tracking_code_to_class_method(   klass, method_name)
     end
 
 
+  private
 
-    def self.instrument_class_method_with_pp_observation(klass, method_name)
+    def add_call_tracking_code_to_class_method(klass, method_name)
       orig_method = klass.singleton_class.instance_method(method_name)
 klass.class_eval <<RUBY
       define_singleton_method(method_name) do |*args, &blk|                 # def self.observed_method_i(..)
         set_trace_func(nil) #don't track activity while here                #
-                                                                            #
-        zelf_class=self                                                     #
-        candidate = PrivatePlease::Candidate.for_class_method(zelf_class, method_name)
-        PrivatePlease.after_method_call(candidate, LineChangeTracker.outside_class_method_call_detected?(zelf_class))
-                                                                            #
+        PrivatePlease::Tracking.after_singleton_method_call(method_name, self_class=self)
         set_trace_func(LineChangeTracker::MY_TRACE_FUN)                     #
-        # make the call :                                                   #
+        # make the original call :                                          #
         orig_method.bind(self).call(*args, &blk)                            #   <call original method>
       end                                                                   # end
 RUBY
     end
-    private_class_method :instrument_class_method_with_pp_observation
 
 
-    def self.instrument_instance_method_with_pp_observation(klass, method_name)
+    def add_call_tracking_code_to_instance_method(klass, method_name)
       orig_method = klass.instance_method(method_name)
 klass.class_eval <<RUBY
       define_method(method_name) do |*args, &blk|                           # def observed_method_i(..)
         set_trace_func(nil) #don't track activity while here                #
-                                                                            #
-        candidate = PrivatePlease::Candidate.for_instance_method(self.class, method_name)
-        PrivatePlease.after_method_call(candidate, LineChangeTracker.outside_instance_method_call_detected?(self))                  #
-                                                                            #
+        PrivatePlease::Tracking.after_instance_method_call(method_name, self.class)
         set_trace_func(LineChangeTracker::MY_TRACE_FUN)                     #
-        # make the call :                                                   #
+        # make the original call :                                          #
         orig_method.bind(self).call(*args, &blk)                            #   <call original method>
       end                                                                   # end
 RUBY
     end
-    private_class_method :instrument_instance_method_with_pp_observation
 
   end
+  end
 
 end end

data/lib/private_please/tracking/instruments_all_methods_below.rb

@@ -0,0 +1,28 @@
+module PrivatePlease ; module Tracking
+
+  module InstrumentsAllMethodsBelow
+    include PrivatePlease::Tracking::Extension
+
+    def self.included(base)
+
+      def base.singleton_method_added(method_name)
+        return if Utils.private_singleton_method?(self, method_name) \
+               || Utils.singleton_method_defined_by_ancestor?(self, method_name)
+
+        candidate = Candidate.for_class_method(klass = self, method_name)
+        Instrumentor.add_call_tracking_code_to(candidate)
+      end
+
+
+      def base.method_added(method_name)
+        return if Utils.private_instance_method?(self, method_name) \
+               || Utils.instance_method_defined_by_ancestor?(self, method_name)
+
+        candidate = Candidate.for_instance_method(klass = self, method_name)
+        Instrumentor.add_call_tracking_code_to(candidate)
+      end
+    end
+
+  end
+
+end end

data/lib/private_please/tracking/instruments_automatically_all_methods_in_all_classes.rb

@@ -0,0 +1,52 @@
+
+class Class
+
+  def singleton_method_added(method_name)
+    return unless PrivatePlease.pp_automatic_mode_enabled?
+
+    return if PrivatePlease::Tracking::Utils.private_singleton_method?(self, method_name) \
+           || PrivatePlease::Tracking::Utils.singleton_method_defined_by_ancestor?(self, method_name)
+
+    candidate = PrivatePlease::Candidate.for_class_method(klass = self, method_name)
+    PrivatePlease::Tracking::Instrumentor.add_call_tracking_code_to(candidate)
+  end
+
+
+  def method_added(method_name)
+    return unless PrivatePlease.pp_automatic_mode_enabled?
+
+    return if [:method_added].include?(method_name)
+    return if PrivatePlease::Tracking::Utils.private_instance_method?(self, method_name) \
+           || PrivatePlease::Tracking::Utils.instance_method_defined_by_ancestor?(self, method_name)
+
+    candidate = PrivatePlease::Candidate.for_instance_method(klass = self, method_name)
+    PrivatePlease::Tracking::Instrumentor.add_call_tracking_code_to(candidate)
+  end
+
+end
+
+
+class Module
+
+  def singleton_method_added(method_name)
+    return unless PrivatePlease.pp_automatic_mode_enabled?
+
+    return if [:included].include?(method_name) #&& !self.is_a?(Class)
+    return if PrivatePlease::Tracking::Utils.private_singleton_method?(self, method_name)
+
+    candidate = PrivatePlease::Candidate.for_class_method(klass = self, method_name)
+    PrivatePlease::Tracking::Instrumentor.add_call_tracking_code_to(candidate)
+  end
+
+
+  def method_added(method_name)
+    return unless PrivatePlease.pp_automatic_mode_enabled?
+
+    return if [:method_added, :singleton_method_added].include?(method_name)
+    return if PrivatePlease::Tracking::Utils.private_instance_method?(self, method_name)
+
+    candidate = PrivatePlease::Candidate.for_instance_method(klass = self, method_name)
+    PrivatePlease::Tracking::Instrumentor.add_call_tracking_code_to(candidate)
+  end
+end
+

data/lib/private_please/tracking/line_change_tracker.rb

@@ -2,8 +2,15 @@ module PrivatePlease ; module Tracking
 
   class LineChangeTracker
     class << self
+
       attr_accessor :prev_prev_self, :prev_self, :curr_self
       @@prev_self = @@curr_self = nil
+
+      alias :call_initiator :prev_self
+
+      def reset
+        prev_prev_self = prev_self = curr_self = nil
+      end
     end
 
     MY_TRACE_FUN = lambda do |event, file, line, id, binding, klass|
@@ -14,23 +21,6 @@ module PrivatePlease ; module Tracking
       #puts "my : #{event} in #{file}/#{line} id:#{id} klass:#{klass} - self = #{(eval'self', binding).inspect}"
     end
 
-    def self.outside_instance_method_call_detected?(zelf)
-      caller_class != zelf.class
-    end
-
-    def self.outside_class_method_call_detected?(zelf_class)
-      caller_class != zelf_class
-    end
-
-  private
-
-    def self.caller_class
-      call_initiator = LineChangeTracker.prev_self
-      (caller_is_class_method = call_initiator.is_a?(Class)) ?
-          call_initiator :
-          call_initiator.class
-    end
   end
-end end
 
-set_trace_func(PrivatePlease::Tracking::LineChangeTracker::MY_TRACE_FUN) #
+end end

data/lib/private_please/tracking/utils.rb

@@ -0,0 +1,34 @@
+module PrivatePlease::Tracking
+
+  module Utils
+    class << self
+
+      def private_instance_method?(klass, method_name)
+        klass.private_method_defined?(method_name)
+      end
+
+      def private_singleton_method?(klass, method_name)
+        klass.singleton_class.private_method_defined?(method_name)
+      end
+
+      def instance_method_defined_by_ancestor?(klass, method_name)
+        ancestor_of(klass).any? do |a|
+          a.method_defined?(method_name) || a.private_method_defined?(method_name)
+        end
+      end
+
+      def singleton_method_defined_by_ancestor?(klass, method_name)
+        ancestor_of(klass).any? do |a|
+          a.singleton_class.method_defined?(method_name) || a.singleton_class.private_method_defined?(method_name)
+        end
+      end
+
+    private
+      def ancestor_of(klass)
+        klass.ancestors - [klass]
+      end
+
+    end
+  end
+
+end

data/lib/private_please/tracking.rb

@@ -0,0 +1,48 @@
+require 'private_please/tracking/line_change_tracker'
+module PrivatePlease
+  module Tracking
+
+    class << self
+
+      def after_instance_method_call(method_name, zelf_class)
+        store_call_to_tracked_method(
+          candidate       = PrivatePlease::Candidate.for_instance_method(zelf_class, method_name),
+          is_outside_call = (caller_class != zelf_class)
+        )
+      end
+
+      def after_singleton_method_call(method_name, zelf_class)
+        store_call_to_tracked_method(
+          candidate       = PrivatePlease::Candidate.for_class_method(zelf_class, method_name),
+          is_outside_call = (caller_class != zelf_class)
+        )
+      end
+
+    private
+
+      def caller_class
+        call_initiator = LineChangeTracker.call_initiator
+        if call_initiator.nil?
+          #TODO : investigate why and how this happens
+        end
+        (caller_is_class_method = call_initiator.is_a?(Class)) ?
+            call_initiator :
+            call_initiator.class
+      end
+
+      def store_call_to_tracked_method(candidate, is_outside_call)
+        is_outside_call ?
+            PrivatePlease.calls_store.store_outside_call(candidate) :
+            PrivatePlease.calls_store.store_inside_call( candidate)
+      end
+
+    end
+
+  end
+end
+
+require 'private_please/tracking/utils'
+require 'private_please/tracking/instrumentor'
+require 'private_please/tracking/extension'
+require 'private_please/tracking/instruments_all_methods_below'
+require 'private_please/tracking/instruments_automatically_all_methods_in_all_classes'

data/lib/private_please/version.rb

@@ -1,3 +1,3 @@
 module PrivatePlease
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/private_please.rb

@@ -1,66 +1,49 @@
 require 'private_please/version'
 require 'private_please/ruby_backports'
 require 'private_please/candidate'
-require 'private_please/storage/calls_store'
-require 'private_please/storage/candidates_store'
-require 'private_please/storage/methods_names'
-require 'private_please/storage/methods_names_bucket'
-require 'private_please/report/reporter'
-require 'private_please/tracking/line_change_tracker'
-require 'private_please/tracking/extension'
-require 'private_please/tracking/instrumentor'
-require 'private_please/tracking/instruments_all_below'
+require 'private_please/storage'
+require 'private_please/report'
+require 'private_please/reporter'
+
+at_exit do
+  PrivatePlease.at_exit
+end
 
 module PrivatePlease
 
   def self.install
     Module.send :include, PrivatePlease::Tracking::Extension
+    PrivatePlease.pp_automatic_mode_enable
+    set_trace_func PrivatePlease::Tracking::LineChangeTracker::MY_TRACE_FUN
   end
 
-#--------------
-# config
-#--------------
-
-  def self.after_method_call(candidate, outside_call)
-    outside_call ?
-      calls_store.store_outside_call(candidate) :
-      calls_store.store_inside_call(candidate)
-  end
-
-  def self.remember_candidate(candidate)
-    candidates_store.store(candidate)
-  end
-
-
-#--------------
-# data & config containers :
-#--------------
+  def self.pp_automatic_mode_enabled? ; !!$pp_automatic_mode_enabled          end
+  def self.pp_automatic_mode_enable   ;   $pp_automatic_mode_enabled =  true  end
+  def self.pp_automatic_mode_disable  ;   $pp_automatic_mode_enabled = false  end
 
-  def self.reset_before_new_test
-    @@_calls_store = @@_candidates_store = nil
+  # TODO : replace class methods by PP instance + instance methods
+  def self.calls_store
+    @@_calls_store ||= Storage::CallsStore.new
   end
 
-#--------------
-# report
-#--------------
-
-  def self.report
-    Report::Reporter.new(candidates_store, calls_store)
+  def self.candidates_store
+    @@_candidates_store ||= Storage::CandidatesStore.new
   end
 
-private
-
-  def self.calls_store
-  @@_calls_store ||= Storage::CallsStore.new
+  def self.reset
+    @@_candidates_store = @@_calls_store = nil
+    Tracking::LineChangeTracker.reset
+    set_trace_func nil
   end
 
-  def self.candidates_store
-    @@_candidates_store ||= Storage::CandidatesStore.new
+  def self.at_exit
+    report = PrivatePlease::Reporter::SimpleText.new(PrivatePlease.candidates_store, PrivatePlease.calls_store)
+    unless $private_please_tests_are_running
+      $stdout.puts report.text
+    end
   end
 end
 
+require 'private_please/tracking'
 
 PrivatePlease.install
-at_exit {
-  puts PrivatePlease.report.to_s
-}

data/private_please.gemspec

@@ -1,5 +1,11 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/private_please/version', __FILE__)
+if RUBY_VERSION == '1.8.7'
+  # avoid double-require of version.rb - see http://bit.ly/18lspBV 
+  $:.unshift File.expand_path("../lib", __FILE__)
+  require "private_please/version"
+else
+  require File.expand_path('../lib/private_please/version', __FILE__)
+end
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Alain Ravet"]