web-console 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c224d95365158b5d6c2c74a723e0f980d6ec2cc1
-  data.tar.gz: 96c1809b1e11969901c710bd3d6f316bbc1221c5
+  metadata.gz: 02d40821ae813ac4e5893b4c853725833017cb46
+  data.tar.gz: 56b2826919677b8a93e6ecedce69a176949d15ee
 SHA512:
-  metadata.gz: 43fb7f5387311dde55c6464a64ff9f9498486b7afc35f7c0254c851ce77027d288b190cfdd73c56bfebf7987e87d3f33315f7c626fef97b4da044892dbf135c5
-  data.tar.gz: 51395dfa02548a44395e5bffa801d3c28a4e95b556fa1982ba7045d279871e1c98de4e0bf1fd1b6a5273348ac5ad3c405bde530ffa394d6becab9ea39cf24bc3
+  metadata.gz: 6c6a07f241b5bfad39c7a588ac92bccc8f0786db1b807d3ab94b4ec13464d7d8514493634c88247a868e78e43169094d216da6f01c3559be45af39854a76a0a0
+  data.tar.gz: 4b656f08efb441715996f541f94806d9f6249171502fded529041c5fc5cead0a73ce4f155fe246f0c4a36c4a0b54f9bdd65fb3091ed5e9b9bfa86b9d95f3a552

data/CHANGELOG.markdown

@@ -2,9 +2,14 @@
 
 ## master (unreleased)
 
+## 2.3.0
+
+* [#181](https://github.com/rails/web-console/pull/181) Log internal Web Console errors ([@schneems])
+* [#150](https://github.com/rails/web-console/pull/150) Revert #150. ([@gsamokovarov])
+
 ## 2.2.1
 
-* [#150](https://github.com/rails/web-console/pull/150) Change config.development_only default until 4.2.4 is released.
+* [#150](https://github.com/rails/web-console/pull/150) Change config.development_only default until 4.2.4 is released. ([@gsamokovarov])
 
 ## 2.2.0
 
@@ -48,3 +53,4 @@
 [@parterburn]: https://github.com/parterburn
 [@sh19910711]: https://github.com/sh19910711
 [@frenesim]: https://github.com/frenesim
+[@schneems]: https://github.com/schneems

data/README.markdown

@@ -161,6 +161,18 @@ end
 You may wanna check the [templates] folder at the source tree for the files you
 may override.
 
+### config.web_console.mount_point
+
+Usually the middleware of _Web Console_ is mounted at `/__web_console`.
+If you wanna change the path for some reasons, you can specify it
+by `config.web_console.mount_point`:
+
+```ruby
+Rails.application.configure do
+  config.web_console.mount_point = '/path/to/web_console'
+end
+```
+
 ## FAQ
 
 ### Where did /console go?

data/Rakefile

@@ -8,6 +8,8 @@ require 'socket'
 require 'rake/testtask'
 require 'tmpdir'
 require 'securerandom'
+require 'json'
+require 'web_console/testing/erb_precompiler'
 
 EXPANDED_CWD = File.expand_path(File.dirname(__FILE__))
 
@@ -18,40 +20,7 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-namespace :test do
-  desc "Run tests for templates"
-  task :templates => "templates:all"
-
-  namespace :templates do
-    task :all   => [:daemonize, :npm, :rackup, :mocha, :kill]
-    task :serve => [:npm, :rackup]
-
-    work_dir    = Pathname(__FILE__).dirname.join("test/templates")
-    pid_file    = Pathname(Dir.tmpdir).join("web_console.#{SecureRandom.uuid}.pid")
-    server_port = 29292
-    rackup_opts = "-p #{server_port}"
-
-    task :daemonize do
-      rackup_opts += " -D -P #{pid_file}"
-    end
-
-    task :npm do
-      Dir.chdir(work_dir) { system "npm install --silent" }
-    end
-
-    task :rackup do
-      Dir.chdir(work_dir) { system "bundle exec rackup #{rackup_opts}" }
-    end
-
-    task :mocha do
-      Dir.chdir(work_dir) { system "$(npm bin)/mocha-phantomjs http://localhost:#{server_port}/html/spec_runner.html" }
-    end
-
-    task :kill do
-      system "kill #{File.read pid_file}"
-    end
-  end
-end
+Dir['lib/web_console/tasks/**/*.rake'].each { |task| load task  }
 
 Bundler::GemHelper.install_tasks
 

data/lib/web_console.rb

@@ -13,6 +13,8 @@ require 'web_console/template'
 require 'web_console/middleware'
 require 'web_console/whitelist'
 require 'web_console/request'
+require 'web_console/response'
+require 'web_console/view'
 require 'web_console/whiny_request'
 
 module WebConsole

data/lib/web_console/extensions.rb

@@ -1,6 +1,9 @@
 ActionDispatch::DebugExceptions.class_eval do
-  def render_exception_with_web_console(env, exception)
-    render_exception_without_web_console(env, exception).tap do
+  def render_exception_with_web_console(request, exception)
+    render_exception_without_web_console(request, exception).tap do
+      # Retain superficial Rails 5 compatibility.
+      env = Hash === request ? request : request.env
+
       error = ActionDispatch::ExceptionWrapper.new(env, exception).exception
 
       # Get the original exception if ExceptionWrapper decides to follow it.

data/lib/web_console/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  errors:
+    unavailable_session: |
+      Session %{id} is is no longer available in memory.
+
+      If you happen to run on a multi-process server (like Unicorn or Puma) the process
+      this request hit doesn't store %{id} in memory. Consider turning the number of
+      processes/workers to one (1) or using a different server in development.
+
+    unacceptable_request: |
+      A supported version is expected in the Accept header.
+
+    connection_refused: |
+      Oops! Failed to connect to the Web Console middleware.
+      Please make sure a rails development server is running.

data/lib/web_console/middleware.rb

@@ -4,60 +4,60 @@ module WebConsole
   class Middleware
     TEMPLATES_PATH = File.expand_path('../templates', __FILE__)
 
-    DEFAULT_OPTIONS = {
-      update_re: %r{/repl_sessions/(?<id>.+?)\z},
-      binding_change_re: %r{/repl_sessions/(?<id>.+?)/trace\z}
-    }
-
-    UNAVAILABLE_SESSION_MESSAGE = <<-END.strip_heredoc
-      Session %{id} is is no longer available in memory.
-
-      If you happen to run on a multi-process server (like Unicorn) the process
-      this request hit doesn't store %{id} in memory.
-    END
-
-    UNACCEPTABLE_REQUEST_MESSAGE = "A supported version is expected in the Accept header."
+    cattr_accessor :mount_point
+    @@mount_point = '/__web_console'
 
     cattr_accessor :whiny_requests
     @@whiny_requests = true
 
-    def initialize(app, options = {})
-      @app     = app
-      @options = DEFAULT_OPTIONS.merge(options)
+    def initialize(app)
+      @app = app
     end
 
     def call(env)
-      request = create_regular_or_whiny_request(env)
-      return @app.call(env) unless request.from_whitelited_ip?
-
-      if id = id_for_repl_session_update(request)
-        return update_repl_session(id, request)
-      elsif id = id_for_repl_session_stack_frame_change(request)
-        return change_stack_trace(id, request)
-      end
+      app_exception = catch :app_exception do
+        request = create_regular_or_whiny_request(env)
+        return @app.call(env) unless request.from_whitelited_ip?
+
+        if id = id_for_repl_session_update(request)
+          return update_repl_session(id, request)
+        elsif id = id_for_repl_session_stack_frame_change(request)
+          return change_stack_trace(id, request)
+        end
 
-      status, headers, body = @app.call(env)
+        status, headers, body = @app.call(env)
 
-      if exception = env['web_console.exception']
-        session = Session.from_exception(exception)
-      elsif binding = env['web_console.binding']
-        session = Session.from_binding(binding)
-      end
+        if exception = env['web_console.exception']
+          session = Session.from_exception(exception)
+        elsif binding = env['web_console.binding']
+          session = Session.from_binding(binding)
+        end
 
-      if session && request.acceptable_content_type?
-        headers["X-Web-Console-Session-Id"] = session.id
-        response = Rack::Response.new(body, status, headers)
-        template = Template.new(env, session)
+        if session && acceptable_content_type?(headers)
+          response = Response.new(body, status, headers)
+          template = Template.new(env, session)
 
-        response.write(template.render('index'))
-        response.finish
-      else
-        [ status, headers, body ]
+          response.headers["X-Web-Console-Session-Id"] = session.id
+          response.headers["X-Web-Console-Mount-Point"] = mount_point
+          response.write(template.render('index'))
+          response.finish
+        else
+          [ status, headers, body ]
+        end
       end
+    rescue => e
+      WebConsole.logger.error("\n#{e.class}: #{e}\n\tfrom #{e.backtrace.join("\n\tfrom ")}")
+      raise e
+    ensure
+      raise app_exception if Exception === app_exception
     end
 
     private
 
+      def acceptable_content_type?(headers)
+        Mime::Type.parse(headers['Content-Type']).first == Mime::HTML
+      end
+
       def json_response(opts = {})
         status  = opts.fetch(:status, 200)
         headers = { 'Content-Type' => 'application/json; charset = utf-8' }
@@ -67,17 +67,10 @@ module WebConsole
       end
 
       def json_response_with_session(id, request, opts = {})
-        json_response(opts) do
-          unless request.acceptable?
-            return respond_with_unacceptable_request
-          end
+        return respond_with_unacceptable_request unless request.acceptable?
+        return respond_with_unavailable_session(id) unless session = Session.find(id)
 
-          unless session = Session.find(id)
-            return respond_with_unavailable_session(id)
-          end
-
-          yield session
-        end
+        json_response(opts) { yield session }
       end
 
       def create_regular_or_whiny_request(env)
@@ -85,23 +78,27 @@ module WebConsole
         whiny_requests ? WhinyRequest.new(request) : request
       end
 
+      def repl_sessions_re
+        @_repl_sessions_re ||= %r{#{mount_point}/repl_sessions/(?<id>[^/]+)}
+      end
+
       def update_re
-        @options[:update_re]
+        @_update_re ||= %r{#{repl_sessions_re}\z}
       end
 
       def binding_change_re
-        @options[:binding_change_re]
+        @_binding_change_re ||= %r{#{repl_sessions_re}/trace\z}
       end
 
       def id_for_repl_session_update(request)
         if request.xhr? && request.put?
-          update_re.match(request.path_info) { |m| m[:id] }
+          update_re.match(request.path) { |m| m[:id] }
         end
       end
 
       def id_for_repl_session_stack_frame_change(request)
         if request.xhr? && request.post?
-          binding_change_re.match(request.path_info) { |m| m[:id] }
+          binding_change_re.match(request.path) { |m| m[:id] }
         end
       end
 
@@ -121,14 +118,20 @@ module WebConsole
 
       def respond_with_unavailable_session(id)
         json_response(status: 404) do
-          { output: format(UNAVAILABLE_SESSION_MESSAGE, id: id)}
+          { output: format(I18n.t('errors.unavailable_session'), id: id)}
         end
       end
 
       def respond_with_unacceptable_request
         json_response(status: 406) do
-          { error: UNACCEPTABLE_REQUEST_MESSAGE }
+          { output: I18n.t('errors.unacceptable_request') }
         end
       end
+
+      def call_app(env)
+        @app.call(env)
+      rescue => e
+        throw :app_exception, e
+      end
   end
 end

data/lib/web_console/railtie.rb

@@ -5,10 +5,6 @@ module WebConsole
     config.web_console = ActiveSupport::OrderedOptions.new
     config.web_console.whitelisted_ips = %w( 127.0.0.1 ::1 )
 
-    # See rails/web-console#150 and rails/rails#20319. Revert when Ruby on
-    # Rails 4.2.4 is released.
-    config.web_console.development_only = false
-
     initializer 'web_console.initialize' do
       require 'web_console/extensions'
 
@@ -43,6 +39,12 @@ module WebConsole
       app.middleware.insert_before ActionDispatch::DebugExceptions, Middleware
     end
 
+    initializer 'web_console.mount_point' do
+      if mount_point = config.web_console.mount_point
+        Middleware.mount_point = mount_point.chomp('/')
+      end
+    end
+
     initializer 'web_console.template_paths' do
       if template_paths = config.web_console.template_paths
         Template.template_paths.unshift(*Array(template_paths))
@@ -61,12 +63,8 @@ module WebConsole
       end
     end
 
-    # Leave this undocumented so we treat such content type misses as bugs,
-    # while still being able to help the affected users in the meantime.
-    initializer 'web_console.acceptable_content_types' do
-      if acceptable_content_types = config.web_console.acceptable_content_types
-        Request.acceptable_content_types.concat(Array(acceptable_content_types))
-      end
+    initializer 'i18n.load_path' do
+      config.i18n.load_path.concat(Dir[File.expand_path('../locales/*.yml', __FILE__)])
     end
   end
 end

data/lib/web_console/request.rb

@@ -1,11 +1,6 @@
 module WebConsole
   # Web Console tailored request object.
   class Request < ActionDispatch::Request
-    # While most of the servers will return blank content type if none given,
-    # Puma will return text/plain.
-    cattr_accessor :acceptable_content_types
-    @@acceptable_content_types = [Mime::HTML, Mime::TEXT, Mime::URL_ENCODED_FORM]
-
     # Configurable set of whitelisted networks.
     cattr_accessor :whitelisted_ips
     @@whitelisted_ips = Whitelist.new
@@ -23,16 +18,7 @@ module WebConsole
 
     # Determines the remote IP using our much stricter whitelist.
     def strict_remote_ip
-      GetSecureIp.new(env, whitelisted_ips).to_s
-    end
-
-    # Returns whether the request is from an acceptable content type.
-    #
-    # We can render a console for HTML and TEXT by default. If a client didn't
-    # specified any content type and the server returned it as blank, we'll
-    # render it as well.
-    def acceptable_content_type?
-      content_type.blank? || content_type.in?(acceptable_content_types)
+      GetSecureIp.new(self, whitelisted_ips).to_s
     end
 
     # Returns whether the request is acceptable.
@@ -40,18 +26,25 @@ module WebConsole
       xhr? && accepts.any? { |mime| Mime::WEB_CONSOLE_V2 == mime }
     end
 
-    class GetSecureIp < ActionDispatch::RemoteIp::GetIp
-      def initialize(env, proxies)
-        @env      = env
-        @check_ip = true
-        @proxies  = proxies
-      end
+    private
+
+      class GetSecureIp < ActionDispatch::RemoteIp::GetIp
+        def initialize(req, proxies)
+          # After rails/rails@07b2ff0 ActionDispatch::RemoteIp::GetIp initializes
+          # with a ActionDispatch::Request object instead of plain Rack
+          # environment hash. Keep both @req and @env here, so we don't if/else
+          # on Rails versions.
+          @req      = req
+          @env      = req.env
+          @check_ip = true
+          @proxies  = proxies
+        end
 
-      def filter_proxies(ips)
-        ips.reject do |ip|
-          @proxies.include?(ip)
+        def filter_proxies(ips)
+          ips.reject do |ip|
+            @proxies.include?(ip)
+          end
         end
       end
-    end
   end
 end

data/lib/web_console/response.rb

@@ -0,0 +1,23 @@
+module WebConsole
+  # A response object that writes content before the closing </body> tag, if
+  # possible.
+  #
+  # The object quacks like Rack::Response.
+  class Response < Struct.new(:body, :status, :headers)
+    def write(content)
+      raw_body = Array(body).first.to_s
+
+      if position = raw_body.rindex('</body>')
+        raw_body.insert(position, content)
+      else
+        raw_body << content
+      end
+
+      self.body = raw_body
+    end
+
+    def finish
+      Rack::Response.new(body, status, headers).finish
+    end
+  end
+end

data/lib/web_console/tasks/extensions.rake

@@ -0,0 +1,60 @@
+namespace :ext do
+  rootdir = Pathname('extensions')
+
+  desc 'Build Chrome Extension'
+  task chrome: 'chrome:build'
+
+  namespace :chrome do
+    dist   = Pathname('dist/crx')
+    extdir = rootdir.join(dist)
+    manifest_json = rootdir.join('chrome/manifest.json')
+
+    directory extdir
+
+    task build: [ extdir, 'lib:templates' ] do
+      cd rootdir do
+        cp_r [ 'img/', 'tmp/lib/' ], dist
+        `cd chrome && git ls-files`.split("\n").each do |src|
+          dest = dist.join(src)
+          mkdir_p dest.dirname
+          cp Pathname('chrome').join(src), dest
+        end
+      end
+    end
+
+    # Generate a .crx file.
+    task crx: [ :build, :npm ] do
+      out = "crx-web-console-#{JSON.parse(File.read(manifest_json))["version"]}.crx"
+      cd(extdir) { sh "node \"$(npm bin)/crx\" pack ./ -p ../crx-web-console.pem -o ../#{out}" }
+    end
+
+    # Generate a .zip file for Chrome Web Store.
+    task zip: [ :build ] do
+      version = JSON.parse(File.read(manifest_json))["version"]
+      cd(extdir) { sh "zip -r ../crx-web-console-#{version}.zip ./" }
+    end
+
+    desc 'Launch a browser with the chrome extension.'
+    task run: [ :build ] do
+      cd(rootdir) { sh "sh ./script/run_chrome.sh --load-extension=#{dist}" }
+    end
+  end
+
+  task :npm do
+    cd(rootdir) { sh "npm install --silent" }
+  end
+
+  namespace :lib do
+    templates = Pathname('lib/web_console/templates')
+    tmplib    = rootdir.join('tmp/lib/')
+    js_erb    = FileList.new(templates.join('**/*.js.erb'))
+    dirs      = js_erb.pathmap("%{^#{templates},#{tmplib}}d")
+
+    task templates: dirs + js_erb.pathmap("%{^#{templates},#{tmplib}}X")
+
+    dirs.each { |d| directory d }
+    rule '.js' => [ "%{^#{tmplib},#{templates}}X.js.erb" ] do |t|
+      File.write(t.name, WebConsole::Testing::ERBPrecompiler.new(t.source).build)
+    end
+  end
+end

data/lib/web_console/tasks/test_templates.rake

@@ -0,0 +1,50 @@
+namespace :test do
+  desc "Run tests for templates"
+  task templates: "templates:all"
+
+  namespace :templates do
+    task all: [ :daemonize, :npm, :rackup, :wait, :mocha, :kill, :exit ]
+    task serve: [ :npm, :rackup ]
+
+    work_dir    = Pathname(EXPANDED_CWD).join("test/templates")
+    pid_file    = Pathname(Dir.tmpdir).join("web_console.#{SecureRandom.uuid}.pid")
+    runner_uri  = URI.parse("http://localhost:29292/html/spec_runner.html")
+    rackup_opts = "-p #{runner_uri.port}"
+    test_result = nil
+
+    def need_to_wait?(uri)
+      Net::HTTP.start(uri.host, uri.port) { |http| http.get(uri.path) }
+    rescue Errno::ECONNREFUSED
+      retry if yield
+    end
+
+    task :daemonize do
+      rackup_opts += " -D -P #{pid_file}"
+    end
+
+    task :npm do
+      Dir.chdir(work_dir) { system "npm install --silent" }
+    end
+
+    task :rackup do
+      Dir.chdir(work_dir) { system "bundle exec rackup #{rackup_opts}" }
+    end
+
+    task :wait do
+      cnt = 0
+      need_to_wait?(runner_uri) { sleep 1; cnt += 1; cnt < 5 }
+    end
+
+    task :mocha do
+      Dir.chdir(work_dir) { test_result = system("$(npm bin)/mocha-phantomjs #{runner_uri}") }
+    end
+
+    task :kill do
+      system "kill #{File.read pid_file}"
+    end
+
+    task :exit do
+      exit test_result
+    end
+  end
+end

data/lib/web_console/template.rb

@@ -4,33 +4,6 @@ module WebConsole
   # It introduces template helpers to ease the inclusion of scripts only on
   # Rails error pages.
   class Template
-    class Context < ActionView::Base
-      # Execute a block only on error pages.
-      #
-      # The error pages are special, because they are the only pages that
-      # currently require multiple bindings. We get those from exceptions.
-      def only_on_error_page(*args)
-        yield if @env['web_console.exception'].present?
-      end
-
-      # Render JavaScript inside a script tag and a closure.
-      #
-      # This one lets write JavaScript that will automatically get wrapped in a
-      # script tag and enclosed in a closure, so you don't have to worry for
-      # leaking globals, unless you explicitly want to.
-      def render_javascript(template)
-        render(template: template, layout: 'layouts/javascript')
-      end
-
-      # Render inlined string to be used inside of JavaScript code.
-      #
-      # The inlined string is returned as an actual JavaScript string. You
-      # don't need to wrap the result yourself.
-      def render_inlined_string(template)
-        render(template: template, layout: 'layouts/inlined_string')
-      end
-    end
-
     # Lets you customize the default templates folder location.
     cattr_accessor :template_paths
     @@template_paths = [ File.expand_path('../templates', __FILE__) ]
@@ -38,12 +11,13 @@ module WebConsole
     def initialize(env, session)
       @env = env
       @session = session
+      @mount_point = Middleware.mount_point
     end
 
     # Render a template (inferred from +template_paths+) as a plain string.
     def render(template)
-      context = Context.new(template_paths, instance_values)
-      context.render(template: template, layout: false)
+      view = View.new(template_paths, instance_values)
+      view.render(template: template, layout: false)
     end
   end
 end

data/lib/web_console/templates/_markup.html.erb

@@ -1,4 +1,5 @@
 <div id="console"
-  data-remote-path='<%= "console/repl_sessions/#{@session.id}" %>'
-  data-initial-prompt='>> '>
+  data-mount-point='<%= @mount_point %>'
+  data-session-id='<%= @session.id %>'
+  data-prompt-label='>> '>
 </div>

data/lib/web_console/templates/console.js.erb

@@ -54,11 +54,69 @@ var styleElementId = 'sr02459pvbvrmhco';
 
 // REPLConsole Constructor
 function REPLConsole(config) {
+  function getConfig(key, defaultValue) {
+    return config && config[key] || defaultValue;
+  }
+
   this.commandStorage = new CommandStorage();
-  this.prompt = config && config.promptLabel ? config.promptLabel : ' >>';
-  this.commandHandle = config && config.commandHandle ? config.commandHandle : function() { return this; }
+  this.prompt = getConfig('promptLabel', ' >>');
+  this.mountPoint = getConfig('mountPoint');
+  this.sessionId = getConfig('sessionId');
 }
 
+REPLConsole.prototype.getSessionUrl = function(path) {
+  var parts = [ this.mountPoint, 'repl_sessions', this.sessionId ];
+  if (path) {
+    parts.push(path);
+  }
+  // Join and remove duplicate slashes.
+  return parts.join('/').replace(/([^:]\/)\/+/g, '$1');
+};
+
+REPLConsole.prototype.commandHandle = function(line, callback) {
+  var self = this;
+  var params = 'input=' + encodeURIComponent(line);
+  callback = callback || function() {};
+
+  function isSuccess(status) {
+    return status >= 200 && status < 300 || status === 304;
+  }
+
+  function parseJSON(text) {
+    try {
+      return JSON.parse(text);
+    } catch (e) {
+      return null;
+    }
+  }
+
+  function getErrorText(xhr) {
+    if (!xhr.status) {
+      return "<%= t 'errors.connection_refused' %>";
+    } else {
+      return xhr.status + ' ' + xhr.statusText;
+    }
+  }
+
+  putRequest(self.getSessionUrl(), params, function(xhr) {
+    var response = parseJSON(xhr.responseText);
+    var result   = isSuccess(xhr.status);
+    if (result) {
+      self.writeOutput(response.output);
+    } else {
+      if (response && response.output) {
+        self.writeError(response.output);
+      } else {
+        self.writeError(getErrorText(xhr));
+      }
+    }
+    callback(result, response);
+  });
+};
+
+REPLConsole.prototype.uninstall = function() {
+  this.container.parentNode.removeChild(this.container);
+};
 
 REPLConsole.prototype.install = function(container) {
   var _this = this;
@@ -99,8 +157,8 @@ REPLConsole.prototype.install = function(container) {
 
   // Make the console resizable.
   function resizeContainer(ev) {
-    var startY                   = ev.clientY;
-    var startHeight              = parseInt(document.defaultView.getComputedStyle(container).height, 10);
+    var startY              = ev.clientY;
+    var startHeight         = parseInt(document.defaultView.getComputedStyle(container).height, 10);
     var scrollTopStart      = consoleOuter.scrollTop;
     var clientHeightStart   = consoleOuter.clientHeight;
 
@@ -137,10 +195,10 @@ REPLConsole.prototype.install = function(container) {
   }
 
   // Initialize
+  this.container = container;
   this.outer = consoleOuter;
   this.inner = findChild(this.outer, 'console-inner');
   this.clipboard = findChild(container, 'clipboard');
-  this.remotePath = container.dataset.remotePath;
   this.newPromptBox();
   this.insertCss();
 
@@ -263,6 +321,13 @@ REPLConsole.prototype.writeOutput = function(output) {
   consoleMessage.innerHTML = escapeHTML(output);
   this.inner.appendChild(consoleMessage);
   this.newPromptBox();
+  return consoleMessage;
+};
+
+REPLConsole.prototype.writeError = function(output) {
+  var consoleMessage = this.writeOutput(output);
+  addClass(consoleMessage, "error-message");
+  return consoleMessage;
 };
 
 REPLConsole.prototype.onEnterKey = function() {
@@ -385,7 +450,7 @@ REPLConsole.prototype.scrollToBottom = function() {
 
 // Change the binding of the console
 REPLConsole.prototype.switchBindingTo = function(frameId, callback) {
-  var url = this.remotePath + "/trace";
+  var url = this.getSessionUrl('trace');
   var params = "frame_id=" + encodeURIComponent(frameId);
   postRequest(url, params, callback);
 };
@@ -394,22 +459,16 @@ REPLConsole.prototype.switchBindingTo = function(frameId, callback) {
  * Install the console into the element with a specific ID.
  * Example: REPLConsole.installInto("target-id")
  */
-REPLConsole.installInto = function(id) {
+REPLConsole.installInto = function(id, options) {
   var consoleElement = document.getElementById(id);
-  var remotePath = consoleElement.dataset.remotePath;
-  var replConsole = new REPLConsole({
-    promptLabel: consoleElement.dataset.initialPrompt,
-    commandHandle: function(line) {
-      var _this = this;
-      var url = remotePath;
-      var params = "input=" + encodeURIComponent(line);
-      putRequest(url, params, function(xhr) {
-        var response = JSON.parse(xhr.responseText);
-        _this.writeOutput(response.output);
-      });
-    }
-  });
 
+  options = options || {};
+
+  for (var prop in consoleElement.dataset) {
+    options[prop] = options[prop] || consoleElement.dataset[prop];
+  }
+
+  var replConsole = new REPLConsole(options);
   replConsole.install(consoleElement);
   return replConsole;
 };
@@ -419,6 +478,26 @@ REPLConsole.installInto = function(id) {
 // It allows to operate the current session from the other scripts.
 REPLConsole.currentSession = null;
 
+// This line is for the Firefox Add-on, because it doesn't have XMLHttpRequest as default.
+// And so we need to require a module compatible with XMLHttpRequest from SDK.
+REPLConsole.XMLHttpRequest = typeof XMLHttpRequest === 'undefined' ? null : XMLHttpRequest;
+
+REPLConsole.request = function request(method, url, params, callback) {
+  var xhr = new REPLConsole.XMLHttpRequest();
+
+  xhr.open(method, url, true);
+  xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+  xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
+  xhr.setRequestHeader("Accept", "<%= Mime::WEB_CONSOLE_V2 %>");
+  xhr.send(params);
+
+  xhr.onreadystatechange = function() {
+    if (xhr.readyState === 4) {
+      callback(xhr);
+    }
+  };
+};
+
 // DOM helpers
 function hasClass(el, className) {
   var regex = new RegExp('(?:^|\\s)' + className + '(?!\\S)', 'g');
@@ -470,28 +549,16 @@ function escapeHTML(html) {
 }
 
 // XHR helpers
-function request(method, url, params, callback) {
-  var xhr = new XMLHttpRequest();
-
-  xhr.open(method, url, true);
-  xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
-  xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
-  xhr.setRequestHeader("Accept", "<%= Mime::WEB_CONSOLE_V2 %>");
-  xhr.send(params);
-
-  xhr.onreadystatechange = function() {
-    if (xhr.readyState === 4) {
-      callback(xhr);
-    }
-  }
+function postRequest() {
+  REPLConsole.request.apply(this, ["POST"].concat([].slice.call(arguments)));
 }
 
-function postRequest(url, params, callback) {
-  request("POST", url, params, callback);
+function putRequest() {
+  REPLConsole.request.apply(this, ["PUT"].concat([].slice.call(arguments)));
 }
 
-function putRequest(url, params, callback) {
-  request("PUT", url, params, callback);
+if (typeof exports === 'object') {
+  exports.REPLConsole = REPLConsole;
+} else {
+  window.REPLConsole = REPLConsole;
 }
-
-window.REPLConsole = REPLConsole;

data/lib/web_console/templates/style.css.erb

@@ -10,6 +10,7 @@
 .console .console-inner { font-family: monospace; font-size: 11px; width: 100%; height: 100%; overflow: none; background: #333; }
 .console .console-prompt-box { color: #FFF; }
 .console .console-message { color: #1AD027; margin: 0; border: 0; white-space: pre-wrap; background-color: #333; padding: 0; }
+.console .console-message.error-message { color: #fc9; }
 .console .console-focus .console-cursor { background: #FEFEFE; color: #333; font-weight: bold; }
 .console .resizer { background: #333; width: 100%; height: 4px; cursor: ns-resize; }
 .console .console-actions { padding-right: 3px; }
@@ -20,3 +21,7 @@
 .console .clipboard { height: 0px; padding: 0px; margin: 0px; width: 0px; margin-left: -1000px; }
 .console .console-prompt-label { display: inline; color: #FFF; background: none repeat scroll 0% 0% #333; border: 0; padding: 0; }
 .console .console-prompt-display { display: inline; color: #FFF; background: none repeat scroll 0% 0% #333; border: 0; padding: 0; }
+.console.full-screen { height: 100%; }
+.console.full-screen .console-outer { padding-top: 3px; }
+.console.full-screen .resizer { display: none; }
+.console.full-screen .close-button { display: none; }

data/lib/web_console/testing/erb_precompiler.rb

@@ -0,0 +1,25 @@
+require 'web_console/testing/helper'
+require 'web_console/testing/fake_middleware'
+
+module WebConsole
+  module Testing
+    # This class is to pre-compile 'templates/*.erb'.
+    class ERBPrecompiler
+      def initialize(path)
+        @erb  = ERB.new(File.read(path))
+        @view = FakeMiddleware.new(
+          view_path: Helper.gem_root.join('lib/web_console/templates'),
+        ).view
+      end
+
+      def build
+        @erb.result(binding)
+      end
+
+      def method_missing(name, *args, &block)
+        return super unless @view.respond_to?(name)
+        @view.send(name, *args, &block)
+      end
+    end
+  end
+end

data/lib/web_console/testing/fake_middleware.rb

@@ -0,0 +1,43 @@
+require 'action_view'
+require 'action_dispatch'
+require 'active_support/core_ext/string/access'
+require 'json'
+require 'web_console/whitelist'
+require 'web_console/request'
+require 'web_console/view'
+require 'web_console/testing/helper'
+
+module WebConsole
+  module Testing
+    class FakeMiddleware
+      I18n.load_path.concat(Dir[Helper.gem_root.join('lib/web_console/locales/*.yml')])
+
+      DEFAULT_HEADERS = { "Content-Type" => "application/javascript" }
+
+      def initialize(opts)
+        @headers        = opts.fetch(:headers, DEFAULT_HEADERS)
+        @req_path_regex = opts[:req_path_regex]
+        @view_path      = opts[:view_path]
+      end
+
+      def call(env)
+        [ 200, @headers, [ render(req_path(env)) ] ]
+      end
+
+      def view
+        @view ||= View.new(@view_path)
+      end
+
+      private
+
+        # extract target path from REQUEST_PATH
+        def req_path(env)
+          env["REQUEST_PATH"].match(@req_path_regex)[1]
+        end
+
+        def render(template)
+          view.render(template: template, layout: nil)
+        end
+    end
+  end
+end

data/lib/web_console/testing/helper.rb

@@ -0,0 +1,9 @@
+module WebConsole
+  module Testing
+    module Helper
+      def self.gem_root
+        Pathname(File.expand_path('../../../../', __FILE__))
+      end
+    end
+  end
+end

data/lib/web_console/version.rb

@@ -1,3 +1,3 @@
 module WebConsole
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/lib/web_console/view.rb

@@ -0,0 +1,37 @@
+module WebConsole
+  class View < ActionView::Base
+    # Execute a block only on error pages.
+    #
+    # The error pages are special, because they are the only pages that
+    # currently require multiple bindings. We get those from exceptions.
+    def only_on_error_page(*args)
+      yield if @env['web_console.exception'].present?
+    end
+
+    # Render JavaScript inside a script tag and a closure.
+    #
+    # This one lets write JavaScript that will automatically get wrapped in a
+    # script tag and enclosed in a closure, so you don't have to worry for
+    # leaking globals, unless you explicitly want to.
+    def render_javascript(template)
+      render(template: template, layout: 'layouts/javascript')
+    end
+
+    # Render inlined string to be used inside of JavaScript code.
+    #
+    # The inlined string is returned as an actual JavaScript string. You
+    # don't need to wrap the result yourself.
+    def render_inlined_string(template)
+      render(template: template, layout: 'layouts/inlined_string')
+    end
+
+    # Override method for ActionView::Helpers::TranslationHelper#t.
+    #
+    # This method escapes the original return value for JavaScript, since the
+    # method returns a HTML tag with some attributes when the key is not found,
+    # so it could cause a syntax error if we use the value in the string literals.
+    def t(key, options = {})
+      j super
+    end
+  end
+end

data/lib/web_console/whiny_request.rb

@@ -11,13 +11,6 @@ module WebConsole
       end
     end
 
-    def acceptable_content_type?
-      whine_unless request.acceptable_content_type? do
-        "Cannot render console with content type #{request.content_type}" \
-          "Allowed content types: #{request.acceptable_content_types}"
-      end
-    end
-
     private
 
       def whine_unless(condition)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web-console
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Charlie Somerville
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -127,10 +127,14 @@ files:
 - lib/web_console/integration/cruby.rb
 - lib/web_console/integration/jruby.rb
 - lib/web_console/integration/rubinius.rb
+- lib/web_console/locales/en.yml
 - lib/web_console/middleware.rb
 - lib/web_console/railtie.rb
 - lib/web_console/request.rb
+- lib/web_console/response.rb
 - lib/web_console/session.rb
+- lib/web_console/tasks/extensions.rake
+- lib/web_console/tasks/test_templates.rake
 - lib/web_console/template.rb
 - lib/web_console/templates/_inner_console_markup.html.erb
 - lib/web_console/templates/_markup.html.erb
@@ -142,8 +146,11 @@ files:
 - lib/web_console/templates/layouts/javascript.erb
 - lib/web_console/templates/main.js.erb
 - lib/web_console/templates/style.css.erb
-- lib/web_console/tracer.rb
+- lib/web_console/testing/erb_precompiler.rb
+- lib/web_console/testing/fake_middleware.rb
+- lib/web_console/testing/helper.rb
 - lib/web_console/version.rb
+- lib/web_console/view.rb
 - lib/web_console/whiny_request.rb
 - lib/web_console/whitelist.rb
 homepage: https://github.com/rails/web-console
@@ -166,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A debugging tool for your Ruby on Rails applications.

data/lib/web_console/tracer.rb

@@ -1,11 +0,0 @@
-module WebConsole
-  class BindingTracer
-    def initialize(exception)
-      @bindings  = exception.bindings
-      @backtrace = exception.backtrace
-    end
-
-    def binding_for_trace(trace)
-    end
-  end
-end