rails-web-console 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1956b78ee5cb2191f15180797569c85955d42b1
-  data.tar.gz: f74438c098e505b5094eff6e2feb7b87b5f1db62
+  metadata.gz: 48a0115d62369530d97294128030118e370cae80
+  data.tar.gz: 942163e1f2658d5496c2414a594ed09f376df4ef
 SHA512:
-  metadata.gz: f7a77900c9937f07a0f55580b2ee08bc4f0973cab88e3f38a4f64cc0760bff377b5706ab5755fd3da1e67a368a8c21b6bf71406741e2a08939b739518d424179
-  data.tar.gz: 096ab909bcab8863555dd1b8f36065b95013bf5037490036c70f51d0a34d7bcfd6c1c1335bd5a8e334f6ab981ca709896b18b8056de757af18887ad507175c6c
+  metadata.gz: b9a4c721832189b0a4887aa9dcf2451eb336da962bb0960a0aadeaaa01cc7ef2e628da9bd1ba4e0c0c1abfb2955db3c4cc3bfc4315f283593105b942f3f17087
+  data.tar.gz: 8b9c8e30d3d95efc6bb2537eb04fa6a5c9b6735032354ee86eae6fd1b6659f070c14d8735d7245f071f04852f67877d2811b997e86a688ecf347a31b2d2f29d7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Rodrigo Rosenfeld Rosas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# RailsWebConsole
+
+A Rails mountable engine for running Ruby scripts on the browser in the context of a
+controller action.
+
+## Dependencies
+
+It doesn't assume anything about Sprockets being available and will embed any JS directly into
+the views to avoid any dependencies on Sprockets.
+
+ActionView is required though but it's not declared as a dependency in the gemspec as it's a
+separate gem just as of Rails 4.1.x, so it would prevent this gem from working with older Rails
+versions, but you should make sure your Rails application include support to ActionView.
+
+## Browser support
+
+All modern browsers and IE >= 8 should be supported.
+
+## Minimal Ruby supported version
+
+1.9 is the minimal required version due to usage of `require_relative` and the new hash syntax.
+
+Patches for supporting older Ruby versions won't be accepted.
+
+## Install
+
+In your Gemfile, put the dependency like this:
+
+```ruby
+gem 'rails-web-console', group: :development
+```
+
+This will automatically mount it in /console. If you want to specify a different mount point,
+use:
+
+```ruby
+gem 'rails-web-console', require: 'rails_web_console/engine', group: :development
+```
+
+And add this to your config/routes.rb:
+
+```ruby
+mount RailsWebConsole::Engine => '/inspect' if Rails.env.development?
+```
+
+If you intend to use this in production environment (strongly discouraged), be sure to protect console routes. Do it on your own risk!
+
+## Usage
+
+Just access "/console" (or whatever path you've chosen) in your browser.
+
+## Support for older versions of Rails
+
+I won't be supporting older versions of Rails to keep the source as simple as possible.
+
+Take a look at older releases of this gem for supporting older Rails.
+
+
+Copyright (c) 2014 [Rodrigo Rosenfeld Rosas], released under the MIT license
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rosenfeld/rails-web-console/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/app/controllers/rails_web_console/console_controller.rb

@@ -0,0 +1,33 @@
+require 'stringio'
+
+module RailsWebConsole
+  class ConsoleController < ::ActionController::Base
+    skip_before_action :verify_authenticity_token
+    layout false
+
+    def index
+    end
+
+    def run
+      session[:script] = params[:script]
+      stdout_orig = $stdout
+      $stdout = StringIO.new
+      begin
+        result_eval = eval params[:script], binding
+        $stdout.rewind
+        result = %Q{<div class="stdout">#{escape $stdout.read}</div>
+          <div class="return">#{escape result_eval.inspect}</div>}
+      rescue => e
+        result = e.to_s
+      end
+      $stdout = stdout_orig
+      render text: result.gsub("\n", "<br>\n")
+    end
+
+    private
+
+    def escape(content)
+      view_context.escape_once content
+    end
+  end
+end

data/app/views/rails_web_console/console/index.html.erb

@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Console</title>
+  <style>
+    #script {width: 100%}
+    .console_result {
+        background-color: black;
+        color: white;
+        margin: 1em 0;
+    }
+
+    .return {
+        background-color: blue;
+    }
+  </style>
+</head>
+<body>
+  <textarea id="script" rows="10" cols="80"><%= session[:script] %></textarea>
+  <div>
+    <button id=clear-results>Clear (Esc, Esc)</button>
+    <button id=run-script>Run (Ctrl+Enter)</button>
+  </div>
+  <div id="results"></div>
+
+  <script>
+  var run_path = '<%= rails_web_console.run_path %>', lastEscTime = 0,
+      results = $el('results'), runScriptButton = $el('run-script'),
+      clearResultsButton = $el('clear-results'), script = $el('script'), request
+    function $el(id){ return document.getElementById(id) }
+    addEventListener(clearResultsButton, 'click', clearResults)
+    addEventListener(runScriptButton, 'click', runScript)
+    addEventListener(script, 'keydown', onKeyDown)
+    function addEventListener(el, eventName, handler) {
+      if (el.addEventListener) el.addEventListener(eventName, handler);
+      else el.attachEvent('on' + eventName, handler);
+    }
+    function clearResults() {
+      results.innerHTML = ''
+    }
+    function runScript() {
+      request = new XMLHttpRequest()
+      request.open('POST', run_path, true)
+      request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8')
+      request.onreadystatechange = function() {
+        if (!(this.readyState === 4 && this.status >= 200 && this.status < 400)) return
+        var div = document.createElement('div')
+        div.setAttribute('class', 'console_result')
+        div.innerHTML = this.responseText
+        results.appendChild(div)
+      }
+      request.send('script=' + encodeURIComponent(script.value))
+    }
+    function onKeyDown(ev) {
+      if (ev.ctrlKey && ev.keyCode == 13) runScript() // Ctrl + Enter
+      if (ev.keyCode == 27) {
+        if (new Date().getTime() - lastEscTime < 1000) clearResults() // Esc, Esc within a second
+        lastEscTime = new Date().getTime()
+      }
+    }
+  </script>
+</body>
+</html>

data/config/routes.rb

@@ -1,4 +1,4 @@
-Rails.application.routes.draw do
-  get 'console' => 'console#index'
-  post 'console/run' => 'console#run'
+RailsWebConsole::Engine.routes.draw do
+  root to: 'console#index'
+  post 'run' => 'console#run', as: :run
 end

data/lib/rails-web-console.rb

@@ -1 +1,7 @@
-require 'console'
+require_relative 'rails_web_console/engine'
+
+RailsWebConsole::Engine.initializer 'rails_web_console.mount_default' do
+  Rails.application.routes.prepend do
+    mount RailsWebConsole::Engine => '/console'
+  end
+end

data/lib/rails_web_console/engine.rb

@@ -0,0 +1,5 @@
+module RailsWebConsole
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsWebConsole
+  end
+end

data/lib/rails_web_console/version.rb

@@ -0,0 +1,3 @@
+module RailsWebConsole
+  VERSION = "0.3.0"
+end

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: rails-web-console
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Rodrigo Rosenfeld Rosas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 description: Run any Ruby script from the context of a web request.
-email: rr.rosas@gmail.com
+email:
+- rr.rosas@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.markdown
+extra_rdoc_files: []
 files:
-- app/assets/javascripts/console.js
-- app/assets/stylesheets/console.css
-- app/controllers/console_controller.rb
-- app/views/console/index.html.erb
-- app/views/layouts/console.html.erb
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails_web_console/console_controller.rb
+- app/views/rails_web_console/console/index.html.erb
 - config/routes.rb
-- lib/console.rb
 - lib/rails-web-console.rb
-- README.markdown
+- lib/rails_web_console/engine.rb
+- lib/rails_web_console/version.rb
 homepage: https://github.com/rosenfeld/rails-web-console
 licenses:
 - MIT
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A web console for Rails

data/README.markdown

@@ -1,41 +0,0 @@
-Console
-=======
-
-A Rails 3.1 and above engine for running Ruby scripts on the browser in the context of a controller action.
-
-You can install it as a gem or putting it in your vendor/plugins/console directory.
-
-Installing as a Gem (preferred method)
--------------------------------------
-
-In your Gemfile, put the dependency like this:
-
-<pre>
-gem 'rails-web-console', :group => :development
-</pre>
-
-If you intend to use this in production environment (strongly discouraged), be sure to protect console routes. Do it on your own risk!
-
-Installing with a clone
------------------------
-
-Just put it in your vendor/plugins/console. For instance:
-
-<pre>
-git submodule add git://github.com/rosenfeld/rails-web-console.git vendor/plugins/console
-</pre>
-
-Usage
------
-
-Just access "/console" in your browser.
-
-Support for older versions of Rails
------------------------------------
-
-I won't be supporting older versions of Rails to keep the source as simple as possible.
-
-Take a look at older releases of this gem for supporting older Rails.
-
-
-Copyright (c) 2010 [Rodrigo Rosenfeld Rosas], released under the MIT license

data/app/assets/javascripts/console.js

@@ -1,16 +0,0 @@
-var lastEscTime = 0
-jQuery(function($) {
-    $('#clearResults').click(function() { $('#results').empty() })
-    $('#runScript').click(function() {
-        $.post('/console/run', {script: $('#script').val()}, function(data) {
-            $('<div/>').attr('class', 'console_result').html(data).appendTo('#results')
-        })
-    })
-    $('#script').keydown(function(ev) {
-        if (ev.ctrlKey && ev.keyCode == 13) $('#runScript').click() // Ctrl + Enter
-        if (ev.keyCode == 27) {
-            if (new Date().getTime() - lastEscTime < 1000) $('#clearResults').click() // Esc, Esc within a second
-            lastEscTime = new Date().getTime()
-        }
-    })
-})

data/app/assets/stylesheets/console.css

@@ -1,10 +0,0 @@
-#script {width: 100%}
-.console_result {
-    background-color: black;
-    color: white;
-    margin: 1em 0;
-}
-
-.return {
-    background-color: blue;
-}

data/app/controllers/console_controller.rb

@@ -1,29 +0,0 @@
-require 'stringio'
-class ConsoleController < ApplicationController
-
-  skip_before_filter :verify_authenticity_token
-
-  def index
-  end
-
-  def run
-    session[:script] = params[:script]
-    stdout_orig = $stdout
-    $stdout = StringIO.new
-    begin
-      result_eval = eval params[:script], binding
-      $stdout.rewind
-      result = %Q{<div class="stdout">#{escape $stdout.read}</div>
-        <div class="return">#{escape result_eval.inspect}</div>}
-    rescue Exception => e
-      result = e.to_s
-    end
-    $stdout = stdout_orig
-    render :text => result.gsub("\n", "<br />\n")
-  end
-
-private
-  def escape(content)
-    view_context.escape_once content
-  end
-end

data/app/views/console/index.html.erb

@@ -1,3 +0,0 @@
-<textarea id="script" rows="10" cols="80"><%= session[:script] %></textarea>
-<div><input type="button" value="Clear (Esc, Esc)" id="clearResults" /><input type="button" value="Run (Ctrl+Enter)" id="runScript" /></div>
-<div id="results"></div>

data/app/views/layouts/console.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Console</title>
-  <%= javascript_include_tag 'http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js' %>
-  <%= javascript_include_tag 'console' %>
-  <%= stylesheet_link_tag 'console' %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/lib/console.rb

@@ -1,4 +0,0 @@
-module Console
-  class Engine < Rails::Engine
-  end
-end