mega-clean-box 0.0.1

data/web-console-4.3.0/lib/web_console/injector.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module WebConsole
+  # Injects content into a Rack body.
+  class Injector
+    def initialize(body, headers)
+      @body = "".dup
+
+      body.each { |part| @body << part }
+      body.close if body.respond_to?(:close)
+
+      @headers = headers
+    end
+
+    def inject(content)
+      # Set content-length header to the size of the current body
+      # + the extra content. Otherwise the response will be truncated.
+      if @headers[Rack::CONTENT_LENGTH]
+        @headers[Rack::CONTENT_LENGTH] = (@body.bytesize + content.bytesize).to_s
+      end
+
+      [
+        if position = @body.rindex("</body>")
+          [ @body.insert(position, content) ]
+        else
+          [ @body << content ]
+        end,
+        @headers
+      ]
+    end
+  end
+end

data/web-console-4.3.0/lib/web_console/interceptor.rb

@@ -0,0 +1,17 @@
+module WebConsole
+  module Interceptor
+    def self.call(request, error)
+      backtrace_cleaner = request.get_header("action_dispatch.backtrace_cleaner")
+
+      # Get the original exception if ExceptionWrapper decides to follow it.
+      Thread.current[:__web_console_exception] = error
+
+      # ActionView::Template::Error bypass ExceptionWrapper original
+      # exception following. The backtrace in the view is generated from
+      # reaching out to original_exception in the view.
+      if error.is_a?(ActionView::Template::Error)
+        Thread.current[:__web_console_exception] = error.cause
+      end
+    end
+  end
+end

data/web-console-4.3.0/lib/web_console/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  errors:
+    unavailable_session: |
+      Session %{id} is no longer available in memory.
+
+      If you happen to run on a multi-process server (like Unicorn or Puma) the process
+      this request hit doesn't store %{id} in memory. Consider turning the number of
+      processes/workers to one (1) or using a different server in development.
+
+    unacceptable_request: |
+      A supported version is expected in the Accept header.
+
+    connection_refused: |
+      Oops! Failed to connect to the Web Console middleware.
+      Please make sure a rails development server is running.

data/web-console-4.3.0/lib/web_console/middleware.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/strip"
+
+module WebConsole
+  class Middleware
+    TEMPLATES_PATH = File.expand_path("../templates", __FILE__)
+
+    cattr_accessor :mount_point, default: "/__web_console"
+    cattr_accessor :whiny_requests, default: true
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      app_exception = catch :app_exception do
+        request = create_regular_or_whiny_request(env)
+        return call_app(env) unless request.permitted?
+
+        if id = id_for_repl_session_update(request)
+          return update_repl_session(id, request)
+        elsif id = id_for_repl_session_stack_frame_change(request)
+          return change_stack_trace(id, request)
+        end
+
+
+        status, headers, body = call_app(env)
+
+        if (session = Session.from(Thread.current)) && acceptable_content_type?(headers)
+          headers["x-web-console-session-id"] = session.id
+          headers["x-web-console-mount-point"] = mount_point
+
+          template = Template.new(env, session)
+          body, headers = Injector.new(body, headers).inject(template.render("index"))
+        end
+
+        [ status, headers, body ]
+      end
+    rescue => e
+      WebConsole.logger.error("\n#{e.class}: #{e}\n\tfrom #{e.backtrace.join("\n\tfrom ")}")
+      raise e
+    ensure
+      # Clean up the fiber locals after the session creation. Object#console
+      # uses those to communicate the current binding or exception to the middleware.
+      Thread.current[:__web_console_exception] = nil
+      Thread.current[:__web_console_binding] = nil
+
+      raise app_exception if Exception === app_exception
+    end
+
+    private
+
+      def acceptable_content_type?(headers)
+        headers[Rack::CONTENT_TYPE].to_s.include?("html")
+      end
+
+      def json_response(opts = {})
+        status  = opts.fetch(:status, 200)
+        headers = { Rack::CONTENT_TYPE => "application/json; charset = utf-8" }
+        body    = yield.to_json
+
+        [ status, headers, [ body ] ]
+      end
+
+      def json_response_with_session(id, request, opts = {})
+        return respond_with_unavailable_session(id) unless session = Session.find(id)
+
+        json_response(opts) { yield session }
+      end
+
+      def create_regular_or_whiny_request(env)
+        request = Request.new(env)
+        whiny_requests ? WhinyRequest.new(request) : request
+      end
+
+      def repl_sessions_re
+        @_repl_sessions_re ||= %r{#{mount_point}/repl_sessions/(?<id>[^/]+)}
+      end
+
+      def update_re
+        @_update_re ||= %r{#{repl_sessions_re}\z}
+      end
+
+      def binding_change_re
+        @_binding_change_re ||= %r{#{repl_sessions_re}/trace\z}
+      end
+
+      def id_for_repl_session_update(request)
+        if request.xhr? && request.put?
+          update_re.match(request.path) { |m| m[:id] }
+        end
+      end
+
+      def id_for_repl_session_stack_frame_change(request)
+        if request.xhr? && request.post?
+          binding_change_re.match(request.path) { |m| m[:id] }
+        end
+      end
+
+      def update_repl_session(id, request)
+        json_response_with_session(id, request) do |session|
+          if input = request.params[:input]
+            { output: session.eval(input) }
+          elsif input = request.params[:context]
+            { context: session.context(input) }
+          end
+        end
+      end
+
+      def change_stack_trace(id, request)
+        json_response_with_session(id, request) do |session|
+          session.switch_binding_to(request.params[:frame_id], request.params[:exception_object_id])
+
+          { ok: true }
+        end
+      end
+
+      def respond_with_unavailable_session(id)
+        json_response(status: 404) do
+          { output: format(I18n.t("errors.unavailable_session"), id: id) }
+        end
+      end
+
+      def respond_with_unacceptable_request
+        json_response(status: 406) do
+          { output: I18n.t("errors.unacceptable_request") }
+        end
+      end
+
+      def call_app(env)
+        @app.call(env)
+      rescue => e
+        throw :app_exception, e
+      end
+  end
+end

data/web-console-4.3.0/lib/web_console/permissions.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "ipaddr"
+
+module WebConsole
+  class Permissions
+    # IPv4 and IPv6 localhost should be always allowed.
+    ALWAYS_PERMITTED_NETWORKS = %w( 127.0.0.0/8 ::1 ::ffff:127.0.0.0/104 )
+
+    def initialize(networks = nil)
+      @networks = normalize_networks(networks).map(&method(:coerce_network_to_ipaddr)).uniq
+    end
+
+    def include?(network)
+      @networks.any? { |permission| permission.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_PERMITTED_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

data/web-console-4.3.0/lib/web_console/railtie.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module WebConsole
+  class Railtie < ::Rails::Railtie
+    config.web_console = ActiveSupport::OrderedOptions.new
+
+    initializer "web_console.initialize" do
+      require "bindex"
+      require "web_console/extensions"
+
+      ActionDispatch::DebugExceptions.register_interceptor(Interceptor)
+    end
+
+    initializer "web_console.development_only" do
+      unless (config.web_console.development_only == false) || Rails.env.development?
+        abort <<-END.strip_heredoc
+          Web Console is activated in the #{Rails.env} environment. This is
+          usually a mistake. To ensure it's only activated in development
+          mode, move it to the development group of your Gemfile:
+
+              gem 'web-console', group: :development
+
+          If you still want to run it in the #{Rails.env} environment (and know
+          what you are doing), put this in your Rails application
+          configuration:
+
+              config.web_console.development_only = false
+        END
+      end
+    end
+
+    initializer "web_console.insert_middleware" do |app|
+      app.middleware.insert_before ActionDispatch::DebugExceptions, Middleware
+    end
+
+    initializer "web_console.mount_point" do
+      if mount_point = config.web_console.mount_point
+        Middleware.mount_point = mount_point.chomp("/")
+      end
+
+      if root = Rails.application.config.relative_url_root
+        Middleware.mount_point = File.join(root, Middleware.mount_point)
+      end
+    end
+
+    initializer "web_console.template_paths" do
+      if template_paths = config.web_console.template_paths
+        Template.template_paths.unshift(*Array(template_paths))
+      end
+    end
+
+    initializer "web_console.deprecator" do |app|
+      app.deprecators[:web_console] = WebConsole.deprecator if app.respond_to?(:deprecators)
+    end
+
+    initializer "web_console.permissions" do
+      permissions = web_console_permissions
+      Request.permissions = Permissions.new(permissions)
+    end
+
+    def web_console_permissions
+      case
+      when config.web_console.permissions
+        config.web_console.permissions
+      when config.web_console.allowed_ips
+        config.web_console.allowed_ips
+      when config.web_console.whitelisted_ips
+        WebConsole.deprecator.warn(<<-MSG.squish)
+          The config.web_console.whitelisted_ips is deprecated and will be ignored in future release of web_console.
+          Please use config.web_console.allowed_ips instead.
+        MSG
+        config.web_console.whitelisted_ips
+      end
+    end
+
+    initializer "web_console.whiny_requests" do
+      if config.web_console.key?(:whiny_requests)
+        Middleware.whiny_requests = config.web_console.whiny_requests
+      end
+    end
+
+    initializer "i18n.load_path" do
+      config.i18n.load_path.concat(Dir[File.expand_path("../locales/*.yml", __FILE__)])
+    end
+  end
+end

data/web-console-4.3.0/lib/web_console/request.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module WebConsole
+  class Request < ActionDispatch::Request
+    cattr_accessor :permissions, default: Permissions.new
+
+    def permitted?
+      permissions.include?(strict_remote_ip)
+    end
+
+    def strict_remote_ip
+      GetSecureIp.new(self, permissions).to_s
+    rescue ActionDispatch::RemoteIp::IpSpoofAttackError
+      "[Spoofed]"
+    end
+
+    private
+
+      class GetSecureIp < ActionDispatch::RemoteIp::GetIp
+        def initialize(req, proxies)
+          # After rails/rails@07b2ff0 ActionDispatch::RemoteIp::GetIp initializes
+          # with a ActionDispatch::Request object instead of plain Rack
+          # environment hash. Keep both @req and @env here, so we don't if/else
+          # on Rails versions.
+          @req      = req
+          @env      = req.env
+          @check_ip = true
+          @proxies  = proxies
+        end
+
+        # Used by rails <= 8.1
+        def filter_proxies(ips)
+          ips.reject do |ip|
+            @proxies.include?(ip)
+          end
+        end
+
+        # Used by rails > 8.1.
+        def first_non_proxy(ips)
+          ips.find do |ip|
+            !@proxies.include?(ip)
+          end
+        end
+      end
+  end
+end

data/web-console-4.3.0/lib/web_console/session.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module WebConsole
+  # A session lets you persist an +Evaluator+ instance in memory associated
+  # with multiple bindings.
+  #
+  # Each newly created session is persisted into memory and you can find it
+  # later by its +id+.
+  #
+  # A session may be associated with multiple bindings. This is used by the
+  # error pages only, as currently, this is the only client that needs to do
+  # that.
+  class Session
+    cattr_reader :inmemory_storage, default: {}
+
+    class << self
+      # Finds a persisted session in memory by its id.
+      #
+      # Returns a persisted session if found in memory.
+      # Raises NotFound error unless found in memory.
+      def find(id)
+        inmemory_storage[id]
+      end
+
+      # Create a Session from an binding or exception in a storage.
+      #
+      # The storage is expected to respond to #[]. The binding is expected in
+      # :__web_console_binding and the exception in :__web_console_exception.
+      #
+      # Can return nil, if no binding or exception have been preserved in the
+      # storage.
+      def from(storage)
+        if exc = storage[:__web_console_exception]
+          new(ExceptionMapper.follow(exc))
+        elsif binding = storage[:__web_console_binding]
+          new([[binding]])
+        end
+      end
+    end
+
+    # An unique identifier for every REPL.
+    attr_reader :id
+
+    def initialize(exception_mappers)
+      @id = SecureRandom.hex(16)
+
+      @exception_mappers = exception_mappers
+      @evaluator         = Evaluator.new(@current_binding = exception_mappers.first.first)
+
+      store_into_memory
+    end
+
+    # Evaluate +input+ on the current Evaluator associated binding.
+    #
+    # Returns a string of the Evaluator output.
+    def eval(input)
+      @evaluator.eval(input)
+    end
+
+    # Switches the current binding to the one at specified +index+.
+    #
+    # Returns nothing.
+    def switch_binding_to(index, exception_object_id)
+      bindings = ExceptionMapper.find_binding(@exception_mappers, exception_object_id)
+
+      @evaluator = Evaluator.new(@current_binding = bindings[index.to_i])
+    end
+
+    # Returns context of the current binding
+    def context(objpath)
+      Context.new(@current_binding).extract(objpath)
+    end
+
+    private
+
+      def store_into_memory
+        inmemory_storage[id] = self
+      end
+  end
+end

data/web-console-4.3.0/lib/web_console/source_location.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module WebConsole
+  class SourceLocation
+    def initialize(binding)
+      @binding = binding
+    end
+
+    def path() @binding.source_location.first end
+    def lineno() @binding.source_location.last end
+  end
+end

data/web-console-4.3.0/lib/web_console/tasks/extensions.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+namespace :ext do
+  rootdir = Pathname("extensions")
+
+  desc "Build Chrome Extension"
+  task chrome: "chrome:build"
+
+  namespace :chrome do
+    dist   = Pathname("dist/crx")
+    extdir = rootdir.join(dist)
+    manifest_json = rootdir.join("chrome/manifest.json")
+
+    directory extdir
+
+    task build: [ extdir, "lib:templates" ] do
+      cd rootdir do
+        cp_r [ "img/", "tmp/lib/" ], dist
+        `cd chrome && git ls-files`.split("\n").each do |src|
+          dest = dist.join(src)
+          mkdir_p dest.dirname
+          cp Pathname("chrome").join(src), dest
+        end
+      end
+    end
+
+    # Generate a .crx file.
+    task crx: [ :build, :npm ] do
+      out = "crx-web-console-#{JSON.parse(File.read(manifest_json))["version"]}.crx"
+      cd(extdir) { sh "node \"$(npm bin)/crx\" pack ./ -p ../crx-web-console.pem -o ../#{out}" }
+    end
+
+    # Generate a .zip file for Chrome Web Store.
+    task zip: [ :build ] do
+      version = JSON.parse(File.read(manifest_json))["version"]
+      cd(extdir) { sh "zip -r ../crx-web-console-#{version}.zip ./" }
+    end
+
+    desc "Launch a browser with the chrome extension."
+    task run: [ :build ] do
+      cd(rootdir) { sh "sh ./script/run_chrome.sh --load-extension=#{dist}" }
+    end
+  end
+
+  task :npm do
+    cd(rootdir) { sh "npm install --silent" }
+  end
+
+  namespace :lib do
+    templates = Pathname("lib/web_console/templates")
+    tmplib    = rootdir.join("tmp/lib/")
+    js_erb    = FileList.new(templates.join("**/*.js.erb"))
+    dirs      = js_erb.pathmap("%{^#{templates},#{tmplib}}d")
+
+    task templates: dirs + js_erb.pathmap("%{^#{templates},#{tmplib}}X")
+
+    dirs.each { |d| directory d }
+    rule ".js" => [ "%{^#{tmplib},#{templates}}X.js.erb" ] do |t|
+      File.write(t.name, WebConsole::Testing::ERBPrecompiler.new(t.source).build)
+    end
+  end
+end

data/web-console-4.3.0/lib/web_console/tasks/templates.rake

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+namespace :templates do
+  desc "Run tests for templates"
+  task test: [ :daemonize, :npm, :rackup, :wait, :mocha, :kill, :exit ]
+  task serve: [ :npm, :rackup ]
+
+  workdir = Pathname(EXPANDED_CWD).join("test/templates")
+  pid     = Pathname(Dir.tmpdir).join("web_console_test.pid")
+  runner  = URI.parse("http://#{ENV['IP'] || '127.0.0.1'}:#{ENV['PORT'] || 29292}/html/test_runner.html")
+  rackup  = "rackup --host #{runner.host} --port #{runner.port}"
+  result  = nil
+
+  def need_to_wait?(uri)
+    Net::HTTP.start(uri.host, uri.port) { |http| http.get(uri.path) }
+  rescue Errno::ECONNREFUSED
+    retry if yield
+  end
+
+  task :daemonize do
+    rackup += " -D --pid #{pid}"
+  end
+
+  task :npm do
+    Dir.chdir(workdir) { system "npm install --silent" }
+  end
+
+  task :rackup do
+    Dir.chdir(workdir) { system rackup }
+  end
+
+  task :wait do
+    cnt = 0
+    need_to_wait?(runner) { sleep 1; cnt += 1; cnt < 5 }
+  end
+
+  task :mocha do
+    Dir.chdir(workdir) { result = system("npx mocha-headless-chrome -f #{runner} -r dot") }
+  end
+
+  task :kill do
+    system "kill #{File.read pid}"
+  end
+
+  task :exit do
+    exit result
+  end
+end

data/web-console-4.3.0/lib/web_console/template.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WebConsole
+  # A facade that handles template rendering and composition.
+  #
+  # It introduces template helpers to ease the inclusion of scripts only on
+  # Rails error pages.
+  class Template
+    # Lets you customize the default templates folder location.
+    cattr_accessor :template_paths, default: [ File.expand_path("../templates", __FILE__) ]
+
+    def initialize(env, session)
+      @env = env
+      @session = session
+      @mount_point = Middleware.mount_point
+    end
+
+    # Render a template (inferred from +template_paths+) as a plain string.
+    def render(template)
+      view = View.with_empty_template_cache.with_view_paths(template_paths, instance_values)
+      view.render(template: template, layout: false)
+    end
+  end
+end

data/web-console-4.3.0/lib/web_console/templates/_inner_console_markup.html.erb

@@ -0,0 +1,8 @@
+<div class='resizer layer'></div>
+<div class='console-outer layer'>
+  <div class='console-actions'>
+    <div class='close-button button' title='close'>&times;</div>
+  </div>
+  <div class='console-inner'></div>
+</div>
+<input class='clipboard' type='text'>

data/web-console-4.3.0/lib/web_console/templates/_markup.html.erb

@@ -0,0 +1,5 @@
+<div id="console"
+  data-mount-point='<%= @mount_point %>'
+  data-session-id='<%= @session.id %>'
+  data-prompt-label='>> '>
+</div>

data/web-console-4.3.0/lib/web_console/templates/_prompt_box_markup.html.erb

@@ -0,0 +1,2 @@
+<span class='console-prompt-label'></span>
+<pre class='console-prompt-display'></pre>