private_please 0.0.5 → 0.1.0

data/spec/04_instrumented_program_activity_observation_result_spec.rb

@@ -1,86 +0,0 @@
-require 'spec_helper'
-
-describe 'PrivatePlease.reporter', 'observing an instrumented program activity' do
-
-  def run_the_instrumented_program
-    ActivityTest::Simple.new.tap do |o|
-      o.not_a_candidate_1
-      o.not_a_candidate_2
-      o.class.not_a_candidate_c1
-      o.bad_candidate_3
-      o.bad_candidate_6
-      o.class.bad_candidate_c3
-    end
-    ActivityTest::Simple2.new.bad_candidate_too
-    ActivityTest::Simple2    .bad_candidate_c_too
-  end
-
-  before do
-
-    module ActivityTest
-      class Simple
-        def not_a_candidate_1;    bad_candidate_3   end
-        def not_a_candidate_2;    good_candidate_7  end
-        def self.not_a_candidate_c1;
-          good_candidate_c2
-        end
-      private_please
-        def bad_candidate_3;      good_candidate_4  end
-        def good_candidate_4;     good_candidate_5  end
-        def good_candidate_5;     bad_candidate_6   end
-        def bad_candidate_6;      good_candidate_7  end
-        def good_candidate_7;                       end
-        def ignored_8  ;          'never called'    end
-        def self.ignored_c9 ;          'never called'    end
-        def self.good_candidate_c2;                 end
-        def self.bad_candidate_c3;                  end
-      end
-
-      class Simple2
-      private_please
-        def bad_candidate_too;                      end
-        def ignored_2;            'never called'    end
-        def self.ignored_c3;      'never called'    end
-        def self.bad_candidate_c_too;               end
-      end
-    end unless defined?(ActivityTest::Simple)
-  end
-
-  # 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_data = PrivatePlease::Reporter::SimpleText.new(PrivatePlease.candidates_store, PrivatePlease.calls_store).data
-    {
-        :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])
-        },
-        :good_candidates_c => {
-            'ActivityTest::Simple'   =>  mnames_for([:good_candidate_c2])
-        },
-        :bad_candidates   => {
-            'ActivityTest::Simple'   =>  mnames_for([:bad_candidate_3, :bad_candidate_6]),
-            'ActivityTest::Simple2'  =>  mnames_for([:bad_candidate_too])
-        },
-        :bad_candidates_c => {
-            'ActivityTest::Simple'   =>  mnames_for([:bad_candidate_c3]),
-            'ActivityTest::Simple2'  =>  mnames_for([:bad_candidate_c_too])
-        },
-        :ignored          => {
-            'ActivityTest::Simple'   =>  mnames_for([:ignored_8]),
-            'ActivityTest::Simple2'  =>  mnames_for([:ignored_2])
-        },
-        :ignored_c        => {
-            'ActivityTest::Simple'   =>  mnames_for([:ignored_c9]),
-            'ActivityTest::Simple2'  =>  mnames_for([:ignored_c3])
-        }
-    }
-  end
-
-end

data/spec/05_reporting/report_table_spec.rb

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease::Report::Table do
-  let(:col_1) { %w(a b c) }
-  let(:col_2) { %w(X Y Z) }
-
-  def table(col_1, col_2)
-    PrivatePlease::Report::Table.new(col_1, col_2)    
-  end
-#------------------------------------------------------------------------------
-  
-  it 'wraps 2 columns of data' do
-    t = table(col_1, col_2)
-    t.col_1.should == col_1
-    t.col_2.should == col_2
-  end
-
-  it 'pads with nil whichever column is shorter' do
-    table(['1'], %w(a b c)).tap do |t|
-      t.col_1.should == ['1', nil, nil]
-      t.col_2.should == %w(a b c)
-    end
-    table(%w(a b c), ['1']).tap do |t|
-      t.col_1.should == %w(a b c)
-      t.col_2.should == ['1', nil, nil]
-    end
-    
-  end  
-
-  example '#rows returns an array of [String, String]' do
-    t = table(['1', '2'], col_2)
-    t.rows.should == [
-        ['1', 'X'],
-        ['2', 'Y'],
-        [nil, 'Z'],
-    ]
-  end
-
-  example '#empty?' do
-    table(['1', '2'], []).should_not be_empty    
-    table([], ['1', '2']).should_not be_empty    
-    table([], []        ).should     be_empty    
-  end
-
-  example '#longest_value_length' do
-    table(['a', '12345'], ['b', 'c']).longest_value_length.should == '12345'.length     
-    table(['b'], ['a', '12345']     ).longest_value_length.should == '12345'.length     
-    table([], []                    ).longest_value_length.should == 0     
-  end
-  
-end

data/spec/06_at_exit_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe 'at_exit() behaviour' do
-  
-  it 'prints the PP simpletext report to $stdout (when not in test mode)' do
-    $private_please_tests_are_running = false
-    PrivatePlease::Reporter::SimpleText.stub(:new => stub(:text => '<the-report-text>'))
-    $stdout.
-        should_receive(:puts).
-        with('<the-report-text>')
-    begin
-      PrivatePlease.at_exit
-    ensure
-      $private_please_tests_are_running = true
-    end
-  end
-
-end

data/spec/_helpers/assert_helpers.rb

@@ -1,76 +0,0 @@
-#----------
-
-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_22.rb

@@ -1,17 +0,0 @@
-load File.expand_path File.dirname(__FILE__) + '/../../doc/fixtures/fixture_helper.rb'
-
-module Extra
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-  module ClassMethods
-    def a_class_method_via_module_Extra ; end
-  end
-end
-
-
-class Simple
-  include Extra
-end
-Simple.a_class_method_via_module_Extra
-

data/spec/fixtures/bug_30.rb

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

@@ -1,12 +0,0 @@
-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/fixtures/sample_class_for_report.rb

@@ -1,56 +0,0 @@
-require 'private_please'
-
-module ReportSample
-                                                ###########################################
-  class Simple                                  # Internal calls :                        #
-                                                # -> called methods are _GOOD CANDIDATES_ #
-    def make_internal_calls                     ###########################################
-      instance_m_1                              #  i -> i
-      self.class.class_m_1                      #  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) #
-                                                # -> 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
-    end                                         #
-    def call_the_candidate_from_inside_and_outside
-      make_external_calls
-      Simple.new.make_internal_calls
-    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 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)
-#-----------------------------------------------------------------------------------------------------------------------

data/spec/fixtures/sample_class_with_all_calls_combinations.rb

@@ -1,69 +0,0 @@
-module CallsSample
-                                                ###########################################
-  class Simple                                  # Internal calls :                        #
-                                                # -> called methods are _GOOD CANDIDATES_ #
-    def make_internal_calls                     ###########################################
-      instance_m_1                              #  i -> i
-      self.class.class_m_1                      #  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) #
-                                                # -> 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
-    end                                         #
-    def call_the_candidate_from_inside_and_outside
-      make_external_calls
-      CallsSample::Simple.new.make_internal_calls
-    end
-  end
-
-#-----------------------------------------------------------------------------------------------------------------------
-  module Extra               ; private_please end  # <<=== Pre-instrument.
-  module Extra::ClassMethods ; private_please end  # <<=== Pre-instrument.
-
-  module Extra
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-    def an_instance_method ; end
-    module ClassMethods
-      def a_class_method_via_module_Extra ; end
-    end
-  end
-
-
-  class Simple
-    def self.not_a_candidate_c1;
-      class_m_2
-    end
-
-  private_please
-    include Extra
-    def instance_m_1;   end
-    def instance_m_2;   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?(CallsSample::Simple)

data/spec/sandbox/Gemfile

@@ -1,4 +0,0 @@
-# A sample Gemfile
-source "https://rubygems.org"
-
-gem 'private_please', :path => '../..'

data/spec/sandbox/Gemfile.lock

@@ -1,14 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    private_please (0.0.4rc)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  private_please!

data/spec/sandbox/README.txt

@@ -1,26 +0,0 @@
-To inspect the program 
-    normal.rb 
-with PrivatePlease, launch it one of these ways :
-
-  $ ruby -rubygems   -e "require 'private_please' ; load 'normal.rb'"
-or
-  $ bundle exec ruby -e "require 'private_please' ; load 'normal.rb'"
-
-You can also insert the     
-   require 'private_please'
-code in the program itself. (see normal_prepended_with_require.rb, line 3)
-
-
-  ruby normal.rb
-->
-  ruby -rubygems -e "require 'private_please' ; load 'normal.rb'"
-  ruby -rubygems simple_with_require.rb
-  
-
-  be ruby normal.rb
-->
-  be ruby -e "require 'private_please' ; load 'normal.rb'"
-  be ruby simple_with_require.rb
-
-
-