RubyGems - tobias-rack-webconsole - Versions diffs - 0.1.4 - Mend

tobias-rack-webconsole 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/.gitignore +9 -0
data/.rvmrc +1 -0
data/.travis.yml +9 -0
data/Gemfile +6 -0
data/Gemfile.lock +40 -0
data/History +27 -0
data/Rakefile +23 -0
data/Readme.md +125 -0
data/lib/rack-webconsole.rb +3 -0
data/lib/rack/webconsole.rb +83 -0
data/lib/rack/webconsole/asset_helpers.rb +73 -0
data/lib/rack/webconsole/assets.rb +75 -0
data/lib/rack/webconsole/railtie.rb +14 -0
data/lib/rack/webconsole/repl.rb +86 -0
data/lib/rack/webconsole/sandbox.rb +33 -0
data/lib/rack/webconsole/shell.rb +74 -0
data/lib/rack/webconsole/version.rb +7 -0
data/public/jquery.html +1 -0
data/public/webconsole.css +86 -0
data/public/webconsole.html +15 -0
data/public/webconsole.js +92 -0
data/rack-webconsole.gemspec +36 -0
data/spec/rack/webconsole/asset_helpers_spec.rb +56 -0
data/spec/rack/webconsole/assets_spec.rb +101 -0
data/spec/rack/webconsole/repl_spec.rb +106 -0
data/spec/rack/webconsole/sandbox_spec.rb +50 -0
data/spec/rack/webconsole/shell_spec.rb +73 -0
data/spec/rack/webconsole_spec.rb +56 -0
data/spec/spec_helper.rb +10 -0
metadata +190 -0

data/spec/rack/webconsole/asset_helpers_spec.rb ADDED Viewed

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require 'spec_helper'
+class AssetClass
+  include Rack::Webconsole::AssetHelpers
+end
+module Rack
+  describe Webconsole::AssetHelpers do
+    describe '#html_code' do
+      it 'loads the html code' do
+        asset_class = AssetClass.new
+        html = asset_class.html_code
+        html.must_match /console/
+        html.must_match /results/
+        html.must_match /form/
+      end
+    end
+    describe '#css_code' do
+      it 'loads the css code' do
+        asset_class = AssetClass.new
+        css = asset_class.css_code
+        css.must_match /<style/
+        css.must_match /text\/css/
+        css.must_match /#console/
+      end
+    end
+    describe '#js_code' do
+      it 'loads the js code' do
+        asset_class = AssetClass.new
+        js = asset_class.js_code
+        js.must_match /\$\("#rack-webconsole"\)/
+        js.must_match /escapeHTML/
+      end
+    end
+    describe '#render' do
+      it 'knows how to replace $ vars' do
+        asset_class = AssetClass.new
+        text = "test $test test $test"
+        asset_class.render(text, :test => "123").must_equal("test 123 test 123")
+        text = "test $var1 test $var2"
+        asset_class.render(text, :var1 => "123", :var2 => "321").must_equal("test 123 test 321")
+      end
+    end
+  end
+end

data/spec/rack/webconsole/assets_spec.rb ADDED Viewed

@@ -0,0 +1,101 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'ostruct'
+module Rack
+  describe Webconsole::Assets do
+    it 'initializes with an app' do
+      @app = stub
+      @assets = Webconsole::Assets.new(@app)
+      @assets.instance_variable_get(:@app).must_equal @app
+    end
+    describe "#code" do
+      it 'injects the token, key_code, and context path' do
+        Webconsole::Repl.stubs(:token).returns('fake_generated_token')
+        Webconsole.key_code = "96"
+        @assets = Webconsole::Assets.new(nil)
+        assets_code = @assets.code('SCRIPT_NAME' => '/hambiscuit')
+        assets_code.must_match /fake_generated_token/
+        assets_code.must_match /event\.which == 96/
+        assets_code.must_match %r{/hambiscuit/webconsole}
+      end
+    end
+    describe "#call" do
+      describe 'when the call is not appropriate to inject the view code' do
+        # Different invalid cases
+        [
+          [200, {'Content-Type' => 'text/html'}, ['Whatever']],
+          [200, {'Content-Type' => 'text/plain'}, ['Hello World']],
+          [404, {'Content-Type' => 'text/html'}, ['Hello World']],
+          [404, {'Content-Type' => 'text/html'}, ['Hello, World']],
+        ].each do |invalid_response|
+          it 'passes the call untouched' do
+            @app = lambda { |env| invalid_response }
+            assets = Webconsole::Assets.new(@app)
+            assets.expects(:inject_code).never
+            assets.call({}).last.first.must_equal invalid_response.last.first
+          end
+        end
+      end
+      describe 'otherwise' do
+        it 'injects the view code before the body ending' do
+          valid_html = "<!DOCTYPE html>\n<html>\n<head>\n  <title>Testapp</title>\n  <link href=\"/assets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n  <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n  <meta content=\"authenticity_token\" name=\"csrf-param\" />\n<meta content=\"26Ls63zdKBiCXoqU5CuG6KqVbeMYydRqOuovP+DXx8g=\" name=\"csrf-token\" />\n</head>\n<body>\n\n<h1> Hello bitches </h1>\n\n<p> Lorem ipsum dolor sit amet. </p>\n\n\n</body>\n</html>\n"
+          html = [valid_html]
+          @app = lambda { |env| [200, {'Content-Type' => 'text/html'}, html] }
+          assets = Webconsole::Assets.new(@app)
+          response = assets.call({}).last.first
+          response.must_match /input name/m # html
+          response.must_match /text\/css/m # css
+          response.must_match /escapeHTML/m # js
+        end
+        it "works with Rails' particular conception of what a response is" do
+          valid_html = "<!DOCTYPE html>\n<html>\n<head>\n  <title>Testapp</title>\n  <link href=\"/assets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n  <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n  <meta content=\"authenticity_token\" name=\"csrf-param\" />\n<meta content=\"26Ls63zdKBiCXoqU5CuG6KqVbeMYydRqOuovP+DXx8g=\" name=\"csrf-token\" />\n</head>\n<body>\n\n<h1> Hello bitches </h1>\n\n<p> Lorem ipsum dolor sit amet. </p>\n\n\n</body>\n</html>\n"
+          @app = lambda { |env| [200, {'Content-Type' => 'text/html'}, OpenStruct.new({:body => valid_html})] }
+          assets = Webconsole::Assets.new(@app)
+          response = assets.call({}).last.first
+          response.must_match /input name/m # html
+          response.must_match /text\/css/m # css
+          response.must_match /escapeHTML/m # js
+        end
+        it 'exposes the request object to the console' do
+          valid_html = "<!DOCTYPE html>\n<html>\n<head>\n  <title>Testapp</title>\n  <link href=\"/assets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n  <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n  <meta content=\"authenticity_token\" name=\"csrf-param\" />\n<meta content=\"26Ls63zdKBiCXoqU5CuG6KqVbeMYydRqOuovP+DXx8g=\" name=\"csrf-token\" />\n</head>\n<body>\n\n<h1> Hello bitches </h1>\n\n<p> Lorem ipsum dolor sit amet. </p>\n\n\n</body>\n</html>\n"
+          @app = lambda { |env| [200, {'Content-Type' => 'text/html'}, OpenStruct.new({:body => valid_html})] }
+          env = {'PATH_INFO' => '/some_path'}
+          assets = Webconsole::Assets.new(@app)
+          assets.call(env)
+          Webconsole::Repl.request.env['PATH_INFO'].must_equal '/some_path'
+        end
+      end
+    end
+  end
+end

data/spec/rack/webconsole/repl_spec.rb ADDED Viewed

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'ostruct'
+module Rack
+  describe Webconsole::Repl do
+    it 'initializes with an app' do
+      @app = stub
+      @repl = Webconsole::Repl.new(@app)
+      @repl.instance_variable_get(:@app).must_equal @app
+    end
+    describe "#call" do
+      it 'evaluates the :query param in a sandbox and returns the result' do
+        @app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['hello world']] }
+        env = {}
+        Webconsole::Repl.stubs(:token).returns('abc')
+        request = OpenStruct.new(:params => {'query' => 'a = 4; a * 2', 'token' => 'abc'}, :post? => true)
+        Rack::Request.stubs(:new).returns request
+        @repl = Webconsole::Repl.new(@app)
+        response = @repl.call(env).last.first
+        MultiJson.decode(response)['result'].must_equal "8"
+      end
+      it 'maintains local state in subsequent calls thanks to an evil global variable' do
+        @app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['hello world']] }
+        env = {}
+        Webconsole::Repl.stubs(:token).returns('abc')
+        request = OpenStruct.new(:params => {'query' => 'a = 4', 'token' => 'abc'}, :post? => true)
+        Rack::Request.stubs(:new).returns request
+        @repl = Webconsole::Repl.new(@app)
+        @repl.call(env) # call 1 sets a to 4
+        request = OpenStruct.new(:params => {'query' => 'a * 8', 'token' => 'abc'}, :post? => true)
+        Rack::Request.stubs(:new).returns request
+        response = @repl.call(env).last.first # call 2 retrieves a and multiplies it by 8
+        MultiJson.decode(response)['result'].must_equal "32"
+        $sandbox.instance_variable_get(:@locals)[:a].must_equal 4
+        $sandbox.instance_variable_get(:@locals).size.must_equal 1
+      end
+      it "returns any found errors prepended with 'Error:'" do
+        @app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['hello world']] }
+        env = {}
+        Webconsole::Repl.stubs(:token).returns('abc')
+        request = OpenStruct.new(:params => {'query' => 'unknown_method', 'token' => 'abc'}, :post? => true)
+        Rack::Request.stubs(:new).returns request
+        @repl = Webconsole::Repl.new(@app)
+        response = @repl.call(env).last.first
+        MultiJson.decode(response)['result'].must_match /Error:/
+      end
+      it 'rejects non-post requests' do
+        @app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['hello world']] }
+        env = {}
+        Webconsole::Repl.stubs(:token).returns('abc')
+        request = OpenStruct.new(:params => {'query' => 'unknown_method', 'token' => 'abc'}, :post? => false)
+        Rack::Request.stubs(:new).returns request
+        @repl = Webconsole::Repl.new(@app)
+        $sandbox.expects(:instance_eval).never
+        @repl.call(env).must_equal @app.call(env)
+      end
+      it 'rejects requests with invalid token' do
+        @app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['hello world']] }
+        env = {}
+        Webconsole::Repl.stubs(:token).returns('abc')
+        request = OpenStruct.new(:params => {'query' => 'unknown_method', 'token' => 'cba'}, :post? => true)
+        Rack::Request.stubs(:new).returns request
+        @repl = Webconsole::Repl.new(@app)
+        $sandbox.expects(:instance_eval).never
+        @repl.call(env).must_equal @app.call(env)
+      end
+    end
+    describe 'class methods' do
+      describe '#reset_token and #token' do
+        it 'returns the security token' do
+          Webconsole::Repl.reset_token
+          Webconsole::Repl.token.must_be_kind_of String
+        end
+      end
+      describe '#request= and #request' do
+        it 'returns the request object' do
+          request = stub
+          Webconsole::Repl.request = request
+          Webconsole::Repl.request.must_equal request
+        end
+      end
+    end
+  end
+end

data/spec/rack/webconsole/sandbox_spec.rb ADDED Viewed

@@ -0,0 +1,50 @@
+require 'spec_helper'
+module Rack
+  describe Webconsole::Sandbox do
+    describe "#method_missing" do
+      describe 'when the method exists in @locals' do
+        it 'retrieves it' do
+          @sandbox = Webconsole::Sandbox.new
+          @sandbox.instance_variable_set(:@locals, {:a => 123})
+          @sandbox.a.must_equal 123
+        end
+      end
+      describe 'otherwise' do
+        it 'raises a NoMethodError' do
+          @sandbox = Webconsole::Sandbox.new
+          lambda {
+            @sandbox.a
+          }.must_raise NoMethodError
+        end
+      end
+    end
+    describe "#reload!" do
+      it 'assigns a new, fresh Sandbox to the global variable' do
+        old_sandbox = $sandbox = Webconsole::Sandbox.new
+        $sandbox.reload!
+        $sandbox.wont_equal old_sandbox
+      end
+      it 'returns a feedback string' do
+        Webconsole::Sandbox.new.reload!.must_equal 'ok'
+      end
+    end
+    describe "request" do
+      it 'returns the request object' do
+        @sandbox = Webconsole::Sandbox.new
+        request = Rack::Request.new({'PATH_INFO' => '/some_path'})
+        Webconsole::Repl.request = request
+        @sandbox.request.must_equal request
+      end
+    end
+  end
+end

data/spec/rack/webconsole/shell_spec.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'spec_helper'
+module Rack
+  describe Webconsole::Shell do
+    before do
+      Ripl.instance_variable_set(:@shell, nil)
+    end
+    describe ".eval_query" do
+      describe "sets Ripl::Shell" do
+        before { Webconsole::Shell.eval_query('2 + 2') }
+        it "#input" do
+          Ripl.shell.input.must_equal '2 + 2'
+        end
+        it "#result" do
+          Ripl.shell.result.must_equal 4
+        end
+        it "#history" do
+          Ripl.shell.history.must_equal ['2 + 2']
+        end
+      end
+      describe "for one line input" do
+        def response
+          Webconsole::Shell.eval_query("'input'")
+        end
+        it ":result returns inspected result" do
+          response[:result].must_equal '"input"'
+        end
+        it ":prompt returns normal prompt" do
+          response[:prompt] = '>> '
+        end
+        it "returns false for multi_line keys" do
+          response[:multi_line].must_equal false
+          response[:previous_multi_line].must_equal false
+        end
+        it "with an error :result returns error raised" do
+          Webconsole::Shell.eval_query("blah")[:result].must_match /^Error:/
+        end
+      end
+      describe "for multi line input" do
+        def response
+          [
+            Webconsole::Shell.eval_query("[1,2,3].map do |num|"),
+            Webconsole::Shell.eval_query("num ** 2"),
+            Webconsole::Shell.eval_query("end")
+          ]
+        end
+        it "returns correct results" do
+          response.map {|e| e[:result] }.must_equal [nil, nil, "[1, 4, 9]"]
+        end
+        it "returns correct prompts" do
+          response.map {|e| e[:prompt] }.must_equal ['>> ', '|| ', '|| ']
+        end
+        it "returns correct multi_line keys" do
+          response.map {|e| e[:multi_line] }.must_equal [true, true, false]
+          response.map {|e| e[:previous_multi_line] }.must_equal [false, true, true]
+        end
+      end
+    end
+  end
+end

data/spec/rack/webconsole_spec.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'spec_helper'
+module Rack
+  describe Webconsole do
+    it 'initializes with an app' do
+      @app = stub
+      @webconsole = Webconsole.new(@app)
+      @webconsole.instance_variable_get(:@app).must_equal @app
+    end
+    describe "#call" do
+      it 'delegates the call to the Repl middleware when the path is /webconsole' do
+        @app = stub
+        @webconsole = Webconsole.new(@app)
+        @env = {'PATH_INFO' => '/webconsole'}
+        repl = stub
+        Webconsole::Repl.expects(:new).with(@app).returns repl
+        repl.expects(:call).with @env
+        @webconsole.call(@env)
+      end
+      it 'passes the call to the Assets middleware otherwise' do
+        @app = stub
+        @webconsole = Webconsole.new(@app)
+        @env = {'PATH_INFO' => '/whatever'}
+        assets = stub
+        Webconsole::Assets.expects(:new).with(@app).returns assets
+        assets.expects(:call).with @env
+        @webconsole.call(@env)
+      end
+    end
+    describe 'class methods' do
+      it '#inject_jquery accessors' do
+        Webconsole.inject_jquery.must_equal false
+        Webconsole.inject_jquery = true
+        Webconsole.inject_jquery.must_equal true
+      end
+      it '#key_code accessors' do
+        Webconsole.key_code.must_equal "96"
+        Webconsole.key_code = "97"
+        Webconsole.key_code.must_equal "97"
+      end
+      it '#key_code setter cast parameter type' do
+        Webconsole.key_code = 96
+        Webconsole.key_code.must_equal "96"
+      end
+    end
+  end
+end