web-console 2.0.0 → 2.1.0

data/lib/assets/javascripts/web-console.js

@@ -1 +0,0 @@
-//= require ./web_console

data/lib/assets/javascripts/web_console.js

@@ -1,41 +0,0 @@
-//= require term
-
-;(function(BaseTerminal) {
-
-  // Expose the main WebConsole namespace.
-  var WebConsole = this.WebConsole = {};
-
-  // Follow term.js example and expose inherits and EventEmitter.
-  var inherits = WebConsole.inherits = BaseTerminal.inherits;
-  var EventEmitter = WebConsole.EventEmitter = BaseTerminal.EventEmitter;
-
-  var Terminal = WebConsole.Terminal = function(options) {
-    if (typeof options === 'number') {
-      return BaseTerminal.apply(this, arguments);
-    }
-
-    BaseTerminal.call(this, options || (options = {}));
-
-    this.open();
-
-    if (!(options.rows || options.cols) || !options.geometry) {
-      this.fitScreen();
-    }
-  };
-
-  // Make WebConsole.Terminal inherit from BaseTerminal (term.js).
-  inherits(Terminal, BaseTerminal);
-
-  Terminal.prototype.fitScreen = function() {
-    var width  = Math.floor(this.element.clientWidth / this.cols);
-    var height = Math.floor(this.element.clientHeight / this.rows);
-
-    var rows = Math.floor(window.innerHeight / height);
-    var cols = Math.floor(this.parent.clientWidth / width);
-
-    this.resize(cols, rows);
-
-    return [cols, rows];
-  };
-
-}).call(this, Terminal);

data/lib/web_console/controller_helpers.rb

@@ -1,46 +0,0 @@
-module WebConsole
-  module ControllerHelpers
-    extend ActiveSupport::Concern
-
-    included do
-      # Flag to decide whether the console should be rendered.
-      attr_internal :console_already_rendered
-
-      # Storage of a binding the console to be rendered in.
-      attr_internal :console_binding
-
-      prepend_after_action :inject_console_into_view
-    end
-
-    # Helper for capturing a controller binding to prepare for console
-    # rendering.
-    def console(binding = nil)
-      @_console_binding = binding || ::Kernel.binding.of_caller(1)
-    end
-
-    private
-
-      # Attempt to inject an interactive console to a view.
-      def inject_console_into_view
-        return unless can_render_console?
-
-        console_html = ActionView::Base.new(ActionController::Base.view_paths,
-          console_session: REPLSession.create(binding: @_console_binding)
-        ).render(partial: 'rescues/web_console')
-
-        response.body = response.body + console_html
-      end
-
-      def can_render_console?
-        console_binding && !console_already_rendered && html_format? && whitelisted_ip?
-      end
-
-      def html_format?
-        content_type == Mime::HTML
-      end
-
-      def whitelisted_ip?
-        request.remote_ip.in?(WebConsole.config.whitelisted_ips)
-      end
-  end
-end

data/lib/web_console/core_ext/exception.rb

@@ -1,7 +0,0 @@
-if defined? JRUBY_VERSION
-  require 'web_console/core_ext/exception/jruby'
-elsif RUBY_ENGINE == 'rbx'
-  require 'web_console/core_ext/exception/rubinius'
-else
-  require 'web_console/core_ext/exception/cruby'
-end

data/lib/web_console/core_ext/exception/jruby.rb

@@ -1,25 +0,0 @@
-class Exception
-  # The bindings in which the exception originated in.
-  def bindings
-    @bindings || []
-  end
-
-  # JRuby won't call Exception#set_backtrace when raising, so we can't hook in
-  # there. Our best bet is to hook into Exception#initialize, however we have
-  # the problem that a subclass may forget to call super in its override.
-  def initialize_with_binding_of_caller(*args)
-    unless Thread.current[:__web_console_exception_lock]
-      Thread.current[:__web_console_exception_lock] = true
-      begin
-        @bindings = binding.callers.drop(1)
-      ensure
-        Thread.current[:__web_console_exception_lock] = false
-      end
-    end
-
-    initialize_without_binding_of_caller(*args)
-  end
-
-  alias_method_chain :initialize, :binding_of_caller
-end
-

data/lib/web_console/core_ext/exception/rubinius.rb

@@ -1,32 +0,0 @@
-class Exception
-  # The bindings in which the exception originated in.
-  def bindings
-    @bindings || []
-  end
-
-  # Rubinius, as JRuby, won't call Exception#set_backtrace. This means we'll
-  # miss custom exceptions overriding #initialize, but forgetting to call
-  # super.
-  def initialize_with_binding_of_caller(*args)
-    unless Thread.current[:__web_console_exception_lock]
-      Thread.current[:__web_console_exception_lock] = true
-      begin
-        @bindings = binding.callers.drop(2)
-
-        # When explicitly raising an exception, we have to drop one more frame
-        # on Rubinius. The way we do it is pretty bad as it strongly depends on
-        # the Kerner#raise implementation details. We need to do better in the
-        # future.
-        if _ = @bindings.first and _.eval('local_variables') == [:exc, :msg, :ctx, :skip, :loc, :pos]
-          @bindings.shift
-        end
-      ensure
-        Thread.current[:__web_console_exception_lock] = false
-      end
-    end
-
-    initialize_without_binding_of_caller(*args)
-  end
-
-  alias_method_chain :initialize, :binding_of_caller
-end

data/lib/web_console/engine.rb

@@ -1,47 +0,0 @@
-require 'ipaddr'
-require 'rails/engine'
-
-require 'active_model'
-require 'sprockets/rails'
-
-module WebConsole
-  class Engine < ::Rails::Engine
-    config.web_console = ActiveSupport::OrderedOptions.new
-    config.web_console.whitelisted_ips = %w( 127.0.0.1 ::1 )
-
-    initializer "web_console.initialize_view_helpers" do
-      ActiveSupport.on_load :action_view do
-        include WebConsole::ViewHelpers
-      end
-
-      ActiveSupport.on_load :action_controller do
-        prepend_view_path File.dirname(__FILE__) + '/../action_dispatch/templates'
-        include WebConsole::ControllerHelpers
-      end
-    end
-
-    initializer 'web_console.process_whitelisted_ips' do
-      config.web_console.tap do |c|
-        # Ensure that it is an array of IPAddr instances and it is defaulted to
-        # 127.0.0.1 if not precent. Only unique entries are left in the end.
-        c.whitelisted_ips = Array(c.whitelisted_ips).map { |ip|
-          if ip.is_a?(IPAddr)
-            ip
-          else
-            IPAddr.new(ip.presence || '127.0.0.1')
-          end
-        }.uniq
-
-        # IPAddr instances can cover whole networks, so simplify the #include?
-        # check for the most common case.
-        def (c.whitelisted_ips).include?(ip)
-          if ip.is_a?(IPAddr)
-            super
-          else
-            any? { |net| net.include?(ip.to_s) }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/web_console/repl_session.rb

@@ -1,89 +0,0 @@
-module WebConsole
-  class REPLSession
-    include ActiveModel::Serializers::JSON
-
-    INMEMORY_STORAGE = {}
-
-    ATTRIBUTES = [ :id, :input, :output, :prompt, :binding, :binding_stack ].each do |attr|
-      attr_accessor attr
-    end
-
-    class NotFound < StandardError
-      def to_json(*)
-        { error: message }.to_json
-      end
-    end
-
-    class << self
-      # Finds a session by its id.
-      def find(id)
-        INMEMORY_STORAGE[id] or raise NotFound, 'Session unavailable'
-      end
-
-      # Creates an already persisted console session.
-      #
-      # Use this method if you need to persist a session, without providing it
-      # any input.
-      def create(attributes = {})
-        INMEMORY_STORAGE[(model = new(attributes)).id] = model
-      end
-    end
-
-    def initialize(attributes = {})
-      self.attributes = attributes
-      generate_secure_id!
-      populate_repl_attributes!(initial: true)
-    end
-
-    def binding=(binding)
-      @binding = binding
-      @repl = WebConsole::REPL.new(binding)
-    end
-
-    # Saves the model into the in-memory storage.
-    #
-    # Returns false if the model is not valid (e.g. its missing input).
-    def save(attributes = {})
-      self.attributes = attributes if attributes.present?
-      populate_repl_attributes!
-      store!
-    end
-
-    # Returns true if the current session is persisted in the in-memory storage.
-    def persisted?
-      self == INMEMORY_STORAGE[id]
-    end
-
-    protected
-
-      # Returns a hash of the attributes and their values.
-      def attributes
-        return Hash[ATTRIBUTES.zip([nil])].except(:binding, :binding_stack)
-      end
-
-      # Sets model attributes from a hash.
-      def attributes=(attributes)
-        attributes.each do |attr, value|
-          next unless ATTRIBUTES.include?(attr.to_sym)
-          public_send(:"#{attr}=", value)
-        end
-      end
-
-    private
-
-      def generate_secure_id!
-        self.id = SecureRandom.hex(16)
-      end
-
-      def populate_repl_attributes!(options = {})
-        # Don't send any input on the initial population so we don't bump up
-        # the numbers in the dynamic prompts.
-        self.output = @repl.send_input(input) unless options[:initial]
-        self.prompt = @repl.prompt
-      end
-
-      def store!
-        INMEMORY_STORAGE[id] = self
-      end
-  end
-end

data/lib/web_console/unsupported_platforms.rb

@@ -1,28 +0,0 @@
-module WebConsole
-  # Detect unsupported platforms and try to help the user, if there is
-  # something they can do about it.
-  #
-  # For example, not every JRuby mode is unsupported, we can guide the user
-  # what to do to enable support for that platform.
-  module UnsupportedPlatforms
-    class << self
-      def jruby_in_non_interpreted_mode
-        return unless RUBY_PLATFORM =~ /java/
-
-        compile_mode     = JRuby.runtime.instance_config.compile_mode
-        interpreted_mode = Java::OrgJruby::RubyInstanceConfig::CompileMode::OFF
-
-        yield if compile_mode != interpreted_mode
-      end
-    end
-
-    jruby_in_non_interpreted_mode do
-      warn <<-END.strip_heredoc
-        JRuby needs to run in interpreted mode for Web Console support.
-
-        To turn on interpreted mode, put -J-Djruby.compile.mode=OFF in the
-        JRUBY_OPTS environment variable.
-      END
-    end
-  end
-end

data/lib/web_console/view_helpers.rb

@@ -1,16 +0,0 @@
-module WebConsole
-  module ViewHelpers
-    def console(console_binding = nil)
-      return unless request.remote_ip.in?(WebConsole.config.whitelisted_ips)
-
-      console_binding ||= binding.of_caller(1)
-
-      unless controller.console_already_rendered
-        @console_session = WebConsole::REPLSession.create(binding: console_binding)
-
-        controller.console_already_rendered = true
-        render('rescues/web_console')
-      end
-    end
-  end
-end

data/test/action_pack/exception_wrapper_test.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-
-module ActionDispatch
-  class ExceptionWrapperTest < ActiveSupport::TestCase
-    class TestError < StandardError
-      attr_reader :backtrace
-
-      def initialize(*backtrace)
-        @backtrace = backtrace
-      end
-    end
-
-    test '#extract_sources fetches source fragments for every backtrace' do
-      exc = TestError.new("/test/controller.rb:9 in 'index'")
-
-      wrapper = ExceptionWrapper.new({}, exc)
-      wrapper.expects(:source_fragment).with('/test/controller.rb', 9).returns('some code')
-
-      assert_equal [{
-        code: 'some code',
-        file: '/test/controller.rb',
-        line_number: 9
-      }], wrapper.extract_sources
-    end
-  end
-end

data/test/controllers/tests_controller_test.rb

@@ -1,41 +0,0 @@
-require 'test_helper'
-
-class TestsControllerTest < ActionController::TestCase
-  tests TestsController
-
-  setup do
-    request.stubs(:remote_ip).returns('127.0.0.1')
-  end
-
-  test "injects a console into a view" do
-    get :render_console_ontop_of_text
-
-    assert_select "#console"
-  end
-
-  test "renders console only once" do
-    get :renders_console_only_once
-
-    assert_select "#console", 1
-  end
-
-  test "keeps the original content" do
-    get :render_console_ontop_of_text
-
-    assert_select "#greeting", "Hello World"
-  end
-
-  test "doesn't inject in non HTML views" do
-    get :doesnt_render_console_on_non_html_requests
-
-    assert_no_match %r{#console}, @response.body
-  end
-
-  test "doesn't inject on requests from non whitelisted IPs" do
-    request.stubs(:remote_ip).returns('192.168.0.100')
-
-    get :render_console_ontop_of_text
-
-    assert_select "#console", 0
-  end
-end

data/test/web_console/core_ext/exception_test.rb

@@ -1,46 +0,0 @@
-require 'test_helper'
-
-module WebConsole
-  class ExceptionTest < ActiveSupport::TestCase
-    class TestScenarionWithNestedCalls
-      def call
-        raise_an_error
-      rescue => exc
-        exc
-      end
-
-      private
-
-        def raise_an_error
-          unused_local_variable = 42
-          raise
-        end
-    end
-
-    CustomError = Class.new(StandardError)
-
-    test '#bindings all the bindings of where the error originated' do
-      begin
-        unused_local_variable = "Test"
-        raise
-      rescue => exc
-        assert_equal 'Test', exc.bindings.first.eval('unused_local_variable')
-      end
-    end
-
-    test '#bindings all the bindings of where the error originated from a custom error' do
-      begin
-        unused_local_variable = "Test"
-        raise CustomError
-      rescue => exc
-        assert_equal 'Test', exc.bindings.first.eval('unused_local_variable')
-      end
-    end
-
-    test '#bindings goes down the stack' do
-      exc = TestScenarionWithNestedCalls.new.call
-
-      assert_equal 42, exc.bindings.first.eval('unused_local_variable')
-    end
-  end
-end