private_please 0.0.2 → 0.0.3

data/spec/units/candidates_store_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+
+describe PrivatePlease::Storage::CandidatesStore do
+
+  let(:candidates_store)  { PrivatePlease::Storage::CandidatesStore.new }
+
+  # instance methods
+  let(:object_to_s)  {PrivatePlease::Candidate.for_instance_method(Object, 'to_s' )}
+  let(:object_hash)  {PrivatePlease::Candidate.for_instance_method(Object, 'hash' )}
+  # class methods
+  let(:object_new )  {PrivatePlease::Candidate.for_class_method(Object, 'new'  )}
+
+  context 'when fresh' do
+    it 'is empty (has no candidates)' do
+      candidates_store                 .should be_empty
+      candidates_store.instance_methods.should be_empty
+      candidates_store.class_methods   .should be_empty
+    end
+  end
+
+  example 'storing the 1st instance method candidate stores it so that it can be retrieved' do
+    candidates_store.store(object_to_s)
+
+    candidates_store.stored?(object_to_s).should be_true
+    candidates_store.instance_methods.should == {'Object' => mnames_for('to_s')}
+    candidates_store.class_methods   .should be_empty
+  end
+
+  example 'storing the 1st class method candidate stores it so that it can be retrieved' do
+    candidates_store.store(object_new)
+
+    candidates_store.stored?(object_new).should be_true
+    candidates_store.instance_methods.should be_empty
+    candidates_store.class_methods   .should == {'Object' => mnames_for('new')}
+  end
+
+  example 'storing the 2nd instance method candidate stores it so that it can be retrieved' do
+    candidates_store.store(object_to_s)
+    candidates_store.store(object_hash)
+
+    candidates_store.stored?(object_hash).should be_true
+    candidates_store.instance_methods.should == {'Object' => mnames_for(%w(hash to_s))}
+    candidates_store.class_methods   .should be_empty
+  end
+
+  example 'storing avoids duplication' do
+    candidates_store.store(object_to_s)
+    candidates_store.store(object_to_s) # duplication : ignore it
+
+    candidates_store.instance_methods.should == {'Object' => mnames_for(%w(to_s))}
+    candidates_store.class_methods   .should be_empty
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: private_please
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alain Ravet
@@ -15,10 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-23 00:00:00 Z
+date: 2013-04-28 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -27,12 +28,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :development
   name: rake
-  requirement: *id001
+  version_requirements: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -41,12 +42,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :development
   name: rspec
-  requirement: *id002
+  version_requirements: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -55,10 +56,24 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :development
   name: guard-rspec
-  requirement: *id003
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 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
@@ -71,6 +86,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- .ruby-version
 - CHANGELOG
 - Gemfile
 - Guardfile
@@ -79,19 +95,30 @@ files:
 - Rakefile
 - TODO
 - lib/private_please.rb
-- lib/private_please/candidates.rb
-- lib/private_please/configuration.rb
-- lib/private_please/line_change_tracker.rb
-- lib/private_please/recorder.rb
-- lib/private_please/report.rb
-- lib/private_please/report/template.txt.erb
+- lib/private_please/candidate.rb
+- lib/private_please/report/reporter.rb
+- lib/private_please/report/templates/simple.txt.erb
+- lib/private_please/ruby_backports.rb
+- lib/private_please/storage/calls_store.rb
+- lib/private_please/storage/candidates_store.rb
+- lib/private_please/storage/methods_names.rb
+- lib/private_please/storage/methods_names_bucket.rb
+- lib/private_please/tracking/extension.rb
+- lib/private_please/tracking/instrumentor.rb
+- lib/private_please/tracking/instruments_all_below.rb
+- lib/private_please/tracking/line_change_tracker.rb
 - lib/private_please/version.rb
 - private_please.gemspec
-- spec/01_marking_methods_spec.rb
-- spec/02_calling_methods_spec.rb
-- spec/03_configuration_spec.rb
-- spec/04_at_exit_report_printing_spec.rb
+- sample.rb
+- spec/01_marking_candidate_methods_to_observe_spec.rb
+- spec/02_logging_calls_on_candidate_methods_spec.rb
+- spec/04_instrumented_program_activity_observation_result_spec.rb
+- spec/fixtures/sample_class_for_report.rb
+- spec/fixtures/sample_class_with_all_calls_combinations.rb
 - spec/spec_helper.rb
+- spec/units/calls_store_spec.rb
+- spec/units/candidates_store_spec.rb
+has_rdoc: true
 homepage: https://github.com/alainravet/private_please
 licenses: []
 
@@ -121,13 +148,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Test if methods can be made private
 test_files: 
-- spec/01_marking_methods_spec.rb
-- spec/02_calling_methods_spec.rb
-- spec/03_configuration_spec.rb
-- spec/04_at_exit_report_printing_spec.rb
+- spec/01_marking_candidate_methods_to_observe_spec.rb
+- spec/02_logging_calls_on_candidate_methods_spec.rb
+- spec/04_instrumented_program_activity_observation_result_spec.rb
+- spec/fixtures/sample_class_for_report.rb
+- spec/fixtures/sample_class_with_all_calls_combinations.rb
 - spec/spec_helper.rb
+- spec/units/calls_store_spec.rb
+- spec/units/candidates_store_spec.rb

data/lib/private_please/candidates.rb

@@ -1,37 +0,0 @@
-module PrivatePlease
-  class Candidates
-    def self.instance
-      @@__instance ||= new
-    end
-
-    def self.reset_before_new_test
-      @@__instance = nil
-    end
-
-    attr_reader :candidates, :inside_called_candidates, :outside_called_candidates
-    def initialize
-      @candidates                = Hash.new{ [] }
-      @inside_called_candidates  = Hash.new{ [] }
-      @outside_called_candidates = Hash.new{ [] }
-    end
-
-    def record_candidate(self_class, name)
-      candidates[self_class.to_s] += Array(name)
-    end
-
-    def record_outside_call(self_class, name)
-      #TODO use a Set instead of an Array
-      unless outside_called_candidates[self_class.to_s].include?(name)
-        outside_called_candidates[self_class.to_s] += Array(name)
-      end
-    end
-
-    def record_inside_call(self_class, name)
-      #TODO use a Set instead of an Array
-      unless inside_called_candidates[self_class.to_s].include?(name)
-        inside_called_candidates[self_class.to_s] += Array(name)
-      end
-    end
-
-  end
-end

data/lib/private_please/configuration.rb

@@ -1,21 +0,0 @@
-module PrivatePlease
-  class Configuration
-    def self.instance
-      @@__instance ||= new
-    end
-
-    # only used by tests  #TODO : refactor to remove .instance and .reset
-    def self.reset_before_new_test
-      @@__instance = nil
-    end
-
-    attr_reader :active
-    def initialize
-      @active
-    end
-
-    def activate(flag)
-      @active = flag
-    end
-  end
-end

data/lib/private_please/line_change_tracker.rb

@@ -1,19 +0,0 @@
-module PrivatePlease
-  class LineChangeTracker
-    class << self
-      attr_accessor :prev_prev_self, :prev_self, :curr_self
-      @@prev_self = @@curr_self = nil
-    end
-
-    MY_TRACE_FUN = proc do |event, file, line, id, binding, klass|
-      return unless 'line'==event
-      LineChangeTracker.prev_prev_self = LineChangeTracker.prev_self
-      LineChangeTracker.prev_self      = LineChangeTracker.curr_self
-      LineChangeTracker.curr_self      = (eval 'self', binding)
-      #puts "my : #{event} in #{file}/#{line} id:#{id} klass:#{klass} - self = #{(eval'self', binding).inspect}"
-    end
-
-  end
-end
-
-set_trace_func(PrivatePlease::LineChangeTracker::MY_TRACE_FUN)

data/lib/private_please/recorder.rb

@@ -1,34 +0,0 @@
-module PrivatePlease
-  class Recorder
-
-    def self.instance
-      @@__instance ||= new(Candidates.instance)
-    end
-
-    # only used by tests  #TODO : refactor to remove .instance and .reset
-    def self.reset_before_new_test
-      @@__instance = nil
-    end
-
-    def initialize(storage)
-      @storage = storage
-    end
-
-
-    def record_candidate(self_class, name)
-      @storage.record_candidate(self_class, name)
-      # do more. ex: logging, ..
-    end
-
-    def record_outside_call(self_class, name)
-      @storage.record_outside_call(self_class, name)
-      # do more. ex: logging, ..
-    end
-
-    def record_inside_call(self_class, name)
-      @storage.record_inside_call(self_class, name)
-      # do more. ex: logging, ..
-    end
-
-  end
-end

data/lib/private_please/report/template.txt.erb

@@ -1,15 +0,0 @@
-PrivatePlease report :
-====================================================================================
-Good candidates :
-====================================================================================
-<% good_candidates.keys.each do |klass|%>
- in <%= klass %> :
-    <%= good_candidates[klass].join(', ')%>
-<% end %>
-
-====================================================================================
-Bad  candidates :
-<% bad_candidates.keys.each do |klass| %>
- in <%= klass %> :
-    <%= bad_candidates[klass].join(', ')%>
-<% end %>

data/lib/private_please/report.rb

@@ -1,47 +0,0 @@
-module  PrivatePlease
-  class Report
-
-    # @param [PrivatePlease::Recorder] recorder
-    def self.build(storage)
-      new(storage)
-    end
-
-    # @param [PrivatePlease::Recorder] recorder
-    def initialize(storage)
-      @storage = storage
-    end
-
-    TEMPLATE_PATH     = File.dirname(__FILE__) + '/report/template.txt.erb'
-
-    def to_s
-      erb = ERB.new(File.read(TEMPLATE_PATH))
-
-      good_candidates = good_candidates() # for ERB/binding
-      bad_candidates  = bad_candidates()  # for ERB/binding
-      erb.result(binding)
-    end
-
-    # @return [Hash]
-    def never_called_candidates
-      @storage.candidates.tap do |all|
-        all.keys.each do |klass|
-          all[klass] = all[klass] - @storage.outside_called_candidates[klass] - @storage.inside_called_candidates[klass]
-        end
-      end
-    end
-
-    # @return [Hash]
-    def good_candidates
-      @storage.inside_called_candidates.tap do |all|
-        all.keys.each do |klass|
-           all[klass] = all[klass] - @storage.outside_called_candidates[klass]
-        end
-      end
-    end
-
-    # @return [Hash]
-    def bad_candidates
-      @storage.outside_called_candidates
-    end
-  end
-end

data/spec/01_marking_methods_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'marking methods' do
-
-  let(:storage) { PrivatePlease.storage }
-
-  it('records the candidates and associate them to the owning class') do
-    module Marking
-      class Simple1
-        def foo ; 'foo' end
-        def bar ; 'bar' end
-        def buz ; 'bar' end
-        private_please  :bar, :buz
-      end
-    end
-    storage.candidates['Marking::Simple1'].should == [:bar, :buz]
-  end
-
-  it('does not record invalid candidates (method not found in the class)') do
-    module Marking
-      class Simple2
-        def foo ; 'foo' end
-        private_please  :foo
-        private_please  :invalid_method
-      end
-    end
-    storage.candidates['Marking::Simple2'].should == [:foo]
-  end
-
-end

data/spec/02_calling_methods_spec.rb

@@ -1,58 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'calling marked methods' do
-  before() do
-    PrivatePlease.activate(true)
-  end
-  let(:storage) { PrivatePlease.storage }
-
-  module Calling
-    class Simple
-      def public_m ;  private_m()   end
-      def private_m; 'SUCCESS'      end
-      private_please  :private_m
-    end
-  end
-
-#--------------
-  context 'from INSIDE the class' do
-#--------------
-
-    before { Calling::Simple.new.public_m }
-
-    it('records the call to the p+p method in PrivatePlease.inside_called_candidates') do
-      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
-      storage.outside_called_candidates['Calling::Simple'].to_a.should == []
-    end
-
-    it('records multiple calls only once') do
-      2.times{ Calling::Simple.new.public_m }
-      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
-      storage.outside_called_candidates['Calling::Simple'].to_a.should == []
-    end
-  end
-
-
-#--------------
-  context 'from OUTSIDE the class' do
-#--------------
-
-    before { @result = Calling::Simple.new.private_m }
-
-    it 'goes thru (as the method is still public)' do
-      @result.should == 'SUCCESS'
-    end
-
-    it('records the call to the p+p method in PrivatePlease.inside_called_candidates') do
-      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
-      storage.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
-    end
-
-    it('records multiple calls only once') do
-      2.times{ Calling::Simple.new.private_m }
-      storage.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
-      storage.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
-    end
-  end
-
-end

data/spec/03_configuration_spec.rb

@@ -1,52 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'configuring PrivatePlease' do
-  module Config
-    class Simple
-      def public_m ;  private_m()   end
-      def private_m; 'SUCCESS'      end
-      private_please  :private_m
-    end
-  end
-
-  def do_the_calls
-    Config::Simple.new.tap do |o|
-      o.public_m      # -> inside call
-      o.private_m     # -> outside call
-    end
-  end
-
-#--------------
-
-  it 'is disabled by default' do
-    PrivatePlease::Configuration.reset_before_new_test
-    PrivatePlease.should_not be_active
-  end
-  let(:storage) { PrivatePlease.storage }
-
-  context 'when disabled' do
-
-    before { PrivatePlease.activate(false) }
-    before { do_the_calls }
-
-    it('is not active') { PrivatePlease.should_not be_active }
-
-    it 'does NOT record the calls to candidates' do
-      storage.inside_called_candidates[ 'Config::Simple'].to_a.should == []
-      storage.outside_called_candidates['Config::Simple'].to_a.should == []
-    end
-  end
-
-  context 'when enabled' do
-
-    before { PrivatePlease.activate(true) }
-    before { do_the_calls }
-
-    it('is active') { PrivatePlease.should be_active }
-
-    it 'DOES record the calls to candidates' do
-      storage.inside_called_candidates[ 'Config::Simple'].to_a.should == [:private_m]
-      storage.outside_called_candidates['Config::Simple'].to_a.should == [:private_m]
-    end
-  end
-end

data/spec/04_at_exit_report_printing_spec.rb

@@ -1,47 +0,0 @@
-require 'spec_helper'
-
-describe PrivatePlease, 'reporting the calls on candidates' do
-
-  module Reporting
-    class Simple
-      def public_m    ;  private_m1a()    end
-      def private_m1a ;    private_m1b    end
-      def private_m1b ;      private_m1c  end
-
-      def private_m   ;  private_m1c      end
-      def private_m1c ;  'SUCCESS'        end
-
-      def ignored  ;  'never called'  end
-      private_please  :private_m1a, :private_m1b, :private_m1c, :private_m, :ignored
-    end
-  end
-
-  before() { PrivatePlease.activate(true) }
-  before do
-    Reporting::Simple.new.public_m
-    Reporting::Simple.new.private_m
-    Reporting::Simple.new.private_m1c
-  end
-
-  describe 'the activity report' do
-    let(:the_report) { PrivatePlease.report }
-
-    specify '#good_candidates is the list of methods that CAN be made private' do
-      the_report.good_candidates['Reporting::Simple'].
-          should =~ [:private_m1a, :private_m1b]
-    end
-
-    specify '#bad_candidates is the list of methods that CANNOT be made private' do
-      the_report.bad_candidates['Reporting::Simple'].
-          should =~ [:private_m1c, :private_m]
-    end
-
-    xspecify '#never_called_candidates is the list of methods that were never called' do
-      the_report.never_called_candidates['Reporting::Simple'].
-          should == [:ignored]
-    end
-  end
-
-  specify 'at_exit prints the report in the STDOUT'
-
-end