web-console-compat 3.5.1

data/lib/web_console/templates/error_page.js.erb

@@ -0,0 +1,70 @@
+// Try intercept traces links in Rails 4.2.
+var traceFrames = document.getElementsByClassName('trace-frames');
+var selectedFrame, currentSource = document.getElementById('frame-source-0');
+
+// Add click listeners for all stack frames
+for (var i = 0; i < traceFrames.length; i++) {
+  traceFrames[i].addEventListener('click', function(e) {
+    e.preventDefault();
+    var target = e.target;
+    var frameId = target.dataset.frameId;
+
+    // Change the binding of the console.
+    changeBinding(frameId, function() {
+      if (selectedFrame) {
+        selectedFrame.className = selectedFrame.className.replace("selected", "");
+      }
+
+      target.className += " selected";
+      selectedFrame = target;
+    });
+
+    // Change the extracted source code
+    changeSourceExtract(frameId);
+  });
+}
+
+function changeBinding(frameId, callback) {
+  REPLConsole.currentSession.switchBindingTo(frameId, callback);
+}
+
+function changeSourceExtract(frameId) {
+  var el = document.getElementById('frame-source-' + frameId);
+  if (currentSource && el) {
+    currentSource.className += " hidden";
+    el.className = el.className.replace(" hidden", "");
+    currentSource = el;
+  }
+}
+
+// Push the error page body upwards the size of the console.
+//
+// While, I wouldn't like to do that on every custom page (so I don't screw
+// user's layouts), I think a lot of developers want to see all of the content
+// on the default Rails error page.
+//
+// Since it's quite special as is now, being a bit more special in the name of
+// better user experience, won't hurt.
+document.addEventListener('DOMContentLoaded', function() {
+  var consoleElement = document.getElementById('console');
+  var resizerElement = consoleElement.getElementsByClassName('resizer')[0];
+  var containerElement = document.getElementById('container');
+
+  function setContainerElementBottomMargin(pixels) {
+    containerElement.style.marginBottom = pixels + 'px';
+  }
+
+  var currentConsoleElementHeight = consoleElement.offsetHeight;
+  setContainerElementBottomMargin(currentConsoleElementHeight);
+
+  resizerElement.addEventListener('mousedown', function(event) {
+    function recordConsoleElementHeight(event) {
+      resizerElement.removeEventListener('mouseup', recordConsoleElementHeight);
+
+      var currentConsoleElementHeight = consoleElement.offsetHeight;
+      setContainerElementBottomMargin(currentConsoleElementHeight);
+    }
+
+    resizerElement.addEventListener('mouseup', recordConsoleElementHeight);
+  });
+});

data/lib/web_console/templates/index.html.erb

@@ -0,0 +1,8 @@
+<%= render 'markup' %>
+
+<%= render_javascript 'console' %>
+<%= render_javascript 'main' %>
+
+<% only_on_error_page do %>
+  <%= render_javascript 'error_page' %>
+<% end %>

data/lib/web_console/templates/layouts/inlined_string.erb

@@ -0,0 +1 @@
+"<%= j yield %>"

data/lib/web_console/templates/layouts/javascript.erb

@@ -0,0 +1,5 @@
+<script type="text/javascript" data-template="<%= @template %>">
+(function() {
+  <%= yield %>
+}).call(this);
+</script>

data/lib/web_console/templates/main.js.erb

@@ -0,0 +1 @@
+REPLConsole.installInto('console');

data/lib/web_console/templates/style.css.erb

@@ -0,0 +1,33 @@
+.console .pos-absolute { position: absolute; }
+.console .pos-fixed { position: fixed; }
+.console .pos-right { right: 0; }
+.console .border-box { box-sizing: border-box; }
+.console .layer { width: 100%; height: 100%; }
+.console .layer.console-outer { z-index: 1; }
+.console .layer.resizer { z-index: 2; }
+.console { position: fixed; left: 0; bottom: 0; width: 100%; height: 148px; padding: 0; margin: 0; background: none repeat scroll 0% 0% #333; z-index: 9999; }
+.console .console-outer { overflow: auto; padding-top: 4px; }
+.console .console-inner { font-family: monospace; font-size: 11px; width: 100%; height: 100%; overflow: none; background: #333; }
+.console .console-prompt-box { color: #FFF; }
+.console .console-message { color: #1AD027; margin: 0; border: 0; white-space: pre-wrap; background-color: #333; padding: 0; }
+.console .console-message.error-message { color: #fc9; }
+.console .console-message.auto-complete { word-break: break-all; }
+.console .console-message.auto-complete .keyword { margin-right: 11px; }
+.console .console-message.auto-complete .keyword.selected { background: #FFF; color: #000; }
+.console .console-message.auto-complete .hidden { display: none; }
+.console .console-message.auto-complete .trimmed { display: none; }
+.console .console-hint { color: #096; }
+.console .console-focus .console-cursor { background: #FEFEFE; color: #333; font-weight: bold; }
+.console .resizer { background: #333; width: 100%; height: 4px; cursor: ns-resize; }
+.console .console-actions { padding-right: 3px; }
+.console .console-actions .button { float: left; }
+.console .button { cursor: pointer; border-radius: 1px; font-family: monospace; font-size: 13px; width: 14px; height: 14px; line-height: 14px; text-align: center; color: #ccc; }
+.console .button:hover { background: #666; color: #fff; }
+.console .button.close-button:hover { background: #966; }
+.console .clipboard { height: 0px; padding: 0px; margin: 0px; width: 0px; margin-left: -1000px; }
+.console .console-prompt-label { display: inline; color: #FFF; background: none repeat scroll 0% 0% #333; border: 0; padding: 0; }
+.console .console-prompt-display { display: inline; color: #FFF; background: none repeat scroll 0% 0% #333; border: 0; padding: 0; }
+.console.full-screen { height: 100%; }
+.console.full-screen .console-outer { padding-top: 3px; }
+.console.full-screen .resizer { display: none; }
+.console.full-screen .close-button { display: none; }

data/lib/web_console/testing/erb_precompiler.rb

@@ -0,0 +1,25 @@
+require 'web_console/testing/helper'
+require 'web_console/testing/fake_middleware'
+
+module WebConsole
+  module Testing
+    # This class is to pre-compile 'templates/*.erb'.
+    class ERBPrecompiler
+      def initialize(path)
+        @erb  = ERB.new(File.read(path))
+        @view = FakeMiddleware.new(
+          view_path: Helper.gem_root.join('lib/web_console/templates'),
+        ).view
+      end
+
+      def build
+        @erb.result(binding)
+      end
+
+      def method_missing(name, *args, &block)
+        return super unless @view.respond_to?(name)
+        @view.send(name, *args, &block)
+      end
+    end
+  end
+end

data/lib/web_console/testing/fake_middleware.rb

@@ -0,0 +1,39 @@
+require 'action_view'
+require 'web_console'
+require 'web_console/testing/helper'
+Mime = { web_console_v2: 'fake' }
+
+module WebConsole
+  module Testing
+    class FakeMiddleware
+      I18n.load_path.concat(Dir[Helper.gem_root.join('lib/web_console/locales/*.yml')])
+
+      DEFAULT_HEADERS = { "Content-Type" => "application/javascript" }
+
+      def initialize(opts)
+        @headers        = opts.fetch(:headers, DEFAULT_HEADERS)
+        @req_path_regex = opts[:req_path_regex]
+        @view_path      = opts[:view_path]
+      end
+
+      def call(env)
+        [ 200, @headers, [ render(req_path(env)) ] ]
+      end
+
+      def view
+        @view = View.new(@view_path)
+      end
+
+      private
+
+        # extract target path from REQUEST_PATH
+        def req_path(env)
+          env["REQUEST_PATH"].match(@req_path_regex)[1]
+        end
+
+        def render(template)
+          view.render(template: template, layout: nil)
+        end
+    end
+  end
+end

data/lib/web_console/testing/helper.rb

@@ -0,0 +1,9 @@
+module WebConsole
+  module Testing
+    module Helper
+      def self.gem_root
+        Pathname(File.expand_path('../../../../', __FILE__))
+      end
+    end
+  end
+end

data/lib/web_console/version.rb

@@ -0,0 +1,3 @@
+module WebConsole
+  VERSION = '3.5.1'
+end

data/lib/web_console/view.rb

@@ -0,0 +1,50 @@
+module WebConsole
+  class View < ActionView::Base
+    # Execute a block only on error pages.
+    #
+    # The error pages are special, because they are the only pages that
+    # currently require multiple bindings. We get those from exceptions.
+    def only_on_error_page(*args)
+      yield if Thread.current[:__web_console_exception].present?
+    end
+
+    # Render JavaScript inside a script tag and a closure.
+    #
+    # This one lets write JavaScript that will automatically get wrapped in a
+    # script tag and enclosed in a closure, so you don't have to worry for
+    # leaking globals, unless you explicitly want to.
+    def render_javascript(template)
+      assign(template: template)
+      render(template: template, layout: 'layouts/javascript')
+    end
+
+    # Render inlined string to be used inside of JavaScript code.
+    #
+    # The inlined string is returned as an actual JavaScript string. You
+    # don't need to wrap the result yourself.
+    def render_inlined_string(template)
+      render(template: template, layout: 'layouts/inlined_string')
+    end
+
+    # Custom ActionView::Base#render wrapper which silences all the log
+    # printings.
+    #
+    # Helps to keep the Rails logs clean during errors.
+    def render(*)
+      if logger = WebConsole.logger and logger.respond_to?(:silence)
+        WebConsole.logger.silence { super }
+      else
+        super
+      end
+    end
+
+    # Override method for ActionView::Helpers::TranslationHelper#t.
+    #
+    # This method escapes the original return value for JavaScript, since the
+    # method returns a HTML tag with some attributes when the key is not found,
+    # so it could cause a syntax error if we use the value in the string literals.
+    def t(key, options = {})
+      j super
+    end
+  end
+end

data/lib/web_console/whiny_request.rb

@@ -0,0 +1,31 @@
+module WebConsole
+  # Noisy wrapper around +Request+.
+  #
+  # If any calls to +from_whitelisted_ip?+ and +acceptable_content_type?+
+  # return false, an info log message will be displayed in users' logs.
+  class WhinyRequest < SimpleDelegator
+    def from_whitelisted_ip?
+      whine_unless request.from_whitelisted_ip? do
+        "Cannot render console from #{request.strict_remote_ip}! " \
+          "Allowed networks: #{request.whitelisted_ips}"
+      end
+    end
+
+    private
+
+      def whine_unless(condition)
+        unless condition
+          logger.info { yield }
+        end
+        condition
+      end
+
+      def logger
+        env['action_dispatch.logger'] || WebConsole.logger
+      end
+
+      def request
+        __getobj__
+      end
+  end
+end

data/lib/web_console/whitelist.rb

@@ -0,0 +1,44 @@
+require 'ipaddr'
+
+module WebConsole
+  # Whitelist of allowed networks that can access Web Console.
+  #
+  # Networks are represented by standard IPAddr and can be either IPv4 or IPv6
+  # networks.
+  class Whitelist
+    # IPv4 and IPv6 localhost should be always whitelisted.
+    ALWAYS_WHITELISTED_NETWORKS = %w( 127.0.0.0/8 ::1 )
+
+    def initialize(networks = nil)
+      @networks = normalize_networks(networks).map(&method(:coerce_network_to_ipaddr)).uniq
+    end
+
+    def include?(network)
+      @networks.any? { |whitelist| whitelist.include?(network.to_s) }
+    rescue IPAddr::InvalidAddressError
+      false
+    end
+
+    def to_s
+      @networks.map(&method(:human_readable_ipaddr)).join(', ')
+    end
+
+    private
+
+      def normalize_networks(networks)
+        Array(networks).concat(ALWAYS_WHITELISTED_NETWORKS)
+      end
+
+      def coerce_network_to_ipaddr(network)
+        if network.is_a?(IPAddr)
+          network
+        else
+          IPAddr.new(network)
+        end
+      end
+
+      def human_readable_ipaddr(ipaddr)
+        ipaddr.to_range.to_s.split('..').uniq.join('/')
+      end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: web-console-compat
+version: !ruby/object:Gem::Version
+  version: 3.5.1
+platform: ruby
+authors:
+- Charlie Somerville
+- Genadi Samokovarov
+- Guillermo Iguaran
+- Ryan Dao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: debug_inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- charlie@charliesomerville.com
+- gsamokovarov@gmail.com
+- guilleiguaran@gmail.com
+- daoduyducduong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.markdown
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/web-console-compat.rb
+- lib/web-console.rb
+- lib/web_console.rb
+- lib/web_console/context.rb
+- lib/web_console/errors.rb
+- lib/web_console/evaluator.rb
+- lib/web_console/exception_mapper.rb
+- lib/web_console/extensions.rb
+- lib/web_console/integration.rb
+- lib/web_console/integration/cruby.rb
+- lib/web_console/integration/rubinius.rb
+- lib/web_console/locales/en.yml
+- lib/web_console/middleware.rb
+- lib/web_console/railtie.rb
+- lib/web_console/request.rb
+- lib/web_console/response.rb
+- lib/web_console/session.rb
+- lib/web_console/tasks/extensions.rake
+- lib/web_console/tasks/templates.rake
+- lib/web_console/template.rb
+- lib/web_console/templates/_inner_console_markup.html.erb
+- lib/web_console/templates/_markup.html.erb
+- lib/web_console/templates/_prompt_box_markup.html.erb
+- lib/web_console/templates/console.js.erb
+- lib/web_console/templates/error_page.js.erb
+- lib/web_console/templates/index.html.erb
+- lib/web_console/templates/layouts/inlined_string.erb
+- lib/web_console/templates/layouts/javascript.erb
+- lib/web_console/templates/main.js.erb
+- lib/web_console/templates/style.css.erb
+- lib/web_console/testing/erb_precompiler.rb
+- lib/web_console/testing/fake_middleware.rb
+- lib/web_console/testing/helper.rb
+- lib/web_console/version.rb
+- lib/web_console/view.rb
+- lib/web_console/whiny_request.rb
+- lib/web_console/whitelist.rb
+homepage: https://github.com/rails/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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A debugging tool for your Ruby on Rails applications.
+test_files: []