private_please 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.0.5
+    - required gems/standard libraries are no longer tracked.
+
 v0.0.4
     - `private_please :foo, :bar` syntax is removed.
     - auto-mode via `$ pp_ruby`

data/lib/private_please.rb

@@ -18,7 +18,9 @@ module PrivatePlease
   end
 
   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_enable(value=true)
+    $pp_automatic_mode_enabled =  value
+  end
   def self.pp_automatic_mode_disable  ;   $pp_automatic_mode_enabled = false  end
 
   # TODO : replace class methods by PP instance + instance methods

data/lib/private_please/reporter/base.rb

@@ -1,28 +1,14 @@
+require File.dirname(__FILE__) + '/data_compiler'
 module  PrivatePlease ; module Reporter
 
   class Base
 
-    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
-
+    attr_reader :data
 
     def initialize(candidates_store, calls_store)
-      @candidates_store = candidates_store
-      @calls_store      = calls_store
-
-      start_time = Time.now
-      prepare_report_data
-      @building_time = Time.now - start_time
+      @data = DataCompiler.new(candidates_store, calls_store).compile_data
     end
 
-  private
-
-    def prepare_report_data
-      raise "prepare_report_data() ot implemented in the child class"
-    end
   end
 
 end end

data/lib/private_please/reporter/data_compiler.rb

@@ -0,0 +1,82 @@
+module  PrivatePlease ; module Reporter
+
+  class Data < Struct.new(
+                :candidates_classes_names,
+                :good_candidates,   :bad_candidates,   :never_called_candidates,
+                :good_candidates_c, :bad_candidates_c, :never_called_candidates_c,
+                :building_time
+              )
+  end
+
+  class DataCompiler
+
+    def initialize(candidates_store, calls_store)
+      @candidates_store = candidates_store
+      @calls_store      = calls_store
+    end
+
+    # TODO : optimize (with Hamster?)
+    def compile_data
+      start_time = Time.now
+
+      bad_candidates,
+      bad_candidates_c          = read_bad_candidates
+      candidates_classes_names  = read_candidates_classes_names
+
+      good_candidates,
+      good_candidates_c         = compute_good_candidates(bad_candidates, bad_candidates_c)
+
+      never_called_candidates,
+      never_called_candidates_c = compute_never_called_candidates(good_candidates,   bad_candidates,
+                                                                  good_candidates_c, bad_candidates_c)
+
+      remove_candidates_with_no_methods!(bad_candidates,   good_candidates,   never_called_candidates,
+                                         bad_candidates_c, good_candidates_c, never_called_candidates_c)
+      building_time = Time.now - start_time
+
+      Data.new(
+            candidates_classes_names,
+            good_candidates,   bad_candidates,   never_called_candidates,
+            good_candidates_c, bad_candidates_c, never_called_candidates_c,
+            building_time
+      )
+    end
+
+  private
+
+    def read_candidates_classes_names
+      @candidates_store.classes_names.sort
+    end
+
+    def read_bad_candidates
+      [ bad_candidates    = @calls_store.external_calls,
+        bad_candidates_c  = @calls_store.class_external_calls
+      ]
+    end
+
+    def compute_good_candidates(bad_candidates, bad_candidates_c)
+      [ good_candidates   = @calls_store.internal_calls      .clone.remove(bad_candidates),
+        good_candidates_c = @calls_store.class_internal_calls.clone.remove(bad_candidates_c)
+      ]
+    end
+
+    def compute_never_called_candidates(good_candidates, bad_candidates, good_candidates_c, bad_candidates_c)
+      never_called_candidates = @candidates_store.instance_methods.clone.
+          remove(good_candidates).
+          remove(bad_candidates)
+
+      never_called_candidates_c = @candidates_store.class_methods.clone.
+          remove(good_candidates_c).
+          remove(bad_candidates_c)
+      [never_called_candidates, never_called_candidates_c]
+    end
+
+    def remove_candidates_with_no_methods!(bad_candidates, good_candidates, never_called_candidates, bad_candidates_c, good_candidates_c, never_called_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? } }
+    end
+
+  end
+
+end end

data/lib/private_please/reporter/helpers/options_helpers.rb

@@ -1,12 +1,37 @@
 
-def show_never_called_candidates_section?
-  ENV['PP_OPTIONS'] =~ /--show-never-called/
-end
+DEFAULT_REPORT_OPTIONS = {
+  :show_never_called_candidates_section?  => false,
+  :show_bad_candidates_section?           => false,
+  :show_empty_classes?                    => false
+}
 
-def show_bad_candidates_section?
-  ENV['PP_OPTIONS'] =~ /--show-bad-candidates/
-end
+def options
+  Object.new.tap do |o|
+    def o.show_never_called_candidates_section?
+      (ENV['PP_OPTIONS'] =~ /--show-never-called/) || DEFAULT_REPORT_OPTIONS[:show_never_called_candidates_section?]
+    end
 
-def show_empty_classes?
-  ENV['PP_OPTIONS'] =~ /--show-empty-classes/
+    def o.show_bad_candidates_section?
+      (ENV['PP_OPTIONS'] =~ /--show-bad-candidates/) || DEFAULT_REPORT_OPTIONS[:show_bad_candidates_section?]
+    end
+
+    def o.show_empty_classes?
+      (ENV['PP_OPTIONS'] =~ /--show-empty-classes/) || DEFAULT_REPORT_OPTIONS[:show_empty_classes?]
+    end
+  end
 end
+
+def options_footer_parts
+  parts = []
+  DEFAULT_REPORT_OPTIONS.keys.each do |key|
+    display       = "--#{key}".gsub('_', '-')
+    current_value = options.send(key)
+    is_default    = DEFAULT_REPORT_OPTIONS[key] == current_value
+    parts << [display, (is_default ? '*' : ' '), current_value]
+  end
+  longest_value_length = parts.map(&:first).map(&:length).max || 0
+  parts.each do |p|
+    p[0] = p[0].ljust(longest_value_length)
+  end
+  parts
+end

data/lib/private_please/reporter/simple_text.rb

@@ -13,34 +13,6 @@ module  PrivatePlease ; module Reporter
       erb.result(binding)
     end
 
-  private
-
-    def prepare_report_data
-      start_time = Time.now
-      @bad_candidates   = calls_store.external_calls      .clone
-      @bad_candidates_c = calls_store.class_external_calls.clone
-      # 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)
-
-      @never_called_candidates = candidates_store.instance_methods.clone.
-          remove(@good_candidates).
-          remove(@bad_candidates )
-
-      @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 +
-                                        candidates_store.class_methods   .classes_names ).uniq.sort
-      @good_candidates_classes_names = (@good_candidates_c.classes_names + @good_candidates.classes_names).uniq.sort
-      @bad_candidates_classes_names  = (@bad_candidates_c .classes_names + @bad_candidates .classes_names).uniq.sort
-      @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

@@ -1,26 +1,26 @@
 ====================================================================================
 =                               PrivatePlease report :                             =
 ====================================================================================
-% @candidates_classes_names .sort.each do |class_name|
+% data.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?
+%   show_bad_candidates_section     = options.show_bad_candidates_section?
+%   show_never_candidates_section   = options.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 = "."))
+%                             names_from(class_name, data.good_candidates  , prefix = "#"),
+%                             names_from(class_name, data.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 = "."))
+%                             names_from(class_name, data.bad_candidates  , prefix = "#"),
+%                             names_from(class_name, data.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 = "."))
+%                             names_from(class_name, data.never_called_candidates  , prefix = "#"),
+%                             names_from(class_name, data.never_called_candidates_c, prefix = "."))
 %   end
 %
 % # Always hide empty tables :
@@ -30,8 +30,9 @@
 %   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?
+% next if nothing_to_show && !options.show_empty_classes?
 %
+
 <%= class_name
 %>
 %
@@ -71,7 +72,9 @@
 % end
 
 ====================================================================================
-% if ENV['PP_OPTIONS']
-Default display overriden :
- $PP_OPTIONS = <%= ENV['PP_OPTIONS'].inspect %>
-% end
+
+    Report options :
+% options_footer_parts.each do |o|
+        <%= (value = o[2]) ? "V" : 'x' %> <%= is_default = o[1] %> <%= display = o[0] %>
+% end
+    (PP_OPTIONS = <%= ENV['PP_OPTIONS'] %>)

data/lib/private_please/storage/candidates_store.rb

@@ -28,6 +28,10 @@ module PrivatePlease
         bucket_for(candidate).get_methods_names(candidate.klass_name).include?(candidate.method_name)
       end
 
+      def classes_names
+        (instance_methods.classes_names + class_methods   .classes_names).uniq
+      end
+
     #--------------------------------------------------------------------------
     # COMMANDS:
     #--------------------------------------------------------------------------

data/lib/private_please/tracking.rb

@@ -42,6 +42,7 @@ module PrivatePlease
 end
 
 require 'private_please/tracking/utils'
+require 'private_please/tracking/load_utils'
 require 'private_please/tracking/instrumentor'
 require 'private_please/tracking/extension'
 require 'private_please/tracking/instruments_all_methods_below'

data/lib/private_please/tracking/instruments_automatically_all_methods_in_all_classes.rb

@@ -1,3 +1,19 @@
+module Kernel
+
+  alias_method :_orig_require, :require
+
+  def require string
+    prev_val = PrivatePlease.pp_automatic_mode_enabled?
+    if PrivatePlease::Tracking::LoadUtils.standard_lib_or_gem?(string)
+      PrivatePlease.pp_automatic_mode_disable
+    end
+
+    send :_orig_require, string
+
+    PrivatePlease.pp_automatic_mode_enable(prev_val)
+  end
+
+end
 
 class Class
 

data/lib/private_please/tracking/load_utils.rb

@@ -0,0 +1,32 @@
+module PrivatePlease::Tracking
+
+  module LoadUtils
+    require File.dirname(__FILE__) + '/load_utils/gem_utils'
+    require File.dirname(__FILE__) + '/load_utils/standard_lib_utils'
+
+    class << self
+
+      def standard_lib_or_gem?(requiree)
+        (@@_standard_lib_or_gem ||= {})[requiree] ||= begin
+          standard_lib?(requiree) || gem?(requiree)
+        end
+      end
+
+      def standard_lib?(requiree)
+        (@@_standard_lib ||= {})[requiree] ||= StandardLibUtils.standard_lib?(requiree)
+      end
+
+      def gem?(requiree)
+        (@@_gems ||= {})[requiree] ||= begin
+          base_name = requiree.include?('/') ?
+              requiree.split('/').first :      #  ex:   require 'rspec/autorun'
+              requiree                         #  ex:   require 'rspec'
+          GemUtils.gems_names.include?(base_name)
+        end
+
+      end
+
+    end
+  end
+
+end

data/lib/private_please/tracking/load_utils/gem_utils.rb

@@ -0,0 +1,49 @@
+# OPTIMISATION :
+#     Calls to `$ gem ..` are slow (esp. on jruby!)
+#     => we 1/ pre-perform them asynchronously (Threads) when this file is loaded,
+#           2/ cache the obtained value in a variable,
+#           3/ rewrite the slow method as a noop version that simply returns the cached value.
+
+module PrivatePlease::Tracking::LoadUtils
+
+  module GemUtils
+
+    class << self
+
+      # performs `$ gem env`
+      #
+      def gem_env
+        GEM_ENV_PRELOADER.join
+        gem_env     # call the fast/just rewritten version
+      end
+
+      # performs `$ gem list` + extracts the names
+      #
+      def gems_names
+        GEMS_NAMES_PRELOADER.join
+        gems_names
+      end
+
+    #-------------------------------------------------------------------------------------------------------------------
+    private
+
+      GEM_ENV_PRELOADER = Thread.new do
+        @@_cached_gem_env = `gem env`
+        def GemUtils.gem_env
+          @@_cached_gem_env
+        end
+      end
+
+      GEMS_NAMES_PRELOADER = Thread.new do
+        @@_cached_gems_names = `gem list`.  # very slow on jruby
+            split("\n").
+            map { |l| l.match(/(\S+)\s+.*/)[1]}                # ["bundle", "bundler", "rspec", ..]
+        def GemUtils.gems_names
+          @@_cached_gems_names
+        end
+      end
+
+    end
+  end
+
+end

data/lib/private_please/tracking/load_utils/standard_lib_utils.rb

@@ -0,0 +1,38 @@
+module PrivatePlease::Tracking::LoadUtils
+
+  module StandardLibUtils
+
+    class << self
+
+      def standard_lib?(requiree)
+        path_base   =  "#{std_lib_home}/#{requiree}"
+        if File.exists?(path_base)
+          path_base
+        elsif File.exists?("#{path_base}.rb")
+          "#{path_base}.rb"
+        end
+      end
+
+    #-------------------------------------------------------------------------------------------------------------------
+    private
+
+      # Ex:  "/Users/ara/.rbenv/versions/jruby-1.7.3/bin/jruby"
+      def ruby_executable
+        @@_ruby_executable ||= GemUtils.gem_env.match(/RUBY EXECUTABLE:\s*(.*)/)[1]
+      end
+
+      # Ex: "/Users/ara/.rbenv/versions/jruby-1.7.3/lib/ruby/1.9"
+      def std_lib_home
+        @@_std_lib_home ||= begin
+          basedir      = ruby_executable.gsub(/bin\/[j]?ruby/, 'lib/ruby') # => "/Users/ara/.rbenv/versions/jruby-1.7.3/lib/ruby"
+                                                  # jruby has 2+ directories of std. libs under the basedir : 1.8 and 1.9
+          $:.detect {|path|                       # We choose the one that is also in the load path.
+            path =~ /#{basedir}\/[12][^\/]+$/     #
+          }                                       # => "/Users/ara/.rbenv/versions/jruby-1.7.3/lib/ruby/1.9"
+        end                                       #                                                     ^^^ == the mode
+      end
+
+    end
+  end
+
+end

data/lib/private_please/version.rb

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

data/spec/01_tracking_candidate_methods/excluding_gems_and_standard_libraries_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "acceptance : standard libs are not tracked" do
+
+  before { PrivatePlease.pp_automatic_mode_enable }
+  after  { PrivatePlease.pp_automatic_mode_disable}
+
+  module RequireTest; end
+#-----------------
+
+  example "the csv **standard library** is required but not tracked" do
+
+    class RequireTest::Case1
+      require 'csv'
+      def foo ; end
+    end
+
+    assert_classes_names ['RequireTest::Case1']
+  end
+
+  example "the rspec **gem** is required but not tracked" do
+
+    class RequireTest::Case2
+      require 'rspec/autorun'
+      def foo ; end
+    end
+
+    assert_classes_names ['RequireTest::Case2']
+  end
+
+end

data/spec/01_tracking_candidate_methods/load_utils_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe PrivatePlease::Tracking::LoadUtils do
+
+  def std_lib?(requiree)
+    PrivatePlease::Tracking::LoadUtils.standard_lib?(requiree)
+  end
+
+  def gem?(requiree)
+    PrivatePlease::Tracking::LoadUtils.gem?(requiree)
+  end
+
+
+  example '.standard_lib? detects if a string matches a standard library' do
+    std_lib?('csv'                ).should be_true
+    std_lib?('csv.rb'             ).should be_true
+    std_lib?('bigdecimal'         ).should be_true
+    std_lib?('bigdecimal/util'    ).should be_true
+    std_lib?('bigdecimal/util.rb' ).should be_true
+
+    std_lib?('rspec'              ).should be_false
+    std_lib?('private_please'     ).should be_false
+  end
+
+  example '.gem? detects if a string matches a gem' do
+    gem?('csv'                ).should be_false
+    gem?('csv.rb'             ).should be_false
+    gem?('bigdecimal'         ).should be_false
+    gem?('bigdecimal/util'    ).should be_false
+    gem?('bigdecimal/util.rb' ).should be_false
+
+    gem?('rspec'              ).should be_true
+    gem?('rspec/core/rake_task').should be_true
+    gem?('rspec/autorun'      ).should be_true
+    gem?('coderay'            ).should be_true
+   #gem?('private_please'     ).should be_false
+  end
+
+
+end

data/spec/01_tracking_candidate_methods/systematically_in_auto_mode_spec.rb

@@ -5,8 +5,6 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
   before { PrivatePlease.pp_automatic_mode_enable }
   after  { PrivatePlease.pp_automatic_mode_disable}
 
-  let(:candidates_store) { PrivatePlease.storage }
-
 # ----------------
   context 'in a flat class,' do  # simple class; no module nor inheritance
 # ----------------
@@ -29,7 +27,7 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
       class AutFlatClass::Case2
         def foo           ; end     #
 
-        def self.baz      ; end     # 
+        def self.baz      ; end     #
       end
 
       assert_instance_methods_candidates    'AutFlatClass::Case2' => [:foo]
@@ -84,7 +82,7 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
         def foo           ; end     #
         def included      ; end     # : not a special name in classes
 
-        def self.baz      ; end     # 
+        def self.baz      ; end     #
         def self.included ; end     # : not a special name in classes
       end
 
@@ -125,7 +123,7 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
   context '1 class including 1 module' do
 # ----------------
     module IncludedModule ; end
-    
+
     example 'the tracked module methods are associated to the module, not the class(es) that includes the module' do
       module IncludedModule
         module Module1                    #
@@ -138,10 +136,10 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
           end                             #
         end                               #
         class Case1
-          include Module1                 # NO methods are associated to this class. 
+          include Module1                 # NO methods are associated to this class.
         end
       end
-      
+
       assert_instance_methods_candidates 'IncludedModule::Module1'                  =>[:im_from_module],
                                          'IncludedModule::Module1::ClassMethods'    =>[:cm_from_module]
       assert_singleton_methods_candidates    ({})
@@ -154,10 +152,10 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
   describe 'overridden methods are not tracked in classes' do
 # ----------------
     module ImplOverridingTest ; end
-    
+
     example 'overridden methods are NOT marked as candidate' do
       module ImplOverridingTest
-        class Base  
+        class Base
           def base_t_foo        ; end # is tracked
           def self.c_base_t_foo ; end # is tracked
         private
@@ -168,10 +166,10 @@ describe PrivatePlease, 'in $automatic mode, all the methods are tracked for obs
           def base_priv         ; end   # overriding a private method => not tracked
           def base_yes          ; end   # new -> tracked
           def self.c_base_yes   ; end   # new -> tracked
-        
+
           def base_t_foo        ; end   # NOT tracked
           def self.c_base_t_foo ; end   # NOT tracked
-          
+
           def to_s              ; end   # NOT tracked
         end
       end

data/spec/04_instrumented_program_activity_observation_result_spec.rb

@@ -49,14 +49,14 @@ describe 'PrivatePlease.reporter', 'observing an instrumented program activity'
   # Note: test all in 1 go because testing in bits would fail, and it differs from real usage.
   it 'obtains the right info by observing the program activity' do
     run_the_instrumented_program
-    the_report = PrivatePlease::Reporter::SimpleText.new(PrivatePlease.candidates_store, PrivatePlease.calls_store)
+    the_report_data = PrivatePlease::Reporter::SimpleText.new(PrivatePlease.candidates_store, PrivatePlease.calls_store).data
     {
-        :good_candidates  => the_report.good_candidates,
-        :good_candidates_c => the_report.good_candidates_c,
-        :bad_candidates   => the_report.bad_candidates,
-        :bad_candidates_c => the_report.bad_candidates_c,
-        :ignored          => the_report.never_called_candidates,
-        :ignored_c        => the_report.never_called_candidates_c
+        :good_candidates   => the_report_data.good_candidates,
+        :good_candidates_c => the_report_data.good_candidates_c,
+        :bad_candidates    => the_report_data.bad_candidates,
+        :bad_candidates_c  => the_report_data.bad_candidates_c,
+        :ignored           => the_report_data.never_called_candidates,
+        :ignored_c         => the_report_data.never_called_candidates_c
     }.should == {
         :good_candidates  => {
             'ActivityTest::Simple'   =>  mnames_for([:good_candidate_4, :good_candidate_5, :good_candidate_7])

data/spec/_helpers/assert_helpers.rb

@@ -0,0 +1,76 @@
+#----------
+
+def mnames_for(args)
+  PrivatePlease::Storage::MethodsNames.new(Array(args))
+end
+
+#----------
+
+class Hash
+  def to_methods_names_bucket
+    PrivatePlease::Storage::MethodsNamesBucket.new.tap do |bucket|
+      each_pair do |class_name, method_names_as_a|
+        method_names_as_a.each do |method_name|
+          bucket.add_method_name(class_name, method_name)
+        end
+      end
+    end
+  end
+end
+
+
+def assert_classes_names(expected)
+  PrivatePlease.candidates_store.classes_names.should == expected
+end
+
+def assert_instance_methods_candidates(raw_expected)
+  expected = raw_expected.to_methods_names_bucket if raw_expected.is_a?(Hash)
+  PrivatePlease.candidates_store.instance_methods.should == expected
+end
+
+def assert_class_methods_candidates(raw_expected)
+  expected = raw_expected.to_methods_names_bucket if raw_expected.is_a?(Hash)
+  PrivatePlease.candidates_store.class_methods.should == expected
+end
+alias :assert_singleton_methods_candidates :assert_class_methods_candidates
+
+#----------
+
+def assert_calls_detected(expected)
+  calls_db = PrivatePlease.calls_store
+  { :inside    => calls_db.internal_calls,
+    :inside_c  => calls_db.class_internal_calls,
+    :outside   => calls_db.external_calls,
+    :outside_c => calls_db.class_external_calls
+  }.should == expected
+end
+
+NO_CALLS_OBSERVED = {}
+
+def assert_no_calls_detected
+  assert_calls_detected :inside   => NO_CALLS_OBSERVED, :outside   => NO_CALLS_OBSERVED,
+                        :inside_c => NO_CALLS_OBSERVED, :outside_c => NO_CALLS_OBSERVED
+end
+
+#----------
+# Reporter::DataCompiler :
+#----------
+
+def run_and_inspect(fixture_file, __file__)
+  PrivatePlease.pp_automatic_mode_enable
+  load File.expand_path(File.dirname(__file__) + "/fixtures/#{fixture_file}")
+  c = PrivatePlease::Reporter::DataCompiler.new(PrivatePlease.candidates_store, PrivatePlease.calls_store)
+  data = c.compile_data
+end
+
+def assert_report_data_matches(data, expected_results = $expected_results)
+  ['candidates_classes_names',  data.candidates_classes_names ].should == ['candidates_classes_names',  expected_results[:candidates_classes_names ]]
+  ['good_candidates',           data.good_candidates          ].should == ['good_candidates',           expected_results[:good_candidates          ]]
+  ['bad_candidates',            data.bad_candidates           ].should == ['bad_candidates',            expected_results[:bad_candidates           ]]
+  ['never_called_candidates',   data.never_called_candidates  ].should == ['never_called_candidates',   expected_results[:never_called_candidates  ]]
+  ['good_candidates_c',         data.good_candidates_c        ].should == ['good_candidates_c',         expected_results[:good_candidates_c        ]]
+  ['bad_candidates_c',          data.bad_candidates_c         ].should == ['bad_candidates_c',          expected_results[:bad_candidates_c         ]]
+  ['never_called_candidates_c', data.never_called_candidates_c].should == ['never_called_candidates_c', expected_results[:never_called_candidates_c]]
+end
+
+#----------

data/spec/fixtures/bug_30.rb

@@ -0,0 +1,6 @@
+# Fails with 1.8.7, works with 1.9.3, 2.0.0
+require 'private_please'
+require 'rubygems'
+require 'coderay'
+print CodeRay.scan('puts "Hello, world!"', :ruby).inspect # OK
+print CodeRay.scan('puts "Hello, world!"', :ruby).html    # FAIL

data/spec/fixtures/issue_25.rb

@@ -0,0 +1,12 @@
+require 'private_please'
+
+require 'csv'                               ## <<==
+CSV.generate("/tmp/#{Time.now}") { |_| }    ## <<==
+
+class Foo
+ def initialize; foo end
+  def foo ;end
+end
+Foo.new
+
+puts PrivatePlease.candidates_store.classes_names

data/spec/spec_helper.rb

@@ -11,50 +11,6 @@ module PrivatePlease
   end
 end
 
-class Hash
-  def to_methods_names_bucket
-    PrivatePlease::Storage::MethodsNamesBucket.new.tap do |bucket|
-      each_pair do |class_name, method_names_as_a|
-        method_names_as_a.each do |method_name|
-          bucket.add_method_name(class_name, method_name)
-        end
-      end
-    end
-  end
-end
-
-def assert_instance_methods_candidates(raw_expected)
-  expected = raw_expected.to_methods_names_bucket if raw_expected.is_a?(Hash)
-  PrivatePlease.candidates_store.instance_methods.should == expected
-end
-
-def assert_class_methods_candidates(raw_expected)
-  expected = raw_expected.to_methods_names_bucket if raw_expected.is_a?(Hash)
-  PrivatePlease.candidates_store.class_methods.should == expected
-end
-alias :assert_singleton_methods_candidates :assert_class_methods_candidates
-
-
-def assert_calls_detected(expected)
-  calls_db = PrivatePlease.calls_store
-  { :inside    => calls_db.internal_calls,
-    :inside_c  => calls_db.class_internal_calls,
-    :outside   => calls_db.external_calls,
-    :outside_c => calls_db.class_external_calls
-  }.should == expected
-end
-
-NO_CALLS_OBSERVED = {}
-
-def assert_no_calls_detected
-  assert_calls_detected :inside   => NO_CALLS_OBSERVED, :outside   => NO_CALLS_OBSERVED,
-                        :inside_c => NO_CALLS_OBSERVED, :outside_c => NO_CALLS_OBSERVED
-end
-
-def mnames_for(args)
-  PrivatePlease::Storage::MethodsNames.new(Array(args))
-end
-
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
@@ -72,6 +28,10 @@ RSpec.configure do |config|
   end
 end
 
+require '_helpers/assert_helpers'
+
+#--------------------------------------------------------
+
 require File.dirname(__FILE__) + '/../lib/private_please'
 PrivatePlease.pp_automatic_mode_disable
 

data/spec/units/reporter/data_compiler_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe PrivatePlease::Reporter::DataCompiler do
+
+  context 'report generation for different scenarios' do
+    after  { $expected_results = nil }
+
+    example('simple_case_1') { assert_report_data_matches(run_and_inspect("simple_case_1.rb", __FILE__)) }
+    example('simple_case_2') { assert_report_data_matches(run_and_inspect("simple_case_2.rb", __FILE__)) }
+  end
+
+end

data/spec/units/reporter/fixtures/simple_case_1.rb

@@ -0,0 +1,30 @@
+#---------
+# Setup
+#---------
+
+class SimpleCase1
+  def entry_point; baz ; end
+  def baz ; end
+  def never; end
+  def self.c_entry_point; c_baz ; end
+  def self.c_baz ; end
+  def self.c_never; end
+end
+SimpleCase1.new.entry_point
+SimpleCase1.c_entry_point
+
+#------------------
+# Expected results
+#------------------
+
+$expected_results = {
+    :candidates_classes_names   => ['SimpleCase1'],
+
+    :good_candidates            => {'SimpleCase1' => mnames_for([:baz])          },
+    :bad_candidates             => {'SimpleCase1' => mnames_for([:entry_point])  },
+    :never_called_candidates    => {'SimpleCase1' => mnames_for([:never])        },
+
+    :good_candidates_c          => {'SimpleCase1' => mnames_for([:c_baz])        },
+    :bad_candidates_c           => {'SimpleCase1' => mnames_for([:c_entry_point])},
+    :never_called_candidates_c  => {'SimpleCase1' => mnames_for([:c_never])      }
+}

data/spec/units/reporter/fixtures/simple_case_2.rb

@@ -0,0 +1,55 @@
+#---------
+# Scenario
+#---------
+# - additional internal calls are made to bad candidates (**1 )
+# - an empty   class is defined (**2 )
+# - an ignored class is defined (**3 )
+
+class SimpleCase2
+  def initialize
+    entry_point                     # **1
+  end
+
+  def entry_point
+    baz
+    self.class.c_entry_point        # **1
+  end
+  def baz ; end
+  def never; end
+  def self.c_entry_point
+    c_baz
+  end
+  def self.c_baz ; end
+  def self.c_never; end
+end
+SimpleCase2.new.entry_point
+SimpleCase2.c_entry_point
+
+
+class SimpleCase2
+  class Empty                       # **2
+  end
+  class NotEmptyButNeverCalled      # **3
+    def initialize ; neverr ; end
+    def neverr ; end
+  end
+end
+
+#------------------
+# Expected results
+#------------------
+
+$expected_results = {
+    :candidates_classes_names   => ['SimpleCase2',
+                                    'SimpleCase2::NotEmptyButNeverCalled'   # will produce a (hidden) empty 3-section block
+                                   ],                                       # TODO : filter it out in the DataCompiler
+
+    :good_candidates            => {'SimpleCase2' => mnames_for([:baz])          },
+    :bad_candidates             => {'SimpleCase2' => mnames_for([:entry_point])  },
+    :never_called_candidates    => {'SimpleCase2'                         => mnames_for([:never]),
+                                    'SimpleCase2::NotEmptyButNeverCalled' => mnames_for([:neverr])
+                                   },
+    :good_candidates_c          => {'SimpleCase2' => mnames_for([:c_baz])        },
+    :bad_candidates_c           => {'SimpleCase2' => mnames_for([:c_entry_point])},
+    :never_called_candidates_c  => {'SimpleCase2' => mnames_for([:c_never])      }
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: private_please
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Alain Ravet
@@ -15,10 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-04 00:00:00 +02:00
+date: 2013-05-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,10 +31,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: rake
   version_requirements: *id001
-  prerelease: false
 - !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -43,10 +45,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: rspec
   version_requirements: *id002
-  prerelease: false
 - !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,10 +59,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: guard-rspec
   version_requirements: *id003
-  prerelease: false
 - !ruby/object:Gem::Dependency 
+  name: rb-fsevent
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -71,9 +73,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  name: rb-fsevent
   version_requirements: *id004
-  prerelease: false
 description: Test if methods can be made private
 email: 
 - alainravet@gmail.com
@@ -109,6 +109,7 @@ files:
 - lib/private_please/report/table.rb
 - lib/private_please/reporter.rb
 - lib/private_please/reporter/base.rb
+- lib/private_please/reporter/data_compiler.rb
 - lib/private_please/reporter/helpers/options_helpers.rb
 - lib/private_please/reporter/helpers/text_table_helpers.rb
 - lib/private_please/reporter/simple_text.rb
@@ -125,17 +126,25 @@ files:
 - lib/private_please/tracking/instruments_all_methods_below.rb
 - lib/private_please/tracking/instruments_automatically_all_methods_in_all_classes.rb
 - lib/private_please/tracking/line_change_tracker.rb
+- lib/private_please/tracking/load_utils.rb
+- lib/private_please/tracking/load_utils/gem_utils.rb
+- lib/private_please/tracking/load_utils/standard_lib_utils.rb
 - lib/private_please/tracking/utils.rb
 - lib/private_please/version.rb
 - private_please.gemspec
 - sample.rb
+- spec/01_tracking_candidate_methods/excluding_gems_and_standard_libraries_spec.rb
 - spec/01_tracking_candidate_methods/explicitely_with_the_private_please_command_spec.rb
+- spec/01_tracking_candidate_methods/load_utils_spec.rb
 - spec/01_tracking_candidate_methods/systematically_in_auto_mode_spec.rb
 - spec/03_logging_calls_on_candidate_methods_spec.rb
 - spec/04_instrumented_program_activity_observation_result_spec.rb
 - spec/05_reporting/report_table_spec.rb
 - spec/06_at_exit_spec.rb
+- spec/_helpers/assert_helpers.rb
 - spec/fixtures/bug_22.rb
+- spec/fixtures/bug_30.rb
+- spec/fixtures/issue_25.rb
 - spec/fixtures/sample_class_for_report.rb
 - spec/fixtures/sample_class_with_all_calls_combinations.rb
 - spec/sandbox/Gemfile
@@ -146,6 +155,9 @@ files:
 - spec/spec_helper.rb
 - spec/units/calls_store_spec.rb
 - spec/units/candidates_store_spec.rb
+- spec/units/reporter/data_compiler_spec.rb
+- spec/units/reporter/fixtures/simple_case_1.rb
+- spec/units/reporter/fixtures/simple_case_2.rb
 has_rdoc: true
 homepage: https://github.com/alainravet/private_please
 licenses: []
@@ -181,13 +193,18 @@ signing_key:
 specification_version: 3
 summary: Test if methods can be made private
 test_files: 
+- spec/01_tracking_candidate_methods/excluding_gems_and_standard_libraries_spec.rb
 - spec/01_tracking_candidate_methods/explicitely_with_the_private_please_command_spec.rb
+- spec/01_tracking_candidate_methods/load_utils_spec.rb
 - spec/01_tracking_candidate_methods/systematically_in_auto_mode_spec.rb
 - spec/03_logging_calls_on_candidate_methods_spec.rb
 - spec/04_instrumented_program_activity_observation_result_spec.rb
 - spec/05_reporting/report_table_spec.rb
 - spec/06_at_exit_spec.rb
+- spec/_helpers/assert_helpers.rb
 - spec/fixtures/bug_22.rb
+- spec/fixtures/bug_30.rb
+- spec/fixtures/issue_25.rb
 - spec/fixtures/sample_class_for_report.rb
 - spec/fixtures/sample_class_with_all_calls_combinations.rb
 - spec/sandbox/Gemfile
@@ -198,3 +215,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/units/calls_store_spec.rb
 - spec/units/candidates_store_spec.rb
+- spec/units/reporter/data_compiler_spec.rb
+- spec/units/reporter/fixtures/simple_case_1.rb
+- spec/units/reporter/fixtures/simple_case_2.rb