rack_web_console 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4d00b4ee750af6eb2782b71b432f411964fbd4a
+  data.tar.gz: 60be9ea39bd4756d4b9dac911678ae8752d6f0bd
+SHA512:
+  metadata.gz: 076756194180b419477fc145a67ac1c01e276ddca634d359d0c05de23186b1963da0c15eff378648573b16b7d85e7bc64f04133b1d8e6cb4f43a1725e2406995
+  data.tar.gz: ece2517ff410af142bd1a5d8447f511611b6e3fe4e8044e5a99221ae2881d28f8215d0eb5f92c83d5bdb4bd321441bccb0b9dd6316acdcff0c19396379de37cd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+-I lib
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack_web_console.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,118 @@
+# Rack Web Console
+
+Rack Web Console is a simple Rack app class that allows one to run arbitrary Ruby code on a given
+binding, which may be useful in development mode to test some code in a given context. This is
+similar to the `rails-web-console` (it was indeed extracted from it with a few enhancements) but
+works for any Rack based application, including Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack_web_console'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_web_console
+
+## Usage
+
+The hello world is not much useful, but here you are:
+
+```ruby
+# config.ru
+require 'rack_web_console'
+run RackConsole.new binding
+```
+
+Usually, you'd be more interested in learning about the binding which is usually a controller
+or something like that. For example, if you want to test code from inside a Roda's `route` block:
+
+```ruby
+# config.ru
+require 'roda'
+require 'rack_web_console'
+
+class App < Roda
+  route do |r|
+    r.on('console'){ halt RackConsole.new(binding) }
+    'default response'
+  end
+end
+
+run App
+```
+
+The local variable `r` would be available in the console for example in this case. Some
+frameworks may not have a method like Roda's `halt`, so in a Rails application for example,
+you may have to do this:
+
+``` ruby
+# app/controllers/console_controller.rb:
+require 'rack_web_console'
+class ConsoleController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+  def index
+    status, headers, body = RackConsole.new(binding).call(env)
+    response.headers.merge headers
+    render inline: body.join("\n"), status: status
+  end
+end
+
+# routes.rb:
+Rails.application.routes.draw do
+  # ...
+  match 'console' => 'console#index', via: [:get, :post] if Rails.env.development?
+end
+```
+
+The `rails-web-console` gem is probably a better gem to use with Rails but this example should
+demonstrate how it could be used with basically any framework. If you're not really interested
+on some specific binding, you can simply mount it directly in config.ru:
+
+```ruby
+# config.ru
+require_relative 'config/environment'
+
+require 'rack_web_console'
+map('/console'){ run RackConsole.new }
+
+run Rails.application
+```
+
+By default, only the output of the request thread is sent to the POST request response. If you
+want to spawn new threads from the script and see the output of all threads, set the
+`:rack_console_capture_all` thread local to true:
+
+```ruby
+Thread.current[:rack_console_capture_all] = true
+Thread.start{ puts 'now it should be displayed in the browser' }.join
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`
+to run the tests. You can also run `bin/console` for an interactive prompt that will allow
+you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a
+new version, update the version number in `version.rb`, and then run `bundle exec rake
+release`, which will create a git tag for the version, push git commits and tags, and
+push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub](https://github.com/rosenfeld/rack_web_console).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack_web_console"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack-console-view.erb

@@ -0,0 +1,60 @@
+<!doctype html>
+<html>
+<head>
+  <title>Console</title>
+  <style>
+    #script { width: 100% }
+    .return { background-color: blue }
+    .console_result {
+      background-color: black;
+      color: white;
+      margin: 1em 0;
+    }
+  </style>
+</head>
+<body>
+  <textarea id="script" rows="10" cols="80"><%= 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 = '', 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/lib/rack_console/cookie_script_storage.rb

@@ -0,0 +1,24 @@
+require 'cgi'
+require 'rack/utils'
+
+class RackConsole
+  class CookieScriptStorage
+    attr_accessor :script
+
+    def initialize(env, cookie_key: '_rack-console-script', max_length: 4000)
+      @env, @cookie_key, @max_length = env, cookie_key, max_length
+      @script = ::CGI::Cookie.parse(env['HTTP_COOKIE'].to_s)[cookie_key]&.first || ''
+    end
+
+    WARNING_LIMIT_MSG = ->(max){ 'WARNING: stored script was limited to the first ' +
+      "#{max} chars to avoid issues with cookie overflow\n" }
+    def set_cookie_header!(headers = {})
+      script = @script.to_s
+      puts WARNING_LIMIT_MSG[@max_length] if script.size > @max_length
+      cookie = { value: script[0...@max_length], path: @env['REQUEST_PATH'],
+        domain: @env['SERVER_NAME'] }
+      ::Rack::Utils.set_cookie_header! headers, @cookie_key, cookie
+      headers
+    end
+  end
+end

data/lib/rack_console/output_capture.rb

@@ -0,0 +1,33 @@
+require 'stringio'
+
+class RackConsole
+  class OutputCapture
+    def initialize
+      @old = $stdout
+      @io = ::StringIO.new
+      @main_thread = ::Thread.current
+    end
+
+    def write(value)
+      io.write(value)
+    end
+
+    def capture
+      $stdout = self
+      yield
+    ensure
+      $stdout = @old
+    end
+
+    def output
+      @io.rewind
+      @io.read
+    end
+
+    private
+
+    def io
+      ::Thread.current == @main_thread || @main_thread[:rack_console_capture_all] ? @io : @old
+    end
+  end
+end

data/lib/rack_console/version.rb

@@ -0,0 +1,3 @@
+class RackConsole
+  VERSION = '0.1.0'
+end

data/lib/rack_web_console.rb

@@ -0,0 +1,52 @@
+require 'erb'
+require 'cgi'
+require_relative 'rack_console/version'
+require_relative 'rack_console/cookie_script_storage'
+require_relative 'rack_console/output_capture'
+
+class RackConsole
+  VIEW_TEMPLATE = ::File.join __dir__, 'rack-console-view.erb'
+
+  def initialize(_binding = binding, storage: ->(env){ CookieScriptStorage.new env })
+    @storage, @binding = storage, _binding
+  end
+
+  def call(env)
+    @_storage = ::Proc === @storage ? @storage[env] : @storage
+    env['REQUEST_METHOD'] == 'POST' ? process_script(env) : render_view(env)
+  end
+
+  private
+
+
+  def process_script(env)
+    script = CGI.unescape env['rack.input'].read.sub(/\Ascript=/, '')
+    @_storage&.script=(script)
+    result = []
+    (oc = OutputCapture.new).capture do
+      begin
+        result_eval = eval script, @binding
+        result << %Q{<div class="stdout">#{::ERB::Util.h oc.output}</div>}
+        result << %Q{<div class="return">#{::ERB::Util.h result_eval.inspect}</div>}
+      rescue ::Exception => e
+        result << e.message << "\n" << e.backtrace.join("\n")
+      end
+    end
+    headers = { 'Content-Type' => 'text/html; charset=utf-8' }
+    @_storage.set_cookie_header! headers
+    [ 200, headers, [ result.join("\n").gsub("\n", "<br>\n") ] ]
+  end
+
+  def render_view(env)
+    [ 200, { 'Content-Type' => 'text/html; charset=utf-8' }, [ view_response(env) ] ]
+  end
+
+  def view_response(env)
+    script = (s = @_storage&.script) ? ::ERB::Util.h(s) : ''
+    ::ERB.new(::File.read view_template).result binding
+  end
+
+  def view_template # so that it could be easily subclassed and overriden:
+    VIEW_TEMPLATE
+  end
+end

data/rack_web_console.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack_console/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack_web_console'
+  spec.version       = RackConsole::VERSION
+  spec.authors       = ['Rodrigo Rosenfeld Rosas']
+  spec.email         = ['rr.rosas@gmail.com']
+
+  spec.summary       = %q{A web console for Rack apps.}
+  spec.homepage      = 'https://github.com/rosenfeld/rack_web_console'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rack'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rack_web_console
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Rosenfeld Rosas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- rr.rosas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack-console-view.erb
+- lib/rack_console/cookie_script_storage.rb
+- lib/rack_console/output_capture.rb
+- lib/rack_console/version.rb
+- lib/rack_web_console.rb
+- rack_web_console.gemspec
+homepage: https://github.com/rosenfeld/rack_web_console
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A web console for Rack apps.
+test_files: []