private_please 0.0.5 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfbf97349bffd46dd59b21ce1623036ea7166cf2
+  data.tar.gz: 8b4c879e00f34783fc9c858a47e168733f122043
+SHA512:
+  metadata.gz: 87e54637f8b8c0cf74130345f1fe3fe99250fb0491ccdd6b572887887a9ed43f480bf260c2b6fa4af8df709db86d727d74de66ae720ba7aaeffcaa4bb3e10f6f
+  data.tar.gz: df4179f71fb104bc4a7c7fd3714b443ec47e51c2c3d33dc1e9a49ec983eb90335c3efe77f3b5ce19b5c244ebf75a2a234e28164e3bb08981d9392a32965051e6

data/.ruby-version

@@ -1 +1 @@
-1.8.7
+2.3

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.3"
   - "2.0.0"
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
+  - "2.1.x"
+  - "2.2.x"
 
 # uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rspec
+script: bundle exec rspec

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.1.0
+    - require Ruby 2
+    - use a new algorithm (via TracePoint)
+
 v0.0.5
     - required gems/standard libraries are no longer tracked.
 

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in private_please.gemspec
 gemspec
+
+gem 'rubocop', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alain Ravet
+
+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

@@ -1,123 +1,83 @@
-[![Build Status](https://travis-ci.org/alainravet/private_please.png?branch=master)](https://travis-ci.org/alainravet/private_please) -
-[![Code Climate](https://codeclimate.com/github/alainravet/private_please.png)](https://codeclimate.com/github/alainravet/private_please)
-tested with Ruby (1.8.7, 1.9.3, and 2.0.0) and JRuby(1.8 and 1.9 mode) - see [.travis.yml](.travis.yml)
+-[![Build Status](https://travis-ci.org/alainravet/private_please.png?branch=master)](https://travis-ci.org/alainravet/private_please) -
+-[![Code Climate](https://codeclimate.com/github/alainravet/private_please.png)](https://codeclimate.com/github/alainravet/private_please)
+-[![Coverage Status](https://coveralls.io/repos/alainravet/private_please/badge.png)](https://coveralls.io/r/alainravet/private_please)
+tested with Ruby 2.0.0..2.3.0 - see [.travis.yml](.travis.yml)
+# PrivatePlease
+
+This tool locates public or protected methods that can be made private.
+After you have instrumented the tests suite (see below), it watches the code as the tests are executed and identifies non-private methods that are only called privately.
+As the technique used is tracing, the execution is slowed down substantially (ex: 300%)
+
+## Usage
+
+Add this to the top of `spec_helper.rb`:
 
-## TL;DR :
-Given this code
 ```ruby
-# file : big_code
-class BigCode
-  def long_method # the only method that should be public
-    _part_1
-    _part_2
-  end
-
-  # PROBLEM : Those 2 methods were extracted and should be private
-  def _part_1
-    # ....
-  end
-  def _part_2
-    # ....
-  end
-end
-BigCode.new.long_method
-```
-When you run this command
+require 'private_please'
+PrivatePlease.start_tracking
+at_exit { puts PrivatePlease.report }
+...
+
 ```
-$ pp_ruby big_code
-  ^^^
+
+Optionally, you can `exclude_dir` the tests code, local gems, or any source dir that could touched when running the tests.
+```ruby
+SPECS_DIR  = File.dirname(__FILE__)
+require 'private_please'
+PrivatePlease.exclude_dir SPECS_DIR                  # don't analyze the tests
+PrivatePlease.exclude_dir '/dev/my_local_gem'        # specified via path: in Gemfile
+PrivatePlease.exclude_dir '/Applications/RubyMine.app/Contents/rb/testing'
+PrivatePlease.start_tracking
+at_exit { puts PrivatePlease.report.gsub(Rails.root.to_s, '') }
+...
+
 ```
-Then the methods usage is tracked while the program runs and this findings report is output:
+
+### Example of result :
+
 ```
+265 examples, 0 failures, 2 pending
+
 ====================================================================================
-=                               PrivatePlease report :                             =
+=                               Privatazable methods :                             =
 ====================================================================================
-BigCode
+/app/controllers/application_controller.rb
+    21  ApplicationController::MissingAvatars#must_remind_user_to_setup_avatar?
+    75  ApplicationController#allow?
+/app/controllers/home_controller.rb
+    15  HomeController#redirect_to_default_page_for_signed_in_users
+/app/controllers/mentor_profiles_controller.rb
+     4  MentorProfilesController#after_create_success
 
-    * Good candidates : can be made private :
-    ------------------------------------------
-      #_part_2
-      #_part_1
-
-====================================================================================
 ```
-
 ## Installation
-```
-$ gem install private_please
-```
 
-## Usage : the 2 modes (auto and manual)
+Add this line to your application's Gemfile:
 
-You can use *private_please* (*PP*) in either **auto-mode** or in **manual mode**.  
-Optionally you can customize the report contents with the env. variable ```PP_OPTIONS```.
-
-- in **auto-mode** (the example above in TL;DR), you simply run your program with ```pp_ruby``` (instead of ```ruby```) and all your code is inspected by *PP* while it runs.
-- in **manual mode** you must manually instrument (==add code to) each file you want *PP* to track and inspect.
+```ruby
+gem 'private_please'
+```
 
+And then execute:
 
-### Auto-mode
-PP will run the program and track all the classes and methods that are defined.
+    $ bundle
 
-How to :  
-- step 1 : use ```pp_ruby``` instead of ```ruby```.
+Or install it yourself as:
 
-Example : 
-```
-$ bundle exec pp_ruby -Ilib normal.rb 
-              ^^^
-```
-A report is automatically printed when the program exits
+    $ gem install private_please
 
+## Development
 
-### Manual mode
-You tell PP which classes and which methods to track.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-How to :  
-- step 1 : Instrument your Ruby code
-- step 2 : launch program as usual, with ```ruby```.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Contributing
 
-Example :
-#### step 1 : Instrument your code
-```ruby
-# load PP
-require 'private_please'                  <<<<<<<  ADD THIS (only 1x in the whole program)
-PrivatePlease.pp_automatic_mode_disable   <<<<<<<     "   "   "   "   "   "   "   "   "
-
-class BigCode
-
-  private_please                          << ~~ JUST ADD THIS in every file you want PP to inspect
-                                          <<    
-                                          <<  Meaning : "track the code below"
-
-  def long_method # the only method that should be public
-    _part_1
-    _part_2
-  end
-
-  def _part_1
-    # ....
-  end
-  def _part_2
-    # ....
-  end
-end
-
-BigCode.new.long_method
-```
+Bug reports and pull requests are welcome on GitHub at https://github.com/alainravet/private_please.
 
-####step 2 : run you code normally
-```
-$ ruby big_code.rb
-```
 
+## License
 
-## Contributing
-**Please respect and reuse the current code style and formatting**
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-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

@@ -1,2 +1,6 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'private_please'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/private_please/config.rb

@@ -0,0 +1,15 @@
+require 'private_please/utils/ruby_utils'
+
+module PrivatePlease
+  class Config
+    attr_reader :additional_excluded_dirs
+
+    def initialize
+      @additional_excluded_dirs = ['(eval)']
+    end
+
+    def exclude_dir(val)
+      additional_excluded_dirs << val
+    end
+  end
+end

data/lib/private_please/methods_calls_tracker.rb

@@ -0,0 +1,44 @@
+require 'private_please/tracking/trace_point_processor'
+
+module PrivatePlease
+  class MethodsCallsTracker
+    def self.instance
+      @instance ||= new(Config.new)
+    end
+
+    def self.reset
+      @instance = nil
+    end
+
+    # -----
+    attr_reader :config
+
+    def initialize(config)
+      @config                 = config
+      @trace_point_processor  = Tracking::TracePointProcessor.new(config)
+    end
+    private_class_method :new
+
+    def start_tracking
+      tracer.enable
+    end
+
+    def stop_tracking
+      tracer.disable
+    end
+
+    def result
+      @trace_point_processor.result
+    end
+
+    private
+
+    def tracer
+      @_tracer ||= begin
+        TracePoint.new do |tp|
+          @trace_point_processor.process(tp)
+        end
+      end
+    end
+  end
+end

data/lib/private_please/reporting/simple_text.rb

@@ -0,0 +1,43 @@
+module PrivatePlease
+  module Reporting
+    class SimpleText
+      def initialize(result)
+        @result = result
+      end
+
+      def text
+        compiled_data = compile_data  # passed to ERB via 'binding'
+        erb = ERB.new(File.read(template), 0,  '%<>')
+        erb.result(binding)
+      end
+
+      #-----------------------------------------------------------------------------
+      private
+
+      def template
+        templates_home = File.expand_path(File.dirname(__FILE__) + '/templates')
+        "#{templates_home}/simple.txt.erb"
+      end
+
+      # Output example:
+      # [
+      #   ["/tmp/project/foo/simple_text_foo.rb",
+      #     [[18, "SimpleTextFoo#public_i_2"],
+      #      [11, "SimpleTextFoo.public_c_2"]
+      #     ]
+      #   ]
+      #   ...
+      # ]
+      def compile_data
+        res = Hash.new { |h, k| h[k] = [] }
+        @result.to_two_level_hash.each do |klass, methods_and_locations|
+          methods_and_locations.each_pair do |meth, locations|
+            source, lineno = locations
+            res[source] << [lineno, "#{klass}#{meth}"]
+          end
+        end
+        res.sort    # by source file path
+      end
+    end
+  end
+end

data/lib/private_please/reporting/templates/simple.txt.erb

@@ -0,0 +1,11 @@
+====================================================================================
+=                               Privatazable methods :                             =
+====================================================================================
+% compiled_data.each do |source_file_and_linenos_and_methods|
+%   source_file, linenos_and_methods = source_file_and_linenos_and_methods
+<%= source_file
+%>
+%   linenos_and_methods.sort_by(&:first).each do |lineno, meth|
+  <%= "%4d  %s" % [lineno, meth] %>
+%   end
+% end

data/lib/private_please/storage/called_methods_memory_store.rb

@@ -0,0 +1,20 @@
+module PrivatePlease
+  module Storage
+    class CalledMethodsMemoryStore
+      attr_reader :public_calls, :private_calls
+
+      def initialize
+        @public_calls  = Set.new
+        @private_calls = Set.new
+      end
+
+      def add_public_call(value)
+        @public_calls .add value
+      end
+
+      def add_private_call(value)
+        @private_calls.add value
+      end
+    end
+  end
+end

data/lib/private_please/tracking/debug/trace_point_data_logger.rb

@@ -0,0 +1,81 @@
+# rubocop:disable all
+module PrivatePlease
+  module Debug
+    def self.log_to_trace_file(tpd)
+      TRACES_LINES.puts TracePointDataLogger.format(tpd)
+    end
+
+    def self.enabled?
+      defined?(TRACES_LINES)
+    end
+
+    module TracePointDataLogger
+      MARKERS = {
+        call: '-->',
+        line: "\n l "
+      }.freeze
+
+      def self.format(cur_tpd)
+        class_and_method = cur_tpd.method_full_name
+        if @prev_cur_tpd.nil?
+          same_object_id = same_lineno = false
+        else
+          same_object_id = @prev_cur_tpd.object_id == cur_tpd.object_id
+          same_lineno = @prev_cur_tpd.lineno == cur_tpd.lineno
+          same_code = @prev_cur_tpd.code == cur_tpd.code
+          same_class_and_method = @prev_class_and_method == class_and_method
+          same_self = @prev_self == cur_tpd._self
+          same_defined_class = @prev_defined_class == cur_tpd.defined_class
+        end
+
+        @prev_cur_tpd = cur_tpd
+        @prev_class_and_method = class_and_method
+        @prev_self = cur_tpd._self
+        @prev_defined_class = cur_tpd.defined_class
+
+        data = {
+          marker: MARKERS[cur_tpd.event],
+          lineno: same_lineno ? '==' : cur_tpd.lineno,
+          event: cur_tpd.event,
+          object_id: same_object_id ? '==' : cur_tpd.object_id,
+          code: same_code ? '"' : cur_tpd.code,
+          class_and_method: same_class_and_method ? '""' : class_and_method,
+          _self: same_self ? '=' : cur_tpd._self,
+          defined_class: same_defined_class ? '=' : cur_tpd.defined_class
+        }
+        text_line(data)
+      end
+
+      def self.header
+        text_line(
+          marker: '',
+          lineno: 'LINE',
+          event: 'EVENT',
+          object_id: 'OBJECT_ID',
+          code: 'CODE',
+          class_and_method: 'method_as_key',
+          _self: '_self',
+          defined_class: 'defined_class'
+        )
+      end
+
+      def self.text_line(data)
+        zelf = begin
+                 data[:_self].to_s
+               rescue
+                 'RESCUED:' + data[:_self].inspect
+               end
+        '%3s %4s :%10s | %14s | %-80s | %-60s > %s' % [
+          data[:marker],
+          data[:lineno],
+          data[:event],
+          data[:object_id],
+          data[:code],
+          data[:class_and_method],
+          [zelf, data[:defined_class]].join('/')
+        ]
+      end
+    end
+  end
+end
+# rubocop:enable all