private_please 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in private_please.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alain Ravet
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# PrivatePlease
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'private_please'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install private_please
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/private_please/candidates.rb

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

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

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

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

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

@@ -0,0 +1,47 @@
+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/lib/private_please/version.rb

@@ -0,0 +1,3 @@
+module PrivatePlease
+  VERSION = "0.0.1"
+end

data/lib/private_please.rb

@@ -0,0 +1,92 @@
+require 'private_please/version'
+require 'private_please/configuration'
+require 'private_please/candidates'
+require 'private_please/recorder'
+require 'private_please/report'
+require 'private_please/line_change_tracker'
+
+module PrivatePlease
+
+  def private_please(*args)
+    klass = self
+    args.reject!{|m| !klass.instance_methods.include?(m.to_s)}
+    candidates[klass.to_s] += args
+    args.each do |m|
+      mark_method(m)
+    end
+  end
+
+#--------------
+# config
+#--------------
+  def activate(flag)
+    config.activate(flag)
+  end
+
+  def active?
+    !!config.active
+  end
+
+#--------------
+# partners :
+#--------------
+  def recorder ; Recorder     .instance end
+  def storage  ; Candidates   .instance end
+  def config   ; Configuration.instance end
+
+  def self.reset_before_new_test
+    Recorder      .reset_before_new_test
+    Candidates    .reset_before_new_test
+    Configuration .reset_before_new_test
+  end
+
+
+#--------------
+# candidates
+#--------------
+
+
+  def candidates                ; storage.candidates                 end
+  def inside_called_candidates  ; storage.inside_called_candidates   end
+  def outside_called_candidates ; storage.outside_called_candidates  end
+
+#--------------
+# report
+#--------------
+  def report
+    Report.build(storage)
+  end
+
+private
+
+  def mark_method(name)
+    self_class = self.class
+    PrivatePlease.recorder.record_candidate(self_class, name)
+    orig_method = instance_method(name)
+    define_method(name) do |*args, &blk|
+      set_trace_func(nil) #don't track activity while here
+
+      self_class = self.class
+      if PrivatePlease.active?
+        call_initiator = LineChangeTracker.prev_self
+        is_outside_call = call_initiator.class != self_class
+        is_outside_call ?
+          PrivatePlease.recorder.record_outside_call(self_class, name) :
+          PrivatePlease.recorder.record_inside_call( self_class, name)
+      end
+
+      # make the call :
+      set_trace_func(LineChangeTracker::MY_TRACE_FUN)
+      orig_method.bind(self).call(*args, &blk)
+    end
+  end
+
+
+end
+
+Module.send :include, PrivatePlease
+
+at_exit {
+  puts '-'*888
+  puts PrivatePlease.report.to_s
+}

data/private_please.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/private_please/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alain Ravet"]
+  gem.email         = ["alainravet@gmail.com"]
+  gem.description   = %q{Test if methods can be made private}
+  gem.summary       = %q{Test if methods can be made private}
+  gem.homepage      = "https://github.com/alainravet/private_please"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "private_please"
+  gem.require_paths = ["lib"]
+  gem.version       = PrivatePlease::VERSION
+
+  gem.add_development_dependency 'rake' # to run 'All specs' in Rubymine
+  gem.add_development_dependency 'todo_next'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+end

data/spec/01_marking_methods_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe PrivatePlease, 'marking methods' do
+
+  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
+    PrivatePlease.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
+    PrivatePlease.candidates['Marking::Simple2'].should == [:foo]
+  end
+
+end

data/spec/02_calling_methods_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe PrivatePlease, 'calling marked methods' do
+  before() do
+    PrivatePlease.activate(true)
+  end
+
+  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
+      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
+      PrivatePlease.outside_called_candidates['Calling::Simple'].to_a.should == []
+    end
+
+    it('records multiple calls only once') do
+      2.times{ Calling::Simple.new.public_m }
+      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == [:private_m]
+      PrivatePlease.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
+      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
+      PrivatePlease.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 }
+      PrivatePlease.inside_called_candidates[ 'Calling::Simple'].to_a.should == []
+      PrivatePlease.outside_called_candidates['Calling::Simple'].to_a.should == [:private_m]
+    end
+  end
+
+end

data/spec/03_configuration_spec.rb

@@ -0,0 +1,51 @@
+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
+
+  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
+      PrivatePlease.inside_called_candidates[ 'Config::Simple'].to_a.should == []
+      PrivatePlease.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
+      PrivatePlease.inside_called_candidates[ 'Config::Simple'].to_a.should == [:private_m]
+      PrivatePlease.outside_called_candidates['Config::Simple'].to_a.should == [:private_m]
+    end
+  end
+end

data/spec/04_at_exit_report_printing_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:each) do
+    PrivatePlease.reset_before_new_test
+  end
+end
+
+require File.dirname(__FILE__) + '/../lib/private_please'

data/spec/todo_next_spec.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rspec'
+require 'todo_next'
+
+todo_next(<<TEXT)
+* marking 1 method
+  example :
+    def foo
+      ..
+    end
+    private_please :foo
+
+  * adds the method to $private_please_candidates
+
+Marking 2 methods in 1 call
+  example :
+    ..
+    private_please :foo, :bar
+
+  * adds the 2 method to $private_please_candidates
+
+Global usage
+  example :
+    ..
+    private_please
+      def foo .. end
+      def bar .. end
+
+  * adds the 2 method to $private_please_candidates
+
+An outside call to a candidate marked method
+  - goes through as is the method waspublic
+  - $private_please_called_candidates  << the candidate
+  - $private_please_INVALID_candidates << the candidate
+
+An inside call to a candidate marked method
+  - goes through
+  - $private_please_called_candidates << the candidate
+
+Configuration
+  - 'private_please' is inactive by default
+  'private_please' can be activate
+    - via ENV['private_please']=true
+    - PrivatePlease.activate(true)
+
+at_exit
+  - prints a report about the candidates in STDOUT
+
+TEXT
+
+# √ == passed   => same as a comment line
+# * == current  => leading char - '*' - is kept

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: private_please
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alain Ravet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rake
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: todo_next
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rspec
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: guard-rspec
+  requirement: *id004
+description: Test if methods can be made private
+email: 
+- alainravet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- 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/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
+- spec/spec_helper.rb
+- spec/todo_next_spec.rb
+homepage: https://github.com/alainravet/private_please
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+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/spec_helper.rb
+- spec/todo_next_spec.rb