rorvswild 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 171608a472bba02aca22c38a5ef435ed30f7de99
-  data.tar.gz: e3e0b6d5583d165c411cd9dfc437b5916a61f798
+  metadata.gz: 2a9839d60fe1491b15c28ac0470d2efc320a5bda
+  data.tar.gz: 3ec7cf369a9241604a54769fc7fa17c12fd8bbd2
 SHA512:
-  metadata.gz: 66c87f4cd4eab22ece86273ec9ec1c8e0666410bb9312d0ed1e93ff87f339e61e6a261dacfb4056feb40a45b0ee1bc26d0ace366c41bc16b7f05df858d508a50
-  data.tar.gz: c636eda87ef43cf16a3f9e45e6d07f52c06506cd3040889cdac0ed1f360e9afebe614acd880f6b3593ba487bf5b858928344502f89aafdc191fc8fddb4af75be
+  metadata.gz: ad3e2443dbb3c308cadba11a3da2faf091f0af3e32cb77ffbf36518ea748450e3891e54afce0cf9b8651ce609ac57945fb78831321a4f1c8b4eb7b59fd08d31c
+  data.tar.gz: 90a17b8993c535aadd22a9cd95ef3a457e301ebdcb47ab4325a3168efc16196236ad49d60766816f7c234719d8f1a6dc244d05e89494a40b648b7af18ec0feb8

data/lib/rorvswild/agent.rb

@@ -2,8 +2,6 @@ require "logger"
 
 module RorVsWild
   class Agent
-    include RorVsWild::Location
-
     def self.default_config
       {
         api_url: "https://www.rorvswild.com/api/v1",
@@ -22,18 +20,15 @@ module RorVsWild
       end
     end
 
-    attr_reader :config, :app_root, :app_root_regex, :client, :queue
+    attr_reader :config, :locator, :client, :queue
 
     def initialize(config)
       @config = self.class.default_config.merge(config)
       @client = Client.new(@config)
       @queue = config[:queue] || Queue.new(client)
+      @locator = RorVsWild::Locator.new(defined?(Rails) ? Rails.root.to_s : ENV["PWD"])
 
-      @app_root = config[:app_root]
-      @app_root ||= Rails.root.to_s if defined?(Rails)
-      @app_root_regex = app_root ? /\A#{app_root}/ : nil
-
-      RorVsWild.logger.info("Start RorVsWild #{RorVsWild::VERSION} from #{app_root}")
+      RorVsWild.logger.info("Start RorVsWild #{RorVsWild::VERSION}")
       setup_plugins
       cleanup_data
     end
@@ -170,10 +165,10 @@ module RorVsWild
     end
 
     def exception_to_hash(exception, extra_details = nil)
-      file, line = extract_most_relevant_file_and_line_from_exception(exception)
+      file, line = locator.find_most_relevant_file_and_line_from_exception(exception)
       {
         line: line.to_i,
-        file: relative_path(file),
+        file: locator.relative_path(file),
         message: exception.message,
         backtrace: exception.backtrace || ["No backtrace"],
         exception: exception.class.to_s,

data/lib/rorvswild/locator.rb

@@ -0,0 +1,67 @@
+module RorVsWild
+  class Locator
+    attr_reader :current_path
+
+    def initialize(current_path = ENV["PWD"])
+      @current_path = current_path
+    end
+
+    def find_most_relevant_file_and_line(locations)
+      location = find_most_relevant_location(locations)
+      [relative_path(location.path), location.lineno]
+    end
+
+    def find_most_relevant_location(locations)
+      locations.find { |l| relevant_path?(l.path) } || locations.find { |l| !irrelevant_path?(l.path) } || locations.first
+    end
+
+    def find_most_relevant_file_and_line_from_exception(exception)
+      # Exception#backtrace_locations is faster but exists since 2.1.0.
+      # Sometime Exception#backtrace_locations returns nil for an unknow reason. So we fallback to the old way.
+      if exception.respond_to?(:backtrace_locations) && locations = exception.backtrace_locations
+        find_most_relevant_file_and_line(locations)
+      elsif (backtrace = exception.backtrace) && backtrace.size > 0
+        find_most_relevant_file_and_line_from_array_of_strings(backtrace)
+      else
+        ["No backtrace".freeze, 1]
+      end
+    end
+
+    def find_most_relevant_file_and_line_from_array_of_strings(stack)
+      location = stack.find { |str| relevant_path?(str) }
+      location ||= stack.find { |str| !irrelevant_path?(str) }
+      relative_path(location || stack.first).split(":".freeze)
+    end
+
+    def relative_path(path)
+      path.index(current_path) == 0 ? path.sub(current_path, "".freeze) : path
+    end
+
+    def relevant_path?(path)
+      path.index(current_path) == 0 && !irrelevant_path?(path)
+    end
+
+    def irrelevant_path?(path)
+      irrelevant_paths.any? { |irrelevant_path| path.index(irrelevant_path) }
+    end
+
+    def irrelevant_paths
+      @irrelevant_paths ||= initialize_irrelevant_paths
+    end
+
+    private
+
+    def initialize_irrelevant_paths
+      array = ["RUBYLIB", "GEM_HOME", "GEM_PATH", "BUNDLER_ORIG_PATH", "BUNDLER_ORIG_GEM_PATH"].flat_map do |name|
+        ENV[name].split(":".freeze) if ENV[name]
+      end
+      array += [heroku_ruby_lib_path] if File.exists?(heroku_ruby_lib_path)
+      array += Gem.path
+      array.compact.uniq
+    end
+
+    def heroku_ruby_lib_path
+      "/app/vendor/ruby-#{RUBY_VERSION}/lib"
+    end
+  end
+end

data/lib/rorvswild/plugin/action_controller.rb

@@ -24,6 +24,7 @@ module RorVsWild
           RorVsWild::Section.start do |section|
             method_name = controller.method_for_action(controller.action_name)
             section.file, section.line = controller.method(method_name).source_location
+            section.file = RorVsWild.agent.locator.relative_path(section.file)
             section.command = "#{controller.class}##{method_name}"
             section.kind = "code".freeze
           end

data/lib/rorvswild/plugin/action_view.rb

@@ -16,7 +16,7 @@ module RorVsWild
       def finish(name, id, payload)
         RorVsWild::Section.stop do |section|
           section.kind = "view".freeze
-          section.command = RorVsWild.agent.relative_path(payload[:identifier])
+          section.command = RorVsWild.agent.locator.relative_path(payload[:identifier])
           section.file = section.command
           section.line = 1
         end

data/lib/rorvswild/section.rb

@@ -31,8 +31,8 @@ module RorVsWild
       @total_runtime = 0
       @children_runtime = 0
       @started_at = RorVsWild.clock_milliseconds
-      location = RorVsWild.agent.find_most_relevant_location(caller_locations)
-      @file = RorVsWild.agent.relative_path(location.path)
+      location = RorVsWild.agent.locator.find_most_relevant_location(caller_locations)
+      @file = RorVsWild.agent.locator.relative_path(location.path)
       @line = location.lineno
       @appendable_command = false
     end

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.4.4".freeze
+  VERSION = "1.4.5".freeze
 end

data/lib/rorvswild.rb

@@ -1,5 +1,5 @@
 require "rorvswild/version"
-require "rorvswild/location"
+require "rorvswild/locator"
 require "rorvswild/section"
 require "rorvswild/client"
 require "rorvswild/plugins"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Alexis Bernard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Performances and quality insights for rails developers.
 email:
@@ -36,7 +36,7 @@ files:
 - lib/rorvswild/local/queue.rb
 - lib/rorvswild/local/stylesheet/local.css
 - lib/rorvswild/local/stylesheet/vendor/prism.css
-- lib/rorvswild/location.rb
+- lib/rorvswild/locator.rb
 - lib/rorvswild/plugin/action_controller.rb
 - lib/rorvswild/plugin/action_mailer.rb
 - lib/rorvswild/plugin/action_view.rb
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails app monitoring

data/lib/rorvswild/location.rb

@@ -1,51 +0,0 @@
-module RorVsWild
-  module Location
-    def extract_most_relevant_file_and_line(locations)
-      location = find_most_relevant_location(locations)
-      [relative_path(location.path), location.lineno]
-    end
-
-    def find_most_relevant_location(locations)
-      result = locations.find { |l| l.path.index(app_root) == 0 && !(l.path =~ gem_home_regex) } if app_root
-      result || locations.find { |l| !(l.path =~ gem_home_regex) } || locations.first
-    end
-
-    def extract_most_relevant_file_and_line_from_exception(exception)
-      # Exception#backtrace_locations is faster but exists since 2.1.0.
-      # Sometime Exception#backtrace_locations returns nil for an unknow reason. So we fallback to the old way.
-      if exception.respond_to?(:backtrace_locations) && locations = exception.backtrace_locations
-        extract_most_relevant_file_and_line(locations)
-      elsif (backtrace = exception.backtrace) && backtrace.size > 0
-        extract_most_relevant_file_and_line_from_array_of_strings(backtrace)
-      else
-        ["No backtrace".freeze, 1]
-      end
-    end
-
-    def extract_most_relevant_file_and_line_from_array_of_strings(stack)
-      location = stack.find { |str| str =~ app_root_regex && !(str =~ gem_home_regex) } if app_root_regex
-      location ||= stack.find { |str| !(str =~ gem_home_regex) } if gem_home_regex
-      relative_path(location || stack.first).split(":".freeze)
-    end
-
-    def gem_home_regex
-      @gem_home_regex ||= gem_home ? /\A#{gem_home}/.freeze : /\/gems\//.freeze
-    end
-
-    def gem_home
-      @gem_home ||= guess_gem_home
-    end
-
-    def guess_gem_home
-      if ENV["GEM_HOME"] && !ENV["GEM_HOME"].empty?
-        ENV["GEM_HOME"]
-      elsif ENV["GEM_PATH"] && !(first_gem_path = ENV["GEM_PATH"].split(":").first)
-        first_gem_path if first_gem_path && !first_gem_path.empty?
-      end
-    end
-
-    def relative_path(path)
-      app_root_regex ? path.sub(app_root_regex, "".freeze) : path
-    end
-  end
-end