deforest 0.0.1 → 1.0.0

data/app/controllers/deforest/files_controller.rb

@@ -3,19 +3,20 @@ 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 = {}
       @low_percentile_methods = {}
 
-      Deforest::Log.percentile().each do |log, pcnt|
+      Deforest::Log.percentile(params[:dir] || "/app/models").each do |log, pcnt|
         if pcnt >= Deforest.most_used_percentile_threshold
-          @top_percentile_methods["#{log.model_name}##{log.method_name}"] = { color: "highlight-red", total_call_count: log.count_sum, file_name: log.file_name, line_no: log.line_no }
+          @top_percentile_methods[log.method_name] = { color: "highlight-red", total_call_count: log.count_sum, file_name: log.file_name, line_no: log.line_no }
         elsif pcnt <= Deforest.least_used_percentile_threshold
-          @low_percentile_methods["#{log.model_name}##{log.method_name}"] = { color: "highlight-green", total_call_count: log.count_sum, file_name: log.file_name, line_no: log.line_no }
+          @low_percentile_methods[log.method_name] = { color: "highlight-green", total_call_count: log.count_sum, file_name: log.file_name, line_no: log.line_no }
         else
-          @medium_percentile_methods["#{log.model_name}##{log.method_name}"] = { color: "highlight-yellow", total_call_count: log.count_sum, file_name: log.file_name, line_no: log.line_no }
+          @medium_percentile_methods[log.method_name] = { color: "highlight-yellow", total_call_count: log.count_sum, file_name: log.file_name, line_no: log.line_no }
         end
       end
     end
@@ -39,6 +40,22 @@ module Deforest
       # @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|
+        Log.percentile(dir).each do |log, pcnt|
+          if pcnt >= Deforest.most_used_percentile_threshold
+            result[log.file_name] << { line_no: log.line_no, use_type: "most_used", call_count: log.count_sum }
+          elsif pcnt <= Deforest.least_used_percentile_threshold
+            result[log.file_name] << { line_no: log.line_no, use_type: "least_used", call_count: log.count_sum }
+          else
+            result[log.file_name] << { line_no: log.line_no, use_type: "medium_used", call_count: log.count_sum }
+          end
+        end
+      end
+      send_data result.to_json, filename: "deforest.json", type: "application/json", disposition: "attachment"
+    end
+
     private
 
     def check_if_admin_logged_in
@@ -46,5 +63,11 @@ module Deforest
         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/models/deforest/log.rb

@@ -1,14 +1,16 @@
 module Deforest
   class Log < ActiveRecord::Base
     def model_name
-      idx = self.file_name.index(/\/app\/models\/(\w)*.rb/)
-      if idx.present?
-        self.file_name[idx, file_name.size].gsub("/app/models/", "").chomp(".rb").camelize
+      Deforest.track_dirs.map { |d| Regexp.escape(d) }.each do |d|
+        idx = self.file_name.index(/\#{d}\/(\w)*.rb/)
+        if idx.present?
+          return self.file_name[idx, file_name.size].gsub("#{d}/", "").chomp(".rb").camelize
+        end
       end
     end
 
-    def self.percentile()
-      grouped_logs = Deforest::Log.where("file_name like '%/app/models/%'").group(:file_name, :line_no, :method_name).select("file_name, line_no, method_name, SUM(count) AS count_sum")
+    def self.percentile(dir)
+      grouped_logs = Deforest::Log.where("file_name like '%#{dir}/%'").group(:file_name, :line_no, :method_name).select("file_name, line_no, method_name, SUM(count) AS count_sum")
       groups_of_count_sum = grouped_logs.group_by { |r| r.count_sum }
       n = groups_of_count_sum.size
       result = Hash.new { |h,k| h[k] = nil }
@@ -22,7 +24,8 @@ module Deforest
 
     def self.get_highlight_colors_for_file(file_name)
       result = {}
-      self.percentile.select { |log, _| log.file_name == file_name }.each do |log, pcnt|
+      dir = Deforest.track_dirs.find { |d| file_name.include?(d) }
+      self.percentile(dir).select { |log, _| log.file_name == file_name }.each do |log, pcnt|
         result[log.line_no] = if pcnt <= Deforest.least_used_percentile_threshold
           "highlight-green"
         elsif pcnt >= Deforest.most_used_percentile_threshold

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

@@ -0,0 +1,35 @@
+<h4><%= heading %></h4>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>File Name</th>
+      <th>Method Name</th>
+      <th>Line Number</th>
+      <th>Count</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% method_stats.each do |method_name, color_and_count| %>
+      <tr>
+        <td>
+          <%= 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 %>
+        </td>
+        <td>
+          <%= color_and_count[:line_no] %>
+        </td>
+        <td>
+          <%= color_and_count[:total_call_count] %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -1,28 +1,29 @@
-<h2>Top <%= 100 - Deforest.most_used_percentile_threshold %> percentile</h2>
-<% @top_percentile_methods.each do |method_name, color_and_count| %>
-  <a href=<%= file_path(path: "#{color_and_count[:file_name]}", line_no: color_and_count[:line_no]) %> class="<%= color_and_count[:color] %>"><%= method_name %> = <%= color_and_count[:total_call_count] %></a><br/><br/>
-<% end %>
+<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>
 
-<h2>Bottom <%= Deforest.least_used_percentile_threshold %> percentile</h2>
-<% @low_percentile_methods.each do |method_name, color_and_count| %>
-  <a href=<%= file_path(path: "#{color_and_count[:file_name]}", line_no: color_and_count[:line_no]) %> class="<%= color_and_count[:color] %>"><%= method_name %> = <%= color_and_count[:total_call_count] %></a><br/><br/>
-<% end %>
+  <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>
 
-<h2>Between <%= Deforest.least_used_percentile_threshold %> and <%= Deforest.most_used_percentile_threshold %> percentile</h2>
-<% @medium_percentile_methods.each do |method_name, color_and_count| %>
-  <a href=<%= file_path(path: "#{color_and_count[:file_name]}", line_no: color_and_count[:line_no]) %> class="<%= color_and_count[:color] %>"><%= method_name %> = <%= color_and_count[:total_call_count] %></a><br/><br/>
-<% end %>
 
-<style>
-  .highlight-red {
-    background: rgba(245, 66, 72, 0.8);
-  }
-  .highlight-yellow {
-    background: rgba(240, 240, 5, 0.8);
-    color: #000;
-  }
-  .highlight-green {
-    background: rgba(0, 227, 38, 0.8);
-    color: #000;
-  }
-</style>
+<%= 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 } %>

data/config/routes.rb

@@ -2,4 +2,5 @@ Deforest::Engine.routes.draw do
   get "/files", controller: "files", action: "index"
   get "/file", controller: "files", action: "show"
   get "/files/dashboard", controller: "files", action: "dashboard"
+  get "/files/extension_data", controller: "files", action: "extension_data"
 end

data/lib/deforest/version.rb

@@ -1,3 +1,3 @@
 module Deforest
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/deforest.rb

@@ -4,18 +4,14 @@ 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
+  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 = nil
   @@saving_log_file = false
 
-  def self.initialize!
-    if block_given?
-      yield self
-    end
-    self.initialize_db_sync_file()
-    Dir["#{Rails.root}/app/models/**/*.rb"].map do |f|
-      idx = f.index("app/models")
-      models_heirarchy = f[idx..-1].gsub("app/models/","")
+  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("/")
@@ -29,59 +25,79 @@ module Deforest
       end
       begin
         model = exec_str.constantize
+        yield model
       rescue
         puts "Deforest warning: could not track #{exec_str}"
       end
-      if model.present?
-        model.instance_methods(false).each do |mname|
-          model.instance_eval do
-            alias_method "old_#{mname}", mname
-            define_method mname do |*args, &block|
-              old_method = self.class.instance_method("old_#{mname}")
-              file_name, line_no = old_method.source_location
-              if file_name.include?("/app/models")
-                Deforest.insert_into_logs(mname, file_name, line_no)
-              end
-              Deforest.insert_into_logs(mname, file_name, line_no)
-              if @@last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !@@saving_log_file
-                Deforest.parse_and_save_log_file()
-                t = Time.zone.now
-                @@last_saved_log_file_at = t
-                File.open("deforest_db_sync.txt", "w") { |fl| fl.write(t.to_i) }
-              end
-              old_method.bind(self).call(*args, &block)
-            end 
+    end
+  end
+
+  def self.override_instance_methods_for(klass, dir)
+    klass.instance_methods(false).each do |mname|
+      klass.instance_eval do
+        alias_method "old_#{mname}", mname
+        define_method mname do |*args, &block|
+          old_method = self.class.instance_method("old_#{mname}")
+          file_name, line_no = old_method.source_location
+          if file_name.include?(dir)
+            Deforest.insert_into_logs(mname, file_name, line_no)
           end
-        end
-        model.singleton_methods(false).each do |mname|
-          model.singleton_class.send(:alias_method, "old_#{mname}", mname)
-          model.define_singleton_method mname do |*args, &block|
-            old_method = self.singleton_method("old_#{mname}")
-            file_name, line_no = old_method.source_location
-            if file_name.include?("/app/models")
-              Deforest.insert_into_logs(mname, file_name, line_no)
-            end
-            if @@last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !@@saving_log_file
-              Deforest.parse_and_save_log_file()
-              t = Time.zone.now
-              @@last_saved_log_file_at = t
-              File.open("deforest_db_sync.txt", "w") { |fl| fl.write(t.to_i) }
-            end
-            old_method.unbind.bind(self).call(*args, &block)
+          if @@last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !@@saving_log_file
+            Deforest.parse_and_save_log_file()
+            t = Time.zone.now
+            @@last_saved_log_file_at = t
+            File.open("deforest_db_sync.txt", "w") { |fl| fl.write(t.to_i) }
           end
+          old_method.bind(self).call(*args, &block)
+        end 
+      end
+    end
+  end
+
+  def self.override_class_methods_for(klass, dir)
+    klass.singleton_methods(false).each do |mname|
+      klass.singleton_class.send(:alias_method, "old_#{mname}", mname)
+      klass.define_singleton_method mname do |*args, &block|
+        old_method = self.singleton_method("old_#{mname}")
+        file_name, line_no = old_method.source_location
+        if file_name.include?(dir)
+          Deforest.insert_into_logs(mname, file_name, line_no)
+        end
+        if @@last_saved_log_file_at < Deforest.write_logs_to_db_every.ago && !@@saving_log_file
+          Deforest.parse_and_save_log_file()
+          t = Time.zone.now
+          @@last_saved_log_file_at = t
+          File.open("deforest_db_sync.txt", "w") { |fl| fl.write(t.to_i) }
+        end
+        old_method.unbind.bind(self).call(*args, &block)
+      end
+    end
+  end
+  
+  def self.initialize!
+    if block_given?
+      yield self
+    end
+    self.initialize_db_sync_file()
+    Deforest.track_dirs.each do |dir|
+      self.get_app_classes(dir) do |model|
+        if model.present?
+          self.override_instance_methods_for(model, dir)
+          self.override_class_methods_for(model, dir) unless dir.include?("/app/controllers")
         end
       end
     end
   end
 
   def self.initialize_db_sync_file
-    if File.exists?("deforest_db_sync.txt")
+    File.open("deforest.log", "w") unless File.exist?("deforest.log")
+    if File.exist?("deforest_db_sync.txt")
       @@last_saved_log_file_at = Time.at(File.open("deforest_db_sync.txt").read.to_i)
     else
       File.open("deforest_db_sync.txt", "w") do |f|
-        current_time = Time.zone.now.to_i
+        current_time = Time.zone.now
         @@last_saved_log_file_at = current_time
-        f.write(current_time)
+        f.write(current_time.to_i)
       end
     end
   end
@@ -107,16 +123,19 @@ module Deforest
       end
     end
     hash.each do |loc, count|
-      sql_stmt += "(#{loc.split("|").map { |s| "'#{s}'" }.join(",")}, #{count}, current_timestamp, current_timestamp),"
+      t = Time.zone.now
+      sql_stmt += "(#{loc.split("|").map { |s| "'#{s}'" }.join(",")}, #{count}, '#{t}', '#{t}'),"
     end
     sql_stmt.chomp!(",")
     sql_stmt += ";"
-    ActiveRecord::Base.connection.execute(sql_stmt)
-    if File.exists?("deforest_tmp.log")
-      File.delete("deforest.log")
-      File.rename("deforest_tmp.log", "deforest.log")
-    else
-      File.delete("deforest.log")
+    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")
+      else
+        File.delete("deforest.log")
+      end
     end
     @@saving_log_file = false
   end

data/lib/tasks/deforest_initializer.rb

@@ -3,4 +3,6 @@ Deforest.initialize! do |config|
   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/test/deforest_test.rb

@@ -2,15 +2,20 @@ require 'test_helper'
 
 class DeforestTest < ActiveSupport::TestCase
   setup do
-    Deforest.class_variable_set("@@last_saved_log_file_at", nil)
+    File.open("deforest_db_sync.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")
   end
 
   test "initialize db_sync_file when db_sync_file does not exist" do
-    if File.exist?("deforest_db_sync.txt")
-      File.delete("deforest_db_sync.txt")
-      Deforest.initialize_db_sync_file
-      assert Deforest.class_variable_get("@@last_saved_log_file_at") > 1.minute.ago.to_i
-    end
+    File.delete("deforest_db_sync.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

data/test/dummy/app/models/comment.rb

@@ -0,0 +1,12 @@
+class Comment < ActiveRecord::Base
+  belongs_to :post
+
+  def stupid_comment?
+    stupid_words = ["very good", "nice"]
+    self.body.length < 20 && stupid_words.find { |w| self.body.include?(w) }
+  end
+
+  def contains_embedded_links?
+    (self.body =~ /<a.*>.+<\/a>/i) != nil
+  end
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,19 @@
+class Post < ActiveRecord::Base
+  has_many :comments
+
+  def self.get_titles
+    Post.all.map(&:title)
+  end
+
+  def get_title_with_italics
+    "<i>#{self.title}</i>"
+  end
+
+  def self.get_posts_created_after(date)
+    self.where("DATE(created_at) > DATE(?)", date)
+  end
+
+  def self.posts_created_yesterday
+    self.where("DATE(created_at) = DATE(?)", Date.yesterday)
+  end
+end

data/test/dummy/app/models/special/custom/post.rb

@@ -0,0 +1,2 @@
+class Special::Custom::Post < ActiveRecord::Base
+end

data/test/dummy/app/models/special/post.rb

@@ -0,0 +1,2 @@
+class Special::Post < ActiveRecord::Base
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  
+end

data/test/dummy/config/initializers/deforest.rb

@@ -0,0 +1,7 @@
+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"]
+end

data/test/dummy/db/migrate/20230211204438_create_users.rb

@@ -1,6 +1,6 @@
 class CreateUsers < ActiveRecord::Migration
   def change
-    create_table :deforest_users do |t|
+    create_table :users do |t|
       t.string :first_name
       t.string :last_name
       t.string :email

data/test/dummy/db/migrate/20230216154544_create_posts.rb

@@ -0,0 +1,11 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+      t.integer :author_id
+
+      t.timestamps null: false
+    end
+  end
+end

data/test/dummy/db/migrate/20230218121433_create_special_posts.rb

@@ -0,0 +1,10 @@
+class CreateSpecialPosts < ActiveRecord::Migration
+  def change
+    create_table :special_posts do |t|
+      t.string :title
+      t.text :body
+
+      t.timestamps null: false
+    end
+  end
+end

data/test/dummy/db/migrate/20230218161957_create_special_custom_posts.rb

@@ -0,0 +1,10 @@
+class CreateSpecialCustomPosts < ActiveRecord::Migration
+  def change
+    create_table :special_custom_posts do |t|
+      t.string :title
+      t.text :body
+
+      t.timestamps null: false
+    end
+  end
+end

data/test/dummy/db/migrate/20230219174900_create_comments.rb

@@ -0,0 +1,11 @@
+class CreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.text :body
+      t.integer :author_id
+      t.integer :post_id
+
+      t.timestamps null: false
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,10 +11,12 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20230211204438) do
+ActiveRecord::Schema.define(version: 20230219174900) do
 
-  create_table "ar_internal_metadata", primary_key: "key", force: :cascade do |t|
-    t.string   "value"
+  create_table "comments", force: :cascade do |t|
+    t.text     "body"
+    t.integer  "author_id"
+    t.integer  "post_id"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
   end
@@ -28,7 +30,29 @@ ActiveRecord::Schema.define(version: 20230211204438) do
     t.datetime "updated_at",  null: false
   end
 
-  create_table "deforest_users", force: :cascade do |t|
+  create_table "posts", force: :cascade do |t|
+    t.string   "title"
+    t.text     "body"
+    t.integer  "author_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "special_custom_posts", force: :cascade do |t|
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "special_posts", force: :cascade do |t|
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "users", force: :cascade do |t|
     t.string   "first_name"
     t.string   "last_name"
     t.string   "email"