scarpe 0.2.1 → 0.3.0

data/lib/scarpe/wv/web_wrangler.rb

@@ -8,49 +8,70 @@ require "cgi"
 # After creation, it starts in setup mode, and you can
 # use setup-mode callbacks.
 
-class Scarpe
+module Scarpe::Webview
+  # The Scarpe WebWrangler, for Webview, manages a lot of Webviews quirks. It provides
+  # a simpler underlying abstraction for DOMWrangler and the Webview drawables.
+  # Webview can be picky - if you send it too many messages, it can crash. If the
+  # messages you send it are too large, it can crash. If you don't return control
+  # to its event loop, it can crash. It doesn't save references to all event handlers,
+  # so if you don't save references to them, garbage collection will cause it to
+  # crash.
+  #
+  # As well, Webview only supports asynchronous JS code evaluation with no value
+  # being returned. One of WebWrangler's responsibilities is to make asynchronous
+  # JS calls, detect when they return a value or time out, and make the result clear
+  # to other Scarpe code.
+  #
+  # Some Webview API functions will crash on some platforms if called from a
+  # background thread. Webview will halt all background threads when it runs its
+  # event loop. So it's best to assume no Ruby background threads will be available
+  # while Webview is running. If a Ruby app wants ongoing work to occur, that work
+  # should be registered via a heartbeat handler on the Webview.
+  #
+  # A WebWrangler is initially in Setup mode, where the underlying Webview exists
+  # but does not yet control the event loop. In Setup mode you can bind JS functions,
+  # set up initialization code, but nothing is yet running.
+  #
+  # Once run() is called on WebWrangler, we will hand control of the event loop to
+  # the Webview. This will also stop any background threads in Ruby.
   class WebWrangler
-    include Scarpe::Log
+    include Shoes::Log
 
+    # Whether Webview has been started. Once Webview is running you can't add new
+    # Javascript bindings. Until it is running, you can't use eval to run Javascript.
     attr_reader :is_running
-    attr_reader :is_terminated
-    attr_reader :heartbeat # This is the heartbeat duration in seconds, usually fractional
-    attr_reader :control_interface
 
-    # This error indicates a problem when running ConfirmedEval
-    class JSEvalError < Scarpe::Error
-      def initialize(data)
-        @data = data
-        super(data[:msg] || (self.class.name + "!"))
-      end
-    end
-
-    # We got an error running the supplied JS code string in confirmed_eval
-    class JSRuntimeError < JSEvalError
-    end
+    # Once Webview is marked terminated, it's attempting to shut down. If we get
+    # events (e.g. heartbeats) after that, we should ignore them.
+    attr_reader :is_terminated
 
-    # The code timed out for some reason
-    class JSTimeoutError < JSEvalError
-    end
+    # This is the time between heartbeats in seconds, usually fractional
+    attr_reader :heartbeat
 
-    # We got weird or nonsensical results that seem like an error on WebWrangler's part
-    class InternalError < JSEvalError
-    end
+    # A reference to the control_interface that manages internal Scarpe Webview events.
+    attr_reader :control_interface
 
-    # This is the JS function name for eval results
+    # This is the JS function name for eval results (internal-only)
     EVAL_RESULT = "scarpeAsyncEvalResult"
 
-    # Allow a half-second for Webview to finish our JS eval before we decide it's not going to
+    # Allow this many seconds for Webview to finish our JS eval before we decide it's not going to
     EVAL_DEFAULT_TIMEOUT = 0.5
 
-    def initialize(title:, width:, height:, resizable: false, debug: false, heartbeat: 0.1)
-      log_init("WV::WebWrangler")
+    # Create a new WebWrangler.
+    #
+    # @param title [String] window title
+    # @param width [Integer] window width in pixels
+    # @param height [Integer] window height in pixels
+    # @param resizable [Boolean] whether the window should be resizable by the user
+    # @param heartbeat [Float] time between heartbeats in seconds
+    def initialize(title:, width:, height:, resizable: false, heartbeat: 0.1)
+      log_init("Webview::WebWrangler")
 
       @log.debug("Creating WebWrangler...")
 
-      # For now, always allow inspect element
+      # For now, always allow inspect element, so pass debug: true
       @webview = WebviewRuby::Webview.new debug: true
-      @webview = Scarpe::LoggedWrapper.new(@webview, "WebviewAPI") if debug
+      @webview = Shoes::LoggedWrapper.new(@webview, "WebviewAPI") if ENV["SCARPE_DEBUG"]
       @init_refs = {} # Inits don't go away so keep a reference to them to prevent GC
 
       @title = title
@@ -59,8 +80,8 @@ class Scarpe
       @resizable = resizable
       @heartbeat = heartbeat
 
-      # Better to have a single setInterval than many when we don't care too much
-      # about the timing.
+      # JS setInterval uses RPC and is quite expensive. For many periodic operations
+      # we can group them under a single heartbeat handler and avoid extra JS calls or RPC.
       @heartbeat_handlers = []
 
       # Need to keep track of which WebView Javascript evals are still pending,
@@ -100,16 +121,28 @@ class Scarpe
 
     ### Setup-mode Callbacks
 
+    # Bind a Javascript-callable function by name. When JS calls the function,
+    # an async message is sent to Ruby via RPC and will eventually cause the
+    # block to be called. This method only works in setup mode, before the
+    # underlying Webview has been told to run.
+    #
+    # @param name [String] the Javascript name for the new function
+    # @yield The Ruby block to be invoked when JS calls the function
     def bind(name, &block)
-      raise "App is running, javascript binding no longer works because it uses WebView init!" if @is_running
+      raise Scarpe::JSBindingError, "App is running, javascript binding no longer works because it uses WebView init!" if @is_running
 
       @webview.bind(name, &block)
     end
 
+    # Request that this block of code be run initially when the Webview is run.
+    # This operates via #init and will not work if Webview is already running.
+    #
+    # @param name [String] the Javascript name for the init function
+    # @yield The Ruby block to be invoked when Webview runs
     def init_code(name, &block)
-      raise "App is running, javascript init no longer works!" if @is_running
+      raise Scarpe::JSInitError, "App is running, javascript init no longer works!" if @is_running
 
-      # Save a reference to the init string so that it goesn't get GC'd
+      # Save a reference to the init string so that it doesn't get GC'd
       code_str = "#{name}();"
       @init_refs[name] = code_str
 
@@ -118,8 +151,16 @@ class Scarpe
     end
 
     # Run the specified code periodically, every "interval" seconds.
-    # If interface is unspecified, run per-heartbeat, which is very
-    # slightly more efficient.
+    # If interval is unspecified, run per-heartbeat. This avoids extra
+    # RPC and Javascript overhead. This may use the #init mechanism,
+    # so it should be invoked when the WebWrangler is in setup mode,
+    # before the Webview is running.
+    #
+    # TODO: add a way to stop this loop and unsubscribe.
+    #
+    # @param name [String] the name of the Javascript init function, if needed
+    # @param interval [Float] the duration between invoking this block
+    # @yield the Ruby block to invoke periodically
     def periodic_code(name, interval = heartbeat, &block)
       if interval == heartbeat
         @heartbeat_handlers << block
@@ -129,7 +170,7 @@ class Scarpe
           # new window. But will there ever be a new page/window? Can we just
           # use eval instead of init to set up a periodic handler and call it
           # good?
-          raise "App is running, can't set up new periodic handlers with init!"
+          raise Scarpe::PeriodicHandlerSetupError, "App is running, can't set up new periodic handlers with init!"
         end
 
         js_interval = (interval.to_f * 1_000.0).to_i
@@ -143,7 +184,7 @@ class Scarpe
 
     # Running callbacks
 
-    # js_eventually is a simple JS evaluation. On syntax error, nothing happens.
+    # js_eventually is a native Webview JS evaluation. On syntax error, nothing happens.
     # On runtime error, execution stops at the error with no further
     # effect or notification. This is rarely what you want.
     # The js_eventually code is run asynchronously, returning neither error
@@ -151,10 +192,13 @@ class Scarpe
     #
     # This method does *not* return a promise, and there is no way to track
     # its progress or its success or failure.
+    #
+    # @param code [String] the Javascript code to attempt to execute
+    # @return [void]
     def js_eventually(code)
-      raise "WebWrangler isn't running, eval doesn't work!" unless @is_running
+      raise Scarpe::WebWranglerNotRunningError, "WebWrangler isn't running, eval doesn't work!" unless @is_running
 
-      @log.warning "Deprecated: please do NOT use js_eventually, it's basically never what you want!" unless ENV["CI"]
+      @log.warn "Deprecated: please do NOT use js_eventually, it's basically never what you want!" unless ENV["CI"]
 
       @webview.eval(code)
     end
@@ -163,21 +207,27 @@ class Scarpe
     # promise which will be fulfilled or rejected after the JS executes
     # or times out.
     #
-    # Note that we *both* care whether the JS has finished after it was
+    # We *both* care whether the JS has finished after it was
     # scheduled *and* whether it ever got scheduled at all. If it
-    # depends on tasks that never fulfill or reject then it may wait
-    # in limbo, potentially forever.
+    # depends on tasks that never fulfill or reject then it will
+    # raise a timed-out exception.
     #
-    # Right now we can't/don't handle arguments from previous fulfilled
-    # promises. To do that, we'd probably need to know we were passing
-    # in a JS function.
-    EVAL_OPTS = [:timeout, :wait_for]
-    def eval_js_async(code, opts = {})
-      bad_opts = opts.keys - EVAL_OPTS
-      raise("Bad options given to eval_with_handler! #{bad_opts.inspect}") unless bad_opts.empty?
-
+    # Right now we can't/don't pass arguments through from previous fulfilled
+    # promises. To do that, you can schedule the JS to run after the
+    # other promises succeed.
+    #
+    # Webview does not allow interacting with a JS eval once it has
+    # been scheduled. So there is no way to guarantee that a piece of JS has
+    # not executed, or will not execute in the future. A timeout exception
+    # only means that WebWrangler will no longer wait for confirmation or
+    # fulfill the promise if the JS later completes.
+    #
+    # @param code [String] the Javascript code to execute
+    # @param timeout [Float] how long to allow before raising a timeout exception
+    # @param wait_for [Array<Scarpe::Promise>] promises that must complete successfully before this JS is scheduled
+    def eval_js_async(code, timeout: EVAL_DEFAULT_TIMEOUT, wait_for: [])
       unless @is_running
-        raise "WebWrangler isn't running, so evaluating JS won't work!"
+        raise Scarpe::WebWranglerNotRunningError, "WebWrangler isn't running, so evaluating JS won't work!"
       end
 
       this_eval_serial = @eval_counter
@@ -192,9 +242,8 @@ class Scarpe
 
       # We'll need this inside the promise-scheduling block
       pending_evals = @pending_evals
-      timeout = opts[:timeout] || EVAL_DEFAULT_TIMEOUT
 
-      promise = Scarpe::Promise.new(parents: (opts[:wait_for] || [])) do
+      promise = Scarpe::Promise.new(parents: wait_for) do
         # Are we mid-shutdown?
         if @webview
           wrapped_code = WebWrangler.js_wrapped_code(code, this_eval_serial)
@@ -220,6 +269,16 @@ class Scarpe
       promise
     end
 
+    # This method takes a piece of Javascript code and wraps it in the WebWrangler
+    # boilerplate to see if it parses successfully, run it, and see if it succeeds.
+    # This function would normally be used by testing code, to mock Webview and
+    # watch for code being run. Javascript code containing backticks
+    # could potentially break this abstraction layer, which would cause the resulting
+    # code to fail to parse and Webview would return no error. This should not be
+    # used for random or untrusted code.
+    #
+    # @param code [String] the Javascript code to be wrapped
+    # @param eval_id [Integer] the tracking code to use when calling EVAL_RESULT
     def self.js_wrapped_code(code, eval_id)
       <<~JS_CODE
         (function() {
@@ -243,7 +302,7 @@ class Scarpe
     def receive_eval_result(r_type, id, val)
       entry = @pending_evals.delete(id)
       unless entry
-        raise "Received an eval result for a nonexistent ID #{id.inspect}!"
+        raise Scarpe::NonexistentEvalResultError, "Received an eval result for a nonexistent ID #{id.inspect}!"
       end
 
       @log.debug("Got JS value: #{r_type} / #{id} / #{val.inspect}")
@@ -254,13 +313,13 @@ class Scarpe
       when "success"
         promise.fulfilled!(val)
       when "error"
-        promise.rejected! JSRuntimeError.new(
+        promise.rejected! Scarpe::JSRuntimeError.new(
           msg: "JS runtime error: #{val.inspect}!",
           code: entry[:code],
           ret_value: val,
         )
       else
-        promise.rejected! InternalError.new(
+        promise.rejected! Scarpe::JSInternalError.new(
           msg: "JS eval internal error! r_type: #{r_type.inspect}",
           code: entry[:code],
           ret_value: val,
@@ -268,11 +327,11 @@ class Scarpe
       end
     end
 
-    # TODO: would be good to keep 'tombstone' results for awhile after timeout, maybe up to around a minute,
-    # so we can detect if we're timing things out and then having them return successfully after a delay.
-    # Then we could adjust the timeouts. We could also check if later serial numbers have returned, and time
-    # out earlier serial numbers... *if* we're sure Webview will always execute JS evals in order.
-    # This all adds complexity, though. For now, do timeouts on a simple max duration.
+    # @todo would be good to keep 'tombstone' results for awhile after timeout, maybe up to around a minute,
+    #   so we can detect if we're timing things out and then having them return successfully after a delay.
+    #   Then we could adjust the timeouts. We could also check if later serial numbers have returned, and time
+    #   out earlier serial numbers... *if* we're sure Webview will always execute JS evals in order.
+    #   This all adds complexity, though. For now, do timeouts on a simple max duration.
     def time_out_eval_results
       t_now = Time.now
       timed_out_from_scheduling = @pending_evals.keys.select do |id|
@@ -296,29 +355,34 @@ class Scarpe
       timed_out_ids.each do |id|
         @log.error "Timing out JS eval! #{@pending_evals[id][:code]}"
         entry = @pending_evals.delete(id)
-        err = JSTimeoutError.new(msg: "JS timeout error!", code: entry[:code], ret_value: nil)
+        err = Scarpe::JSTimeoutError.new(msg: "JS timeout error!", code: entry[:code], ret_value: nil)
         entry[:promise].rejected!(err)
       end
     end
 
     public
 
-    # After setup, we call run to go to "running" mode.
-    # No more setup callbacks, only running callbacks.
+    attr_writer :empty_page
 
+    # After setup, we call run to go to "running" mode.
+    # No more setup callbacks should be called, only running callbacks.
     def run
       @log.debug("Run...")
 
       # From webview:
       # 0 - Width and height are default size
-      # 1 - Width and height are minimum bonds
-      # 2 - Width and height are maximum bonds
+      # 1 - Width and height are minimum bounds
+      # 2 - Width and height are maximum bounds
       # 3 - Window size can not be changed by a user
       hint = @resizable ? 0 : 3
 
       @webview.set_title(@title)
       @webview.set_size(@width, @height, hint)
-      @webview.navigate("data:text/html, #{empty}")
+      unless @empty_page
+        raise Scarpe::EmptyPageNotSetError, "No empty page markup was set!"
+      end
+
+      @webview.navigate("data:text/html, #{CGI.escape @empty_page}")
 
       monkey_patch_console(@webview)
 
@@ -329,6 +393,8 @@ class Scarpe
       @webview = nil
     end
 
+    # Request destruction of WebWrangler, including terminating the underlying
+    # Webview and (when possible) destroying it.
     def destroy
       @log.debug("Destroying WebWrangler...")
       @log.debug("  (WebWrangler was already terminated)") if @is_terminated
@@ -362,318 +428,402 @@ class Scarpe
     end
 
     def empty
-      html = <<~HTML
-        <html>
-          <head id='head-wvroot'>
-            <style id='style-wvroot'>
-              /** Style resets **/
-              body {
-                font-family: arial, Helvetica, sans-serif;
-                margin: 0;
-                height: 100%;
-                overflow: hidden;
-              }
-              p {
-                margin: 0;
-              }
-            </style>
-          </head>
-          <body id='body-wvroot'>
-            <div id='wrapper-wvroot'></div>
-          </body>
-        </html>
-      HTML
-
-      CGI.escape(html)
+      Scarpe::Components::Calzini.empty_page_element
     end
 
     public
 
-    # For now, the WebWrangler gets a bunch of fairly low-level requests
-    # to mess with the HTML DOM. This needs to be turned into a nicer API,
-    # but first we'll get it all into one place and see what we're doing.
-
     # Replace the entire DOM - return a promise for when this has been done.
     # This will often get rid of smaller changes in the queue, which is
     # a good thing since they won't have to be run.
+    #
+    # @param html_text [String] The new HTML for the new full DOM
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the update is complete
     def replace(html_text)
       @dom_wrangler.request_replace(html_text)
     end
 
     # Request a DOM change - return a promise for when this has been done.
+    # If a full replacement (see #replace) is requested, this change may
+    # be lost. Only use it for changes that are preserved by a full update.
+    #
+    # @param js [String] the JS to execute to alter the DOM
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the update is complete
     def dom_change(js)
       @dom_wrangler.request_change(js)
     end
 
     # Return whether the DOM is, right this moment, confirmed to be fully
     # up to date or not.
+    #
+    # @return [Boolean] true if the window is fully updated, false if changes are pending
     def dom_fully_updated?
       @dom_wrangler.fully_updated?
     end
 
     # Return a promise that will be fulfilled when all current DOM changes
-    # have committed (but not necessarily any future DOM changes.)
+    # have committed. If other changes are requested before these
+    # complete, the promise will ***not*** wait for them. If you wish to
+    # wait until all changes from all sources have completed, use
+    # #promise_dom_fully_updated.
+    #
+    # @return [Scarpe::Promise] a promise that will be fulfilled when all current changes complete
     def dom_promise_redraw
       @dom_wrangler.promise_redraw
     end
 
     # Return a promise which will be fulfilled the next time the DOM is
-    # fully up to date. Note that a slow trickle of changes can make this
-    # take a long time, since it is *not* only changes up to this point.
-    # If you want to know that some specific change is done, it's often
-    # easiest to use the promise returned by dom_change(), which will
-    # be fulfilled when that specific change commits.
+    # fully up to date. A slow trickle of changes can make this
+    # take a long time, since it includes all current and future changes,
+    # not just changes before this call.
+    #
+    # If you want to know that some specific individual change is done, it's often
+    # easiest to use the promise returned by #dom_change, which will
+    # be fulfilled when that specific change is verified complete.
+    #
+    # If no changes are pending, promise_dom_fully_updated will
+    # return a promise that is already fulfilled.
+    #
+    # @return [Scarpe::Promise] a promise that will be fulfilled when all changes are complete
     def promise_dom_fully_updated
       @dom_wrangler.promise_fully_updated
     end
 
+    # DOMWrangler will frequently schedule and confirm small JS updates.
+    # A handler registered with on_every_redraw will be called after each
+    # small update.
+    #
+    # @yield Called after each update or batch of updates is verified complete
+    # @return [void]
     def on_every_redraw(&block)
       @dom_wrangler.on_every_redraw(&block)
     end
   end
 end
 
-# Leaving DOM changes as "meh, async, we'll see when it happens" is terrible for testing.
-# Instead, we need to track whether particular changes have committed yet or not.
-# So we add a single gateway for all DOM changes, and we make sure its work is done
-# before we consider a redraw complete.
-#
-# DOMWrangler batches up changes - it's fine to have a redraw "in flight" and have
-# changes waiting to catch the next bus. But we don't want more than one in flight,
-# since it seems like having too many pending RPC requests can crash Webview. So:
-# one redraw scheduled and one redraw promise waiting around, at maximum.
-class Scarpe
-  class WebWrangler
-    class DOMWrangler
-      include Scarpe::Log
+class Scarpe::Webview::WebWrangler
+  # Leaving DOM changes as "meh, async, we'll see when it happens" is terrible for testing.
+  # Instead, we need to track whether particular changes have committed yet or not.
+  # So we add a single gateway for all DOM changes, and we make sure its work is done
+  # before we consider a redraw complete.
+  #
+  # DOMWrangler batches up changes into fewer RPC calls. It's fine to have a redraw
+  # "in flight" and have changes waiting to catch the next bus. But we don't want more
+  # than one in flight, since it seems like having too many pending RPC requests can
+  # crash Webview. So we allow one redraw scheduled and one redraw promise waiting,
+  # at maximum.
+  #
+  # A WebWrangler will create and wrap a DOMWrangler, serving as the interface
+  # for all DOM operations.
+  #
+  # A batch of DOMWrangler changes may be removed if a full update is scheduled. That
+  # update is considered to replace the previous incremental changes. Any changes that
+  # need to execute even if a full update happens should be scheduled through
+  # WebWrangler#eval_js_async, not DOMWrangler.
+  class DOMWrangler
+    include Shoes::Log
+
+    # Changes that have not yet been executed
+    attr_reader :waiting_changes
+
+    # A Scarpe::Promise for JS that has been scheduled to execute but is not yet verified complete
+    attr_reader :pending_redraw_promise
+
+    # A Scarpe::Promise for waiting changes - it will be fulfilled when all waiting changes
+    # have been verified complete, or when a full redraw that removed them has been
+    # verified complete. If many small changes are scheduled, the same promise will be
+    # returned for many of them.
+    attr_reader :waiting_redraw_promise
+
+    # Create a DOMWrangler that is paired with a WebWrangler. The WebWrangler is
+    # treated as an underlying abstraction for reliable JS evaluation.
+    def initialize(web_wrangler)
+      log_init("Webview::WebWrangler::DOMWrangler")
+
+      @wrangler = web_wrangler
+
+      @waiting_changes = []
+      @pending_redraw_promise = nil
+      @waiting_redraw_promise = nil
+
+      @fully_up_to_date_promise = nil
+
+      # Initially we're waiting for a full replacement to happen.
+      # It's possible to request updates/changes before we have
+      # a DOM in place and before Webview is running. If we do
+      # that, we should discard those updates.
+      @first_draw_requested = false
+
+      @redraw_handlers = []
+
+      # The "fully up to date" logic is complicated and not
+      # as well tested as I'd like. This makes it far less
+      # likely that the event simply won't fire.
+      # With more comprehensive testing, this should be
+      # removable.
+      web_wrangler.periodic_code("scarpeDOMWranglerHeartbeat") do
+        if @fully_up_to_date_promise && fully_updated?
+          @log.info("Fulfilling up-to-date promise on heartbeat")
+          @fully_up_to_date_promise.fulfilled!
+          @fully_up_to_date_promise = nil
+        end
+      end
+    end
 
-      attr_reader :waiting_changes
-      attr_reader :pending_redraw_promise
-      attr_reader :waiting_redraw_promise
+    def request_change(js_code)
+      # No updates until there's something to update
+      return unless @first_draw_requested
 
-      def initialize(web_wrangler, debug: false)
-        log_init("WV::WebWrangler::DOMWrangler")
+      @waiting_changes << js_code
 
-        @wrangler = web_wrangler
+      promise_redraw
+    end
 
-        @waiting_changes = []
-        @pending_redraw_promise = nil
-        @waiting_redraw_promise = nil
-
-        @fully_up_to_date_promise = nil
-
-        # Initially we're waiting for a full replacement to happen.
-        # It's possible to request updates/changes before we have
-        # a DOM in place and before Webview is running. If we do
-        # that, we should discard those updates.
-        @first_draw_requested = false
-
-        @redraw_handlers = []
-
-        # The "fully up to date" logic is complicated and not
-        # as well tested as I'd like. This makes it far less
-        # likely that the event simply won't fire.
-        # With more comprehensive testing, this should be
-        # removable.
-        web_wrangler.periodic_code("scarpeDOMWranglerHeartbeat") do
-          if @fully_up_to_date_promise && fully_updated?
-            @log.info("Fulfilling up-to-date promise on heartbeat")
-            @fully_up_to_date_promise.fulfilled!
-            @fully_up_to_date_promise = nil
-          end
-        end
-      end
+    def self.replacement_code(html_text)
+      "document.getElementById('wrapper-wvroot').innerHTML = `#{html_text}`; true"
+    end
 
-      def request_change(js_code)
-        # No updates until there's something to update
-        return unless @first_draw_requested
+    def request_replace(html_text)
+      # Replace other pending changes, they're not needed any more
+      @waiting_changes = [DOMWrangler.replacement_code(html_text)]
+      @first_draw_requested = true
 
-        @waiting_changes << js_code
+      @log.debug("Requesting DOM replacement...")
+      promise_redraw
+    end
 
-        promise_redraw
-      end
+    def on_every_redraw(&block)
+      @redraw_handlers << block
+    end
 
-      def self.replacement_code(html_text)
-        "document.getElementById('wrapper-wvroot').innerHTML = `#{html_text}`; true"
+    # promise_redraw returns a Scarpe::Promise which will be fulfilled after all current
+    # pending or waiting changes have completed. This may require creating a new
+    # promise.
+    #
+    # What are the states of redraw?
+    # "empty" - no waiting promise, no pending-redraw promise, no pending changes
+    # "pending only" - no waiting promise, but we have a pending redraw with some changes; it hasn't committed yet
+    # "pending and waiting" - we have a waiting promise for our unscheduled changes; we can add more unscheduled
+    #     changes since we haven't scheduled them yet.
+    #
+    # This is often called after adding a new waiting change or replacing them, so the state may have just changed.
+    # It can also be called when no changes have been made and no updates need to happen.
+    def promise_redraw
+      if fully_updated?
+        # No changes to make, nothing in-process or waiting, so just return a pre-fulfilled promise
+        @log.debug("Requesting redraw but there are no pending changes or promises, return pre-fulfilled")
+        return ::Scarpe::Promise.fulfilled
       end
 
-      def request_replace(html_text)
-        # Replace other pending changes, they're not needed any more
-        @waiting_changes = [DOMWrangler.replacement_code(html_text)]
-        @first_draw_requested = true
-
-        @log.debug("Requesting DOM replacement...")
-        promise_redraw
+      # Already have a redraw requested *and* one on deck? Then all current changes will have committed
+      # when we (eventually) fulfill the waiting_redraw_promise.
+      if @waiting_redraw_promise
+        @log.debug("Promising eventual redraw of #{@waiting_changes.size} waiting unscheduled changes.")
+        return @waiting_redraw_promise
       end
 
-      def on_every_redraw(&block)
-        @redraw_handlers << block
+      if @waiting_changes.empty?
+        # There's no waiting_redraw_promise. There are no waiting changes. But we're not fully updated.
+        # So there must be a redraw in flight, and we don't need to schedule a new waiting_redraw_promise.
+        @log.debug("Returning in-flight redraw promise")
+        return @pending_redraw_promise
       end
 
-      # What are the states of redraw?
-      # "empty" - no waiting promise, no pending-redraw promise, no pending changes
-      # "pending only" - no waiting promise, but we have a pending redraw with some changes; it hasn't committed yet
-      # "pending and waiting" - we have a waiting promise for our unscheduled changes; we can add more unscheduled
-      #     changes since we haven't scheduled them yet.
-      #
-      # This is often called after adding a new waiting change or replacing them, so the state may have just changed.
-      # It can also be called when no changes have been made and no updates need to happen.
-      def promise_redraw
-        if fully_updated?
-          # No changes to make, nothing in-process or waiting, so just return a pre-fulfilled promise
-          @log.debug("Requesting redraw but there are no pending changes or promises, return pre-fulfilled")
-          return Promise.fulfilled
-        end
-
-        # Already have a redraw requested *and* one on deck? Then all current changes will have committed
-        # when we (eventually) fulfill the waiting_redraw_promise.
-        if @waiting_redraw_promise
-          @log.debug("Promising eventual redraw of #{@waiting_changes.size} waiting unscheduled changes.")
-          return @waiting_redraw_promise
-        end
-
-        if @waiting_changes.empty?
-          # There's no waiting_redraw_promise. There are no waiting changes. But we're not fully updated.
-          # So there must be a redraw in flight, and we don't need to schedule a new waiting_redraw_promise.
-          @log.debug("Returning in-flight redraw promise")
-          return @pending_redraw_promise
-        end
-
-        @log.debug("Requesting redraw with #{@waiting_changes.size} waiting changes and no waiting promise - need to schedule something!")
-
-        # We have at least one waiting change, possibly newly-added. We have no waiting_redraw_promise.
-        # Do we already have a redraw in-flight?
-        if @pending_redraw_promise
-          # Yes we do. Schedule a new waiting promise. When it turns into the pending_redraw_promise it will
-          # grab all waiting changes. In the mean time, it sits here and waits.
-          #
-          # We *could* do a fancy promise thing and have it update @waiting_changes for itself, etc, when it
-          # schedules itself. But we should always be calling promise_redraw or having a redraw fulfilled (see below)
-          # when these things change. I'd rather keep the logic in this method. It's easier to reason through
-          # all the cases.
-          @waiting_redraw_promise = Promise.new
-
-          @log.debug("Creating a new waiting promise since a pending promise is already in place")
-          return @waiting_redraw_promise
-        end
+      @log.debug("Requesting redraw with #{@waiting_changes.size} waiting changes and no waiting promise - need to schedule something!")
+
+      # We have at least one waiting change, possibly newly-added. We have no waiting_redraw_promise.
+      # Do we already have a redraw in-flight?
+      if @pending_redraw_promise
+        # Yes we do. Schedule a new waiting promise. When it turns into the pending_redraw_promise it will
+        # grab all waiting changes. In the mean time, it sits here and waits.
+        #
+        # We *could* do a fancy promise thing and have it update @waiting_changes for itself, etc, when it
+        # schedules itself. But we should always be calling promise_redraw or having a redraw fulfilled (see below)
+        # when these things change. I'd rather keep the logic in this method. It's easier to reason through
+        # all the cases.
+        @waiting_redraw_promise = ::Scarpe::Promise.new
+
+        @log.debug("Creating a new waiting promise since a pending promise is already in place")
+        return @waiting_redraw_promise
+      end
 
-        # We have no redraw in-flight and no pre-existing waiting line. The new change(s) are presumably right
-        # after things were fully up-to-date. We can schedule them for immediate redraw.
+      # We have no redraw in-flight and no pre-existing waiting line. The new change(s) are presumably right
+      # after things were fully up-to-date. We can schedule them for immediate redraw.
 
-        @log.debug("Requesting redraw with #{@waiting_changes.size} waiting changes - scheduling a new redraw for them!")
-        promise = schedule_waiting_changes # This clears the waiting changes
-        @pending_redraw_promise = promise
+      @log.debug("Requesting redraw with #{@waiting_changes.size} waiting changes - scheduling a new redraw for them!")
+      promise = schedule_waiting_changes # This clears the waiting changes
+      @pending_redraw_promise = promise
 
-        promise.on_fulfilled do
-          @redraw_handlers.each(&:call)
-          @pending_redraw_promise = nil
+      promise.on_fulfilled do
+        @redraw_handlers.each(&:call)
+        @pending_redraw_promise = nil
 
-          if @waiting_redraw_promise
-            # While this redraw was in flight, more waiting changes got added and we made a promise
-            # about when they'd complete. Now they get scheduled, and we'll fulfill the waiting
-            # promise when that redraw finishes. Clear the old waiting promise. We'll add a new one
-            # when/if more changes are scheduled during this redraw.
-            old_waiting_promise = @waiting_redraw_promise
-            @waiting_redraw_promise = nil
+        if @waiting_redraw_promise
+          # While this redraw was in flight, more waiting changes got added and we made a promise
+          # about when they'd complete. Now they get scheduled, and we'll fulfill the waiting
+          # promise when that redraw finishes. Clear the old waiting promise. We'll add a new one
+          # when/if more changes are scheduled during this redraw.
+          old_waiting_promise = @waiting_redraw_promise
+          @waiting_redraw_promise = nil
 
-            @log.debug "Fulfilled redraw with #{@waiting_changes.size} waiting changes - scheduling a new redraw for them!"
+          @log.debug "Fulfilled redraw with #{@waiting_changes.size} waiting changes - scheduling a new redraw for them!"
 
-            new_promise = promise_redraw
-            new_promise.on_fulfilled { old_waiting_promise.fulfilled! }
-          else
-            # The in-flight redraw completed, and there's still no waiting promise. Good! That means
-            # we should be fully up-to-date.
-            @log.debug "Fulfilled redraw with no waiting changes - marking us as up to date!"
-            if @waiting_changes.empty?
-              # We're fully up to date! Fulfill the promise. Now we don't need it again until somebody asks
-              # us for another.
-              if @fully_up_to_date_promise
-                @fully_up_to_date_promise.fulfilled!
-                @fully_up_to_date_promise = nil
-              end
-            else
-              @log.error "WHOAH, WHAT? My logic must be wrong, because there's " +
-                "no waiting promise, but waiting changes!"
+          new_promise = promise_redraw
+          new_promise.on_fulfilled { old_waiting_promise.fulfilled! }
+        else
+          # The in-flight redraw completed, and there's still no waiting promise. Good! That means
+          # we should be fully up-to-date.
+          @log.debug "Fulfilled redraw with no waiting changes - marking us as up to date!"
+          if @waiting_changes.empty?
+            # We're fully up to date! Fulfill the promise. Now we don't need it again until somebody asks
+            # us for another.
+            if @fully_up_to_date_promise
+              @fully_up_to_date_promise.fulfilled!
+              @fully_up_to_date_promise = nil
             end
+          else
+            @log.error "WHOAH, WHAT? My logic must be wrong, because there's " +
+              "no waiting promise, but waiting changes!"
           end
+        end
 
-          @log.debug("Redraw is now fully up-to-date") if fully_updated?
-        end.on_rejected do
-          @log.error "Could not complete JS redraw! #{promise.reason.full_message}"
-          @log.debug("REDRAW FULLY UP TO DATE BUT JS FAILED") if fully_updated?
-
-          raise "JS Redraw failed! Bailing!"
+        @log.debug("Redraw is now fully up-to-date") if fully_updated?
+      end.on_rejected do
+        @log.error "Could not complete JS redraw! #{promise.reason.full_message}"
+        @log.debug("REDRAW FULLY UP TO DATE BUT JS FAILED") if fully_updated?
 
-          # Later we should figure out how to handle this. Clear the promises and queues and request another redraw?
-        end
-      end
+        raise Scarpe::JSRedrawError, "JS Redraw failed! Bailing!"
 
-      def fully_updated?
-        @pending_redraw_promise.nil? && @waiting_redraw_promise.nil? && @waiting_changes.empty?
+        # Later we should figure out how to handle this. Clear the promises and queues and request another redraw?
       end
+    end
 
-      # Return a promise which will be fulfilled when the DOM is fully up-to-date
-      def promise_fully_updated
-        if fully_updated?
-          # No changes to make, nothing in-process or waiting, so just return a pre-fulfilled promise
-          return Promise.fulfilled
-        end
+    def fully_updated?
+      @pending_redraw_promise.nil? && @waiting_redraw_promise.nil? && @waiting_changes.empty?
+    end
 
-        # Do we already have a promise for this? Return it. Everybody can share one.
-        if @fully_up_to_date_promise
-          return @fully_up_to_date_promise
-        end
+    # Return a promise which will be fulfilled when the DOM is fully up-to-date
+    def promise_fully_updated
+      if fully_updated?
+        # No changes to make, nothing in-process or waiting, so just return a pre-fulfilled promise
+        return ::Scarpe::Promise.fulfilled
+      end
 
-        # We're not fully updated, so we need a promise. Create it, return it.
-        @fully_up_to_date_promise = Promise.new
+      # Do we already have a promise for this? Return it. Everybody can share one.
+      if @fully_up_to_date_promise
+        return @fully_up_to_date_promise
       end
 
-      private
+      # We're not fully updated, so we need a promise. Create it, return it.
+      @fully_up_to_date_promise = ::Scarpe::Promise.new
+    end
 
-      # Put together the waiting changes into a new in-flight redraw request.
-      # Return it as a promise.
-      def schedule_waiting_changes
-        return if @waiting_changes.empty?
+    private
 
-        js_code = @waiting_changes.join(";")
-        @waiting_changes = [] # They're not waiting any more!
-        @wrangler.eval_js_async(js_code)
-      end
+    # Put together the waiting changes into a new in-flight redraw request.
+    # Return it as a promise.
+    def schedule_waiting_changes
+      return if @waiting_changes.empty?
+
+      js_code = @waiting_changes.join(";")
+      @waiting_changes = [] # They're not waiting any more!
+      @wrangler.eval_js_async(js_code)
     end
   end
-end
 
-# For now we don't need one of these to add DOM elements, just to manipulate them
-# after initial render.
-class Scarpe
-  class WebWrangler
-    class ElementWrangler
-      attr_reader :html_id
+  # An ElementWrangler provides a way for a Drawable to manipulate is DOM element(s)
+  # via their HTML IDs. The most straightforward Drawables can have a single HTML ID
+  # and use a single ElementWrangler to make any needed changes.
+  #
+  # For now we don't need an ElementWrangler to add DOM elements, just to manipulate them
+  # after initial render. New DOM objects for Drawables are normally added via full
+  # redraws rather than incremental updates.
+  #
+  # Any changes made via ElementWrangler may be cancelled if a full redraw occurs,
+  # since it is assumed that small DOM manipulations are no longer needed. If a
+  # change would need to be made even if a full redraw occurred, it should be
+  # scheduled via WebWrangler#eval_js_async, not via an ElementWrangler.
+  class ElementWrangler
+    attr_reader :html_id
+
+    # Create an ElementWrangler for the given HTML ID
+    #
+    # @param html_id [String] the HTML ID for the DOM element
+    def initialize(html_id)
+      @webwrangler = ::Scarpe::Webview::DisplayService.instance.wrangler
+      raise Scarpe::MissingWranglerError, "Can't get WebWrangler!" unless @webwrangler
 
-      def initialize(html_id)
-        @webwrangler = WebviewDisplayService.instance.wrangler
-        @html_id = html_id
-      end
+      @html_id = html_id
+    end
 
-      def promise_update
-        @webwrangler.dom_promise_redraw
-      end
+    # Return a promise that will be fulfilled when all changes scheduled via
+    # this ElementWrangler are verified complete.
+    #
+    # @return [Scarpe::Promise] a promise that will be fulfilled when scheduled changes are complete
+    def promise_update
+      @webwrangler.dom_promise_redraw
+    end
 
-      def value=(new_value)
-        @webwrangler.dom_change("document.getElementById('" + html_id + "').value = `" + new_value + "`; true")
-      end
+    # Update the JS DOM element's value. The given Ruby value will be converted to string and assigned in backquotes.
+    #
+    # @param new_value [String] the new value
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the change is complete
+    def value=(new_value)
+      @webwrangler.dom_change("document.getElementById('" + html_id + "').value = `" + new_value + "`; true")
+    end
 
-      def inner_text=(new_text)
-        @webwrangler.dom_change("document.getElementById('" + html_id + "').innerText = '" + new_text + "'; true")
-      end
+    # Update the JS DOM element's inner_text. The given Ruby value will be converted to string and assigned in single-quotes.
+    #
+    # @param new_text [String] the new inner_text
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the change is complete
+    def inner_text=(new_text)
+      @webwrangler.dom_change("document.getElementById('" + html_id + "').innerText = '" + new_text + "'; true")
+    end
 
-      def inner_html=(new_html)
-        @webwrangler.dom_change("document.getElementById(\"" + html_id + "\").innerHTML = `" + new_html + "`; true")
-      end
+    # Update the JS DOM element's inner_html. The given Ruby value will be converted to string and assigned in backquotes.
+    #
+    # @param new_html [String] the new inner_html
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the change is complete
+    def inner_html=(new_html)
+      @webwrangler.dom_change("document.getElementById(\"" + html_id + "\").innerHTML = `" + new_html + "`; true")
+    end
 
-      def remove
-        @webwrangler.dom_change("document.getElementById('" + html_id + "').remove(); true")
-      end
+    # Update the JS DOM element's outer_html. The given Ruby value will be converted to string and assigned in backquotes.
+    #
+    # @param new_html [String] the new outer_html
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the change is complete
+    def outer_html=(new_html)
+      @webwrangler.dom_change("document.getElementById(\"" + html_id + "\").outerHTML = `" + new_html + "`; true")
+    end
+
+    # Update the JS DOM element's attribute. The given Ruby value will be inspected and assigned.
+    #
+    # @param attribute [String] the attribute name
+    # @param value [String] the new attribute value
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the change is complete
+    def set_attribute(attribute, value)
+      @webwrangler.dom_change("document.getElementById(\"" + html_id + "\").setAttribute(" + attribute.inspect + "," + value.inspect + "); true")
+    end
+
+    # Update an attribute of the JS DOM element's style. The given Ruby value will be inspected and assigned.
+    #
+    # @param style_attr [String] the style attribute name
+    # @param value [String] the new style attribute value
+    # @return [Scarpe::Promise] a promise that will be fulfilled when the change is complete
+    def set_style(style_attr, value)
+      @webwrangler.dom_change("document.getElementById(\"" + html_id + "\").style.#{style_attr} = " + value.inspect + "; true")
+    end
+
+    # Remove the specified DOM element
+    #
+    # @return [Scarpe::Promise] a promise that wil be fulfilled when the element is removed
+    def remove
+      @webwrangler.dom_change("document.getElementById('" + html_id + "').remove(); true")
+    end
+
+    def toggle_input_button(mark)
+      checked_value = mark ? "true" : "false"
+      @webwrangler.dom_change("document.getElementById('#{html_id}').checked = #{checked_value};")
     end
   end
 end