meta_request 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b9c5b68ec96706c97b7694930d494d51a71d4cdfe8d0e4a31a1c5a3bd6162b
-  data.tar.gz: 12175a52caa80018ac03d1c47cce506da4f41094e72bbb36a3f950812436b2e5
+  metadata.gz: 40d50e7981aca25dd87449d817b7a6e223491be3cb2155ad3ee82e081afce02f
+  data.tar.gz: 8fa75570b5c5b41b546f71aa883bd9df3bdf9b76e4a6a38f5498aa3af641e0fd
 SHA512:
-  metadata.gz: f4344ff68b5379c110ed0a6f1d4b9e852b8dc72b3f6c3e323bcf36fc6e62b4aef196d9f61b81f38922c1c577c48f763b0fe574a7db6183d28ef931e8746d02d5
-  data.tar.gz: 5e3f37af2fb91197b442cb41f57f71c3c8aff600cfa6ce9ccf516419aa48f2e954ae7553b038c67b2bf7efbe647f34a794fd4afe2fb5554b7d53f4976b6a1bcb
+  metadata.gz: 22764f1ec9e723a596e56993c802e541263ce1c7902b88c30902d69701a4b47705c404ce85fd3d2240f5fda7f5d1e85f0512f192647d181e10f30a5f13c6e6a0
+  data.tar.gz: 4c62d0983519f5ae3779759aeba06354e6cb9d4c920feb42f9966be91d0615ca8439c7749109435c3d916f1a40d3718b7c9c5dc99d88b50a04ee44b243b74374

data/README.md

@@ -23,11 +23,35 @@ If you're using [LiveReload](http://livereload.com/) or
 exclude watching your tmp/ folder because meta_request writes a lot of data there
 and your browser will refresh like a madman.
 
+## Configuration
+
+Gem can be configured using block:
+
+```ruby
+MetaRequest.configure do |config|
+  config.storage_pool_size = 30
+end
+```
+
+List of available attributes and defaults can be found in [lib/meta_request/config.rb](lib/meta_request/config.rb).
+
+## Docker
+
+Apps runing in Docker container will have filepaths of the container so links to editor would not work. To fix this, you need to propagate working directory through enviroment variable `SOURCE_PATH`. With docker-compose it can be done like this:
+
+```yaml
+services:
+  app:
+    environment:
+      - SOURCE_PATH=$PWD
+    # ...
+```
+
 ## Development
 
-Run tests:
+Run all tests:
 
-    make
+    docker-compose up
 
 ## Licence
 

data/lib/meta_request.rb

@@ -1,20 +1,26 @@
 module MetaRequest
   autoload :VERSION,          "meta_request/version"
+  autoload :Config,           "meta_request/config"
   autoload :Event,            "meta_request/event"
   autoload :AppRequest,       "meta_request/app_request"
   autoload :Storage,          "meta_request/storage"
   autoload :Middlewares,      "meta_request/middlewares"
   autoload :LogInterceptor,   "meta_request/log_interceptor"
   autoload :AppNotifications, "meta_request/app_notifications"
+  autoload :Utils,            "meta_request/utils"
 
-  def self.logger
-    @@logger ||= Logger.new(File.join(Rails.root, 'log', 'meta_request.log'))
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
   end
 
   # stash a frozen copy away so we're not allocating a new string over and over
   # again in AppNotifications and LogInterceptor
   def self.rails_root
-    @@rails_root ||= Rails.root.to_s.freeze
+    @rails_root ||= Rails.root.to_s.freeze
   end
 end
 

data/lib/meta_request/app_notifications.rb

@@ -24,11 +24,8 @@ module MetaRequest
         payload[:options][k] = payload.delete(k) unless k.in? CACHE_KEY_COLUMNS
       end
 
-      dev_caller = caller.detect { |c| c.include? MetaRequest.rails_root }
-      if dev_caller
-        c = Callsite.parse(dev_caller)
-        payload.merge!(:line => c.line, :filename => c.filename, :method => c.method)
-      end
+      callsite = Utils.dev_callsite(caller)
+      payload.merge!(callsite) if callsite
 
       Event.new(name, start, ending, transaction_id, payload)
     }
@@ -43,13 +40,19 @@ module MetaRequest
 
     SQL_BLOCK = Proc.new {|*args|
       name, start, ending, transaction_id, payload = args
-      dev_caller = caller.detect { |c| c.include? MetaRequest.rails_root }
-      if dev_caller
-        c = Callsite.parse(dev_caller)
-        payload.merge!(:line => c.line, :filename => c.filename, :method => c.method)
-      end
+      callsite = Utils.dev_callsite(caller)
+      payload.merge!(callsite) if callsite
+
       Event.new(SQL_EVENT_NAME, start, ending, transaction_id, payload)
     }
+
+    VIEW_BLOCK = Proc.new {|*args|
+      name, start, ending, transaction_id, payload = args
+      payload[:identifier] = MetaRequest::Utils.sub_source_path(payload[:identifier])
+
+      Event.new(name, start, ending, transaction_id, payload)
+    }
+
     # Subscribe to all events relevant to RailsPanel
     #
     def self.subscribe
@@ -57,8 +60,8 @@ module MetaRequest
         subscribe("meta_request.log").
         subscribe("sql.active_record", &SQL_BLOCK).
         subscribe("sql.sequel", &SQL_BLOCK).
-        subscribe("render_partial.action_view").
-        subscribe("render_template.action_view").
+        subscribe("render_partial.action_view", &VIEW_BLOCK).
+        subscribe("render_template.action_view", &VIEW_BLOCK).
         subscribe("process_action.action_controller.exception").
         subscribe("process_action.action_controller") do |*args|
           name, start, ending, transaction_id, payload = args

data/lib/meta_request/config.rb

@@ -0,0 +1,20 @@
+module MetaRequest
+  class Config
+    attr_writer :logger, :storage_pool_size, :source_path
+
+    # logger used for reporting gem's fatal errors
+    def logger
+      @logger ||= Logger.new(File.join(Rails.root, 'log', 'meta_request.log'))
+    end
+
+    # Number of files kept in storage.
+    # Increase when using an application loading many simultaneous requests.
+    def storage_pool_size
+      @storage_pool_size ||= 20
+    end
+
+    def source_path
+      @source_path ||= ENV['SOURCE_PATH'] || Rails.root.to_s
+    end
+  end
+end

data/lib/meta_request/event.rb

@@ -38,7 +38,7 @@ module MetaRequest
       transform_hash(payload, :deep => true) { |hash, key, value|
         if value.class.to_s == 'ActionDispatch::Http::Headers'
           value = value.to_h.select { |k, _| k.upcase == k }
-        elsif value.is_a?(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+        elsif defined?(ActiveRecord) && value.is_a?(ActiveRecord::ConnectionAdapters::AbstractAdapter)
           value = NOT_JSON_ENCODABLE
         end
 

data/lib/meta_request/log_interceptor.rb

@@ -1,5 +1,3 @@
-require 'callsite'
-
 module MetaRequest
   module LogInterceptor
 
@@ -33,17 +31,15 @@ module MetaRequest
       super
     end
 
-
     private
     def push_event(level, message)
-      dev_log = AppRequest.current && caller[1].include?(MetaRequest.rails_root)
-      if dev_log
-        c = Callsite.parse(caller[1])
-        payload = {:message => message, :level => level, :line => c.line, :filename => c.filename, :method => c.method}
+      callsite = AppRequest.current && Utils.dev_callsite(caller.drop(1))
+      if callsite
+        payload = callsite.merge(message: message, level: level)
         AppRequest.current.events << Event.new('meta_request.log', 0, 0, 0, payload)
       end
     rescue Exception => e
-      MetaRequest.logger.fatal(e.message + "\n " + e.backtrace.join("\n "))
+      MetaRequest.config.logger.fatal(e.message + "\n " + e.backtrace.join("\n "))
     end
   end
 end

data/lib/meta_request/storage.rb

@@ -9,7 +9,7 @@ module MetaRequest
     def write(value)
       FileUtils.mkdir_p dir_path
       File.open(json_file, 'wb') { |file| file.write(value) }
-      maintain_file_pool(10)
+      maintain_file_pool(MetaRequest.config.storage_pool_size)
     end
 
     def read
@@ -27,7 +27,7 @@ module MetaRequest
     end
 
     def file_ctime(file)
-      File.stat(file).ctime.to_i 
+      File.stat(file).ctime.to_i
     rescue Errno::ENOENT
       0
     end

data/lib/meta_request/utils.rb

@@ -0,0 +1,25 @@
+module MetaRequest
+  module Utils
+    extend self
+
+    def dev_callsite(caller)
+      app_line = caller.detect { |c| c.start_with? MetaRequest.rails_root }
+      return nil unless app_line
+
+      _, filename, _, line, _, method = app_line.split(/^(.*?)(:(\d+))(:in `(.*)')?$/)
+
+      {
+        filename: sub_source_path(filename),
+        line: line.to_i,
+        method: method
+      }
+    end
+
+    def sub_source_path(path)
+      rails_root = MetaRequest.rails_root
+      source_path = MetaRequest.config.source_path
+      return path if rails_root == source_path
+      path.sub(rails_root, source_path)
+    end
+  end
+end

data/lib/meta_request/version.rb

@@ -1,3 +1,3 @@
 module MetaRequest
-  VERSION = '0.7.0'
+  VERSION = Gem.loaded_specs["meta_request"].version.to_s
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meta_request
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Dejan Simic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2019-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: callsite
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
 description: Supporting gem for Rails Panel (Google Chrome extension for Rails development)
 email: desimic@gmail.com
 executables: []
@@ -80,6 +60,7 @@ files:
 - lib/meta_request.rb
 - lib/meta_request/app_notifications.rb
 - lib/meta_request/app_request.rb
+- lib/meta_request/config.rb
 - lib/meta_request/event.rb
 - lib/meta_request/log_interceptor.rb
 - lib/meta_request/middlewares.rb
@@ -88,6 +69,7 @@ files:
 - lib/meta_request/middlewares/meta_request_handler.rb
 - lib/meta_request/railtie.rb
 - lib/meta_request/storage.rb
+- lib/meta_request/utils.rb
 - lib/meta_request/version.rb
 homepage: https://github.com/dejan/rails_panel/tree/master/meta_request
 licenses:
@@ -108,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Request your Rails request