private_please 0.0.5 → 0.1.0

data/lib/private_please/report/table.rb

@@ -1,44 +0,0 @@
-module  PrivatePlease::Report
-
-  class Table
-
-    def initialize(col_1, col_2)
-      @col_1, @col_2 = col_1, col_2
-
-      prepare_data
-    end
-
-  #----------------------------------------------------------------------------
-  # QUERIES:
-  #----------------------------------------------------------------------------
-
-    attr_reader :col_1,
-                :col_2,
-                :rows,
-                :longest_value_length
-
-    def empty?
-      col_1.empty? && col_2.empty?
-    end
-
-  #----------------------------------------------------------------------------
-  # COMMANDS:
-  #----------------------------------------------------------------------------
-
-    # none (immutable)
-
-  #----------------------------------------------------------------------------
-  private
-
-    def prepare_data
-      @longest_value_length = [col_1 + col_2].flatten.map(&:length).max || 0
-
-      # pad whichever column is shorter
-      @col_1[@col_2.length-1] ||= nil  unless @col_2.empty?
-      @col_2[@col_1.length-1] ||= nil  unless @col_1.empty?
-
-      @rows = @col_1.zip(@col_2)
-    end
-
-  end
-end

data/lib/private_please/report.rb

@@ -1,6 +0,0 @@
-module PrivatePlease
-  module Report
-  end
-end
-
-require File.dirname(__FILE__) + '/report/table'

data/lib/private_please/reporter/base.rb

@@ -1,14 +0,0 @@
-require File.dirname(__FILE__) + '/data_compiler'
-module  PrivatePlease ; module Reporter
-
-  class Base
-
-    attr_reader :data
-
-    def initialize(candidates_store, calls_store)
-      @data = DataCompiler.new(candidates_store, calls_store).compile_data
-    end
-
-  end
-
-end end

data/lib/private_please/reporter/data_compiler.rb

@@ -1,82 +0,0 @@
-module  PrivatePlease ; module Reporter
-
-  class Data < Struct.new(
-                :candidates_classes_names,
-                :good_candidates,   :bad_candidates,   :never_called_candidates,
-                :good_candidates_c, :bad_candidates_c, :never_called_candidates_c,
-                :building_time
-              )
-  end
-
-  class DataCompiler
-
-    def initialize(candidates_store, calls_store)
-      @candidates_store = candidates_store
-      @calls_store      = calls_store
-    end
-
-    # TODO : optimize (with Hamster?)
-    def compile_data
-      start_time = Time.now
-
-      bad_candidates,
-      bad_candidates_c          = read_bad_candidates
-      candidates_classes_names  = read_candidates_classes_names
-
-      good_candidates,
-      good_candidates_c         = compute_good_candidates(bad_candidates, bad_candidates_c)
-
-      never_called_candidates,
-      never_called_candidates_c = compute_never_called_candidates(good_candidates,   bad_candidates,
-                                                                  good_candidates_c, bad_candidates_c)
-
-      remove_candidates_with_no_methods!(bad_candidates,   good_candidates,   never_called_candidates,
-                                         bad_candidates_c, good_candidates_c, never_called_candidates_c)
-      building_time = Time.now - start_time
-
-      Data.new(
-            candidates_classes_names,
-            good_candidates,   bad_candidates,   never_called_candidates,
-            good_candidates_c, bad_candidates_c, never_called_candidates_c,
-            building_time
-      )
-    end
-
-  private
-
-    def read_candidates_classes_names
-      @candidates_store.classes_names.sort
-    end
-
-    def read_bad_candidates
-      [ bad_candidates    = @calls_store.external_calls,
-        bad_candidates_c  = @calls_store.class_external_calls
-      ]
-    end
-
-    def compute_good_candidates(bad_candidates, bad_candidates_c)
-      [ good_candidates   = @calls_store.internal_calls      .clone.remove(bad_candidates),
-        good_candidates_c = @calls_store.class_internal_calls.clone.remove(bad_candidates_c)
-      ]
-    end
-
-    def compute_never_called_candidates(good_candidates, bad_candidates, good_candidates_c, bad_candidates_c)
-      never_called_candidates = @candidates_store.instance_methods.clone.
-          remove(good_candidates).
-          remove(bad_candidates)
-
-      never_called_candidates_c = @candidates_store.class_methods.clone.
-          remove(good_candidates_c).
-          remove(bad_candidates_c)
-      [never_called_candidates, never_called_candidates_c]
-    end
-
-    def remove_candidates_with_no_methods!(bad_candidates, good_candidates, never_called_candidates, bad_candidates_c, good_candidates_c, never_called_candidates_c)
-      [
-          bad_candidates, bad_candidates_c, good_candidates, good_candidates_c, never_called_candidates, never_called_candidates_c
-      ].each { |arr| arr.reject! { |k, v| v.empty? } }
-    end
-
-  end
-
-end end

data/lib/private_please/reporter/helpers/options_helpers.rb

@@ -1,37 +0,0 @@
-
-DEFAULT_REPORT_OPTIONS = {
-  :show_never_called_candidates_section?  => false,
-  :show_bad_candidates_section?           => false,
-  :show_empty_classes?                    => false
-}
-
-def options
-  Object.new.tap do |o|
-    def o.show_never_called_candidates_section?
-      (ENV['PP_OPTIONS'] =~ /--show-never-called/) || DEFAULT_REPORT_OPTIONS[:show_never_called_candidates_section?]
-    end
-
-    def o.show_bad_candidates_section?
-      (ENV['PP_OPTIONS'] =~ /--show-bad-candidates/) || DEFAULT_REPORT_OPTIONS[:show_bad_candidates_section?]
-    end
-
-    def o.show_empty_classes?
-      (ENV['PP_OPTIONS'] =~ /--show-empty-classes/) || DEFAULT_REPORT_OPTIONS[:show_empty_classes?]
-    end
-  end
-end
-
-def options_footer_parts
-  parts = []
-  DEFAULT_REPORT_OPTIONS.keys.each do |key|
-    display       = "--#{key}".gsub('_', '-')
-    current_value = options.send(key)
-    is_default    = DEFAULT_REPORT_OPTIONS[key] == current_value
-    parts << [display, (is_default ? '*' : ' '), current_value]
-  end
-  longest_value_length = parts.map(&:first).map(&:length).max || 0
-  parts.each do |p|
-    p[0] = p[0].ljust(longest_value_length)
-  end
-  parts
-end

data/lib/private_please/reporter/helpers/text_table_helpers.rb

@@ -1,9 +0,0 @@
-
-def table_for(col_1, col_2)
-  PrivatePlease::Report::Table.new(col_1, col_2)
-end
-
-def names_from(class_name, candidates, prefix)
-  candidates.get_methods_names(class_name).collect{|n|"#{prefix}#{n}"}
-end
-

data/lib/private_please/reporter/simple_text.rb

@@ -1,18 +0,0 @@
-require File.dirname(__FILE__) + '/base'
-require 'erb'
-require File.dirname(__FILE__) + '/helpers/options_helpers'
-require File.dirname(__FILE__) + '/helpers/text_table_helpers'
-module  PrivatePlease ; module Reporter
-
-  class SimpleText < Base
-
-    TEMPLATE_PATH     = File.expand_path(File.dirname(__FILE__) + '/templates/simple.txt.erb')
-
-    def text
-      erb = ERB.new(File.read(TEMPLATE_PATH), 0,  "%<>")
-      erb.result(binding)
-    end
-
-  end
-
-end end

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

@@ -1,80 +0,0 @@
-====================================================================================
-=                               PrivatePlease report :                             =
-====================================================================================
-% data.candidates_classes_names .sort.each do |class_name|
-%
-%   show_good_candidates_section    = true
-%   show_bad_candidates_section     = options.show_bad_candidates_section?
-%   show_never_candidates_section   = options.show_never_called_candidates_section?
-%
-%   if show_good_candidates_section
-%     good_candidates_table = table_for(
-%                             names_from(class_name, data.good_candidates  , prefix = "#"),
-%                             names_from(class_name, data.good_candidates_c, prefix = "."))
-%   end
-%   if show_bad_candidates_section
-%     bad_candidates_table = table_for(
-%                             names_from(class_name, data.bad_candidates  , prefix = "#"),
-%                             names_from(class_name, data.bad_candidates_c, prefix = "."))
-%   end
-%   if show_never_candidates_section
-%     never_called_candidates_table = table_for(
-%                             names_from(class_name, data.never_called_candidates  , prefix = "#"),
-%                             names_from(class_name, data.never_called_candidates_c, prefix = "."))
-%   end
-%
-% # Always hide empty tables :
-% ###########################
-%   show_good_candidates_section    &&= !good_candidates_table.empty?
-%   show_bad_candidates_section     &&= !bad_candidates_table.empty?
-%   show_never_candidates_section   &&= !never_called_candidates_table.empty?
-%
-% nothing_to_show = !(show_good_candidates_section || show_bad_candidates_section || show_never_candidates_section)
-% next if nothing_to_show && !options.show_empty_classes?
-%
-
-<%= class_name
-%>
-%
-% if show_good_candidates_section
-%   t = good_candidates_table
-
-    * Good candidates : can be made private :
-    ------------------------------------------
-%   cell_width = 3 + [38, t.longest_value_length].max
-%   t.rows.each do |inst_m, class_m|
-      <%= inst_m && inst_m.ljust(cell_width) %><%= class_m && class_m.ljust(cell_width) %>
-%   end
-% end
-%
-% if show_bad_candidates_section
-%   t = bad_candidates_table
-
-    * Bad candidates : must stay public/protected:
-    . . . . . . . . . . . . . . . . . . . . .
-%  cell_width = 3 + [38, t.longest_value_length].max
-%   t.rows.each do |inst_m, class_m|
-      <%= inst_m && inst_m.ljust(cell_width) %><%= class_m && class_m.ljust(cell_width) %>
-%   end
-% end
-%
-% if show_never_candidates_section
-%   t = never_called_candidates_table
-
-    * Methods that were never called :
-    . . . . . . . . . . . . . . . . . . . . .
-%  cell_width = 3 + [38, t.longest_value_length].max
-%   t.rows.each do |inst_m, class_m|
-      <%= inst_m && inst_m.ljust(cell_width) %><%= class_m && class_m.ljust(cell_width) %>
-%   end
-% end
-%
-% end
-
-====================================================================================
-
-    Report options :
-% options_footer_parts.each do |o|
-        <%= (value = o[2]) ? "V" : 'x' %> <%= is_default = o[1] %> <%= display = o[0] %>
-% end
-    (PP_OPTIONS = <%= ENV['PP_OPTIONS'] %>)

data/lib/private_please/reporter.rb

@@ -1,8 +0,0 @@
-module PrivatePlease
-  module Reporter
-
-  end
-end
-
-require File.dirname(__FILE__) + '/reporter/base'
-require File.dirname(__FILE__) + '/reporter/simple_text'

data/lib/private_please/ruby_backports.rb

@@ -1,22 +0,0 @@
-# Unify the Ruby APIs across versions
-#
-
-# src : https://github.com/marcandre/backports/blob/master/lib/backports/1.9.1/kernel/define_singleton_method.rb
-unless Kernel.method_defined? :define_singleton_method
-  module Kernel
-    def define_singleton_method(*args, &block)
-      class << self
-        self
-      end.send(:define_method, *args, &block)
-    end
-  end
-end
-
-# src: https://github.com/marcandre/backports/blob/master/lib/backports/1.9.2/kernel/singleton_class.rb
-unless Kernel.method_defined? :singleton_class
-  module Kernel
-    def singleton_class
-      class << self; self; end
-    end
-  end
-end

data/lib/private_please/storage/calls_store.rb

@@ -1,41 +0,0 @@
-# As the main program runs, the various method calls are logged here
-# (only for the methods marked with `private_please`)
-
-module PrivatePlease
-  module Storage
-
-    class CallsStore
-
-      def initialize
-        @internal_calls       = MethodsNamesBucket.new
-        @external_calls       = MethodsNamesBucket.new
-        @class_internal_calls = MethodsNamesBucket.new
-        @class_external_calls = MethodsNamesBucket.new
-      end
-
-    #--------------------------------------------------------------------------
-    # QUERIES:
-    #--------------------------------------------------------------------------
-
-      attr_reader :internal_calls,
-                  :external_calls,
-                  :class_internal_calls,
-                  :class_external_calls
-
-    #--------------------------------------------------------------------------
-    # COMMANDS:
-    #--------------------------------------------------------------------------
-
-      def store_outside_call(candidate)
-        bucket = candidate.instance_method? ? external_calls : class_external_calls
-        bucket.add_method_name(candidate.klass_name, candidate.method_name)
-      end
-
-      def store_inside_call(candidate)
-        bucket = candidate.instance_method? ? internal_calls : class_internal_calls
-        bucket.add_method_name(candidate.klass_name, candidate.method_name)
-      end
-    end
-
-  end
-end

data/lib/private_please/storage/candidates_store.rb

@@ -1,52 +0,0 @@
-# Holds in 2 "buckets" the details (class name + methods names) of the
-# methods that are candidate for privatization.
-# Those methods were marked via `private_please` in the code.
-# Instance methods and class methods are kept separate.
-
-module PrivatePlease
-  module Storage
-
-    class CandidatesStore
-
-      def initialize
-        @instance_methods = MethodsNamesBucket.new
-        @class_methods    = MethodsNamesBucket.new
-      end
-
-    #--------------------------------------------------------------------------
-    # QUERIES:
-    #--------------------------------------------------------------------------
-
-      attr_reader :instance_methods,
-                  :class_methods
-
-      def empty?
-        instance_methods.empty? && class_methods.empty?
-      end
-
-      def stored?(candidate)
-        bucket_for(candidate).get_methods_names(candidate.klass_name).include?(candidate.method_name)
-      end
-
-      def classes_names
-        (instance_methods.classes_names + class_methods   .classes_names).uniq
-      end
-
-    #--------------------------------------------------------------------------
-    # COMMANDS:
-    #--------------------------------------------------------------------------
-
-      def store(candidate)
-        bucket_for(candidate).add_method_name(candidate.klass_name, candidate.method_name)
-      end
-
-    #--------------------------------------------------------------------------
-    private
-
-      def bucket_for(candidate)
-        candidate.instance_method? ? @instance_methods : @class_methods
-      end
-
-    end
-  end
-end

data/lib/private_please/storage/methods_names.rb

@@ -1,10 +0,0 @@
-require 'set'
-module PrivatePlease
-  module Storage
-
-    class MethodsNames < Set
-      # based on Set => no risk of duplicates when using #add
-    end
-
-  end
-end