rack-webconsole 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-webconsole (0.1.1)
+    rack-webconsole (0.1.2)
       json
       rack
 

data/History

@@ -1,3 +1,10 @@
+=== 0.1.2 / 2011-08-01
+
+  + Change field name to avoid conflicts with other forms (Chris Apolzon)
+  + Prevent visual flash of unstyled content (Rob Cameron)
+  + Fix minor styling issues (Jeff Kreeftmeijer)
+  + Avoid conflicts with libraries other than JQuery (Jo Liss)
+
 === 0.1.1 / 2011-07-27
 
   ! Fix bug with Content-Length not being calculated appropriately. (Corin Langosch)

data/Readme.md

@@ -27,7 +27,9 @@ protect against cross-site request forgery.
 
 In your Gemfile:
 
-    gem 'rack-webconsole'
+```ruby
+gem 'rack-webconsole'
+```
 
 Rack-webconsole **needs JQuery**. If you are using Rails 3, JQuery is loaded by
 default. In case you don't want to use JQuery in your application,
@@ -35,7 +37,9 @@ default. In case you don't want to use JQuery in your application,
 should put this line somewhere in your application (a Rails initializer, or
 some configuration file):
 
-    Rack::Webconsole.inject_jquery = true
+```ruby
+Rack::Webconsole.inject_jquery = true
+```
 
 ##Usage with Rails 3
 
@@ -48,24 +52,34 @@ the console will show :)
 With Sinatra and Padrino you have to tell your application to use the
 middleware:
 
-    require 'sinatra'
-    require 'rack/webconsole'
+```ruby
+require 'sinatra'
+require 'rack/webconsole'
 
-    class MySinatraApp < Sinatra::Application
-      use Rack::Webconsole
-      # . . .
-    end
+class MySinatraApp < Sinatra::Application
+  use Rack::Webconsole
+  # . . .
+end
 
-    class SamplePadrino < Padrino::Application
-      use Rack::Webconsole
-      # . . .
-    end
+class SamplePadrino < Padrino::Application
+  use Rack::Webconsole
+  # . . .
+end
+```
 
 NOTE: If you are using Bundler and initializing it from config.ru, you don't
 have to `require 'rack/webconsole'` manually, otherwise you have to.
 
 And it works! Fire up the server, go to any page and press the ` ` ` key.
 
+##Usage with Rails 2
+
+You need to add the following code to an intializer (i.e. config/initializers/webconsole.rb):
+
+```ruby
+require 'rack/webconsole'
+ActionController::Dispatcher.middleware.insert_after 1, Rack::Webconsole
+```
 
 ##Commands
 
@@ -88,9 +102,9 @@ You can also build the documentation with the following command:
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
+* Add tests for it. This is important so we don't break it in a
   future version unintentionally.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself we can ignore when we pull)
 * Send us a pull request. Bonus points for topic branches.
 
 ## Copyright

data/lib/rack/webconsole/version.rb

@@ -2,6 +2,6 @@
 module Rack
   class Webconsole
     # rack-webconsole version number.
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/public/webconsole.css

@@ -38,14 +38,14 @@
   color: #FFF;
 }
 #rack-webconsole form div.results_wrapper{
-  height: 100%;
   width: 100%;
   position: absolute;
   overflow-x: auto;
+  top: 0;
+  bottom: 40px;
 }
 #rack-webconsole form div.results{
   padding: 10px;
-  padding-bottom: 40px;
 }
 #rack-webconsole .prompt{
   width: 30px;
@@ -59,8 +59,6 @@
   width: 100%;
   position: absolute;
   bottom: 0px;
-  height: 30px;
-  padding-top: 10px;
   background: #000;
 }
 #rack-webconsole form div.input input{
@@ -69,6 +67,7 @@
   box-sizing: border-box;
   margin-top: 0px;
   margin-bottom: 0px;
+  padding: 0px;
   width: 100%;
   font-size: 14px;
   background: transparent;

data/public/webconsole.html

@@ -1,4 +1,4 @@
-<div id="rack-webconsole">
+<div id="rack-webconsole" style="display:none">
   <form accept-charset="UTF-8" action="/webconsole" method="post">
     <input name="utf8" type="hidden" value="✓"/>
     <div class="results_wrapper">
@@ -8,7 +8,7 @@
     <div class="input">
       <span class="prompt">>></span>
       <span class="input_box">
-        <input id="query" name="query" type="text" />
+        <input id="webconsole_query" name="webconsole_query" type="text" />
       </div>
     </div>
   </form>

data/public/webconsole.js

@@ -1,53 +1,53 @@
-$('#rack-webconsole form').submit(function(e){
-  e.preventDefault();
-});
-
-$("#rack-webconsole form input").keyup(function(event) {
-  function escapeHTML(string) {
-    return(string.replace(/&/g,'&').
-      replace(/>/g,'>').
-      replace(/</g,'&lt;').
-      replace(/"/g,'&quot;')
-    );
-  };
+(function($) {
+  $('#rack-webconsole form').submit(function(e){
+    e.preventDefault();
+  });
 
-  if (event.which == 13) {
-    /*$.post('/webconsole', $("#rack-webconsole form").serialize());*/
-    var query = $("#query").val();
-    $.ajax({
-      url: '/webconsole',
-      type: 'POST',
-      dataType: 'json',
-      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>";
-        $("#rack-webconsole .results").append(q + r);
-        $("#rack-webconsole .results_wrapper").scrollTop(
-          $("#rack-webconsole .results").height()
-        );
-        $("#query").val('');
-      }
-    });
-  }
-});
+  $("#rack-webconsole form input").keyup(function(event) {
+    function escapeHTML(string) {
+      return(string.replace(/&/g,'&amp;').
+        replace(/>/g,'&gt;').
+        replace(/</g,'&lt;').
+        replace(/"/g,'&quot;')
+      );
+    };
 
-$(document).ready(function() {
-  $("#rack-webconsole").hide();
-  $(this).keypress(function(event) {
-    if (event.which == 96) {
-      $("#rack-webconsole").slideToggle('fast', function() {
-        if ($(this).is(':visible')) {
-          $("#rack-webconsole form input").focus();
+    if (event.which == 13) {
+      /*$.post('/webconsole', $("#rack-webconsole form").serialize());*/
+      var query = $("#webconsole_query").val();
+      $.ajax({
+        url: '/webconsole',
+        type: 'POST',
+        dataType: 'json',
+        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>";
+          $("#rack-webconsole .results").append(q + r);
           $("#rack-webconsole .results_wrapper").scrollTop(
             $("#rack-webconsole .results").height()
           );
-        } else {
-          $("#rack-webconsole form input").blur();
+          $("#webconsole_query").val('');
         }
       });
-      event.preventDefault();
     }
   });
-});
 
+  $(document).ready(function() {
+    $(this).keypress(function(event) {
+      if (event.which == 96) {
+        $("#rack-webconsole").slideToggle('fast', function() {
+          if ($(this).is(':visible')) {
+            $("#rack-webconsole form input").focus();
+            $("#rack-webconsole .results_wrapper").scrollTop(
+              $("#rack-webconsole .results").height()
+            );
+          } else {
+            $("#rack-webconsole form input").blur();
+          }
+        });
+        event.preventDefault();
+      }
+    });
+  });
+})(jQuery);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-webconsole
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,12 +11,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-27 00:00:00.000000000 +02:00
+date: 2011-08-01 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2170028480 !ruby/object:Gem::Requirement
+  requirement: &2156017340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2170028480
+  version_requirements: *2156017340
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2170027860 !ruby/object:Gem::Requirement
+  requirement: &2156016220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2170027860
+  version_requirements: *2156016220
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2170027360 !ruby/object:Gem::Requirement
+  requirement: &2156015160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2170027360
+  version_requirements: *2156015160
 - !ruby/object:Gem::Dependency
   name: purdytest
-  requirement: &2170026920 !ruby/object:Gem::Requirement
+  requirement: &2156012860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2170026920
+  version_requirements: *2156012860
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2170026420 !ruby/object:Gem::Requirement
+  requirement: &2156010800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +68,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2170026420
+  version_requirements: *2156010800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2170025580 !ruby/object:Gem::Requirement
+  requirement: &2156009780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2170025580
+  version_requirements: *2156009780
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2170023940 !ruby/object:Gem::Requirement
+  requirement: &2156008200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +90,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2170023940
+  version_requirements: *2156008200
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2170022320 !ruby/object:Gem::Requirement
+  requirement: &2156007060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,7 +101,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2170022320
+  version_requirements: *2156007060
 description: Rack-based console inside your web applications
 email:
 - info@codegram.com
@@ -151,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4524250854472631456
+      hash: 1863180217222437049
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4524250854472631456
+      hash: 1863180217222437049
 requirements: []
 rubyforge_project: rack-webconsole
 rubygems_version: 1.6.2