scarpe 0.3.0 → 0.4.0

data/lib/scarpe/cats_cradle.rb

@@ -1,76 +1,15 @@
 # frozen_string_literal: true
 
 require "scarpe/components/unit_test_helpers"
-require "scarpe/evented_assertions"
 
 require "fiber"
 
-module Scarpe::Test
-  # We'd like something we can call Shoes drawable methods on, such as para.replace.
-  # But we'd also like to be able to grab the corresponding display drawable and
-  # call some of *those* methods.
-  class CCProxy
-    attr_reader :display
-    attr_reader :obj
-
-    def initialize(obj)
-      @obj = obj
-      # TODO: how to do this with Webview relay? Proxy object to send a message, maybe?
-      @display = ::Shoes::DisplayService.display_service.query_display_drawable_for(obj.linkable_id)
-    end
-
-    def method_missing(method, ...)
-      if @obj.respond_to?(method)
-        self.singleton_class.define_method(method) do |*args, **kwargs, &block|
-          @obj.send(method, *args, **kwargs, &block)
-        end
-        send(method, ...)
-      else
-        super # raise an exception
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      @obj.respond_to_missing?(method_name, include_private)
-    end
-
-    def trigger(event_name, *args)
-      name = "#{@obj.linkable_id}-#{event_name}"
-      Scarpe::Webview::DisplayService.instance.app.handle_callback(name, *args)
-    end
-
-    [:click, :hover, :leave, :change].each do |ev|
-      define_method "trigger_#{ev}" do |*args|
-        trigger(ev, *args)
-      end
-    end
-  end
-
-  module DrawableFinders
-    # What to do about TextDrawables? Link, code, em, strong?
-    # Also, wait, what's up with span? What *is* that?
-    Shoes::Drawable.drawable_classes.each do |drawable_class|
-      finder_name = drawable_class.dsl_name
-
-      define_method(finder_name) do |*args|
-        app = Shoes::App.instance
-
-        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
-        raise Shoes::Errors::NoDrawablesFoundError, "Found no #{finder_name} matching #{args.inspect}!" if drawables.empty?
-
-        CCProxy.new(drawables[0])
-      end
-    end
-  end
-
+module Scarpe
   # This class defines the CatsCradle DSL. It also holds a "bag of fibers"
   # with promises for when they should next resume.
   class CCInstance
     include Shoes::Log
-    include Scarpe::Test::EventedAssertions
     include Scarpe::Test::Helpers
-    include Scarpe::Test::DrawableFinders
 
     def self.instance
       @instance ||= CCInstance.new
@@ -79,18 +18,19 @@ module Scarpe::Test
     def initialize
       log_init("CatsCradle")
 
-      evented_assertions_initialize
-
       @waiting_fibers = []
       @event_promises = {}
+      @shutdown = false
 
       @manager_fiber = Fiber.new do
+        Fiber[:catscradle] = true
+
         loop do
           # A fiber can run briefly and then exit. It can run and then block on an API call.
           # These fibers return promises to indicate to CatsCradle when they can run again.
           # A fiber that is no longer #alive? is assumed to be successfully finished.
           @waiting_fibers.each do |fiber_data|
-            next unless fiber_data[:promise].fulfilled?
+            next if !fiber_data[:promise].fulfilled? || !fiber_data[:fiber].alive? || @shutdown
 
             @log.debug("Resuming fiber with value #{fiber_data[:promise].returned_value.inspect}")
             result = fiber_data[:fiber].transfer fiber_data[:promise].returned_value
@@ -117,6 +57,17 @@ module Scarpe::Test
       end
     end
 
+    private
+
+    def cc_fiber(&block)
+      Fiber.new do
+        Fiber[:catscradle] = true
+        CCInstance.instance.instance_eval(&block)
+      end
+    end
+
+    public
+
     # If we add "every" events, that's likely to complicate timing and event_promise handling.
     EVENT_TYPES = [:init, :next_heartbeat, :next_redraw, :every_heartbeat, :every_redraw]
 
@@ -140,9 +91,16 @@ module Scarpe::Test
           p = @event_promises.delete(:every_heartbeat)
           p&.fulfilled!
 
+          # Reschedule on_every_heartbeat fibers for next heartbeat, too.
+          # This fiber won't be called again by a heartbeat, though it may
+          # continue if it waits on another promise.
+          @waiting_fibers.select { |f| f[:on_event] == :every_heartbeat }.each do |f|
+            on_event(:every_heartbeat, &f[:block])
+          end
+
           # Give every ready fiber a chance to run once.
-          @manager_fiber.resume
-        end
+          @manager_fiber.resume unless @shutdown
+        end unless @shutdown
       end
 
       @control_interface.on_event(:every_redraw) do
@@ -153,42 +111,38 @@ module Scarpe::Test
           p = @event_promises.delete(:every_redraw)
           p&.fulfilled!
 
+          # Reschedule on_every_redraw fibers for next redraw, too.
+          @waiting_fibers.select { |f| f[:on_event] == :every_redraw }.each do |f|
+            on_event(:every_redraw, &f[:block])
+          end
+
           # Give every ready fiber a chance to run once.
-          @manager_fiber.resume
-        end
+          @manager_fiber.resume unless @shutdown
+        end unless @shutdown
       end
     end
 
+    def fiber_start
+      @manager_fiber.resume unless @shutdown
+    end
+
     def event_promise(event)
       @event_promises[event] ||= ::Scarpe::Promise.new
     end
 
     def on_event(event, &block)
       raise Scarpe::UnknownEventTypeError, "Unknown event type: #{event.inspect}!" unless EVENT_TYPES.include?(event)
+      return if @shutdown
 
-      f = Fiber.new do
-        CCInstance.instance.instance_eval(&block)
-      end
-      @waiting_fibers << { promise: event_promise(event), fiber: f }
+      @waiting_fibers << { promise: event_promise(event), fiber: cc_fiber(&block), on_event: event, block: }
     end
 
-    def proxy_for(shoes_drawable)
-      CCProxy.new(shoes_drawable)
-    end
+    def active_fiber(&block)
+      return if @shutdown
 
-    def die_after(time)
-      t_start = Time.now
-      @die_after = [t_start, time]
-
-      @wrangler.periodic_code("scarpeTestTimeout") do |*_args|
-        t_delta = (Time.now - t_start).to_f
-        if t_delta > time
-          @did_time_out = true
-          @log.warn("die_after - timed out after #{t_delta.inspect} (threshold: #{time.inspect})")
-          return_results(false, "Timed out!")
-          ::Shoes::DisplayService.dispatch_event("destroy", nil)
-        end
-      end
+      p = ::Scarpe::Promise.new
+      p.fulfilled!
+      @waiting_fibers << { promise: p, fiber: cc_fiber(&block), on_event: nil, block: }
     end
 
     def wait(promise)
@@ -198,6 +152,12 @@ module Scarpe::Test
       @manager_fiber.transfer(promise)
     end
 
+    def yield
+      p = ::Scarpe::Promise.new
+      p.fulfilled!
+      @manager_fiber.transfer(p)
+    end
+
     # This returns a promise, which can be waited on using wait()
     def fully_updated
       @wrangler.promise_dom_fully_updated
@@ -218,13 +178,12 @@ module Scarpe::Test
       @wrangler.eval_js_async(js_code, timeout:)
     end
 
-    def test_finished(return_results: true)
-      return_assertion_data if return_results
-
-      ::Shoes::DisplayService.dispatch_event("destroy", nil)
-    end
+    def shut_down_shoes_code
+      if @shutdown
+        exit 0
+      end
 
-    def test_finished_no_results
+      @shutdown = true
       ::Shoes::DisplayService.dispatch_event("destroy", nil)
     end
   end
@@ -232,8 +191,8 @@ module Scarpe::Test
   # "Cat's Cradle" is a children's game where they interlace string between
   # their fingers to make beautiful complicated shapes. The interlacing
   # of fibers made it a good name for a prototype.
-
-  # An attempt at an experimental Fiber-based testing system to deal with
+  #
+  # An attempt at an experimental Fiber-based control-flow system to deal with
   # Shoes, Display and JS all at the same time.
   #
   # In general, we'll use Fiber.transfer to bounce control back and forth
@@ -243,7 +202,7 @@ module Scarpe::Test
   #
   # Ruby Fiber basic docs: https://ruby-doc.org/core-3.0.0/Fiber.html
   #
-  # This module is mixed into a test object if we're running CatsCradle-based tests
+  # This module is mixed into an object to coordinate fibers app-wide.
   module CatsCradle
     attr_reader :cc_instance
 

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,12 +100,9 @@ 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
 
@@ -141,7 +125,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 +135,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.4.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
 
     def initialize(properties)
       super
@@ -11,8 +11,11 @@ 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)
       t = changes.delete("text")
       if t

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