class Xray::Middleware

This middleware is responsible for injecting xray.js and the Xray bar into the app's pages. It also listens for requests to open files with the user's editor.

Public Class Methods

new(app) click to toggle source
# File lib/xray/middleware.rb, line 11
def initialize(app)
  @app = app
end

Public Instance Methods

call(env) click to toggle source
# File lib/xray/middleware.rb, line 15
def call(env)
  # Request for opening a file path.
  if env['PATH_INFO'] == OPEN_PATH
    req, res = Rack::Request.new(env), Rack::Response.new
    out, _err, status = Xray.open_file(req.GET['path'])
    if status.success?
      res.status = 200
    else
      res.write out
      res.status = 500
    end
    res.finish
  elsif env['PATH_INFO'] == UPDATE_CONFIG_PATH
    req, res = Rack::Request.new(env), Rack::Response.new
    if req.post? && Xray.config.editor = req.POST['editor']
      res.status = 200
    else
      res.status = 400
    end
    res.finish

  # Inject xray.js and friends if this is a successful HTML response
  else
    status, headers, response = @app.call(env)

    if html_headers?(status, headers) && body = response_body(response)
      if body =~ script_matcher('xray')
        # Inject the xray bar if xray.js is already on the page
        inject_xray_bar!(body)
      elsif Rails.application.config.assets.debug
        # Otherwise try to inject xray.js if assets are unbundled
        if append_js!(body, 'jquery', 'xray')
          inject_xray_bar!(body)
        end
      end

      content_length = body.bytesize.to_s

      # For rails v4.2.0+ compatibility
      if defined?(ActionDispatch::Response::RackBody) && ActionDispatch::Response::RackBody === response
        response = response.instance_variable_get(:@response)
      end

      # Modifying the original response obj maintains compatibility with other middlewares
      if ActionDispatch::Response === response
        response.body = [body]
        response.header['Content-Length'] = content_length unless committed?(response)
        response.to_a
      else
        headers['Content-Length'] = content_length
        [status, headers, [body]]
      end
    else
      [status, headers, response]
    end
  end
end

Private Instance Methods

append_js!(html, after_script_name, script_name) click to toggle source

Appends the given `script_name` after the `after_script_name`.

# File lib/xray/middleware.rb, line 114
def append_js!(html, after_script_name, script_name)
  html.sub!(script_matcher(after_script_name)) do
    "#{$~}\n" + helper.javascript_include_tag(script_name)
  end
end
committed?(response) click to toggle source
# File lib/xray/middleware.rb, line 75
def committed?(response)
  response.respond_to?(:committed?) && response.committed?
end
helper() click to toggle source
# File lib/xray/middleware.rb, line 120
def helper
  ActionController::Base.helpers
end
html_headers?(status, headers) click to toggle source
# File lib/xray/middleware.rb, line 124
def html_headers?(status, headers)
  status == 200 &&
  headers['Content-Type'] &&
  headers['Content-Type'].include?('text/html') &&
  headers["Content-Transfer-Encoding"] != "binary"
end
inject_xray_bar!(html) click to toggle source
# File lib/xray/middleware.rb, line 79
def inject_xray_bar!(html)
  html.sub!(/<body[^>]*>/) { "#{$~}\n#{render_xray_bar}" }
end
render_xray_bar() click to toggle source
# File lib/xray/middleware.rb, line 83
def render_xray_bar
  if ApplicationController.respond_to?(:render)
    # Rails 5
    ApplicationController.render(:partial => "/xray_bar").html_safe
  else
    # Rails <= 4.2
    ac = ActionController::Base.new
    ac.render_to_string(:partial => '/xray_bar').html_safe
  end
end
response_body(response) click to toggle source
# File lib/xray/middleware.rb, line 131
def response_body(response)
  body = ''
  response.each { |s| body << s.to_s }
  body
end
script_matcher(script_name) click to toggle source

Matches:

<script src="/assets/jquery.js"></script>
<script src="/assets/jquery-min.js"></script>
<script src="/assets/jquery.min.1.9.1.js"></script>
<script src="/assets/jquery.min.1.9.1-89255b9dbf3de2fbaa6754b3a00db431.js"></script>
# File lib/xray/middleware.rb, line 99
def script_matcher(script_name)
  /
    <script[^>]+
    \/#{script_name}
    (2|3)?                 # Optional jQuery version specification
    ([-.]{1}[\d\.]+)?      # Optional version identifier (e.g. -1.9.1)
    ([-.]{1}min)?          # Optional -min suffix
    (\.self)?              # Sprockets 3 appends .self to the filename
    (-\h{32,64})?          # Fingerprint varies based on Sprockets version
    \.js                   # Must have .js extension
    [^>]+><\/script>
  /x
end