Merge pull request #24 from rogerleite/master

Make javascript key_code configurable

Author: oriolgual

.gitignore

@@ -6,3 +6,4 @@ graph.png
 doc/*
 coverage/*
 *.rbc
+tags

Readme.md

@@ -41,6 +41,13 @@ some configuration file):
 Rack::Webconsole.inject_jquery = true
 ```
 
+You can also change the javascript key_code used to start webconsole:
+
+```ruby
+ # ` = 96 (default), ^ = 94, ç = 231 ... etc.
+Rack::Webconsole.key_code = "231"
+```
+
 ##Usage with Rails 3
 
 If you are using Rails 3, you have no further steps to do. It works! To give

lib/rack/webconsole.rb

@@ -24,21 +24,36 @@ module Rack
   # variables and giving a true IRB-esque experience.
   #
   class Webconsole
-    @@inject_jquery = false
+    @@config = {:inject_jquery => false, :key_code => "96"}
 
     class << self
       # Returns whether the Asset injecter must inject JQuery or not.
       #
       # @return [Boolean] whether to inject JQuery or not.
       def inject_jquery
-        @@inject_jquery
+        @@config[:inject_jquery]
       end
 
       # Sets whether the Asset injecter must inject JQuery or not.
       #
       # @param [Boolean] value whether to inject JQuery or not.
       def inject_jquery=(value)
-        @@inject_jquery = value
+        @@config[:inject_jquery] = value
+      end
+
+      # Returns key code used to start web console.
+      #
+      # @return [String] key code used at keypress event to start web console.
+      def key_code
+        @@config[:key_code]
+      end
+
+      # Sets key code used to start web console.
+      #
+      # @param [String] value key code used at keypress event to start web console.
+      def key_code=(value)
+        value = value.to_s unless value.is_a?(String)
+        @@config[:key_code] = value
       end
     end
 

lib/rack/webconsole/asset_helpers.rb

@@ -44,6 +44,14 @@ def js_code
           '</script>'
       end
 
+      def render(text, variables = {})
+        result_text = text.dup
+        variables.each_pair do |variable, value|
+          result_text.gsub!("$#{variable}", value)
+        end
+        result_text
+      end
+
       private
 
       def asset(file)

lib/rack/webconsole/assets.rb

@@ -56,7 +56,7 @@ def call(env)
       def code
         html_code <<
           css_code <<
-          js_code.gsub('TOKEN', Webconsole::Repl.token)
+          render(js_code, :TOKEN => Webconsole::Repl.token, :KEY_CODE => Webconsole.key_code)
       end
 
       private

public/webconsole.js

@@ -19,7 +19,7 @@
         url: '/webconsole',
         type: 'POST',
         dataType: 'json',
-        data: ({query: query, token: "TOKEN"}),
+        data: ({query: query, token: "$TOKEN"}),
         success: function (data) {
           var q = "<div class='query'>" + escapeHTML(">> " + query) + "</div>";
           var r = "<div class='result'>" + escapeHTML("=> " + data.result) + "</div>";
@@ -35,7 +35,7 @@
 
   $(document).ready(function() {
     $(this).keypress(function(event) {
-      if (event.which == 96) {
+      if (event.which == $KEY_CODE) {
         $("#rack-webconsole").slideToggle('fast', function() {
           if ($(this).is(':visible')) {
             $("#rack-webconsole form input").focus();

spec/rack/webconsole/asset_helpers_spec.rb

@@ -40,5 +40,17 @@ module Rack
       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

spec/rack/webconsole/assets_spec.rb

@@ -8,10 +8,20 @@ module Rack
     it 'initializes with an app' do
       @app = stub
       @assets = Webconsole::Assets.new(@app)
-
       @assets.instance_variable_get(:@app).must_equal @app
     end
 
+    it '#code should inject token and key_code' do
+      Webconsole::Repl.stubs(:token).returns('fake_generated_token')
+      Webconsole.key_code = "96"
+
+      @assets = Webconsole::Assets.new(nil)
+      assets_code = @assets.code
+
+      assets_code.must_match /fake_generated_token/
+      assets_code.must_match /event\.which == 96/
+    end
+
     describe "#call" do
 
       describe 'when the call is not appropriate to inject the view code' do

spec/rack/webconsole_spec.rb

@@ -42,6 +42,15 @@ module Rack
         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