deforest 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 696760761eb3f30b0c9005b4b415517b2425e818b5a314d23872821b3a596877
-  data.tar.gz: fc24e0c602020f5b8bafb8ec8bc409e7e08ae7a84832654ec4c2b6d8aaf21633
+  metadata.gz: f124724d629f69ad95476356da5f41d1d7c6e15f273d93db8b383474875a51f8
+  data.tar.gz: 18fee8cb02cfe65e5b16e146f02a189dec55f454528786a932aef7e6d7a472e2
 SHA512:
-  metadata.gz: 3037cd3c5f07cf97a16199ffb3c710f6190be9575db5f96037b8d406eeecadc8fa3d2f5e7edf7a83c2a8eb490697d836403157b0d6b5efd14b3370fc5f375f39
-  data.tar.gz: bff04b8410c8c02c9ddb60d44190d1fc28eac31083e9c19842b3a10197120f4f9f7e1dfc73faafcbb5fe682ad7ebf6806ee091c4c3fd9fd75c9db1fafc2d7ab4
+  metadata.gz: 1b8ca750779df577eb512a8b928d60678a01597686a806df8b93b710cab2d696767d30b81dad810edc6c7cd9d339919d4b077933355122482ff16e6daf7d9916
+  data.tar.gz: fb94f2c1dc011e29b6b566da7c5265f0ea806b876806caebe1b6c616bed408ccbcdec81b73dfbed8b922fad8778f74432810b29d081a6a83e39673047e5acb18

data/app/controllers/deforest/files_controller.rb

@@ -2,9 +2,6 @@ require_dependency "deforest/application_controller"
 
 module Deforest
   class FilesController < ApplicationController
-    before_action :check_if_admin_logged_in
-    before_action :should_render_source, only: [:index, :show]
-
     def dashboard
       @top_percentile_methods = {}
       @medium_percentile_methods = {}
@@ -21,25 +18,6 @@ module Deforest
       end
     end
 
-    def index
-      @dirs = []
-      @files = []
-      @path = params[:path] || "#{Rails.root}/app/models"
-      Dir.entries(@path)[2..-1].each do |m|
-        if Dir.exists?("#{@path}/#{m}")
-          @dirs << m
-        else
-          @files << m
-        end
-      end
-      @dirs.uniq!
-    end
-
-    def show
-      @full_path = params[:path]
-      # @full_path = "#{params[:path]}/#{params[:file_name]}.rb"
-    end
-
     def extension_data
       result = Hash.new { |h,k| h[k] = [] }
       Deforest.track_dirs.each do |dir|
@@ -55,20 +33,5 @@ module Deforest
       end
       send_data result.to_json, filename: "deforest.json", type: "application/json", disposition: "attachment"
     end
-
-    private
-
-    def check_if_admin_logged_in
-      if send(Deforest.current_admin_method_name).blank?
-        puts "Make sure to set config.current_admin_method_name to the correct method in config/initializers/deforest.rb"
-        raise ActionController::RoutingError.new('Not Found')
-      end
-    end
-
-    def should_render_source
-      if !Deforest.render_source_on_browser
-        redirect_to files_dashboard_path and return
-      end
-    end
   end
 end

data/app/views/deforest/files/_percentile_table.html.erb

@@ -1,4 +1,4 @@
-<h4><%= heading %></h4>
+<h3><%= heading %></h3>
 <table class="table table-striped">
   <thead>
     <tr>
@@ -15,13 +15,7 @@
           <%= color_and_count[:file_name] %>
         </td>
         <td>
-          <% if Deforest.render_source_on_browser %>
-            <a href=<%= file_path(path: color_and_count[:file_name], line_no: color_and_count[:line_no]) %>>
-              <%= method_name %>
-            </a>
-          <% else %>
-            <%= method_name %>
-          <% end %>
+          <%= method_name %>
         </td>
         <td>
           <%= color_and_count[:line_no] %>

data/app/views/deforest/files/dashboard.html.erb

@@ -1,29 +1,28 @@
-<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
-  <a class="navbar-brand" href="#">Deforest</a>
-  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
-    <span class="navbar-toggler-icon"></span>
-  </button>
+<%= link_to "Extension Data", files_extension_data_path, id: "extension-data-btn", aria: { current: "page" } %>
 
-  <div class="collapse navbar-collapse" id="navbarSupportedContent">
-    <ul class="navbar-nav mr-auto">
-      <li class="nav-item active">
-      <%= link_to "Extension Data", files_extension_data_path, class: "nav-link active", aria: { current: "page" } %>
-      </li>
-      <li class="nav-item dropdown">
-        <a class="nav-link dropdown-toggle" href="#" role="button" data-toggle="dropdown" aria-expanded="false">
-          Directory
-        </a>
-        <div class="dropdown-menu">
-          <% Deforest.track_dirs.each do |dir| %>
-            <a class="dropdown-item" href="<%= files_dashboard_path(dir: dir) %>"><%= dir %></a>
-          <% end %>
-        </div>
-      </li>
-    </ul>
-  </div>
-</nav>
+<%= form_tag files_dashboard_path, method: :get do %>
+  <%= label_tag "Show data for Directory" %>
+  <%= select_tag :dir, options_for_select(Deforest.track_dirs, params[:dir]) %>
+  <%= submit_tag "Submit" %>
+<% end %>
 
 
 <%= render partial: "percentile_table", locals: { heading: "Top #{100 - Deforest.most_used_percentile_threshold} percentile", method_stats: @top_percentile_methods } %>
 <%= render partial: "percentile_table", locals: { heading: "Bottom #{100 - Deforest.most_used_percentile_threshold} percentile", method_stats: @low_percentile_methods } %>
-<%= render partial: "percentile_table", locals: { heading: "Between #{Deforest.least_used_percentile_threshold} and #{Deforest.most_used_percentile_threshold} percentile", method_stats: @medium_percentile_methods } %>
+<%#= render partial: "percentile_table", locals: { heading: "Between #{Deforest.least_used_percentile_threshold} and #{Deforest.most_used_percentile_threshold} percentile", method_stats: @medium_percentile_methods } %>
+
+<style>
+  #extension-data-btn {
+    float: right;
+    padding: 10px;
+    background: blue;
+    color: white;
+    border-radius: 2px;
+    text-decoration: none;
+  }
+  table {
+    border-collapse: separate;
+    border-spacing: 10px;
+    margin-bottom: 50px;
+  }
+</style>

data/app/views/layouts/deforest/application.html.erb

@@ -2,8 +2,6 @@
 <html>
 <head>
   <title>Deforest</title>
-  <%= stylesheet_link_tag    "deforest/application", media: "all" %>
-  <%= javascript_include_tag "deforest/application" %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/lib/deforest/version.rb

@@ -1,3 +1,3 @@
 module Deforest
-  VERSION = "1.0.2"
+  VERSION = "1.1.1"
 end

data/lib/deforest.rb

@@ -4,23 +4,13 @@ require "active_support"
 require "active_record"
 
 module Deforest
-  mattr_accessor :write_logs_to_db_every, :current_admin_method_name, :most_used_percentile_threshold, :least_used_percentile_threshold, :track_dirs, :render_source_on_browser, :last_saved_log_file_at, :saving_log_file
+  mattr_accessor :write_logs_to_db_every, :current_admin_method_name, :most_used_percentile_threshold, :least_used_percentile_threshold, :track_dirs, :last_saved_log_file_at, :saving_log_file
 
   def self.get_app_classes(dir)
     Dir["#{Rails.root}#{dir}/**/*.rb"].each do |f|
       idx = f.index(dir)
       models_heirarchy = f[idx..-1].gsub(dir,"")
-      exec_str = ""
-      loop do
-        parent, *children = models_heirarchy.split("/")
-        if children.any?
-          exec_str += "#{parent.camelize}::"
-        else
-          exec_str += parent.chomp(".rb").camelize
-          break
-        end
-        models_heirarchy = children.join("/")
-      end
+      exec_str = models_heirarchy.split("/").map(&:camelize).join("::").chomp(".rb")
       begin
         model = exec_str.constantize
         yield model
@@ -29,6 +19,40 @@ module Deforest
       end
     end
   end
+
+  def self.inject_tracking_module(klass, dir, method_type)
+    track_methods = if method_type == 'instance'
+      klass.instance_methods(false)
+    elsif method_type == 'class'
+      klass.singleton_methods(false)
+    else
+      raise "Unknown method type: #{method_type}"
+    end
+    Module.new do
+      track_methods.each do |mname|
+        method_location = if method_type == 'instance'
+          klass.instance_method(mname).source_location
+        else
+          klass.singleton_method(mname).source_location
+        end
+        if method_location.first.ends_with?("#{klass.to_s.underscore}.rb")
+          define_method mname do |*args, &block|
+            file_name, line_no = method_location
+            if file_name.include?(dir)
+              Deforest.insert_into_logs(mname, file_name, line_no)
+            end
+            if Deforest.last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !Deforest.saving_log_file
+              Deforest.parse_and_save_log_file()
+              t = Time.zone.now
+              Deforest.last_saved_log_file_at = t
+              File.open("deforest_db_sync.#{Process.pid}.txt", "w") { |fl| fl.write(t.to_i) }
+            end
+            super(*args, &block)
+          end
+        end
+      end
+    end
+  end
   
   def self.initialize!
     if block_given?
@@ -38,58 +62,19 @@ module Deforest
     Deforest.track_dirs.each do |dir|
       self.get_app_classes(dir) do |klass|
         if klass.present?
-          klass.prepend(Module.new do
-            klass.instance_methods(false).each do |mname|
-              method_location = klass.instance_method(mname).source_location
-              if method_location.first.ends_with?("#{klass.to_s.underscore}.rb")
-                define_method mname do |*args, &block|
-                  file_name, line_no = method_location
-                  if file_name.include?(dir)
-                    Deforest.insert_into_logs(mname, file_name, line_no)
-                  end
-                  if Deforest.last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !Deforest.saving_log_file
-                    Deforest.parse_and_save_log_file()
-                    t = Time.zone.now
-                    Deforest.last_saved_log_file_at = t
-                    File.open("deforest_db_sync.txt", "w") { |fl| fl.write(t.to_i) }
-                  end
-                  super(*args, &block)
-                end
-              end
-            end
-          end)
-          
-          klass.singleton_class.prepend(Module.new do
-            klass.singleton_methods(false).each do |mname|
-              method_location = klass.singleton_method(mname).source_location
-              if method_location.first.ends_with?("#{klass.to_s.underscore}.rb")
-                define_method mname do |*args, &block|
-                  file_name, line_no = method_location
-                  if file_name.include?(dir)
-                    Deforest.insert_into_logs(mname, file_name, line_no)
-                  end
-                  if Deforest.last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !Deforest.saving_log_file
-                    Deforest.parse_and_save_log_file()
-                    t = Time.zone.now
-                    Deforest.last_saved_log_file_at = t
-                    File.open("deforest_db_sync.txt", "w") { |fl| fl.write(t.to_i) }
-                  end
-                  super(*args, &block)
-                end
-              end
-            end
-          end)
+          klass.prepend(Deforest.inject_tracking_module(klass, dir, 'instance'))
+          klass.singleton_class.prepend(Deforest.inject_tracking_module(klass, dir, 'class'))
         end
       end
     end
   end
 
   def self.initialize_db_sync_file
-    File.open("deforest.log", "w") unless File.exist?("deforest.log")
-    if File.exist?("deforest_db_sync.txt")
-      Deforest.last_saved_log_file_at = Time.at(File.open("deforest_db_sync.txt").read.to_i)
+    File.open("deforest.#{Process.pid}.log", "w") unless File.exist?("deforest.#{Process.pid}.log")
+    if File.exist?("deforest_db_sync.#{Process.pid}.txt")
+      Deforest.last_saved_log_file_at = Time.at(File.open("deforest_db_sync.#{Process.pid}.txt").read.to_i)
     else
-      File.open("deforest_db_sync.txt", "w") do |f|
+      File.open("deforest_db_sync.#{Process.pid}.txt", "w") do |f|
         current_time = Time.zone.now
         Deforest.last_saved_log_file_at = current_time
         f.write(current_time.to_i)
@@ -99,7 +84,7 @@ module Deforest
 
   def self.insert_into_logs(method_name, file_name, line_no)
     key = "#{file_name}|#{line_no}|#{method_name}\n"
-    log_file_name = Deforest.saving_log_file ? "deforest_tmp.log" : "deforest.log"
+    log_file_name = Deforest.saving_log_file ? "deforest_tmp.#{Process.pid}.log" : "deforest.#{Process.pid}.log"
     File.open(log_file_name, "a") do |f|
       f.write(key)
     end
@@ -109,7 +94,7 @@ module Deforest
     Deforest.saving_log_file = true
     sql_stmt = "INSERT INTO deforest_logs (file_name, line_no, method_name, count, created_at, updated_at) VALUES "
     hash = {}
-    File.foreach("deforest.log") do |line|
+    File.foreach("deforest.#{Process.pid}.log") do |line|
       line = line.chomp("\n")
       if hash.has_key?(line)
         hash[line] += 1
@@ -125,51 +110,36 @@ module Deforest
     sql_stmt += ";"
     if hash.present?
       ActiveRecord::Base.connection.execute(sql_stmt)
-      if File.exist?("deforest_tmp.log")
-        File.delete("deforest.log")
-        File.rename("deforest_tmp.log", "deforest.log")
+      if File.exist?("deforest_tmp.#{Process.pid}.log")
+        File.delete("deforest.#{Process.pid}.log")
+        File.rename("deforest_tmp.#{Process.pid}.log", "deforest.#{Process.pid}.log")
       else
-        File.delete("deforest.log")
+        File.delete("deforest.#{Process.pid}.log")
       end
     end
     Deforest.saving_log_file = false
   end
 
-  def self.prepare_file_for_render(file)
-    line_no_count = Log.where(file_name: file).group(:line_no).select("line_no,SUM(count) AS count_sum").inject({}) { |h, el| h.merge!(el.line_no => el.count_sum) }
-    stack = []
-    current_highlight_color = nil
-    highlight = Log.get_highlight_colors_for_file(file)
-    prepare_for_render(File.open(file).read) do |line, idx|
-      idx += 1
-      if line_no_count.has_key?(idx)
-        stack = [1]
-        current_highlight_color = highlight[idx]
-        last_log_for_current_line = Log.where(file_name: file).where(line_no: idx).order("created_at DESC").limit(1).first
-        "<span id='#{idx}' class='highlight-line #{current_highlight_color}'>" +
-          line +
-        "</span>&nbsp;&nbsp;" +
-        "<span class='method_call_count'>#{line_no_count[idx]}</span>" +
-        "<span class='last_accessed'>last called at: #{last_log_for_current_line.created_at.localtime.strftime('%m/%d/%Y')}</span>"
-      else
-        "<span>#{line}</span>"
-      end
+  def self.most_used_methods(dir, size=1)
+    query = Deforest::Log.group(:file_name, :line_no, :method_name)
+    if dir.present?
+      query = query.where("file_name like '%#{dir}/%'")
+    end
+    res = query.pluck("file_name, line_no, method_name, SUM(count)")
+              .sort_by { |fname, lno, method, cnt| cnt }
+              .reverse
+    if size == nil
+      return res
+    else
+      return res.take(size)
     end
   end
 
-  def self.prepare_for_render(source_code, add_line_number = true)
-    source_code.split("\n").map.with_index do |line, index|
-      first_letter_idx = line.chars.index { |ch| ch != " " }
-      if first_letter_idx && first_letter_idx >= 0 && first_letter_idx < line.size
-        leading_nbsp = (0...first_letter_idx).map { "&nbsp;" }.join("")
-        prepared_line = leading_nbsp.present? ? leading_nbsp + line.lstrip : line.strip
-        result_line = if block_given?
-          yield prepared_line + "\n", index
-        else
-          "<span>#{prepared_line}</span>"
-        end
-        "<span class='line-no'>#{index + 1}</span>" + result_line
-      end
-    end.join("<br/>")
+  def self.least_used_methods(dir, size=1)
+    if size == nil
+      self.most_used_methods(dir, nil).reverse
+    else
+      self.most_used_methods(dir, nil).reverse.take(size)
+    end
   end
 end

data/lib/generators/deforest/deforest_generator.rb

@@ -11,27 +11,26 @@ class DeforestGenerator < Rails::Generators::Base
   end
 
   def copy_initializer_file
-    if rails5_and_up? && Rails.autoloaders.zeitwerk_enabled?
+    if DeforestGenerator.rails5_and_up? && Rails.autoloaders.zeitwerk_enabled?
       copy_file "zeitwerk_enabled_initializer.rb", "config/initializers/deforest.rb"
     else
       copy_file "classic_enabled_initializer.rb", "config/initializers/deforest.rb"
     end
   end
 
-  def rails5_and_up?
+  def self.rails5_and_up?
     Rails::VERSION::MAJOR >= 5
   end
 
   def migration_version
-    if rails5_and_up?
+    if DeforestGenerator.rails5_and_up?
       "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
     end
   end
 
   def self.next_migration_number(dirname)
-    if ActiveRecord::Base.timestamped_migrations
-      current_time = Time.now.utc
-      current_time.strftime("%Y%m%d%H%M%S")
+    if (rails5_and_up? && ActiveRecord.timestamped_migrations) || ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
     else
       "%.3d" % (current_numeric_version(dirname) + 1)
     end

data/lib/generators/deforest/templates/classic_enabled_initializer.rb

@@ -1,8 +1,6 @@
 Deforest.initialize! do |config|
   config.write_logs_to_db_every = 1.minute
-  config.current_admin_method_name = :current_admin
   config.most_used_percentile_threshold = 80
   config.least_used_percentile_threshold = 20
   config.track_dirs = ["/app/models", "/app/controllers", "/app/helpers"]
-  config.render_source_on_browser = true
 end

data/lib/generators/deforest/templates/zeitwerk_enabled_initializer.rb

@@ -1,10 +1,8 @@
 Rails.application.config.to_prepare do
   Deforest.initialize! do |config|
     config.write_logs_to_db_every = 1.minute
-    config.current_admin_method_name = :current_admin
     config.most_used_percentile_threshold = 80
     config.least_used_percentile_threshold = 20
     config.track_dirs = ["/app/models", "/app/controllers", "/app/helpers"]
-    config.render_source_on_browser = true
   end
 end

data/test/deforest_test.rb

@@ -2,31 +2,31 @@ require 'test_helper'
 
 class DeforestTest < ActiveSupport::TestCase
   setup do
-    File.open("deforest_db_sync.txt", "w") { |f| f.write(1.hour.ago.to_i.to_s) }
+    File.open("deforest_db_sync.#{Process.pid}.txt", "w") { |f| f.write(1.hour.ago.to_i.to_s) }
     Deforest.initialize_db_sync_file
     Deforest.class_variable_set('@@write_logs_to_db_every', 1.minute)
   end
 
   teardown do
-    File.delete("deforest_db_sync.txt") if File.exist?("deforest_db_sync.txt")
-    File.delete("deforest.log") if File.exist?("deforest.log")
+    File.delete("deforest_db_sync.#{Process.pid}.txt") if File.exist?("deforest_db_sync.#{Process.pid}.txt")
+    File.delete("deforest.#{Process.pid}.log") if File.exist?("deforest.#{Process.pid}.log")
   end
 
   test "initialize db_sync_file when db_sync_file does not exist" do
-    File.delete("deforest_db_sync.txt")
+    File.delete("deforest_db_sync.#{Process.pid}.txt")
     Deforest.initialize_db_sync_file
     assert Deforest.class_variable_get("@@last_saved_log_file_at") > 1.minute.ago
   end
 
   test "initialize db_sync_file when db_sync_file does exist" do
-    File.open("deforest_db_sync.txt", "w") { |f| f.write("1676127114") }
+    File.open("deforest_db_sync.#{Process.pid}.txt", "w") { |f| f.write("1676127114") }
     Deforest.initialize_db_sync_file
     assert Deforest.class_variable_get("@@last_saved_log_file_at") == Time.at(1676127114)
   end
 
   test "insert into logs" do
     Deforest.insert_into_logs("lock_user", "/Users/johndoe/workspace/app/models/doctor.rb", 2144)
-    File.foreach("deforest.log") do |line|
+    File.foreach("deforest.#{Process.pid}.log") do |line|
       line = line.chomp("\n")
       file_name, line_no, method_name  = line.split("|")
       assert file_name == "/Users/johndoe/workspace/app/models/doctor.rb", "file_name mismatched"

data/test/dummy/deforest_db_sync.txt

@@ -0,0 +1 @@
+1726132725