scarpe 0.3.0 → 0.4.0

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

data/lib/scarpe/wv/webview_local_display.rb

@@ -52,10 +52,10 @@ module Scarpe
     # @param properties [Hash] a JSON-serialisable Hash with the drawable's Shoes styles
     # @param is_widget [Boolean] whether the class is a user-defined Shoes::Widget subclass
     # @return [Webview::Drawable] the newly-created Webview drawable
-    def create_display_drawable_for(drawable_class_name, drawable_id, properties, is_widget:)
+    def create_display_drawable_for(drawable_class_name, drawable_id, properties, parent_id:, is_widget:)
       existing = query_display_drawable_for(drawable_id, nil_ok: true)
       if existing
-        @log.warn("There is already a display drawable for #{drawable_id.inspect}! Returning #{existing.class.name}.")
+        @log.warn("There is already a Scarpe drawable for #{drawable_id.inspect}! Returning #{existing.class.name} rather than creating a #{drawable_class_name}.")
         return existing
       end
 
@@ -95,6 +95,10 @@ module Scarpe
         @doc_root = display_drawable
       end
 
+      # Nil parent is fine for DocumentRoot and any TextDrawable, so we have to specify it.
+      display_parent = Scarpe::Webview::DisplayService.instance.query_display_drawable_for(parent_id, nil_ok: true)
+      display_drawable.set_parent(display_parent)
+
       display_drawable
     end
 

data/lib/scarpe/wv.rb

@@ -63,6 +63,9 @@ Shoes::FONTS.push(
   "Monaco",
 )
 
+Shoes::FEATURES.push(:html)
+Shoes::EXTENSIONS.push(:scarpe)
+
 require_relative "shoes_spec"
 Shoes::Spec.instance = Scarpe::Test
 
@@ -72,6 +75,7 @@ require_relative "wv/control_interface"
 require_relative "wv/drawable"
 
 require_relative "wv/star"
+require_relative "wv/oval"
 require_relative "wv/radio"
 
 require_relative "wv/arc"
@@ -91,7 +95,6 @@ require_relative "wv/list_box"
 require_relative "wv/shape"
 
 require_relative "wv/text_drawable"
-require_relative "wv/span"
 require_relative "wv/link"
 require_relative "wv/line"
 require_relative "wv/rect"
@@ -99,3 +102,7 @@ require_relative "wv/video"
 require_relative "wv/check"
 require_relative "wv/progress"
 require_relative "wv/arrow"
+
+require_relative "wv/scarpe_extensions"
+require_relative "assets"
+require_relative "wv/border"

data/scarpe-components/Gemfile

@@ -8,11 +8,14 @@ gem "lacci", path: "../lacci"
 
 gem "rake", "~> 13.0"
 
-gem "nokogiri"
+#gem "nokogiri"
 
 group :test do
   gem "minitest", "~> 5.0"
   gem "minitest-reporters"
+
+  # Dependencies for specific components being tested
+  gem "webrick"
 end
 
 group :development do

data/scarpe-components/Gemfile.lock

@@ -31,8 +31,6 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.15.4-x86_64-darwin)
-      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -67,6 +65,7 @@ GEM
     ruby-progressbar (1.13.0)
     stringio (3.0.8)
     unicode-display_width (2.4.2)
+    webrick (1.8.1)
 
 PLATFORMS
   x86_64-darwin-22
@@ -76,11 +75,11 @@ DEPENDENCIES
   lacci!
   minitest (~> 5.0)
   minitest-reporters
-  nokogiri
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-shopify
   scarpe-components!
+  webrick
 
 BUNDLED WITH
    2.4.14

data/scarpe-components/README.md

@@ -2,9 +2,9 @@
 
 Scarpe is several things. We package up the Shoes API with as few implementation details as possible (called Lacci.) We have a Webview-based display library, in both local and over-a-socket (relay) versions. We have a Wasm display library (Scarpe-Wasm) in a separate gem.
 
-And we have various default implementations of different reusable components. Scarpe's hierarchical logger isn't particularly specific to your display library or underlying GUI library, but we'd like it to be usable by multiple display libs. CatsCradle is only useful if you're trying to fix up an impedance mismatch between Ruby and an evented under-layer, but it's not really specific to Webview. Scarpe's default downloader, using Ruby's built-in HTTP libraries, is good in many cases but you might want to replace it (e.g. with Typhoeus for better parallel downloads or Hystrix for robustness to bad network connections) in some cases.
+And we have various default implementations of different reusable components. Calzini is a Shoes-to-HTML renderer shared between Scarpe-Webview and Scarpe-Wasm. Scarpe's hierarchical logger isn't particularly specific to your display library or underlying GUI library and we'd like it to be usable by multiple display libs. Scarpe's default downloader, using Ruby's built-in HTTP libraries, is good in many cases but you might want to replace it (e.g. with Typhoeus for better parallel downloads or Hystrix for robustness to bad network connections) in some cases.
 
-Part of our solution is the Scarpe-Components gem, which lives in the same repository as Scarpe (for now?). These components can live there. Any specific display library can pick and choose what it wants or needs and handle its dependencies as it sees fit.
+Part of our solution is the Scarpe-Components gem, which lives in the same repository as Scarpe and Lacci for now. These components can live there. Any specific display library can pick and choose what it wants or needs and handle its dependencies as it sees fit.
 
 ## Dependency Hell