private_please 0.0.5 → 0.1.0

data/sample.rb

@@ -1,68 +0,0 @@
-#   require 'private_please'
-require 'lib/private_please'  # use the latest version
-
-module ReportSample
-                                                ###########################################
-  class Simple                                  # Internal calls :                        #
-                                                # -> called methods are _GOOD CANDIDATES_ #
-    def make_internal_calls                     ###########################################
-      instance_m_1                              #  i -> i
-      instance_m_3                              #  i -> i
-      self.class.class_m_1                      #  i -> C
-      self.class.class_m_2                      #  i -> C
-      self.class.c_make_internal_method_calls   #  i -> C --> C
-    end                                         #         +-> i
-
-    def self.c_make_internal_method_calls       #
-      class_m_1                                 #  C -> C
-      new.instance_m_2                          #  C -> i
-    end                                         #
-  end
-
-                                                #######################################################
-  class AnotherClass                            # External calls (would fail if methods were private) #
-    private_please                              # -> called methods are _BAD CANDIDATES_              #
-    def make_external_calls                     #######################################################
-      Simple.new.instance_m_1                   #  i -> i
-      Simple    .class_m_1                      #  i -> C
-      self.class.c_make_external_calls          #  i -> C -> i
-    end                                         #         -> C
-    def self.c_make_external_calls              #
-      Simple.new.instance_m_1                   #  C -> i
-      Simple    .class_m_1                      #  C -> C
-      Simple    .class_m_2                      #  C -> C
-    end                                         #
-    def call_the_candidate_from_inside_and_outside
-      make_external_calls
-      Simple.new.make_internal_calls
-    end
-    def never_called; end
-    def self.never_called_c; end
-  end
-
-#-----------------------------------------------------------------------------------------------------------------------
- class Simple
-    def self.not_a_candidate_c1;
-      class_m_2
-    end
-
-    private_please
-    def instance_m_1;   end
-    def instance_m_2;   end
-    def instance_m_3;   end
-
-    def self.class_m_1;
-      class_m_2
-    end
-    def self.class_m_2; end
-
-    def never_called_1;             end
-    def self.class_never_called_1;  end
-  end
-end unless defined?(ReportSample::Simple)
-#-----------------------------------------------------------------------------------------------------------------------
-
-ReportSample::Simple.new.make_internal_calls
-ReportSample::AnotherClass.new.make_external_calls
-ReportSample::AnotherClass.c_make_external_calls
-

data/spec/01_tracking_candidate_methods/excluding_gems_and_standard_libraries_spec.rb

@@ -1,31 +0,0 @@
-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/explicitely_with_the_private_please_command_spec.rb

@@ -1,118 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'collecting the details of selected candidate-methods to observe' do
-  module MarkingTest; end
-
-  let(:candidates_store) { PrivatePlease.storage }
-
-# ----------------
-  context 'observing with `private_please`' do
-# ----------------
-
-    example 'all the instance methods defined after `private_please` are stored as candidates' do
-
-      class MarkingTest::Automatic1
-        def foo ; end          #    NO (too early)
-      private_please # --->    # <start observing>
-        def baz ; end          #    *
-      public                   #    *
-        def qux ; end          #    *
-        def included ; end     #    * special name, but valid candidate (in classes).
-      end
-      assert_instance_methods_candidates 'MarkingTest::Automatic1' =>[:baz, :qux, :included]
-      assert_class_methods_candidates    ({})
-    end
-
-
-    example 'all the class methods defined after `private_please` are stored as candidates' do
-      class MarkingTest::Automatic1b
-        def self.foo ; end       #    NO (too early)
-      private_please   # --->    # <start observing>
-        def self.baz ; end       #    YES
-      public                     #    *
-        def self.qux ; end       #    YES
-      end
-
-      assert_instance_methods_candidates ({})
-      assert_class_methods_candidates    'MarkingTest::Automatic1b' =>[:baz, :qux]
-    end
-
-    example ('already private methods are ignored/not observed') do
-      class MarkingTest::Automatic1c
-      private_please   # --->    # <start observing>
-        def self.baz ; end       #    YES
-      public                     #    *
-        def qux ; end            #    YES
-      private                    #
-        def already_private ; end            #    NO
-        class << self
-        private
-          def class_already_private ; end     #    NO
-        end
-      end
-
-      assert_instance_methods_candidates 'MarkingTest::Automatic1c' =>[:qux]
-      assert_class_methods_candidates    'MarkingTest::Automatic1c' =>[:baz]
-    end
-
-
-    example 'method coming from an included module are observed too' do
-
-      module Extra002               ; private_please end  # <<=== Pre-instrument.
-      module Extra002::ClassMethods ; private_please end  # <<=== Pre-instrument.
-
-      module Extra002                                     # Reopen the pre-instrumented
-        def im_from_module ; end                          # module.
-        def self.included(base)                           #
-          base.extend ClassMethods                        #
-        end                                               #
-        module ClassMethods                               #
-          def cm_from_module ; end                        #
-        end                                               #
-      end                                                 #
-      assert_instance_methods_candidates 'Extra002'                 =>[:im_from_module],
-                                         'Extra002::ClassMethods'   =>[:cm_from_module]
-      assert_class_methods_candidates    ({})
-    end
-  end
-
-# ----------------
-  describe 'overridden methods are not tracked' do
-# ----------------
-    module ExplOverridingTest ; end
-    
-    example 'overridden methods are NOT marked as candidate' do
-      module ExplOverridingTest::UserClasses
-        class Base                    #  
-          def base_foo        ; end   #
-          def self.c_base_foo ; end   #
-        private_please                # <start tracking>
-          def base_t_bar        ; end # is tracked
-          def self.c_base_t_bar ; end # is tracked
-        private
-          def base_priv         ; end # private => not tracked
-        end
-
-        class Overrider < Base
-        private_please                  # <start tracking>
-          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_foo          ; end   # NOT tracked
-          def base_t_bar        ; end   # NOT tracked
-          def self.c_base_foo   ; end   # NOT tracked
-          def self.c_base_t_bar ; end   # NOT tracked
-          
-          def to_s              ; end   # NOT tracked
-        end
-      end
-
-      assert_instance_methods_candidates 'ExplOverridingTest::UserClasses::Base'      => [:base_t_bar],
-                                         'ExplOverridingTest::UserClasses::Overrider' => [:base_yes]
-      assert_class_methods_candidates    'ExplOverridingTest::UserClasses::Base'      => [:c_base_t_bar],
-                                         'ExplOverridingTest::UserClasses::Overrider' => [:c_base_yes]
-    end
-  end
-
-end

data/spec/01_tracking_candidate_methods/load_utils_spec.rb

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

@@ -1,185 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'in $automatic mode, all the methods are tracked for observation by PP' do
-
-  before { PrivatePlease.pp_automatic_mode_enable }
-  after  { PrivatePlease.pp_automatic_mode_disable}
-
-# ----------------
-  context 'in a flat class,' do  # simple class; no module nor inheritance
-# ----------------
-    module AutFlatClass; end
-
-    example 'instance and singleton methods are tracked' do
-      class AutFlatClass::Case1
-        def foo      ; end     #
-        def baz      ; end     #
-        def self.foo ; end     #
-        def self.baz ; end     #
-      end
-
-      assert_instance_methods_candidates    'AutFlatClass::Case1' => [:baz, :foo]
-      assert_singleton_methods_candidates   'AutFlatClass::Case1' => [:baz, :foo]
-    end
-
-
-    example '.included and #included are 2 methods we track in classes.' do
-      class AutFlatClass::Case2
-        def foo           ; end     #
-
-        def self.baz      ; end     #
-      end
-
-      assert_instance_methods_candidates    'AutFlatClass::Case2' => [:foo]
-      assert_singleton_methods_candidates   'AutFlatClass::Case2' => [:baz]
-    end
-
-
-    example 'already private methods are not tracked' do
-      class AutFlatClass::Case3
-        def foo       ; end                 #    YES
-        def self.baz  ; end                 #    YES
-      private
-        def already_private         ; end   #    NO
-        class << self
-        private
-          def class_already_private ; end   #    NO
-        end
-      end
-
-      assert_instance_methods_candidates    'AutFlatClass::Case3' => [:foo]
-      assert_singleton_methods_candidates   'AutFlatClass::Case3' => [:baz]
-    end
-
-    example 'metaprograpping-related Class methods are not tracked' do
-      class AutFlatClass::Case4
-        def singleton_method_added(_) ; end #    NO
-        def method_added(          _) ; end #    NO
-      end
-
-      assert_instance_methods_candidates    ({})
-      assert_singleton_methods_candidates   ({})
-    end
-  end
-
-# ----------------
-  context 'in a flat module,' do  # no inheritance
-# ----------------
-    module AutFlatModule; end
-
-    example 'instance and singleton methods are tracked' do
-      module AutFlatModule::Case1
-        def foo      ; end     #
-        def self.baz ; end     #
-      end
-
-      assert_instance_methods_candidates    'AutFlatModule::Case1' => [:foo]
-      assert_singleton_methods_candidates   'AutFlatModule::Case1' => [:baz]
-    end
-
-    example 'we track #included but not .included' do
-      module AutFlatModule::Case2
-        def foo           ; end     #
-        def included      ; end     # : not a special name in classes
-
-        def self.baz      ; end     #
-        def self.included ; end     # : not a special name in classes
-      end
-
-      assert_instance_methods_candidates    'AutFlatModule::Case2' => [:foo, :included]
-      assert_singleton_methods_candidates   'AutFlatModule::Case2' => [:baz]
-    end
-
-
-    example 'already private methods are not tracked' do
-      module AutFlatModule::Case3
-      private
-        def already_private         ; end   #    NO
-        class << self
-        private
-          def class_already_private ; end   #    NO
-        end
-      end
-
-      assert_instance_methods_candidates    ({})
-      assert_singleton_methods_candidates   ({})
-    end
-
-    example 'metaprograpping-related Module methods are not tracked' do
-      module AutFlatModule::Case4
-        def singleton_method_added(_) ; end #    NO
-        def method_added(          _) ; end #    NO
-        def self.included(base)       ; end #    NO
-      end
-
-      assert_instance_methods_candidates    ({})
-      assert_singleton_methods_candidates   ({})
-    end
-
-  end
-
-
-# ----------------
-  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                    #
-          def im_from_module ; end        # YES
-          def self.included(base)         # NO
-            base.extend ClassMethods      #
-          end                             #
-          module ClassMethods             #
-            def cm_from_module ; end      # YES
-          end                             #
-        end                               #
-        class Case1
-          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    ({})
-    end
-
-  end
-
-
-# ----------------
-  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
-          def base_t_foo        ; end # is tracked
-          def self.c_base_t_foo ; end # is tracked
-        private
-          def base_priv         ; end # private => not tracked
-        end
-
-        class Overrider < Base
-          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
-
-      assert_instance_methods_candidates 'ImplOverridingTest::Base'      => [:base_t_foo],
-                                         'ImplOverridingTest::Overrider' => [:base_yes]
-      assert_class_methods_candidates    'ImplOverridingTest::Base'      => [:c_base_t_foo],
-                                         'ImplOverridingTest::Overrider' => [:c_base_yes]
-    end
-  end
-
-
-end

data/spec/03_logging_calls_on_candidate_methods_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'calling observed methods and logging calls in 2 categories : internal or external' do
-
-  before do
-#-----------------------------------------------------------------------------------------------------------------------
-    load File.dirname(__FILE__) + '/fixtures/sample_class_with_all_calls_combinations.rb'
-#-----------------------------------------------------------------------------------------------------------------------
-  end
-  after { Object.send(:remove_const, :CallsSample) }
-
-  example ('pure internal calls are categorized correctly') do
-    CallsSample::Simple.new.make_internal_calls
-    assert_calls_detected :inside     => {'CallsSample::Simple' => mnames_for([:instance_m_1, :instance_m_2])},
-                          :outside    => NO_CALLS_OBSERVED,
-                          :inside_c   => {'CallsSample::Simple' => mnames_for([:class_m_1, :class_m_2])},
-                          :outside_c  => NO_CALLS_OBSERVED
-  end
-
-  example ('pure external calls are categorized correctly') do
-    CallsSample::AnotherClass.new.make_external_calls
-    assert_calls_detected :inside     => NO_CALLS_OBSERVED,
-                          :outside    => {'CallsSample::Simple' => mnames_for([:instance_m_1])},
-                          :inside_c   => {'CallsSample::Simple' => mnames_for([:class_m_2])},
-                          :outside_c  => {'CallsSample::Simple' => mnames_for([:class_m_1])}
-  end
-
-  example('when a method is called both from inside and from outside its class, it is recorded is both categories') do
-    CallsSample::AnotherClass.new.call_the_candidate_from_inside_and_outside
-    assert_calls_detected :inside     => {'CallsSample::Simple' => mnames_for([:instance_m_1, :instance_m_2])},
-                          :outside    => {'CallsSample::Simple' => mnames_for([:instance_m_1])},
-                          :inside_c   => {'CallsSample::Simple' => mnames_for([:class_m_2, :class_m_1])},
-                          :outside_c  => {'CallsSample::Simple' => mnames_for([:class_m_1])}
-  end
-
-#-----------------------------------------------------------------------------------------------------------------------
-end