private_please 0.0.5 → 0.1.0

data/lib/private_please/tracking/method_details.rb

@@ -0,0 +1,27 @@
+require 'private_please/utils/ruby_utils'
+require 'private_please/utils/source_file_utils'
+
+module PrivatePlease
+  module Tracking
+    class MethodDetails < Struct.new(:klass, :separator, :method, :source_path, :lineno)
+      METHOD_AS_KEY_PATTERN = /(?<klass>.*)
+                               (?<separator>[#.])
+                               (?<method>.*)
+                              /x
+
+      def self.from_class_plus_method(class_plus_method)
+        md = class_plus_method.match(METHOD_AS_KEY_PATTERN)
+        klass     = Object.const_get(md[:klass])
+        separator = md[:separator]
+        method    = md[:method].to_sym
+        source_path, lineno = Utils::SourceFileUtils.source_path_and_lineno(klass, separator, method)
+
+        new(klass, separator, method, source_path, lineno)
+      end
+
+      def separator_plus_method
+        "#{separator}#{method}"
+      end
+    end
+  end
+end

data/lib/private_please/tracking/result.rb

@@ -0,0 +1,25 @@
+require 'private_please/tracking/method_details'
+
+module PrivatePlease
+  module Tracking
+    class Result
+      def initialize(encountered_method_calls)
+        @private_calls = encountered_method_calls.private_calls
+        @public_calls = encountered_method_calls.public_calls
+      end
+
+      def public_methods_only_called_privately
+        @private_calls - @public_calls
+      end
+
+      def to_two_level_hash
+        two_level_hash = Hash.new { |h, k| h[k] = {} }
+        public_methods_only_called_privately.each do |class_plus_method|
+          md = MethodDetails.from_class_plus_method(class_plus_method)
+          two_level_hash[md.klass][md.separator_plus_method] = [md.source_path, md.lineno]
+        end
+        two_level_hash.delete_if { |_k, v| v.empty? }
+      end
+    end
+  end
+end

data/lib/private_please/tracking/trace_point_details.rb

@@ -0,0 +1,41 @@
+module PrivatePlease
+  module Tracking
+    class TracePointDetails < Struct.new(:event, :object_id, :path, :lineno, :defined_class, :method_id, :_self)
+      def self.from(tp)
+        new(tp.event, tp.self.object_id, tp.path, tp.lineno, tp.defined_class, tp.method_id, tp.self)
+      end
+
+      def same_object?(other)
+        object_id == other.object_id
+      end
+
+      def code
+        @_code ||= File.readlines(path)[lineno - 1].chomp
+      end
+
+      # Combine the class and method name with the proper separator
+      # Examples:
+      #  Array#new
+      #  Array.size
+      def method_full_name
+        if module_method?
+          instance_method = defined_class.instance_methods.include?(method_id)
+          instance_method ?
+            "#{defined_class}##{method_id}" :
+            "#{defined_class}.#{method_id}"
+        else
+          instance_method = !(_self.class == Class)
+          instance_method ?
+              "#{defined_class}##{method_id}" :
+              "#{_self}.#{method_id}"
+        end
+      end
+
+      private
+
+      def module_method?
+        defined_class.instance_of?(Module)
+      end
+    end
+  end
+end

data/lib/private_please/tracking/trace_point_processor.rb

@@ -0,0 +1,71 @@
+require 'private_please/config'
+require 'private_please/storage/called_methods_memory_store'
+require 'private_please/tracking/debug/trace_point_data_logger'
+require 'private_please/tracking/result'
+require 'private_please/tracking/trace_point_details'
+require 'private_please/utils/two_level_stack'
+
+module PrivatePlease
+  module Tracking
+    class TracePointProcessor
+      def initialize(config)
+        @config                   = config
+
+        @latest_tracepoints       = Utils::TwoLevelStack.new
+        @encountered_method_calls = Storage::CalledMethodsMemoryStore.new
+      end
+
+      def process(tp)
+        return if untracked_code?(tp.path)
+        remember_trace_point tp
+        store_method_call_details if tp.event == :call
+      end
+
+      def result
+        Result.new(@encountered_method_calls)
+      end
+
+      private
+
+      def remember_trace_point(tp)
+        @latest_tracepoints.push TracePointDetails.from(tp)
+        # Debug.log_to_trace_file tpd if Debug.enabled?
+      end
+
+      def untracked_code?(path)
+        path.start_with?(*untracked_source_dirs)
+      end
+
+      def untracked_source_dirs
+        @_untracked_source_dirs ||= begin
+          Utils::RubyUtils.gems_paths +
+          Array(Utils::RubyUtils.std_lib_home) +
+          @config.additional_excluded_dirs
+        end
+      end
+
+      def tp_curr; @latest_tracepoints.curr end
+      def tp_prev; @latest_tracepoints.prev end
+
+      def store_method_call_details
+        key = tp_curr.method_full_name
+        if private_call?
+          @encountered_method_calls.add_private_call(key) unless already_private?
+        else
+          @encountered_method_calls.add_public_call(key)
+        end
+      end
+
+      def private_call?
+        curr_event, prev_event = tp_curr.event, tp_prev.event
+        (curr_event == :call) &&
+          [:line, :return, :c_return].include?(prev_event) &&
+          tp_curr.same_object?(tp_prev)
+      end
+
+      def already_private?
+        tp_curr._self.private_methods.include?(tp_curr.method_id)
+      end
+    end
+  end
+end

data/lib/private_please/utils/ruby_utils.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+module PrivatePlease
+  module Utils
+    module RubyUtils
+      module_function
+
+      def gem_env
+        @_gem_env ||= begin
+          `gem env`
+        end
+      end
+
+      # Ex: "/Users/ara/.rbenv/versions/jruby-1.7.3/lib/ruby/1.9"
+      def std_lib_home
+        @_std_lib_home ||= begin
+          basedir = ruby_executable_path.gsub(/bin\/[j]?ruby/, 'lib/ruby')
+          # => "/Users/ara/.rbenv/versions/jruby-1.7.3/lib/ruby"
+          # jruby has 2+ directories of std. libs under the basedir : 1.8 and 1.9
+          $LOAD_PATH.detect do |path| # We choose the one that is also in the load path.
+            path =~ /#{basedir}\/[12][^\/]+$/ #
+          end #                    ^^^^^^^^^^       # => "/Users/ara/.rbenv/versions/jruby-1.7.3/lib/ruby/1.9"
+        end #                                                     ^^^ == the mode
+      end
+
+      # - GEM PATHS:
+      #   - /Users/alain/.rvm/gems/ruby-2.3.0
+      #   - /Users/alain/.rvm/gems/ruby-2.3.0@global
+
+      def gems_paths
+        @_gems_paths ||= YAML.load(gem_env)['RubyGems Environment'].detect do |hash|
+          hash['GEM PATHS']
+        end['GEM PATHS']
+      end
+
+      # Ex:  "/Users/ara/.rbenv/versions/jruby-1.7.3/bin/jruby"
+      def ruby_executable_path
+        @_ruby_executable_path ||= gem_env.match(/RUBY EXECUTABLE:\s*(.*)/)[1]
+      end
+
+      private_class_method :ruby_executable_path
+    end
+  end
+end

data/lib/private_please/utils/source_file_utils.rb

@@ -0,0 +1,20 @@
+module PrivatePlease
+  module Utils
+    module SourceFileUtils
+      module_function
+
+      def source_path_and_lineno(klass, separator, method)
+        is_instance_method = separator == '#'
+        if klass.instance_of?(Module)
+          is_instance_method ?
+              klass.instance_method(method).source_location :
+              klass.singleton_method(method).source_location
+        else
+          is_instance_method ?
+              klass.instance_method(method).source_location :
+              klass.method(method).source_location
+        end
+      end
+    end
+  end
+end

data/lib/private_please/utils/two_level_stack.rb

@@ -0,0 +1,13 @@
+module PrivatePlease
+  module Utils
+    class TwoLevelStack
+      def push(value)
+        @cell_2 = @cell_1
+        @cell_1 = value
+      end
+
+      def curr; @cell_1 end
+      def prev; @cell_2 end
+    end
+  end
+end

data/lib/private_please/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module PrivatePlease
-  VERSION = "0.0.5"
+  VERSION = '0.1.0'.freeze
 end

data/lib/private_please.rb

@@ -1,51 +1,44 @@
 require 'private_please/version'
-require 'private_please/ruby_backports'
-require 'private_please/candidate'
-require 'private_please/storage'
-require 'private_please/report'
-require 'private_please/reporter'
-
-at_exit do
-  PrivatePlease.at_exit
-end
+require 'private_please/methods_calls_tracker'
+require 'private_please/reporting/simple_text'
 
 module PrivatePlease
+  def self.instance
+    MethodsCallsTracker.instance
+  end
 
-  def self.install
-    Module.send :include, PrivatePlease::Tracking::Extension
-    PrivatePlease.pp_automatic_mode_enable
-    set_trace_func PrivatePlease::Tracking::LineChangeTracker::MY_TRACE_FUN
+  def self.reset
+    MethodsCallsTracker.reset
   end
 
-  def self.pp_automatic_mode_enabled? ; !!$pp_automatic_mode_enabled          end
-  def self.pp_automatic_mode_enable(value=true)
-    $pp_automatic_mode_enabled =  value
+  def self.report
+    Reporting::SimpleText.new(instance.result).text
   end
-  def self.pp_automatic_mode_disable  ;   $pp_automatic_mode_enabled = false  end
 
-  # TODO : replace class methods by PP instance + instance methods
-  def self.calls_store
-    @@_calls_store ||= Storage::CallsStore.new
+  def self.config
+    instance.config
   end
 
-  def self.candidates_store
-    @@_candidates_store ||= Storage::CandidatesStore.new
+  def self.track(reset: true, &block)
+    reset if reset
+    start_tracking
+    block.call
+    stop_tracking
   end
 
-  def self.reset
-    @@_candidates_store = @@_calls_store = nil
-    Tracking::LineChangeTracker.reset
-    set_trace_func nil
+  def self.start_tracking
+    instance.start_tracking
   end
 
-  def self.at_exit
-    report = PrivatePlease::Reporter::SimpleText.new(PrivatePlease.candidates_store, PrivatePlease.calls_store)
-    unless $private_please_tests_are_running
-      $stdout.puts report.text
-    end
+  def self.stop_tracking
+    instance.stop_tracking
   end
-end
 
-require 'private_please/tracking'
+  def self.exclude_dir(val)
+    config.exclude_dir val
+  end
 
-PrivatePlease.install
+  def self.privatazable_methods
+    instance.result.to_two_level_hash
+  end
+end

data/private_please.gemspec

@@ -1,28 +1,35 @@
-# -*- encoding: utf-8 -*-
-if RUBY_VERSION == '1.8.7'
-  # avoid double-require of version.rb - see http://bit.ly/18lspBV 
-  $:.unshift File.expand_path("../lib", __FILE__)
-  require "private_please/version"
-else
-  require File.expand_path('../lib/private_please/version', __FILE__)
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'private_please/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'private_please'
+  spec.version       = PrivatePlease::VERSION
+  spec.authors       = ['Alain Ravet']
+  spec.email         = ['alainravet@gmail.com']
 
-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"
+  spec.summary       = 'Identify dynamically methods that can be made private.'
+  spec.description   = 'Identify dynamically methods that can be made private.'
+  spec.homepage      = 'https://github.com/alainravet/private_please'
+  spec.license       = 'MIT'
 
-  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
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
 
-  gem.add_development_dependency 'rake' # to run 'All specs' in Rubymine
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rb-fsevent'
-end
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',  '~> 1.11'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'rspec',    '~> 3.0'
+  spec.add_development_dependency 'coderay'
+  spec.add_development_dependency 'sinatra'
+end

metadata

@@ -1,220 +1,141 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: private_please
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Alain Ravet
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2013-05-06 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rb-fsevent
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
-description: Test if methods can be made private
-email: 
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Identify dynamically methods that can be made private.
+email:
 - alainravet@gmail.com
-executables: 
-- pp_ruby
-- ruby_pp
+executables: []
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
-- Guardfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
-- TODO
-- bin/pp_ruby
-- bin/ruby_pp
-- doc/dev_notes.txt
-- doc/fixtures/complex.rb
-- doc/fixtures/empty_class.rb
-- doc/fixtures/fixture_helper.rb
-- doc/fixtures/sample.rb
+- bin/console
+- bin/setup
 - lib/private_please.rb
-- lib/private_please/candidate.rb
-- lib/private_please/report.rb
-- lib/private_please/report/table.rb
-- lib/private_please/reporter.rb
-- lib/private_please/reporter/base.rb
-- lib/private_please/reporter/data_compiler.rb
-- lib/private_please/reporter/helpers/options_helpers.rb
-- lib/private_please/reporter/helpers/text_table_helpers.rb
-- lib/private_please/reporter/simple_text.rb
-- lib/private_please/reporter/templates/simple.txt.erb
-- lib/private_please/ruby_backports.rb
-- lib/private_please/storage.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.rb
-- lib/private_please/tracking/extension.rb
-- lib/private_please/tracking/instrumentor.rb
-- lib/private_please/tracking/instruments_all_methods_below.rb
-- lib/private_please/tracking/instruments_automatically_all_methods_in_all_classes.rb
-- lib/private_please/tracking/line_change_tracker.rb
-- lib/private_please/tracking/load_utils.rb
-- lib/private_please/tracking/load_utils/gem_utils.rb
-- lib/private_please/tracking/load_utils/standard_lib_utils.rb
-- lib/private_please/tracking/utils.rb
+- lib/private_please/config.rb
+- lib/private_please/methods_calls_tracker.rb
+- lib/private_please/reporting/simple_text.rb
+- lib/private_please/reporting/templates/simple.txt.erb
+- lib/private_please/storage/called_methods_memory_store.rb
+- lib/private_please/tracking/debug/trace_point_data_logger.rb
+- lib/private_please/tracking/method_details.rb
+- lib/private_please/tracking/result.rb
+- lib/private_please/tracking/trace_point_details.rb
+- lib/private_please/tracking/trace_point_processor.rb
+- lib/private_please/utils/ruby_utils.rb
+- lib/private_please/utils/source_file_utils.rb
+- lib/private_please/utils/two_level_stack.rb
 - lib/private_please/version.rb
 - private_please.gemspec
-- sample.rb
-- spec/01_tracking_candidate_methods/excluding_gems_and_standard_libraries_spec.rb
-- spec/01_tracking_candidate_methods/explicitely_with_the_private_please_command_spec.rb
-- spec/01_tracking_candidate_methods/load_utils_spec.rb
-- spec/01_tracking_candidate_methods/systematically_in_auto_mode_spec.rb
-- spec/03_logging_calls_on_candidate_methods_spec.rb
-- spec/04_instrumented_program_activity_observation_result_spec.rb
-- spec/05_reporting/report_table_spec.rb
-- spec/06_at_exit_spec.rb
-- spec/_helpers/assert_helpers.rb
-- spec/fixtures/bug_22.rb
-- spec/fixtures/bug_30.rb
-- spec/fixtures/issue_25.rb
-- spec/fixtures/sample_class_for_report.rb
-- spec/fixtures/sample_class_with_all_calls_combinations.rb
-- spec/sandbox/Gemfile
-- spec/sandbox/Gemfile.lock
-- spec/sandbox/README.txt
-- spec/sandbox/normal.rb
-- spec/sandbox/normal_prepended_with_require.rb
-- spec/spec_helper.rb
-- spec/units/calls_store_spec.rb
-- spec/units/candidates_store_spec.rb
-- spec/units/reporter/data_compiler_spec.rb
-- spec/units/reporter/fixtures/simple_case_1.rb
-- spec/units/reporter/fixtures/simple_case_2.rb
-has_rdoc: true
 homepage: https://github.com/alainravet/private_please
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
-summary: Test if methods can be made private
-test_files: 
-- spec/01_tracking_candidate_methods/excluding_gems_and_standard_libraries_spec.rb
-- spec/01_tracking_candidate_methods/explicitely_with_the_private_please_command_spec.rb
-- spec/01_tracking_candidate_methods/load_utils_spec.rb
-- spec/01_tracking_candidate_methods/systematically_in_auto_mode_spec.rb
-- spec/03_logging_calls_on_candidate_methods_spec.rb
-- spec/04_instrumented_program_activity_observation_result_spec.rb
-- spec/05_reporting/report_table_spec.rb
-- spec/06_at_exit_spec.rb
-- spec/_helpers/assert_helpers.rb
-- spec/fixtures/bug_22.rb
-- spec/fixtures/bug_30.rb
-- spec/fixtures/issue_25.rb
-- spec/fixtures/sample_class_for_report.rb
-- spec/fixtures/sample_class_with_all_calls_combinations.rb
-- spec/sandbox/Gemfile
-- spec/sandbox/Gemfile.lock
-- spec/sandbox/README.txt
-- spec/sandbox/normal.rb
-- spec/sandbox/normal_prepended_with_require.rb
-- spec/spec_helper.rb
-- spec/units/calls_store_spec.rb
-- spec/units/candidates_store_spec.rb
-- spec/units/reporter/data_compiler_spec.rb
-- spec/units/reporter/fixtures/simple_case_1.rb
-- spec/units/reporter/fixtures/simple_case_2.rb
+specification_version: 4
+summary: Identify dynamically methods that can be made private.
+test_files: []