private_please 0.0.5 → 0.1.0

data/Guardfile

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

@@ -1,22 +0,0 @@
-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/TODO

@@ -1,20 +0,0 @@
-
-install only in classes (? and modules)
-  def self.install
-    Object.send :include, PrivatePlease::Tracking::Extension
-    ^^^^^^
-    TOO WIDE
-  end
-
-
-DSL
-    - observe class methods too
-
-Report :
-    - option : show file and line number of good candidate definition
-    - option : show code snippet around the good candidate
-	- display list of methods that were never called
-	- display candidates that are already private
-
-Doc
-	- write README

data/bin/pp_ruby

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-
-# ----------------------------------------------------------------------------------- #
-#  Effects : inject PrivatePlease tracking in the command                             #
-# ----------------------------------------------------------------------------------- #
-#    $ pp_ruby             normal.rb                                                  #
-#    $ bundle exec pp_ruby normal.rb                                                  #
-#  become                                                                             #
-#    $ ruby             -rubygems  -e "require 'private_please' ; load 'normal.rb'"   #
-#    $ bundle exec ruby            -e "require 'private_please' ; load 'normal.rb'"   #
-# ----------------------------------------------------------------------------------- #
-
-
-########################
-# Extract command parts :
-########################
-
-switches, filename, arguments = [], nil, []
-loop do
-  case ARGV[0]
-    when '-r'   then switches << ARGV.shift << ARGV.shift
-    when '-e'   then switches << ARGV.shift << ARGV.shift.inspect
-    when /^-\S/ then switches << ARGV.shift
-    else        break
-  end
-end
-filename  = ARGV.shift
-arguments = ARGV
-
-
-######################
-# Assemble new command :
-######################
-
-# ? called with `bundle exec ruby .....`
-in_bundler_mode = !!defined?(Bundler)
-
-program = in_bundler_mode ?
-    'bundle exec ruby' :
-    'ruby'
-
-command = if filename
-  rubygems_or_not = in_bundler_mode ? nil : " -rubygems"
-  [ program,
-    switches,
-    %|#{rubygems_or_not} -e "require 'private_please' ; load '#{filename}'"| ,
-    arguments
-  ]
-else
-  [ program,
-    switches,
-    arguments
-  ]
-end.flatten.compact.join(' ')
-
-
-#############################
-# Execute transformed command :
-#############################
-
-puts "Executing: #{command}"
-puts `#{command}`

data/bin/ruby_pp

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-
-# ----------------------------------------------------------------------------------- #
-#  Effects : inject PrivatePlease tracking in the command                             #
-# ----------------------------------------------------------------------------------- #
-#    $ pp_ruby             normal.rb                                                  #
-#    $ bundle exec pp_ruby normal.rb                                                  #
-#  become                                                                             #
-#    $ ruby             -rubygems  -e "require 'private_please' ; load 'normal.rb'"   #
-#    $ bundle exec ruby            -e "require 'private_please' ; load 'normal.rb'"   #
-# ----------------------------------------------------------------------------------- #
-
-
-########################
-# Extract command parts :
-########################
-
-switches, filename, arguments = [], nil, []
-loop do
-  case ARGV[0]
-    when '-r'   then switches << ARGV.shift << ARGV.shift
-    when '-e'   then switches << ARGV.shift << ARGV.shift.inspect
-    when /^-\S/ then switches << ARGV.shift
-    else        break
-  end
-end
-filename  = ARGV.shift
-arguments = ARGV
-
-
-######################
-# Assemble new command :
-######################
-
-# ? called with `bundle exec ruby .....`
-in_bundler_mode = !!defined?(Bundler)
-
-program = in_bundler_mode ?
-    'bundle exec ruby' :
-    'ruby'
-
-command = if filename
-  rubygems_or_not = in_bundler_mode ? nil : " -rubygems"
-  [ program,
-    switches,
-    %|#{rubygems_or_not} -e "require 'private_please' ; load '#{filename}'"| ,
-    arguments
-  ]
-else
-  [ program,
-    switches,
-    arguments
-  ]
-end.flatten.compact.join(' ')
-
-
-#############################
-# Execute transformed command :
-#############################
-
-puts "Executing: #{command}"
-puts `#{command}`

data/doc/dev_notes.txt

@@ -1,32 +0,0 @@
-Q: Where is the TODO list :
-A: https://github.com/alainravet/private_please/issues?state=open
-
-How to run the tests :
-========================
-
-    $ cd <project root>
-    $ bundle exec rspec
-  or
-    $ bundle exec guard  # (see https://github.com/alainravet/private_please/issues/10)
-
-
-How to test on multiple versions of Ruby :
-============================================
-   # install rbenv + multiple versions of Ruby
-   # install the rbenv-each plugin
-   $ rbenv each -v bundle exec ruby -Ilib rspec
-
-
-How to run the latest PP code on a custom Ruby code sample :
-======================================================
- 
-    $ cd <project root>
-    $ bundle exec ruby -Ilib doc/fixtures/complex.rb
-    
-How to display more than the list of methods that can be made private ?
-======================================================
-
-    $ export PP_OPTIONS="--show-bad-candidates --show-never-called"
-    $ bundle exec ruby -Ilib doc/fixtures/complex.rb
-or
-    $ PP_OPTIONS="--show-bad-candidates --show-never-called"  bundle exec ruby -Ilib doc/fixtures/complex.rb

data/doc/fixtures/complex.rb

@@ -1,103 +0,0 @@
-load File.dirname(__FILE__) + '/fixture_helper.rb'
-
-module ComplexReport
-
-  class Class1
-    def initialize
-      super
-    end
-    def sole_entry_point
-      instance_m_1
-      self.class.class_m_1
-      self.class.c_make_internal_method_calls
-    end
-
-    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 self.c_make_internal_method_calls
-      class_m_1
-      new.instance_m_2
-    end
-  end
-
-end
-
-#-----------------------------------------------------------------------------------------------------------------------
-
-ComplexReport::Class1.new.sole_entry_point
-
-module ComplexReport
-                                                ###########################################
-  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
-      Simple.a_class_method_via_module_Extra
-    end
-  end
-
-#-----------------------------------------------------------------------------------------------------------------------
-  module Extra
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-    def im_never_called ; raise; 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
-
-    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
-
-ComplexReport::AnotherClass.new.call_the_candidate_from_inside_and_outside

data/doc/fixtures/empty_class.rb

@@ -1,7 +0,0 @@
-require File.dirname(__FILE__) + '/fixture_helper.rb'
-load File.dirname(__FILE__) + '/fixture_helper.rb'
-
-module ReportSample
-  class EmptyClass
-  end
-end

data/doc/fixtures/fixture_helper.rb

@@ -1,8 +0,0 @@
-begin
-  # for  $ bundle exec ruby -r private_please doc/fixtures/empty_class.r
-  PrivatePlease::Storage
-rescue NameError
-  # for  $ bundle exec ruby -Ilib doc/fixtures/empty_class.r
-  require 'private_please'
-end
-PrivatePlease.pp_automatic_mode_enable

data/doc/fixtures/sample.rb

@@ -1,57 +0,0 @@
-load File.dirname(__FILE__) + '/fixture_helper.rb'
-
-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
-
-    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
-#-----------------------------------------------------------------------------------------------------------------------
-
-ReportSample::Simple.new.make_internal_calls

data/lib/private_please/candidate.rb

@@ -1,49 +0,0 @@
-# Holds the details of 1 method that was marked via `private_please`.
-
-module PrivatePlease
-  class Candidate
-
-    def initialize(klass, method_name, is_instance_method)
-      @klass, @method_name, @is_instance_method = klass, method_name, is_instance_method
-      @klass_name = klass.to_s
-    end
-
-    def self.for_instance_method(klass, method_name)
-      new(klass, method_name, true)
-    end
-
-    def self.for_class_method(klass, method_name)
-      new(klass, method_name, false)
-    end
-
-  #----------------------------------------------------------------------------
-  # QUERIES:
-  #----------------------------------------------------------------------------
-
-    attr_reader :klass,
-                :klass_name,
-                :method_name,
-                :is_instance_method
-
-    alias_method :instance_method?, :is_instance_method
-
-    def already_instrumented?
-      instrumented_candidates_store.stored?(self)
-    end
-
-  #----------------------------------------------------------------------------
-  # SUGAR:
-  #----------------------------------------------------------------------------
-
-  def mark_as_instrumented
-    instrumented_candidates_store.store(self)
-  end
-
-  #----------------------------------------------------------------------------
-  private
-
-    def instrumented_candidates_store
-      PrivatePlease.candidates_store
-    end
-  end
-end