scarpe 0.2.1 → 0.2.2

data/lib/scarpe/wv/control_interface_test.rb

@@ -7,10 +7,16 @@
 
 require "json"
 
+require "scarpe/components/unit_test_helpers"
+require "scarpe/evented_assertions"
+
 class Scarpe
   DEFAULT_ASSERTION_TIMEOUT = 1.0
 
   class ControlInterface
+    include Scarpe::Test::EventedAssertions
+    include Scarpe::Test::Helpers
+
     def timed_out?
       @did_time_out
     end
@@ -44,32 +50,6 @@ class Scarpe
       data
     end
 
-    # This does a final return of results. If it gets called
-    # multiple times, the test fails because that's not okay.
-    def return_results(result_bool, msg, data = {})
-      result_file = ENV["SCARPE_TEST_RESULTS"] || "./scarpe_results.txt"
-
-      result_structs = [result_bool, msg, data.merge(test_metadata)]
-
-      # Multiple different sets of results is bad, even if both are passing.
-      if @results_returned && @results_returned[0..1] != result_structs[0..1]
-        # Just raising here doesn't reliably fail the test.
-        # See: https://github.com/scarpe-team/scarpe/issues/212
-        @log.error("Writing multi-result failure file to #{result_file.inspect}!")
-
-        new_res_data = { first_result: @results_returned, second_result: result_structs }.merge(test_metadata)
-        bad_result = [false, "Returned two sets of results!", new_res_data]
-        File.write(result_file, JSON.pretty_generate(bad_result))
-
-        return
-      end
-
-      @log.debug("Writing results file #{result_file.inspect} to disk!")
-      File.write(result_file, JSON.pretty_generate(result_structs))
-
-      @results_returned = result_structs
-    end
-
     # Need to be able to query widgets in test code
 
     def all_wv_widgets
@@ -106,6 +86,11 @@ class Scarpe
     # We want an assertions library, but one that runs inside the spawned
     # Webview sub-process.
 
+    # Note that we do *not* extract this assertions library to use elsewhere
+    # because it's very focused on evented assertions that start and stop
+    # over a period of time. Instantaneous procedural asserts don't want to
+    # use this API.
+
     def return_when_assertions_done
       assertions_may_exist
 
@@ -218,8 +203,8 @@ class Scarpe
     end
   end
 
-  # A Promise but with helper functions
-  class TestPromise < Promise
+  # A {Scarpe::Promise} but with helper functions for Webview testing.
+  class TestPromise < Scarpe::Promise
     def initialize(iface:, state: nil, wait_for: [], &scheduler)
       @iface = iface
       super(state: state, parents: wait_for, &scheduler)

data/lib/scarpe/wv/document_root.rb

@@ -1,50 +1,8 @@
 # frozen_string_literal: true
 
 class Scarpe
-  class WebviewDocumentRoot < Scarpe::WebviewWidget
-    include Scarpe::WebviewBackground
-
-    def initialize(properties)
-      @callbacks = {}
-
-      super
-    end
-
-    def element(&blck)
-      HTML.render do |h|
-        h.div(style: style.merge(height: "100%"), &blck)
-      end
-    end
-
-    # Bind a Scarpe callback name; see Scarpe::Widget for how the naming is set up
-    def bind(name, &block)
-      @callbacks[name] = block
-    end
-
-    # All JS callbacks to Scarpe widgets are dispatched
-    # via this handler, which is set up in Scarpe::App
-    def handle_callback(name, *args)
-      @callbacks[name].call(*args)
-    end
-
-    # The document root knows when a frame has finished. It registers end-of-frame callbacks and calls them
-    # when requested. It also tracks when a redraw has been requested. Note that often frames will be
-    # very rare if nothing is changing, with seconds or minutes passing in between them.
-
-    def request_redraw!
-      wrangler = WebviewDisplayService.instance.wrangler
-      if wrangler.is_running
-        wrangler.replace(self.to_html)
-      end
-    end
-
-    # The document root manages the connection between widgets and the WebviewWrangler.
-    # By centralising this and wrapping in API functions, we can keep from executing
-    # random Javascript, mostly.
-
-    # A Widget can request one or more of these as insertion points in the DOM
-    def get_element_wrangler(html_id)
-      Scarpe::WebWrangler::ElementWrangler.new(html_id)
-    end
+  # A WebviewDocumentRoot is a WebviewFlow, with all the same properties
+  # and basic behavior.
+  class WebviewDocumentRoot < Scarpe::WebviewFlow
   end
 end

data/lib/scarpe/wv/edit_box.rb

@@ -30,15 +30,13 @@ class Scarpe
       end
     end
 
-    private
+    protected
 
     def style
-      styles = {}
-
-      styles[:height] = Dimensions.length(height)
-      styles[:width] = Dimensions.length(width)
-
-      styles.compact
+      super.merge({
+        height: Dimensions.length(height),
+        width: Dimensions.length(width),
+      }.compact)
     end
   end
 end

data/lib/scarpe/wv/edit_line.rb

@@ -30,10 +30,10 @@ class Scarpe
       end
     end
 
-    private
+    protected
 
     def style
-      styles = {}
+      styles = super
 
       styles[:width] = Dimensions.length(@width) if @width
 

data/lib/scarpe/wv/flow.rb

@@ -1,32 +1,22 @@
 # frozen_string_literal: true
 
 class Scarpe
-  class WebviewFlow < Scarpe::WebviewWidget
-    include Scarpe::WebviewBackground
-    include Scarpe::WebviewBorder
-
+  class WebviewFlow < Scarpe::WebviewSlot
     def initialize(properties)
       super
     end
 
-    def element(&block)
-      HTML.render do |h|
-        h.div(id: html_id, style:, &block)
-      end
-    end
-
-    private
+    protected
 
     def style
-      styles = super
-
-      styles[:display] = "flex"
-      styles["flex-direction"] = "row"
-      styles["flex-wrap"] = "wrap"
-      styles[:width] = Dimensions.length(@width) if @width
-      styles[:height] = Dimensions.length(@height) if @height
-
-      styles
+      {
+        display: "flex",
+        "flex-direction": "row",
+        "flex-wrap": "wrap",
+        "align-content": "flex-start",
+        "justify-content": "flex-start",
+        "align-items": "flex-start",
+      }.merge(super)
     end
   end
 end

data/lib/scarpe/wv/font.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "scarpe/components/base64"
+
+class Scarpe
+  class WebviewFont < WebviewWidget
+    include Components::Base64
+    attr_accessor :font
+
+    def initialize(properties)
+      @font = properties[:font]
+      super
+    end
+
+    def font_name
+      File.basename(@font, ".*")
+    end
+
+    def element
+      HTML.render do |h|
+        h.link(href: @font, rel: "stylesheet")
+        h.style do
+          <<~CSS
+            @font-face {
+              font-family: #{font_name};
+              src: url("data:font/truetype;base64,#{encode_file_to_base64(@font)}") format('truetype');
+            }
+            * {
+              font-family: #{font_name};
+            }
+          CSS
+        end
+      end
+    end
+  end
+end

data/lib/scarpe/wv/html.rb

@@ -2,8 +2,9 @@
 
 class Scarpe
   class HTML
-    CONTENT_TAGS = [:div, :p, :button, :ul, :li, :textarea, :a, :strong, :em, :code, :u, :line, :span, :svg].freeze
-    VOID_TAGS = [:input, :img, :polygon, :path].freeze
+    CONTENT_TAGS = [:div, :p, :button, :ul, :li, :textarea, :a, :video, :strong, :style, :em, :code, :u, :line, :span, :svg].freeze
+    VOID_TAGS = [:input, :img, :polygon, :source, :link, :path].freeze
+
     TAGS = (CONTENT_TAGS + VOID_TAGS).freeze
 
     class << self

data/lib/scarpe/wv/image.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+require "scarpe/components/base64"
+
 class Scarpe
   class WebviewImage < WebviewWidget
+    include Components::Base64
     def initialize(properties)
       super
+
+      @url = valid_url?(@url) ? @url : "data:image/png;base64,#{encode_file_to_base64(@url)}"
     end
 
     def element
@@ -18,10 +23,10 @@ class Scarpe
       end
     end
 
-    private
+    protected
 
     def style
-      styles = {}
+      styles = super
 
       styles[:width] = Dimensions.length(@width) if @width
       styles[:height] = Dimensions.length(@height) if @height

data/lib/scarpe/wv/line.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "shape_helper"
 class Scarpe
   class WebviewLine < Scarpe::WebviewWidget
-    include ShapeHelper
-
     def initialize(properties)
       super(properties)
     end
@@ -19,18 +16,18 @@ class Scarpe
       end
     end
 
-    private
+    protected
 
     def style
-      {
+      super.merge({
         left: "#{@left}px",
         top: "#{@top}px",
-      }
+      })
     end
 
     def line_style
       {
-        stroke: " #{@color}",
+        stroke: @draw_context["stroke"],
         "stroke-width": "4",
       }
     end

data/lib/scarpe/wv/link.rb

@@ -23,6 +23,7 @@ class Scarpe
         id: html_id,
         href: @click,
         onclick: (handler_js_code("click") if @has_block),
+        style: style,
       }.compact
     end
   end

data/lib/scarpe/wv/list_box.rb

@@ -36,15 +36,15 @@ class Scarpe
       end
     end
 
-    private
+    protected
 
     def style
-      styles = {}
+      styles = super
 
       styles[:height] = Dimensions.length(height) if height
       styles[:width] = Dimensions.length(width) if width
 
-      styles.compact
+      styles
     end
   end
 end

data/lib/scarpe/wv/para.rb

@@ -57,6 +57,22 @@ class Scarpe
       element { child_markup }
     end
 
+    protected
+
+    def style
+      super.merge({
+        color: rgb_to_hex(@stroke),
+        "font-size": font_size,
+        "font-family": @font,
+      }.compact)
+    end
+
+    def font_size
+      font_size = @size.is_a?(Symbol) ? SIZES[@size] : @size
+
+      Dimensions.length(font_size)
+    end
+
     private
 
     def child_markup
@@ -72,19 +88,5 @@ class Scarpe
     def options
       @html_attributes.merge(id: html_id, style: style)
     end
-
-    def style
-      {
-        "color" => rgb_to_hex(@stroke),
-        "font-size" => font_size,
-        "font-family" => @font,
-      }.compact
-    end
-
-    def font_size
-      font_size = @size.is_a?(Symbol) ? SIZES[@size] : @size
-
-      Dimensions.length(font_size)
-    end
   end
 end

data/lib/scarpe/wv/radio.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Scarpe
+  class WebviewRadio < Scarpe::WebviewWidget
+    attr_reader :text
+
+    def initialize(properties)
+      super
+
+      bind("click") do
+        send_self_event(event_name: "click", target: shoes_linkable_id)
+      end
+    end
+
+    def properties_changed(changes)
+      items = changes.delete("checked")
+      html_element.toggle_input_button(items)
+
+      super
+    end
+
+    def element
+      HTML.render do |h|
+        h.input(type: :radio, id: html_id, onclick: handler_js_code("click"), name: group_name, value: "hmm #{text}", checked: @checked, style: style)
+      end
+    end
+
+    private
+
+    def group_name
+      @group || @parent
+    end
+  end
+end

data/lib/scarpe/wv/shape.rb

@@ -1,21 +1,35 @@
 # frozen_string_literal: true
 
-require_relative "shape_helper"
-
 class Scarpe
+  # Should inherit from Slot?
   class WebviewShape < Scarpe::WebviewWidget
-    include ShapeHelper
-
     def initialize(properties)
-      @color = color_for_fill
       super(properties)
     end
 
+    def to_html
+      @children ||= []
+      child_markup = @children.map(&:to_html).join
+
+      color = @draw_context["fill"] || "black"
+      self_markup = HTML.render do |h|
+        h.div(id: html_id, style: style) do
+          h.svg(width: "400", height: "500") do
+            h.path(d: path_from_shape_commands, style: "fill:#{color};stroke-width:2;")
+          end
+        end
+      end
+
+      # Put child markup first for backward compatibility, but I'm pretty sure this is wrong.
+      child_markup + self_markup
+    end
+
     def element(&block)
+      color = @draw_context["fill"] || "black"
       HTML.render do |h|
         h.div(id: html_id, style: style) do
           h.svg(width: "400", height: "500") do
-            h.path(d: shape_path, style: "fill:#{@color};stroke-width:2;")
+            h.path(d: path_from_shape_commands, style: "fill:#{color};stroke-width:2;")
           end
           block.call(h) if block_given?
         end
@@ -24,11 +38,33 @@ class Scarpe
 
     private
 
+    # We have a set of Shoes shape commands, but we need SVG objects like paths.
+    def path_from_shape_commands
+      current_path = ""
+
+      @shape_commands.each do |cmd, *args|
+        case cmd
+        when "move_to"
+          x, y = *args
+          current_path += "M #{x} #{y} "
+        when "line_to"
+          x, y = *args
+          current_path += "L #{x} #{y} "
+        else
+          raise "Unknown shape command! #{cmd.inspect}"
+        end
+      end
+
+      current_path
+    end
+
+    protected
+
     def style
-      {
+      super.merge({
         width: "400",
         height: "900",
-      }
+      })
     end
   end
 end

data/lib/scarpe/wv/slot.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class Scarpe
+  class WebviewSlot < Scarpe::WebviewWidget
+    include Scarpe::WebviewBackground
+    include Scarpe::WebviewBorder
+    include Scarpe::WebviewSpacing
+
+    def initialize(properties)
+      @event_callbacks = {}
+
+      super
+    end
+
+    def element(&block)
+      HTML.render do |h|
+        h.div(attributes.merge(id: html_id, style: style), &block)
+      end
+    end
+
+    def set_event_callback(obj, event_name, js_code)
+      event_name = event_name.to_s
+      @event_callbacks[event_name] ||= {}
+      if @event_callbacks[event_name][obj]
+        raise "Can't have two callbacks on the same event, from the same object, on the same parent!"
+      end
+
+      @event_callbacks[event_name][obj] = js_code
+
+      update_dom_event(event_name)
+    end
+
+    def remove_event_callback(obj, event_name)
+      event_name = event_name.to_s
+      @event_callbacks[event_name] ||= {}
+      @event_callbacks[event_name].delete(obj)
+
+      update_dom_event(event_name)
+    end
+
+    def remove_event_callbacks(obj)
+      changed = []
+
+      @event_callbacks.each do |event_name, items|
+        changed << event_name if items.delete(obj)
+      end
+
+      changed.each { |event_name| update_dom_event(event_name) }
+    end
+
+    protected
+
+    def update_dom_event(event_name)
+      html_element.set_attribute(event_name, @event_callbacks[event_name].values.join(";"))
+    end
+
+    def attributes
+      attr = {}
+
+      @event_callbacks.each do |event_name, handlers|
+        attr[event_name] = handlers.values.join(";")
+      end
+
+      attr
+    end
+
+    def style
+      styles = super
+
+      styles[:"margin-top"] = @margin_top if @margin_top
+      styles[:"margin-bottom"] = @margin_bottom if @margin_bottom
+      styles[:"margin-left"] = @margin_left if @margin_left
+      styles[:"margin-right"] = @margin_right if @margin_right
+
+      styles[:width] = Dimensions.length(@width) if @width
+      styles[:height] = Dimensions.length(@height) if @height
+
+      styles
+    end
+  end
+end

data/lib/scarpe/wv/spacing.rb

@@ -5,7 +5,7 @@ class Scarpe
     SPACING_DIRECTIONS = [:left, :right, :top, :bottom]
 
     def style
-      styles = (super if defined?(super)) || {}
+      styles = defined?(super) ? super : {}
 
       extract_spacing_styles_for(:margin, styles, @margin)
       extract_spacing_styles_for(:padding, styles, @padding)

data/lib/scarpe/wv/span.rb

@@ -43,20 +43,22 @@ class Scarpe
       element { @text }
     end
 
-    private
-
-    def options
-      @html_attributes.merge(id: html_id, style: style)
-    end
+    protected
 
     def style
       {
-        "color" => @stroke,
-        "font-size" => font_size,
-        "font-family" => @font,
+        color: @stroke,
+        "font-size": font_size,
+        "font-family": @font,
       }.compact
     end
 
+    private
+
+    def options
+      @html_attributes.merge(id: html_id, style: style)
+    end
+
     def font_size
       font_size = @size.is_a?(Symbol) ? SIZES[@size] : @size
 

data/lib/scarpe/wv/stack.rb

@@ -1,42 +1,22 @@
 # frozen_string_literal: true
 
 class Scarpe
-  class WebviewStack < Scarpe::WebviewWidget
-    include Scarpe::WebviewBackground
-    include Scarpe::WebviewBorder
-    include Scarpe::WebviewSpacing
-
-    def initialize(properties)
-      super
-    end
-
-    def element(&block)
-      HTML.render do |h|
-        h.div(id: html_id, style: style, &block)
-      end
-    end
-
+  class WebviewStack < Scarpe::WebviewSlot
     def get_style
       style
     end
 
-    private
+    protected
 
     def style
-      styles = super
-
-      styles["margin-top"] = @margin_top if @margin_top
-      styles["margin-bottom"] = @margin_bottom if @margin_bottom
-      styles["margin-left"] = @margin_left if @margin_left
-      styles["margin-right"] = @margin_right if @margin_right
-
-      styles[:display] = "flex"
-      styles["flex-direction"] = "column"
-      styles[:width] = Dimensions.length(@width) if @width
-      styles[:height] = Dimensions.length(@height) if @height
-      styles["overflow"] = "auto" if @scroll
-
-      styles
+      {
+        display: "flex",
+        "flex-direction": "column",
+        "align-content": "flex-start",
+        "justify-content": "flex-start",
+        "align-items": "flex-start",
+        overflow: @scroll ? "auto" : nil,
+      }.compact.merge(super)
     end
   end
 end