meta_request 0.6.0 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 184437fd6ea42cfd3276c87c21442aa47263b87f
-  data.tar.gz: 599aece8423f131b32b7da83c0e2ec7253abfe9a
+SHA256:
+  metadata.gz: c006823c94849fdbbd3a58e7c8f28383f29a184da0d5a0ec18ae21d7a309479b
+  data.tar.gz: 3530b801762849da7835dddea6b89861fb98402a0aa1507c8c558f7be3da5faa
 SHA512:
-  metadata.gz: eb35b8df716f3f84501d05e3dc51e831ac0bf915a07521236a9938baeb0be9d99499da9ff9d2e8382e6f60c2ecf7aca872d43d1f3f4e580188330ceb717daaff
-  data.tar.gz: 2ffdf7da526cfa5a1be4a68c52affbaea939961be31afbcf4725840dac7b645fb84b59ace8b0e6ad0829b95036ad3a89135ee60c4e1b873d829f76e737880310
+  metadata.gz: a0a20933e32b050f3e42c035dadc40080479100fe1e7951ea828e2d958f17b00b6cae434afcea39fab268d68e7cb51b058aa2ef08c536eb477f932f591a1b9fd
+  data.tar.gz: d06f1f7b2d846297ec8f3475d75cc19ffa0f76f5ef333428d9713ef43f84e4cb15ecabbd638f36bd55ac65c9f2bce46dd80054b81fb906262b377804e7021932

data/README.md

@@ -1,55 +1,79 @@
-# MetaRequest
-
-Supporting gem for [Rails Panel (Google Chrome extension for Rails development)](https://github.com/dejan/rails_panel).
-
-## Installation
-
-Add meta_request gem to development group in Gemfile:
-
-```ruby
-group :development do
-  gem 'meta_request'
-end
-```
-
-## Usage
-
-See [Rails Panel extension](https://github.com/dejan/rails_panel).
-
-## Compatibility Warnings
-
-If you're using [LiveReload](http://livereload.com/) or
-[Rack::LiveReload](https://github.com/johnbintz/rack-livereload) make sure to
-exclude watching your tmp/ folder because meta_request writes a lot of data there
-and your browser will refresh like a madman.
-
-## Development
-
-Run tests:
-
-    make
-
-## Licence
-
-Copyright (c) 2012 Dejan Simic
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# MetaRequest
+
+Supporting gem for [Rails Panel (Google Chrome extension for Rails development)](https://github.com/dejan/rails_panel).
+
+## Installation
+
+Add meta_request gem to development group in Gemfile:
+
+```ruby
+group :development do
+  gem 'meta_request'
+end
+```
+
+## Usage
+
+See [Rails Panel extension](https://github.com/dejan/rails_panel).
+
+## Compatibility Warnings
+
+If you're using [LiveReload](http://livereload.com/) or
+[Rack::LiveReload](https://github.com/johnbintz/rack-livereload) make sure to
+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 all tests:
+
+    docker-compose up
+
+## Licence
+
+Copyright (c) 2012 Dejan Simic
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/meta_request/app_notifications.rb

@@ -1,86 +1,88 @@
-module MetaRequest
-  class AppNotifications
-
-    # these are the specific keys in the cache payload that we display in the
-    # panel view
-    CACHE_KEY_COLUMNS = [:key, :hit, :options, :type]
-
-    # define this here so we can pass it in to all of our cache subscribe calls
-    CACHE_BLOCK = Proc.new {|*args|
-      name, start, ending, transaction_id, payload = args
-
-      # from http://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-fetch-hit-active-support
-      #
-      # :super_operation	:fetch is added when a read is used with #fetch
-      #
-      # so if :super_operation is present, we'll use it for the type. otherwise
-      # strip (say) 'cache_delete.active_support' down to 'delete'
-      payload[:type] = payload.delete(:super_operation) || name.sub(/cache_(.*?)\..*$/, '\1')
-
-      # anything that isn't in CACHE_KEY_COLUMNS gets shoved into :options
-      # instead
-      payload[:options] = {}
-      payload.keys.each do |k|
-        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
-
-      Event.new(name, start, ending, transaction_id, payload)
-    }
-
-    # sql processing block - used for sql.active_record and sql.sequel
-
-    # HACK: we hardcode the event name to 'sql.active_record' so that the ui will
-    # display sequel events without modification. otherwise the ui would need to
-    # be modified to support a sequel tab (or to change the display name on the
-    # active_record tab when necessary - which maybe makes more sense?)
-    SQL_EVENT_NAME = "sql.active_record"
-
-    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
-      Event.new(SQL_EVENT_NAME, start, ending, transaction_id, payload)
-    }
-    # Subscribe to all events relevant to RailsPanel
-    #
-    def self.subscribe
-      new.
-        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("process_action.action_controller.exception").
-        subscribe("process_action.action_controller") do |*args|
-          name, start, ending, transaction_id, payload = args
-          payload[:status] = '500' if payload[:exception]
-          Event.new(name, start, ending, transaction_id, payload)
-        end.
-        subscribe("cache_read.active_support", &CACHE_BLOCK).
-        subscribe("cache_generate.active_support", &CACHE_BLOCK).
-        subscribe("cache_fetch_hit.active_support", &CACHE_BLOCK).
-        subscribe("cache_write.active_support", &CACHE_BLOCK).
-        subscribe("cache_delete.active_support", &CACHE_BLOCK).
-        subscribe("cache_exist?.active_support", &CACHE_BLOCK)
-    end
-
-    def subscribe(event_name)
-      ActiveSupport::Notifications.subscribe(event_name) do |*args|
-        event = block_given?? yield(*args) : Event.new(*args)
-        AppRequest.current.events << event if AppRequest.current
-      end
-      self
-    end
-
-  end
-
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  class AppNotifications
+    # these are the specific keys in the cache payload that we display in the
+    # panel view
+    CACHE_KEY_COLUMNS = %i[key hit options type].freeze
+
+    # define this here so we can pass it in to all of our cache subscribe calls
+    CACHE_BLOCK = proc { |*args|
+      name, start, ending, transaction_id, payload = args
+
+      # from http://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-fetch-hit-active-support
+      #
+      # :super_operation  :fetch is added when a read is used with #fetch
+      #
+      # so if :super_operation is present, we'll use it for the type. otherwise
+      # strip (say) 'cache_delete.active_support' down to 'delete'
+      payload[:type] = payload.delete(:super_operation) || name.sub(/cache_(.*?)\..*$/, '\1')
+
+      # anything that isn't in CACHE_KEY_COLUMNS gets shoved into :options
+      # instead
+      payload[:options] = {}
+      payload.keys.each do |k|
+        payload[:options][k] = payload.delete(k) unless k.in? CACHE_KEY_COLUMNS
+      end
+
+      callsite = Utils.dev_callsite(caller)
+      payload.merge!(callsite) if callsite
+
+      Event.new(name, start, ending, transaction_id, payload)
+    }
+
+    # sql processing block - used for sql.active_record and sql.sequel
+
+    # HACK: we hardcode the event name to 'sql.active_record' so that the ui will
+    # display sequel events without modification. otherwise the ui would need to
+    # be modified to support a sequel tab (or to change the display name on the
+    # active_record tab when necessary - which maybe makes more sense?)
+    SQL_EVENT_NAME = 'sql.active_record'
+
+    SQL_BLOCK = proc { |*args|
+      _name, start, ending, transaction_id, payload = args
+      callsite = Utils.dev_callsite(caller)
+      payload.merge!(callsite) if callsite
+
+      Event.new(SQL_EVENT_NAME, start, ending, transaction_id, payload)
+    }
+
+    VIEW_BLOCK = proc { |*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
+      new
+        .subscribe('meta_request.log')
+        .subscribe('sql.active_record', &SQL_BLOCK)
+        .subscribe('sql.sequel', &SQL_BLOCK)
+        .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
+          payload[:status] = '500' if payload[:exception]
+          Event.new(name, start, ending, transaction_id, payload)
+        end
+        .subscribe('cache_read.active_support', &CACHE_BLOCK)
+        .subscribe('cache_generate.active_support', &CACHE_BLOCK)
+        .subscribe('cache_fetch_hit.active_support', &CACHE_BLOCK)
+        .subscribe('cache_write.active_support', &CACHE_BLOCK)
+        .subscribe('cache_delete.active_support', &CACHE_BLOCK)
+        .subscribe('cache_exist?.active_support', &CACHE_BLOCK)
+    end
+
+    def subscribe(event_name)
+      ActiveSupport::Notifications.subscribe(event_name) do |*args|
+        event = block_given? ? yield(*args) : Event.new(*args)
+        AppRequest.current.events << event if AppRequest.current
+      end
+      self
+    end
+  end
+end

data/lib/meta_request/app_request.rb

@@ -1,19 +1,20 @@
-module MetaRequest
-  class AppRequest
-    attr_reader :id, :events
-
-    def initialize(id)
-      @id = id
-      @events = []
-    end
-
-    def self.current
-      Thread.current[:meta_request_id]
-    end
-
-    def current!
-      Thread.current[:meta_request_id] = self
-    end
-
-  end
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  class AppRequest
+    attr_reader :id, :events
+
+    def initialize(id)
+      @id = id
+      @events = []
+    end
+
+    def self.current
+      Thread.current[:meta_request_id]
+    end
+
+    def current!
+      Thread.current[:meta_request_id] = self
+    end
+  end
+end

data/lib/meta_request/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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

@@ -1,68 +1,78 @@
-require 'active_support'
-require 'active_support/json'
-require 'active_support/core_ext'
-
-module MetaRequest
-
-  # Subclass of ActiveSupport Event that is JSON encodable
-  #
-  class Event < ActiveSupport::Notifications::Event
-    attr_reader :duration
-
-    def initialize(name, start, ending, transaction_id, payload)
-      super(name, start, ending, transaction_id, json_encodable(payload))
-      @duration = 1000.0 * (ending - start)
-    end
-
-    def self.events_for_exception(exception_wrapper)
-      if defined?(ActionDispatch::ExceptionWrapper)
-        exception = exception_wrapper.exception
-        trace = exception_wrapper.application_trace
-        trace = exception_wrapper.framework_trace if trace.empty?
-      else
-        exception = exception_wrapper
-        trace = exception.backtrace
-      end
-      trace.unshift "#{exception.class} (#{exception.message})"
-      trace.map do |call|
-        Event.new('process_action.action_controller.exception', 0, 0, nil, {:call => call})
-      end
-    end
-
-    private
-
-    def json_encodable(payload)
-      return {} unless payload.is_a?(Hash)
-      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 }
-        end
-
-        begin
-          value.to_json(:methods => [:duration])
-          new_value = value
-        rescue
-          new_value = 'Not JSON Encodable'
-        end
-        hash[key] = new_value
-      }.with_indifferent_access
-    end
-
-    # https://gist.github.com/dbenhur/1070399
-    def transform_hash(original, options={}, &block)
-      options[:safe_descent] ||= {}
-      new_hash = {}
-      options[:safe_descent][original.object_id] = new_hash
-      original.inject(new_hash) { |result, (key,value)|
-        if (options[:deep] && Hash === value)
-          value = options[:safe_descent].fetch( value.object_id ) {
-            transform_hash(value, options, &block)
-          }
-        end
-        block.call(result,key,value)
-        result
-      }
-    end
-
-  end
-end
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/json'
+require 'active_support/core_ext'
+
+module MetaRequest
+  # Subclass of ActiveSupport Event that is JSON encodable
+  #
+  class Event < ActiveSupport::Notifications::Event
+    NOT_JSON_ENCODABLE = 'Not JSON Encodable'
+
+    attr_reader :duration
+
+    def initialize(name, start, ending, transaction_id, payload)
+      super(name, start, ending, transaction_id, json_encodable(payload))
+      @duration = 1000.0 * (ending - start)
+    end
+
+    def self.events_for_exception(exception_wrapper)
+      if defined?(ActionDispatch::ExceptionWrapper)
+        exception = exception_wrapper.exception
+        trace = exception_wrapper.application_trace
+        trace = exception_wrapper.framework_trace if trace.empty?
+      else
+        exception = exception_wrapper
+        trace = exception.backtrace
+      end
+      trace.unshift "#{exception.class} (#{exception.message})"
+      trace.map do |call|
+        Event.new('process_action.action_controller.exception', 0, 0, nil, call: call)
+      end
+    end
+
+    private
+
+    def json_encodable(payload)
+      return {} unless payload.is_a?(Hash)
+
+      transform_hash(payload, deep: true) do |hash, key, value|
+        if value.class.to_s == 'ActionDispatch::Http::Headers'
+          value = value.to_h.select { |k, _| k.upcase == k }
+        elsif not_encodable?(value)
+          value = NOT_JSON_ENCODABLE
+        end
+
+        begin
+          value.to_json(methods: [:duration])
+          new_value = value
+        rescue StandardError
+          new_value = NOT_JSON_ENCODABLE
+        end
+        hash[key] = new_value
+      end.with_indifferent_access
+    end
+
+    def not_encodable?(value)
+      (defined?(ActiveRecord) && value.is_a?(ActiveRecord::ConnectionAdapters::AbstractAdapter)) ||
+        (defined?(ActionDispatch) &&
+          (value.is_a?(ActionDispatch::Request) || value.is_a?(ActionDispatch::Response)))
+    end
+
+    # https://gist.github.com/dbenhur/1070399
+    def transform_hash(original, options = {}, &block)
+      options[:safe_descent] ||= {}
+      new_hash = {}
+      options[:safe_descent][original.object_id] = new_hash
+      original.each_with_object(new_hash) do |(key, value), result|
+        if options[:deep] && Hash === value
+          value = options[:safe_descent].fetch(value.object_id) do
+            transform_hash(value, options, &block)
+          end
+        end
+        block.call(result, key, value)
+      end
+    end
+  end
+end

data/lib/meta_request/log_interceptor.rb

@@ -1,49 +1,47 @@
-require 'callsite'
-
-module MetaRequest
-  module LogInterceptor
-
-    def debug(message=nil, *args)
-      push_event(:debug, message)
-      super
-    end
-
-    def info(message=nil, *args)
-      push_event(:info, message)
-      super
-    end
-
-    def warn(message=nil, *args)
-      push_event(:warn, message)
-      super
-    end
-
-    def error(message=nil, *args)
-      push_event(:error, message)
-      super
-    end
-
-    def fatal(message=nil, *args)
-      push_event(:fatal, message)
-      super
-    end
-
-    def unknown(message=nil, *args)
-      push_event(:unknown, message)
-      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}
-        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 "))
-    end
-  end
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  module LogInterceptor
+    def debug(message = nil, *args)
+      push_event(:debug, message)
+      super
+    end
+
+    def info(message = nil, *args)
+      push_event(:info, message)
+      super
+    end
+
+    def warn(message = nil, *args)
+      push_event(:warn, message)
+      super
+    end
+
+    def error(message = nil, *args)
+      push_event(:error, message)
+      super
+    end
+
+    def fatal(message = nil, *args)
+      push_event(:fatal, message)
+      super
+    end
+
+    def unknown(message = nil, *args)
+      push_event(:unknown, message)
+      super
+    end
+
+    private
+
+    def push_event(level, message)
+      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 StandardError => e
+      MetaRequest.config.logger.fatal(e.message + "\n " + e.backtrace.join("\n "))
+    end
+  end
+end

data/lib/meta_request/middlewares/app_request_handler.rb

@@ -1,32 +1,33 @@
-require 'json'
-
-module MetaRequest
-  module Middlewares
-    class AppRequestHandler
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        app_request = AppRequest.new env["action_dispatch.request_id"]
-        app_request.current!
-        @app.call(env)
-      rescue Exception => exception
-        if defined?(ActionDispatch::ExceptionWrapper)
-          wrapper = if ActionDispatch::ExceptionWrapper.method_defined? :env
-                      ActionDispatch::ExceptionWrapper.new(env, exception)
-                    else
-                      ActionDispatch::ExceptionWrapper.new(env['action_dispatch.backtrace_cleaner'], exception)
-                    end
-          app_request.events.push(*Event.events_for_exception(wrapper))
-        else
-          app_request.events.push(*Event.events_for_exception(exception))
-        end
-        raise
-      ensure
-        Storage.new(app_request.id).write(app_request.events.to_json) unless app_request.events.empty?
-      end
-    end
-  end
-end
-
+# frozen_string_literal: true
+
+require 'json'
+
+module MetaRequest
+  module Middlewares
+    class AppRequestHandler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        app_request = AppRequest.new env['action_dispatch.request_id']
+        app_request.current!
+        @app.call(env)
+      rescue StandardError => e
+        if defined?(ActionDispatch::ExceptionWrapper)
+          wrapper = if ActionDispatch::ExceptionWrapper.method_defined? :env
+                      ActionDispatch::ExceptionWrapper.new(env, e)
+                    else
+                      ActionDispatch::ExceptionWrapper.new(env['action_dispatch.backtrace_cleaner'], e)
+                    end
+          app_request.events.push(*Event.events_for_exception(wrapper))
+        else
+          app_request.events.push(*Event.events_for_exception(e))
+        end
+        raise
+      ensure
+        Storage.new(app_request.id).write(app_request.events.to_json) unless app_request.events.empty?
+      end
+    end
+  end
+end

data/lib/meta_request/middlewares/headers.rb

@@ -1,37 +1,38 @@
-require 'rack/contrib/response_headers'
-
-module MetaRequest
-  module Middlewares
-    class Headers
-      def initialize(app, app_config)
-        @app = app
-        @app_config = app_config
-      end
-
-      def call(env)
-        request_path = env['PATH_INFO']
-        middleware = Rack::ResponseHeaders.new(@app) do |headers|
-          headers['X-Meta-Request-Version'] = MetaRequest::VERSION unless skip?(request_path)
-        end
-        middleware.call(env)
-      end
-
-      private
-
-      # returns true if path should be ignored (not handled by RailsPanel extension)
-      #
-      def skip?(path)
-        asset?(path) || path.start_with?('/__better_errors/')
-      end
-
-      def asset?(path)
-        @app_config.respond_to?(:assets) && path.start_with?(assets_prefix)
-      end
-
-      def assets_prefix
-        "/#{@app_config.assets.prefix[/\A\/?(.*?)\/?\z/, 1]}/"
-      end
-
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rack/contrib/response_headers'
+
+module MetaRequest
+  module Middlewares
+    class Headers
+      def initialize(app, app_config)
+        @app = app
+        @app_config = app_config
+      end
+
+      def call(env)
+        request_path = env['PATH_INFO']
+        middleware = Rack::ResponseHeaders.new(@app) do |headers|
+          headers['X-Meta-Request-Version'] = MetaRequest::VERSION unless skip?(request_path)
+        end
+        middleware.call(env)
+      end
+
+      private
+
+      # returns true if path should be ignored (not handled by RailsPanel extension)
+      #
+      def skip?(path)
+        asset?(path) || path.start_with?('/__better_errors/')
+      end
+
+      def asset?(path)
+        @app_config.respond_to?(:assets) && path.start_with?(assets_prefix)
+      end
+
+      def assets_prefix
+        "/#{@app_config.assets.prefix[%r{\A/?(.*?)/?\z}, 1]}/"
+      end
+    end
+  end
+end

data/lib/meta_request/middlewares/meta_request_handler.rb

@@ -1,25 +1,27 @@
-module MetaRequest
-  module Middlewares
-    class MetaRequestHandler
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        request_id = env["PATH_INFO"][%r{/__meta_request/(.+)\.json$}, 1]
-        if request_id
-          events_json(request_id)
-        else
-          @app.call(env)
-        end
-      end
-
-      private
-
-      def events_json(request_id)
-        events_json = Storage.new(request_id).read
-        [200, { "Content-Type" => "text/plain; charset=utf-8" }, [events_json]]
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  module Middlewares
+    class MetaRequestHandler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request_id = env['PATH_INFO'][%r{/__meta_request/(.+)\.json$}, 1]
+        if request_id
+          events_json(request_id)
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def events_json(request_id)
+        events_json = Storage.new(request_id).read
+        [200, { 'Content-Type' => 'text/plain; charset=utf-8' }, [events_json]]
+      end
+    end
+  end
+end

data/lib/meta_request/middlewares.rb

@@ -1,7 +1,9 @@
-module MetaRequest
-  module Middlewares
-    autoload :Headers,            "meta_request/middlewares/headers"
-    autoload :AppRequestHandler,  "meta_request/middlewares/app_request_handler"
-    autoload :MetaRequestHandler, "meta_request/middlewares/meta_request_handler"
-  end
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  module Middlewares
+    autoload :Headers,            'meta_request/middlewares/headers'
+    autoload :AppRequestHandler,  'meta_request/middlewares/app_request_handler'
+    autoload :MetaRequestHandler, 'meta_request/middlewares/meta_request_handler'
+  end
+end

data/lib/meta_request/railtie.rb

@@ -1,29 +1,27 @@
-require 'rails/railtie'
-
-module MetaRequest
-  class Railtie < ::Rails::Railtie
-
-    initializer 'meta_request.inject_middlewares' do |app|
-      app.middleware.use Middlewares::MetaRequestHandler
-
-      if defined? ActionDispatch::DebugExceptions
-        app.middleware.insert_before ActionDispatch::DebugExceptions, Middlewares::Headers, app.config
-      else
-        app.middleware.use Middlewares::Headers, app.config
-      end
-
-      app.middleware.use Middlewares::AppRequestHandler
-    end
-
-    initializer 'meta_request.log_interceptor' do
-      Rails.logger.extend(LogInterceptor) if Rails.logger
-    end
-
-    initializer 'meta_request.subscribe_to_notifications' do
-      AppNotifications.subscribe
-    end
-
-  end
-end
-
-
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module MetaRequest
+  class Railtie < ::Rails::Railtie
+    initializer 'meta_request.inject_middlewares' do |app|
+      app.middleware.use Middlewares::MetaRequestHandler
+
+      if defined? ActionDispatch::DebugExceptions
+        app.middleware.insert_before ActionDispatch::DebugExceptions, Middlewares::Headers, app.config
+      else
+        app.middleware.use Middlewares::Headers, app.config
+      end
+
+      app.middleware.use Middlewares::AppRequestHandler
+    end
+
+    initializer 'meta_request.log_interceptor' do
+      Rails.logger&.extend(LogInterceptor)
+    end
+
+    initializer 'meta_request.subscribe_to_notifications' do
+      AppNotifications.subscribe
+    end
+  end
+end

data/lib/meta_request/storage.rb

@@ -1,43 +1,45 @@
-module MetaRequest
-  class Storage
-    attr_reader :key
-
-    def initialize(key)
-      @key = key
-    end
-
-    def write(value)
-      FileUtils.mkdir_p dir_path
-      File.open(json_file, 'wb') { |file| file.write(value) }
-      maintain_file_pool(10)
-    end
-
-    def read
-      File.read(json_file)
-    end
-
-    private
-
-    def maintain_file_pool(size)
-      files = Dir["#{dir_path}/*.json"]
-      files = files.sort_by { |f| -file_ctime(f) }
-      (files[size..-1] || []).each do |file|
-        FileUtils.rm_f(file)
-      end
-    end
-
-    def file_ctime(file)
-      File.stat(file).ctime.to_i 
-    rescue Errno::ENOENT
-      0
-    end
-
-    def json_file
-      File.join(dir_path, "#{key}.json")
-    end
-
-    def dir_path
-      File.join(Rails.root, 'tmp', 'data', 'meta_request')
-    end
-  end
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  class Storage
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def write(value)
+      FileUtils.mkdir_p dir_path
+      File.open(json_file, 'wb') { |file| file.write(value) }
+      maintain_file_pool(MetaRequest.config.storage_pool_size)
+    end
+
+    def read
+      File.read(json_file)
+    end
+
+    private
+
+    def maintain_file_pool(size)
+      files = Dir["#{dir_path}/*.json"]
+      files = files.sort_by { |f| -file_ctime(f) }
+      (files[size..-1] || []).each do |file|
+        FileUtils.rm_f(file)
+      end
+    end
+
+    def file_ctime(file)
+      File.stat(file).ctime.to_i
+    rescue Errno::ENOENT
+      0
+    end
+
+    def json_file
+      File.join(dir_path, "#{key}.json")
+    end
+
+    def dir_path
+      File.join(Rails.root, 'tmp', 'data', 'meta_request')
+    end
+  end
+end

data/lib/meta_request/utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  module Utils
+    module_function
+
+    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,5 @@
-module MetaRequest
-  VERSION = '0.6.0'
-end
+# frozen_string_literal: true
+
+module MetaRequest
+  VERSION = Gem.loaded_specs['meta_request'].version.to_s
+end

data/lib/meta_request.rb

@@ -1,21 +1,29 @@
-module MetaRequest
-  autoload :VERSION,          "meta_request/version"
-  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"
-
-  def self.logger
-    @@logger ||= Logger.new(File.join(Rails.root, 'log', 'meta_request.log'))
-  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
-  end
-end
-
-require "meta_request/railtie"
+# frozen_string_literal: true
+
+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.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
+  end
+end
+
+require 'meta_request/railtie'

metadata

@@ -1,75 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: meta_request
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.3
 platform: ruby
 authors:
 - Dejan Simic
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rack-contrib
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: callsite
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
-  type: :runtime
+        version: 3.8.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.74.0
 description: Supporting gem for Rails Panel (Google Chrome extension for Rails development)
 email: desimic@gmail.com
 executables: []
@@ -80,6 +88,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,12 +97,13 @@ 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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,9 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Request your Rails request
 test_files: []