deforest 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46afcedf5c2b2140f01af815c8962d3bcebc884c5f1b397850047c23909012ab
-  data.tar.gz: 84ba4dde69c91fdf8d3670fc913324e28a505e15b1883d0b715ce41beb556901
+  metadata.gz: 696760761eb3f30b0c9005b4b415517b2425e818b5a314d23872821b3a596877
+  data.tar.gz: fc24e0c602020f5b8bafb8ec8bc409e7e08ae7a84832654ec4c2b6d8aaf21633
 SHA512:
-  metadata.gz: 261d8247c160e40d55444d0c655c7777968d78f5ac23cd9938e158cd544fb0373deacb9213f18246b8c4568643f96d563dd70025c438bd4e99bc1c8a7488368d
-  data.tar.gz: 723cefe6975802deda157c05fbadfc70e3c1525ebd102f33f97877db77fef64461bb932750e485846944f3f5937070e88fca1c369e0d53a608d9b0635d2238df
+  metadata.gz: 3037cd3c5f07cf97a16199ffb3c710f6190be9575db5f96037b8d406eeecadc8fa3d2f5e7edf7a83c2a8eb490697d836403157b0d6b5efd14b3370fc5f375f39
+  data.tar.gz: bff04b8410c8c02c9ddb60d44190d1fc28eac31083e9c19842b3a10197120f4f9f7e1dfc73faafcbb5fe682ad7ebf6806ee091c4c3fd9fd75c9db1fafc2d7ab4

data/app/controllers/deforest/application_controller.rb

@@ -1,5 +1,5 @@
 module Deforest
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
     protect_from_forgery with: :exception
   end
 end

data/app/controllers/deforest/files_controller.rb

@@ -60,6 +60,7 @@ module Deforest
 
     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

data/lib/deforest/version.rb

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

data/lib/deforest.rb

@@ -4,9 +4,7 @@ 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 = nil
-  @@saving_log_file = false
+  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
 
   def self.get_app_classes(dir)
     Dir["#{Rails.root}#{dir}/**/*.rb"].each do |f|
@@ -31,48 +29,6 @@ module Deforest
       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
-          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?
@@ -80,10 +36,49 @@ module Deforest
     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")
+      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)
         end
       end
     end
@@ -92,11 +87,11 @@ module Deforest
   def self.initialize_db_sync_file
     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)
+      Deforest.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
-        @@last_saved_log_file_at = current_time
+        Deforest.last_saved_log_file_at = current_time
         f.write(current_time.to_i)
       end
     end
@@ -104,14 +99,14 @@ module Deforest
 
   def self.insert_into_logs(method_name, file_name, line_no)
     key = "#{file_name}|#{line_no}|#{method_name}\n"
-    log_file_name = @@saving_log_file ? "deforest_tmp.log" : "deforest.log"
+    log_file_name = Deforest.saving_log_file ? "deforest_tmp.log" : "deforest.log"
     File.open(log_file_name, "a") do |f|
       f.write(key)
     end
   end
 
   def self.parse_and_save_log_file
-    @@saving_log_file = true
+    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|
@@ -137,7 +132,7 @@ module Deforest
         File.delete("deforest.log")
       end
     end
-    @@saving_log_file = false
+    Deforest.saving_log_file = false
   end
 
   def self.prepare_file_for_render(file)
@@ -155,7 +150,7 @@ module Deforest
           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.strftime('%m/%d/%Y')}</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

data/lib/generators/deforest/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate initializer file and migration file for logs.
+
+Example:
+    rails g deforest
+
+    This will create:
+        db/migrate/[TIMESTAMP]create_deforest_logs.rb
+        config/initializers/deforest.rb

data/lib/generators/deforest/deforest_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/base'
+require 'rails/generators/migration'
+
+class DeforestGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_migration_file
+    migration_template "migration.rb", "db/migrate/create_deforest_logs.rb", migration_version: migration_version
+  end
+
+  def copy_initializer_file
+    if 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?
+    Rails::VERSION::MAJOR >= 5
+  end
+
+  def migration_version
+    if 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")
+    else
+      "%.3d" % (current_numeric_version(dirname) + 1)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+class CreateDeforestLogs < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :deforest_logs do |t|
+      t.string :file_name
+      t.integer :line_no
+      t.string :method_name
+      t.integer :count
+
+      t.timestamps null: false
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+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