web-console 2.0.0 → 2.1.0

data/test/web_console/railtie_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+module WebConsole
+  class RailtieTest < ActiveSupport::TestCase
+    test 'config.whitelisted_ips sets whitelisted networks' do
+      new_uninitialized_app do |app|
+        app.config.web_console.whitelisted_ips = %w( 172.16.0.0/12 192.168.0.0/16 )
+        app.initialize!
+
+        1.upto(255).each do |n|
+          assert_includes Request.whitelisted_ips, "172.16.0.#{n}"
+          assert_includes Request.whitelisted_ips, "192.168.0.#{n}"
+        end
+      end
+    end
+
+    test 'config.whitelisted_ips always includes localhost' do
+      new_uninitialized_app do |app|
+        app.config.web_console.whitelisted_ips = '8.8.8.8'
+        app.initialize!
+
+        assert_includes Request.whitelisted_ips, '127.0.0.1'
+        assert_includes Request.whitelisted_ips, '::1'
+        assert_includes Request.whitelisted_ips, '8.8.8.8'
+      end
+    end
+
+    test 'config.template_paths prepend paths if it exists' do
+      new_uninitialized_app do |app|
+        dirname = File.expand_path('..', __FILE__)
+
+        app.config.web_console.template_paths = dirname
+        app.initialize!
+
+        assert_equal dirname, Template.template_paths.first
+      end
+    end
+
+    test 'config.whiny_request removes extra logging' do
+      new_uninitialized_app do |app|
+        app.config.web_console.whiny_requests = false
+        app.initialize!
+
+        assert_not Middleware.whiny_requests
+      end
+    end
+
+    test 'config.acceptable_content_types adds extra content types' do
+      preserving_acceptable_content_type do
+        new_uninitialized_app do |app|
+          app.config.web_console.acceptable_content_types = [Mime::ALL]
+          app.initialize!
+
+          assert_includes Request.acceptable_content_types, Mime::ALL
+        end
+      end
+    end
+
+    private
+
+      def new_uninitialized_app(root = File.expand_path('../../dummy', __FILE__))
+        old_app = Rails.application
+
+        FileUtils.mkdir_p(root)
+        Dir.chdir(root) do
+          Rails.application = nil
+
+          app = Class.new(Rails::Application)
+          app.config.eager_load = false
+          app.config.time_zone = 'UTC'
+          app.config.middleware ||= Rails::Configuration::MiddlewareStackProxy.new
+          app.config.active_support.deprecation = :notify
+
+          yield app
+        end
+      ensure
+        Rails.application = old_app
+      end
+
+      def preserving_acceptable_content_type
+        acceptable_content_types = Request.acceptable_content_types.dup
+        yield
+      ensure
+        Request.acceptable_content_types = acceptable_content_types
+      end
+
+      def teardown_fixtures(*)
+        super
+      rescue
+        # This is nasty hack to prevent a connection to the database in JRuby's
+        # activerecord-jdbcsqlite3-adapter. We don't really require a database
+        # connection, for the tests to run.
+        #
+        # The sad thing is that I couldn't figure out why does it only happens
+        # on activerecord-jdbcsqlite3-adapter and how to actually prevent it,
+        # rather than work-around it.
+      end
+  end
+end

data/test/web_console/request_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+module WebConsole
+  class RequestTest < ActiveSupport::TestCase
+    setup do
+      Request.stubs(:whitelisted_ips).returns(IPAddr.new('127.0.0.1'))
+    end
+
+    test '#from_whitelited_ip? is falsy for blacklisted IPs' do
+      req = request('http://example.com', 'REMOTE_ADDR' => '0.0.0.0')
+
+      assert_not req.from_whitelited_ip?
+    end
+
+    test '#from_whitelited_ip? is truthy for whitelisted IPs' do
+      req = request('http://example.com', 'REMOTE_ADDR' => '127.0.0.1')
+
+      assert req.from_whitelited_ip?
+    end
+
+    test '#acceptable_content_type? is truthy for explicit HTML content type' do
+      html = request('http://example.com', 'CONTENT_TYPE' => 'text/html')
+      xhtml = request('http://example.com', 'CONTENT_TYPE' => 'application/xhtml+xml')
+
+      [ html, xhtml ].each { |req| assert req.acceptable_content_type? }
+    end
+
+    test '#acceptable_content_type? is truthy for plain text content type' do
+      req = request('http://example.com', 'CONTENT_TYPE' => 'text/plain')
+
+      assert req.acceptable_content_type?
+    end
+
+    test '#acceptable_content_type? is truthy for blank content type' do
+      req = request('http://example.com', 'CONTENT_TYPE' => '')
+
+      assert req.acceptable_content_type?
+    end
+
+    test '#acceptable_content_type? is falsy for non blank and non HTML content type' do
+      req = request('http://example.com', 'CONTENT_TYPE' => 'application/json')
+
+      assert_not req.acceptable_content_type?
+    end
+
+    private
+
+      def request(*args)
+        Request.new(Rack::MockRequest.env_for(*args))
+      end
+  end
+end

data/test/web_console/session_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module WebConsole
+  class SessionTest < ActiveSupport::TestCase
+    class LineAwareError < StandardError
+      def self.raise
+        ::Kernel.raise new(__LINE__)
+      rescue => exc
+        exc
+      end
+
+      attr_reader :line
+
+      def initialize(line)
+        @line = line
+      end
+    end
+
+    setup do
+      Session::INMEMORY_STORAGE.clear
+      @session = Session.new TOPLEVEL_BINDING
+    end
+
+    test 'returns nil when a session is not found' do
+      assert_nil Session.find("nonexistent session")
+    end
+
+    test 'find returns a persisted object' do
+      assert_equal @session, Session.find(@session.id)
+    end
+
+    test 'can evaluate code in the currently selected binding' do
+      assert_equal "=> 42\n", @session.eval('40 + 2')
+    end
+
+    test 'can create session from a single binding' do
+      saved_line, saved_binding = __LINE__, binding
+      session = Session.from_binding(saved_binding)
+
+      assert_equal "=> #{saved_line}\n", session.eval('__LINE__')
+    end
+
+    test 'can create session from an exception' do
+      exc = LineAwareError.raise
+      session = Session.from_exception(exc)
+
+      assert_equal "=> #{exc.line}\n", session.eval('__LINE__')
+    end
+
+    test 'can switch to bindings' do
+      exc, saved_line = LineAwareError.raise, __LINE__
+
+      session = Session.from_exception(exc)
+      session.switch_binding_to(1)
+
+      assert_equal "=> #{saved_line}\n", session.eval('__LINE__')
+    end
+  end
+end

data/test/web_console/whiny_request_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+module WebConsole
+  class WhinyRequestTest < ActiveSupport::TestCase
+    test '#from_whitelited_ip? logs out to stderr' do
+      Request.stubs(:whitelisted_ips).returns(IPAddr.new('127.0.0.1'))
+      assert_output_to_stderr do
+        req = request('http://example.com', 'REMOTE_ADDR' => '0.0.0.0')
+        assert_not req.from_whitelited_ip?
+      end
+    end
+
+    test '#acceptable_content_type? logs out to stderr' do
+      Request.stubs(:acceptable_content_types).returns([])
+      assert_output_to_stderr do
+        req = request('http://example.com', 'CONTENT_TYPE' => 'application/json')
+        assert_not req.acceptable_content_type?
+      end
+    end
+
+    private
+
+      def assert_output_to_stderr
+        output = capture(:stderr) { yield }
+        assert_not output.blank?
+      end
+
+      def request(*args)
+        request = Request.new(Rack::MockRequest.env_for(*args))
+        WhinyRequest.new(request)
+      end
+  end
+end

data/test/web_console/whitelist_test.rb

@@ -0,0 +1,43 @@
+module WebConsole
+  class WhitelistTest < ActiveSupport::TestCase
+    test 'localhost is always whitelisted' do
+      whitelisted_ips = whitelist('8.8.8.8')
+
+      assert_includes whitelisted_ips, '127.0.0.1'
+      assert_includes whitelisted_ips, '::1'
+    end
+
+    test 'can whitelist single IPs' do
+      whitelisted_ips = whitelist('8.8.8.8')
+
+      assert_includes whitelisted_ips, '8.8.8.8'
+    end
+
+    test 'can whitelist whole networks' do
+      whitelisted_ips = whitelist('172.16.0.0/12')
+
+      1.upto(255).each do |n|
+        assert_includes whitelisted_ips, "172.16.0.#{n}"
+      end
+    end
+
+    test 'can whitelist multiple networks' do
+      whitelisted_ips = whitelist %w(172.16.0.0/12 192.168.0.0/16)
+
+      1.upto(255).each do |n|
+        assert_includes whitelisted_ips, "172.16.0.#{n}"
+        assert_includes whitelisted_ips, "192.168.0.#{n}"
+      end
+    end
+
+    test 'can be represented in a human readable form' do
+      assert_includes whitelist.to_s, '127.0.0.0/127.255.255.255, ::1'
+    end
+
+    private
+
+      def whitelist(*args)
+        Whitelist.new(*args)
+      end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web-console
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Charlie Somerville
@@ -11,34 +11,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -79,32 +79,33 @@ dependencies:
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 description: 
 email:
+- charlie@charliesomerville.com
 - gsamokovarov@gmail.com
 - guilleiguaran@gmail.com
 - daoduyducduong@gmail.com
@@ -115,44 +116,33 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- lib/action_dispatch/debug_exceptions.rb
-- lib/action_dispatch/exception_wrapper.rb
-- lib/action_dispatch/templates/rescues/_request_and_response.html.erb
-- lib/action_dispatch/templates/rescues/_request_and_response.text.erb
-- lib/action_dispatch/templates/rescues/_source.erb
-- lib/action_dispatch/templates/rescues/_trace.html.erb
-- lib/action_dispatch/templates/rescues/_trace.text.erb
-- lib/action_dispatch/templates/rescues/_web_console.html.erb
-- lib/action_dispatch/templates/rescues/diagnostics.html.erb
-- lib/action_dispatch/templates/rescues/diagnostics.text.erb
-- lib/action_dispatch/templates/rescues/layout.erb
-- lib/action_dispatch/templates/rescues/missing_template.html.erb
-- lib/action_dispatch/templates/rescues/missing_template.text.erb
-- lib/action_dispatch/templates/rescues/routing_error.html.erb
-- lib/action_dispatch/templates/rescues/routing_error.text.erb
-- lib/action_dispatch/templates/rescues/template_error.html.erb
-- lib/action_dispatch/templates/rescues/template_error.text.erb
-- lib/action_dispatch/templates/rescues/unknown_action.html.erb
-- lib/action_dispatch/templates/rescues/unknown_action.text.erb
-- lib/action_dispatch/templates/routes/_route.html.erb
-- lib/action_dispatch/templates/routes/_table.html.erb
-- lib/assets/javascripts/web-console.js
-- lib/assets/javascripts/web_console.js
 - lib/web-console.rb
 - lib/web_console.rb
-- lib/web_console/controller_helpers.rb
-- lib/web_console/core_ext/exception.rb
-- lib/web_console/core_ext/exception/cruby.rb
-- lib/web_console/core_ext/exception/jruby.rb
-- lib/web_console/core_ext/exception/rubinius.rb
-- lib/web_console/engine.rb
-- lib/web_console/repl.rb
-- lib/web_console/repl_session.rb
-- lib/web_console/unsupported_platforms.rb
+- lib/web_console/errors.rb
+- lib/web_console/evaluator.rb
+- lib/web_console/helper.rb
+- lib/web_console/integration.rb
+- lib/web_console/integration/cruby.rb
+- lib/web_console/integration/jruby.rb
+- lib/web_console/integration/rubinius.rb
+- lib/web_console/middleware.rb
+- lib/web_console/railtie.rb
+- lib/web_console/request.rb
+- lib/web_console/session.rb
+- lib/web_console/template.rb
+- lib/web_console/templates/_inner_console_markup.html
+- lib/web_console/templates/_markup.html
+- lib/web_console/templates/_prompt_box_markup.html
+- lib/web_console/templates/console.js
+- lib/web_console/templates/error_page.js
+- lib/web_console/templates/index.html
+- lib/web_console/templates/layouts/inlined_string.erb
+- lib/web_console/templates/layouts/javascript.erb
+- lib/web_console/templates/main.js
+- lib/web_console/templates/style.css
 - lib/web_console/version.rb
-- lib/web_console/view_helpers.rb
-- test/action_pack/exception_wrapper_test.rb
-- test/controllers/tests_controller_test.rb
+- lib/web_console/whiny_request.rb
+- lib/web_console/whitelist.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
@@ -240,11 +230,22 @@ files:
 - test/dummy/tmp/cache/assets/test/sprockets/d982412def520c434e2240eae6d29cf2
 - test/dummy/tmp/cache/assets/test/sprockets/df048a8b0897b9c04acdf59c8f95b18f
 - test/dummy/tmp/cache/assets/test/sprockets/e6d6b8bde546349764be7b44ffcf5807
+- test/support/scenarios/bad_custom_error_scenario.rb
+- test/support/scenarios/basic_nested_scenario.rb
+- test/support/scenarios/custom_error_scenario.rb
+- test/support/scenarios/eval_nested_scenario.rb
+- test/support/scenarios/flat_scenario.rb
+- test/support/scenarios/reraised_scenario.rb
 - test/test_helper.rb
-- test/web_console/core_ext/exception_test.rb
-- test/web_console/engine_test.rb
-- test/web_console/repl_session_test.rb
-- test/web_console/repl_test.rb
+- test/web_console/evaluator_test.rb
+- test/web_console/helper_test.rb
+- test/web_console/integration_test.rb
+- test/web_console/middleware_test.rb
+- test/web_console/railtie_test.rb
+- test/web_console/request_test.rb
+- test/web_console/session_test.rb
+- test/web_console/whiny_request_test.rb
+- test/web_console/whitelist_test.rb
 homepage: https://github.com/rails/web-console
 licenses:
 - MIT
@@ -268,10 +269,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A set of debugging tools for your Rails application.
+summary: A debugging tool for your Ruby on Rails applications.
 test_files:
-- test/action_pack/exception_wrapper_test.rb
-- test/controllers/tests_controller_test.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -359,8 +358,19 @@ test_files:
 - test/dummy/tmp/cache/assets/test/sprockets/d982412def520c434e2240eae6d29cf2
 - test/dummy/tmp/cache/assets/test/sprockets/df048a8b0897b9c04acdf59c8f95b18f
 - test/dummy/tmp/cache/assets/test/sprockets/e6d6b8bde546349764be7b44ffcf5807
+- test/support/scenarios/bad_custom_error_scenario.rb
+- test/support/scenarios/basic_nested_scenario.rb
+- test/support/scenarios/custom_error_scenario.rb
+- test/support/scenarios/eval_nested_scenario.rb
+- test/support/scenarios/flat_scenario.rb
+- test/support/scenarios/reraised_scenario.rb
 - test/test_helper.rb
-- test/web_console/core_ext/exception_test.rb
-- test/web_console/engine_test.rb
-- test/web_console/repl_session_test.rb
-- test/web_console/repl_test.rb
+- test/web_console/evaluator_test.rb
+- test/web_console/helper_test.rb
+- test/web_console/integration_test.rb
+- test/web_console/middleware_test.rb
+- test/web_console/railtie_test.rb
+- test/web_console/request_test.rb
+- test/web_console/session_test.rb
+- test/web_console/whiny_request_test.rb
+- test/web_console/whitelist_test.rb