scarpe 0.3.0 → 0.5.0

data/lib/scarpe/shoes_spec.rb

@@ -26,38 +26,26 @@ module Scarpe::Test
     class_name ||= ENV["SHOES_MINITEST_CLASS_NAME"] || "TestShoesSpecCode"
     test_name ||= ENV["SHOES_MINITEST_METHOD_NAME"] || "test_shoes_spec"
 
-    require_relative "cats_cradle"
-
-    # We want Minitest assertions available in the test code.
-    # But this will normally run in a subprocess. So we need
-    # to run Minitest tests and then export the results.
-
-    # We create a test object based on CatsCradle, which will
-    # run the test as straight-line code, wait for appropriate
-    # events and generally make things well-behaved. But the
-    # test DSL isn't CatsCradle. It's based on Minitest and
-    # ShoesSpecTest (see below).
-    #
-    # Note that that means that using CatsCradle to "bounce"
-    # control back and forth for evented tricks isn't really
-    # an option. We may need to revisit all of this later...
-    test_obj = Object.new
-    class << test_obj
-      include Scarpe::Test::CatsCradle
-    end
-    Scarpe::ShoesSpecTest.test_obj = test_obj
-    test_obj.instance_eval do
+    Scarpe::CCInstance.include Scarpe::ShoesSpecTest
+
+    Scarpe::CCInstance.instance.instance_eval do
       event_init
 
-      on_heartbeat do
+      t_timeout = ENV["SCARPE_SSPEC_TIMEOUT"] || "30"
+      timeout(t_timeout.to_f) unless t_timeout.downcase == "none"
+
+      on_event(:next_heartbeat) do
         Minitest.run ARGV
 
-        test_finished_no_results
-        Scarpe::ShoesSpecTest.test_obj = nil
+        wait_after = ENV["SCARPE_SSPEC_TIMEOUT_WAIT_AFTER_TEST"]
+        if !(wait_after && wait_after.downcase != "n" && wait_after.downcase != "no")
+          shut_down_shoes_code
+        end
       end
     end
 
-    test_class = Class.new(Scarpe::ShoesSpecTest)
+    test_class = Class.new(Minitest::Test)
+    test_class.include Scarpe::ShoesSpecTest
     Object.const_set(Scarpe::Components::StringHelpers.camelize(class_name), test_class)
     test_name = "test_" + test_name unless test_name.start_with?("test_")
     test_class.define_method(test_name) do
@@ -66,7 +54,6 @@ module Scarpe::Test
   end
 end
 
-# This is based on the CatsCradle proxies initially, but will diverge over time
 class Scarpe::ShoesSpecProxy
   attr_reader :obj
   attr_reader :linkable_id
@@ -113,17 +100,15 @@ end
 
 # When running ShoesSpec tests, we create a parent class for all of them
 # with the appropriate convenience methods and accessors.
-class Scarpe::ShoesSpecTest < Minitest::Test
+module Scarpe::ShoesSpecTest
   include Scarpe::Test::HTMLAssertions
 
-  class << self
-    attr_accessor :test_obj
-  end
   Shoes::Drawable.drawable_classes.each do |drawable_class|
     finder_name = drawable_class.dsl_name
 
     define_method(finder_name) do |*args|
-      app = Shoes::App.instance
+      # Scarpe-Webview only supports a single Shoes::App instance
+      app = Shoes.APPS[0]
 
       drawables = app.find_drawables_by(drawable_class, *args)
       raise Shoes::Errors::MultipleDrawablesFoundError, "Found more than one #{finder_name} matching #{args.inspect}!" if drawables.size > 1
@@ -141,7 +126,7 @@ class Scarpe::ShoesSpecTest < Minitest::Test
   end
 
   def catscradle_dsl(&block)
-    Scarpe::Test::CCInstance.instance.instance_eval(&block)
+    Scarpe::CCInstance.instance.instance_eval(&block)
   end
 
   def dom_html
@@ -151,30 +136,25 @@ class Scarpe::ShoesSpecTest < Minitest::Test
     end
   end
 
-  # This isn't working. Neither is calling die_after. Are the other fibers not
-  # running or something like that? Should run a test from the command line
-  # and see what's happening... Or check logfiles?
-  def timeout(t_timeout = 5.0, exit_code: -1)
+  # A timeout won't cause an error by itself. If you want an error, make sure
+  # to check for a minimum number of assertions or otherwise look for progress.
+  def timeout(t_timeout = 5.0)
     catscradle_dsl do
       t0 = Time.now
       on_event(:every_heartbeat) do
         if Time.now - t0 >= t_timeout
-          if exit_code == 0
-            @log.info "Timed out after #{t_timeout} seconds!"
-          else
-            @log.error "Timed out after #{t_timeout} seconds!"
-          end
-          exit exit_code
+          @log.info "Timed out after #{t_timeout} seconds!"
+          shut_down_shoes_code
         end
       end
     end
   end
 
-  def exit_on_first_heartbeat(exit_code: 0)
+  def exit_on_first_heartbeat
     catscradle_dsl do
       on_event(:next_heartbeat) do
         @log.info "Exiting on first heartbeat (exit code #{exit_code})"
-        exit exit_code
+        exit 0
       end
     end
   end

data/lib/scarpe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scarpe
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/scarpe/wv/app.rb

@@ -55,6 +55,7 @@ module Scarpe::Webview
     end
 
     def run
+      # This is run before the Webview event loop is up and running
       @control_interface.dispatch_event(:init)
 
       @view.empty_page = empty_page_element

data/lib/scarpe/wv/arc.rb

@@ -2,10 +2,6 @@
 
 module Scarpe::Webview
   class Arc < Drawable
-    def initialize(properties)
-      super(properties)
-    end
-
     def element
       render("arc")
     end

data/lib/scarpe/wv/border.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Scarpe::Webview
+  class Border < Drawable
+
+    def initialize(properties)
+      super(properties)
+    end
+
+    # If the drawable is intended to be overridable, add element and style to Calzini instead
+    def element
+      render('border')
+    end
+  end
+end

data/lib/scarpe/wv/control_interface.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
-# The ControlInterface is used for testing. It's a way to register interest
-# in important events like redraw, init and shutdown, and to configure a
-# Shoes app for testing. Note that no part of the Scarpe framework should
-# ever *depend* on ControlInterface. It's for testing, not normal operation.
-# If no ControlInterface were ever created or called, Scarpe apps should run
-# fine with no modifications.
-#
-# And if you depend on this from the framework, I'll add a check-mode that
-# never dispatches any events to any handlers. Do NOT test me on this.
-
+# The ControlInterface is used to coordinate events. It's a way to register interest
+# in important events like redraw, init and shutdown. It's used extensively for testing.
 module Scarpe::Webview
   class ControlInterface
     include Shoes::Log

data/lib/scarpe/wv/document_root.rb

@@ -16,12 +16,12 @@ module Scarpe::Webview
         when "font"
           @fonts << args[0]
           # Can't just create font_updater and alert_updater on initialize - not everything is set up
-          @font_updater ||= Scarpe::Webview::WebWrangler::ElementWrangler.new("root-fonts")
+          @font_updater ||= Scarpe::Webview::WebWrangler::ElementWrangler.new(html_id: "root-fonts")
           @font_updater.inner_html = font_contents
         when "alert"
           bind_ok_event
           @alerts << args[0]
-          @alert_updater ||= Scarpe::Webview::WebWrangler::ElementWrangler.new("root-alerts")
+          @alert_updater ||= Scarpe::Webview::WebWrangler::ElementWrangler.new(html_id: "root-alerts")
           @alert_updater.inner_html = alert_contents
         else
           raise Scarpe::UnknownBuiltinCommandError, "Unexpected builtin command: #{cmd_name.inspect}!"

data/lib/scarpe/wv/drawable.rb

@@ -42,7 +42,6 @@ module Scarpe::Webview
 
       @shoes_style_names = properties.keys.map(&:to_s) - ["shoes_linkable_id"]
 
-      # Call method, which looks up the parent
       @shoes_linkable_id = properties["shoes_linkable_id"] || properties[:shoes_linkable_id]
       unless @shoes_linkable_id
         raise Scarpe::MissingAttributeError, "Could not find property shoes_linkable_id in #{properties.inspect}!"
@@ -58,6 +57,8 @@ module Scarpe::Webview
       # Must call this before bind
       super(linkable_id: @shoes_linkable_id)
 
+      # This will only be used if moving a drawable from one parent to another.
+      # Shoes doesn't normally do that.
       bind_shoes_event(event_name: "parent", target: shoes_linkable_id) do |new_parent_id|
         display_parent = DisplayService.instance.query_display_drawable_for(new_parent_id)
         if @parent != display_parent
@@ -101,9 +102,9 @@ module Scarpe::Webview
         if hidden
           html_element.set_style("display", "none")
         else
-          new_style = style # Get current display CSS property, which may vary by subclass
-          disp = new_style[:display]
-          html_element.set_style("display", disp || "block")
+          # With Calzini we can't easily tell what the display property should be.
+          # Could be flex or inline, not only block or none. Re-render this drawable.
+          needs_update!
         end
       end
 
@@ -143,41 +144,6 @@ module Scarpe::Webview
       needs_update!
     end
 
-    # Convert an [r, g, b, a] array to an HTML hex color code
-    # Arrays support alpha. HTML hex does not. So premultiply.
-    def rgb_to_hex(color)
-      return color if color.nil?
-
-      r, g, b, a = *color
-      if r.is_a?(Float)
-        a ||= 1.0
-        r_float = r * a
-        g_float = g * a
-        b_float = b * a
-      else
-        a ||= 255
-        a_float = (a / 255.0)
-        r_float = (r.to_f / 255.0) * a_float
-        g_float = (g.to_f / 255.0) * a_float
-        b_float = (b.to_f / 255.0) * a_float
-      end
-
-      r_int = (r_float * 255.0).to_i.clamp(0, 255)
-      g_int = (g_float * 255.0).to_i.clamp(0, 255)
-      b_int = (b_float * 255.0).to_i.clamp(0, 255)
-
-      "#%0.2X%0.2X%0.2X" % [r_int, g_int, b_int]
-    end
-
-    # CSS styles
-    def style
-      styles = {}
-      if @hidden
-        styles[:display] = "none"
-      end
-      styles
-    end
-
     public
 
     # This gets an accessor for just this element's HTML ID.
@@ -187,7 +153,7 @@ module Scarpe::Webview
     #
     # @return [Scarpe::WebWrangler::ElementWrangler] a DOM object manager
     def html_element
-      @elt_wrangler ||= Scarpe::Webview::WebWrangler::ElementWrangler.new(html_id)
+      @elt_wrangler ||= Scarpe::Webview::WebWrangler::ElementWrangler.new(html_id:)
     end
 
     # Return a promise that guarantees all currently-requested changes have completed

data/lib/scarpe/wv/edit_box.rb

@@ -2,7 +2,7 @@
 
 module Scarpe::Webview
   class EditBox < Drawable
-    attr_reader :text, :height, :width
+    attr_reader :text, :height, :width, :tooltip , :font
 
     def initialize(properties)
       super
@@ -11,6 +11,9 @@ module Scarpe::Webview
       bind("change") do |new_text|
         send_self_event(new_text, event_name: "change")
       end
+      bind("hover") do
+        send_self_event(event_name: "hover")
+      end
     end
 
     def properties_changed(changes)

data/lib/scarpe/wv/edit_line.rb

@@ -2,7 +2,7 @@
 
 module Scarpe::Webview
   class EditLine < Drawable
-    attr_reader :text, :width
+    attr_reader :text, :width, :stroke, :font, :tooltip, :secret
 
     def initialize(properties)
       super
@@ -11,6 +11,9 @@ module Scarpe::Webview
       bind("change") do |new_text|
         send_self_event(new_text, event_name: "change")
       end
+      bind("hover") do |new_text|
+        send_self_event(new_text, event_name: "hover")
+      end
     end
 
     def properties_changed(changes)

data/lib/scarpe/wv/image.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
-require "scarpe/components/base64"
-
 module Scarpe::Webview
   class Image < Drawable
-    include Scarpe::Components::Base64
-
     def initialize(properties)
       super
 
       unless valid_url?(@url)
-        @url = "data:image/png;base64,#{encode_file_to_base64(@url)}"
+        # It's assumed to be a file path.
+        @url = Scarpe::Webview.asset_server.asset_url(File.expand_path @url)
       end
     end
 

data/lib/scarpe/wv/link.rb

@@ -10,8 +10,10 @@ module Scarpe::Webview
       end
     end
 
-    def element
-      render "link"
+    def to_calzini_hash
+      h = super
+      h[:tag] = "a"
+      h
     end
   end
 end

data/lib/scarpe/wv/oval.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Scarpe::Webview
+  class Oval < Drawable
+    def initialize(properties)
+      super(properties)
+    end
+
+    def element(&block)
+      render("oval", &block)
+    end
+  end
+end

data/lib/scarpe/wv/para.rb

@@ -61,6 +61,7 @@ module Scarpe::Webview
     private
 
     def child_markup
+      # The children should be only text strings or TextDrawables.
       items_to_display_children(@text_items).map do |child|
         if child.respond_to?(:to_html)
           child.to_html

data/lib/scarpe/wv/scarpe_extensions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# This may or may not stay. It's basically an example extension. It can be done
+# better, and there's no reason it should be specific to button.
+Shoes::Button.shoes_style :html_class, feature: :html
+
+# We have a number of real Scarpe extensions that need to be properly marked as such
+# and moved in here. Padding is a great example, as is html_attributes.

data/lib/scarpe/wv/shape.rb

@@ -2,13 +2,16 @@
 
 module Scarpe::Webview
   class Shape < Drawable
+    # Shape is the only (?) remaining drawable that doesn't use Calzini.
+    # It's also kind of broken - it doesn't do what a Shoes Shape is
+    # supposed to do yet. This can really use a rework at some point.
     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.div(id: html_id, style: shape_style) do
           h.svg(width: "400", height: "500") do
             h.path(d: path_from_shape_commands, style: "fill:#{color};stroke-width:2;")
           end
@@ -22,7 +25,7 @@ module Scarpe::Webview
     def element(&block)
       color = @draw_context["fill"] || "black"
       HTML.render do |h|
-        h.div(id: html_id, style: style) do
+        h.div(id: html_id, style: shape_style) do
           h.svg(width: "400", height: "500") do
             h.path(d: path_from_shape_commands, style: "fill:#{color};stroke-width:2;")
           end
@@ -55,11 +58,13 @@ module Scarpe::Webview
 
     protected
 
-    def style
-      super.merge({
+    def shape_style
+      s = {
         width: "400",
         height: "900",
-      })
+      }
+      s[:display] = "none" if @hidden
+      s
     end
   end
 end

data/lib/scarpe/wv/text_drawable.rb

@@ -1,32 +1,90 @@
 # frozen_string_literal: true
 
+# There are different ways to implement these tags. You can change the HTML tag (link,
+# code, strong) or set default values (del for strikethrough.) There's no reason the
+# Shoes tag name has to match the HTML tag (del, link). This can be a little
+# complicated since CSS often sets default values (e.g. del for strikethrough) and
+# Scarpe may use those default values or override them. Long term it may be easier
+# for us to set up our own CSS for this somehow that does *not* use the HTML-tag
+# defaults since the browser can mess with those, and there's no guarantee that
+# Webview uses the same default CSS style across all OSes.
+
 module Scarpe::Webview
+  # This class renders text tags like em, strong, link, etc.
   class TextDrawable < Drawable
-    def to_html
-      # Do not render TextDrawables with individual wrapper divs.
-      element
+    # Calzini renders based on properties, mostly Shoes styles.
+    # To have Calzini render this for us, we convert to the format
+    # Calzini expects and then let it render. See Webview::Para
+    # for the specific Calzini call.
+    def to_calzini_hash
+      text_array = items_to_display_children(@text_items).map do |item|
+        if item.respond_to?(:to_calzini_hash)
+          item.to_calzini_hash
+        elsif item.is_a?(String)
+          item
+        else
+          # This should normally be filtered out in Lacci, long before we see it
+          raise "Unrecognized item in TextDrawable! #{item.inspect}"
+        end
+      end
+
+      {
+        items: text_array,
+        html_id: @linkable_id.to_s,
+        tag: nil, # have Calzini assign a default unless a subclass overrides this
+        props: shoes_styles,
+      }
+    end
+
+    def element
+      render("text_drawable", [to_calzini_hash])
+    end
+
+    def items_to_display_children(items)
+      return [] if items.nil?
+
+      items.map do |item|
+        if item.is_a?(String)
+          item
+        else
+          Scarpe::Webview::DisplayService.instance.query_display_drawable_for(item)
+        end
+      end
+    end
+
+    # Usually we query by ID, but for TextDrawable it has to be by class.
+    # That's how needs_update!, etc continue to work.
+    def html_element
+      @elt_wrangler ||= Scarpe::Webview::WebWrangler::ElementWrangler.new(selector: %{document.getElementsByClassName("id_#{html_id}")}, multi: true)
     end
   end
 
   class << self
-    def default_wv_text_drawable_with(element)
-      webview_class_name = element.capitalize
+    def default_wv_text_drawable_with_tag(shoes_tag, html_tag = nil)
+      html_tag ||= shoes_tag
+      webview_class_name = shoes_tag.capitalize
       webview_drawable_class = Class.new(Scarpe::Webview::TextDrawable) do
-        def initialize(properties)
-          class_name = self.class.name.split("::")[-1]
-          @html_tag = class_name.delete_prefix("Webview").downcase
-          super
+        class << self
+          attr_accessor :html_tag
         end
 
-        def element
-          render(@html_tag) { @content.to_s }
+        def to_calzini_hash
+          h = super
+          h[:tag] = self.class.html_tag
+          h
         end
       end
       Scarpe::Webview.const_set webview_class_name, webview_drawable_class
+      webview_drawable_class.html_tag = html_tag
     end
   end
 end
 
-Scarpe::Webview.default_wv_text_drawable_with(:code)
-Scarpe::Webview.default_wv_text_drawable_with(:em)
-Scarpe::Webview.default_wv_text_drawable_with(:strong)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:code)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:del)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:em)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:strong)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:span)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:sub)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:sup)
+Scarpe::Webview.default_wv_text_drawable_with_tag(:ins, "span") # Styled in Shoes, not CSS

data/lib/scarpe/wv/web_wrangler.rb

@@ -261,6 +261,7 @@ module Scarpe::Webview
           @log.debug("Scheduled JS: (#{this_eval_serial})\n#{wrapped_code}")
         else
           # We're mid-shutdown. No more scheduling things.
+          @log.warn "Mid-shutdown JS eval. Not scheduling JS!"
         end
       end
 
@@ -746,16 +747,37 @@ class Scarpe::Webview::WebWrangler
   class ElementWrangler
     attr_reader :html_id
 
-    # Create an ElementWrangler for the given HTML ID
+    # Create an ElementWrangler for the given HTML ID or selector.
+    # The caller should provide exactly one of the html_id or selector.
     #
     # @param html_id [String] the HTML ID for the DOM element
-    def initialize(html_id)
+    def initialize(html_id: nil, selector: nil, multi: false)
       @webwrangler = ::Scarpe::Webview::DisplayService.instance.wrangler
       raise Scarpe::MissingWranglerError, "Can't get WebWrangler!" unless @webwrangler
 
-      @html_id = html_id
+      if html_id && !selector
+        @selector = "document.getElementById('" + html_id + "')"
+      elsif selector && !html_id
+        @selector = selector
+      else
+        raise ArgumentError, "Must provide exactly one of html_id or selector!"
+      end
+
+      @multi = multi
     end
 
+    private
+
+    def on_each(fragment)
+      if @multi
+        @webwrangler.dom_change("a = Array.from(#{@selector}); a.forEach((item) => item#{fragment}); true")
+      else
+        @webwrangler.dom_change(@selector + fragment + ";true")
+      end
+    end
+
+    public
+
     # Return a promise that will be fulfilled when all changes scheduled via
     # this ElementWrangler are verified complete.
     #
@@ -769,7 +791,7 @@ class Scarpe::Webview::WebWrangler
     # @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")
+      on_each(".value = `" + new_value + "`")
     end
 
     # Update the JS DOM element's inner_text. The given Ruby value will be converted to string and assigned in single-quotes.
@@ -777,7 +799,7 @@ class Scarpe::Webview::WebWrangler
     # @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")
+      on_each(".innerText = '" + new_text + "'")
     end
 
     # Update the JS DOM element's inner_html. The given Ruby value will be converted to string and assigned in backquotes.
@@ -785,7 +807,7 @@ class Scarpe::Webview::WebWrangler
     # @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")
+      on_each(".innerHTML = `" + new_html + "`")
     end
 
     # Update the JS DOM element's outer_html. The given Ruby value will be converted to string and assigned in backquotes.
@@ -793,7 +815,7 @@ class Scarpe::Webview::WebWrangler
     # @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")
+      on_each(".outerHTML = `" + new_html + "`")
     end
 
     # Update the JS DOM element's attribute. The given Ruby value will be inspected and assigned.
@@ -802,7 +824,7 @@ class Scarpe::Webview::WebWrangler
     # @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")
+      on_each(".setAttribute(" + attribute.inspect + "," + value.inspect + ")")
     end
 
     # Update an attribute of the JS DOM element's style. The given Ruby value will be inspected and assigned.
@@ -811,19 +833,19 @@ class Scarpe::Webview::WebWrangler
     # @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")
+      on_each(".style.#{style_attr} = " + value.inspect + ";")
     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")
+      on_each(".remove()")
     end
 
     def toggle_input_button(mark)
       checked_value = mark ? "true" : "false"
-      @webwrangler.dom_change("document.getElementById('#{html_id}').checked = #{checked_value};")
+      on_each(".checked = #{checked_value}")
     end
   end
 end