scarpe 0.2.2 → 0.4.0

data/lib/scarpe/wv/webview_local_display.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class Scarpe
-  # This is the simplest type of Webview DisplayService. It creates Webview widgets
-  # corresponding to Shoes widgets, manages the Webview and its DOM tree, and
+module Scarpe
+  # This is the simplest type of Webview DisplayService. It creates Webview drawables
+  # corresponding to Shoes drawables, manages the Webview and its DOM tree, and
   # generally keeps the Shoes/Webview connection working.
   #
   # This is an in-process Webview-based display service, with all the limitations that
@@ -10,7 +10,7 @@ class Scarpe
   # process, too many or too large evals can crash the process, etc.
   # Frequently it's better to use a RelayDisplayService to a second
   # process containing one of these.
-  class WebviewDisplayService < Shoes::DisplayService
+  class Webview::DisplayService < Shoes::DisplayService
     include Shoes::Log
 
     class << self
@@ -20,67 +20,86 @@ class Scarpe
     # The ControlInterface is used to handle internal events in Webview Scarpe
     attr_reader :control_interface
 
-    # The DocumentRoot is the top widget of the Webview-side widget tree
+    # The DocumentRoot is the top drawable of the Webview-side drawable tree
     attr_reader :doc_root
 
-    # app is the Scarpe::WebviewApp
+    # app is the Scarpe::Webview::App
     attr_reader :app
 
     # wrangler is the Scarpe::WebWrangler
     attr_reader :wrangler
 
-    # This is called before any of the various WebviewWidgets are created, to be
+    # This is called before any of the various Webview::Drawables are created, to be
     # able to create them and look them up.
     def initialize
-      if WebviewDisplayService.instance
-        raise "ERROR! This is meant to be a singleton!"
+      if Webview::DisplayService.instance
+        raise Shoes::Errors::SingletonError, "ERROR! This is meant to be a singleton!"
       end
 
-      WebviewDisplayService.instance = self
+      Webview::DisplayService.instance = self
 
       super()
-      log_init("WV::WebviewDisplayService")
+      log_init("Webview::DisplayService")
 
-      @display_widget_for = {}
+      @display_drawable_for = {}
     end
 
-    # Create a Webview display widget for a specific Shoes widget, and pair it with
-    # the linkable ID for this Shoes widget.
+    # Create a Webview display drawable for a specific Shoes drawable, and pair it with
+    # the linkable ID for this Shoes drawable.
     #
-    # @param widget_class_name [String] The class name of the Shoes widget, e.g. Shoes::Button
-    # @param widget_id [String] the linkable ID for widget events
-    # @param properties [Hash] a JSON-serialisable Hash with the widget's display properties
-    # @return [WebviewWidget] the newly-created Webview widget
-    def create_display_widget_for(widget_class_name, widget_id, properties)
-      if widget_class_name == "App"
+    # @param drawable_class_name [String] The class name of the Shoes drawable, e.g. Shoes::Button
+    # @param drawable_id [String] the linkable ID for drawable events
+    # @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, parent_id:, is_widget:)
+      existing = query_display_drawable_for(drawable_id, nil_ok: true)
+      if existing
+        @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
+
+      if drawable_class_name == "App"
         unless @doc_root
-          raise "WebviewDocumentRoot is supposed to be created before WebviewApp!"
+          raise Scarpe::MissingDocRootError, "Webview::DocumentRoot is supposed to be created before Webview::App!"
         end
 
-        display_app = Scarpe::WebviewApp.new(properties)
+        display_app = Scarpe::Webview::App.new(properties)
         display_app.document_root = @doc_root
         @control_interface = display_app.control_interface
         @control_interface.doc_root = @doc_root
         @app = @control_interface.app
         @wrangler = @control_interface.wrangler
 
-        set_widget_pairing(widget_id, display_app)
+        set_drawable_pairing(drawable_id, display_app)
 
         return display_app
       end
 
-      # Create a corresponding display widget
-      display_class = Scarpe::WebviewWidget.display_class_for(widget_class_name)
-      display_widget = display_class.new(properties)
-      set_widget_pairing(widget_id, display_widget)
+      # Create a corresponding display drawable
+
+      if is_widget
+        display_class = Scarpe::Webview::Flow
+      else
+        display_class = Scarpe::Webview::Drawable.display_class_for(drawable_class_name)
+        unless display_class < Scarpe::Webview::Drawable
+          raise Scarpe::BadDisplayClassType, "Wrong display class type #{display_class.inspect} for class name #{drawable_class_name.inspect}!"
+        end
+      end
+      display_drawable = display_class.new(properties)
+      set_drawable_pairing(drawable_id, display_drawable)
 
-      if widget_class_name == "DocumentRoot"
-        # WebviewDocumentRoot is created before WebviewApp. Mostly doc_root is just like any other widget,
-        # but we'll want a reference to it when we create WebviewApp.
-        @doc_root = display_widget
+      if drawable_class_name == "DocumentRoot"
+        # DocumentRoot is created before App. Mostly doc_root is just like any other drawable,
+        # but we'll want a reference to it when we create App.
+        @doc_root = display_drawable
       end
 
-      display_widget
+      # 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
 
     # Destroy the display service and the app. Quit the process (eventually.)
@@ -88,7 +107,7 @@ class Scarpe
     # @return [void]
     def destroy
       @app.destroy
-      WebviewDisplayService.instance = nil
+      Webview::DisplayService.instance = nil
     end
   end
 end

data/lib/scarpe/wv/webview_relay_display.rb

@@ -5,16 +5,16 @@ require "rbconfig"
 
 require_relative "webview_relay_util"
 
-class Scarpe
+module Scarpe
   # This display service creates a child process and sends events
-  # back and forth, but creates no widgets of its own. The child
-  # process will spawn a worker with its own WebviewDisplayService
+  # back and forth, but creates no drawables of its own. The child
+  # process will spawn a worker with its own Webview::DisplayService
   # where the real Webview exists. By splitting the Webview
-  # process from the Shoes widgets, it can be easier to return
+  # process from the Shoes drawables, it can be easier to return
   # control to Webview's event handler promptly. Also, the Ruby
   # process could run background threads if it wanted, and
   # otherwise behave like a process ***not*** containing Webview.
-  class WVRelayDisplayService < Shoes::DisplayService
+  class Webview::RelayDisplayService < Shoes::DisplayService
     include Shoes::Log
     include WVRelayUtil # Needs Shoes::Log
 
@@ -23,7 +23,7 @@ class Scarpe
     # Create a Webview Relay Display Service
     def initialize
       super()
-      log_init("WV::RelayDisplayService")
+      log_init("Webview::RelayDisplayService")
 
       @event_subs = []
       @shutdown = false
@@ -46,7 +46,7 @@ class Scarpe
         if event_name == "run"
           run_event_loop
         end
-      rescue AppShutdownError
+      rescue Scarpe::AppShutdownError
         @shutdown = true
         @log.info("Attempting to shut down...")
         self.destroy
@@ -59,16 +59,16 @@ class Scarpe
         respond_to_datagram while ready_to_read?
         sleep 0.1
       end
-    rescue AppShutdownError
+    rescue Scarpe::AppShutdownError
       @shutdown = true
       @log.info("Attempting to shut down...")
       self.destroy
     end
 
-    # This method sends a message to the worker process to create a widget. No actual
-    # widget is created or registered with the display service.
-    def create_display_widget_for(widget_class_name, widget_id, properties)
-      send_datagram({ type: :create, class_name: widget_class_name, id: widget_id, properties: })
+    # This method sends a message to the worker process to create a drawable. No actual
+    # drawable is created or registered with the display service.
+    def create_display_drawable_for(drawable_class_name, drawable_id, properties)
+      send_datagram({ type: :create, class_name: drawable_class_name, id: drawable_id, properties: })
       # Don't need to return anything. It wouldn't be used anyway.
     end
 

data/lib/scarpe/wv/webview_relay_util.rb

@@ -2,10 +2,7 @@
 
 require "socket"
 
-class Scarpe
-  # An error occurred which would normally be handled by shutting down the app
-  class AppShutdownError < Scarpe::Error; end
-
+module Scarpe
   # WVRelayUtil defines the datagram format for the sockets that connect a parent
   # Shoes application with a child display server.
   #
@@ -24,7 +21,7 @@ class Scarpe
       return if r.nil?
 
       unless e.empty?
-        raise "#{@i_am}: Got error on connection(s) from IO.select! Dying!"
+        raise Scarpe::ConnectionError, "#{@i_am}: Got error on connection(s) from IO.select! Dying!"
       end
 
       !r.empty?
@@ -43,7 +40,7 @@ class Scarpe
       until written == to_write
         count = @to.write(dgram_str.byteslice(written..-1))
         if count.nil? || count == 0
-          raise "Something was wrong in send_datagram! Write returned #{count.inspect}!"
+          raise Scarpe::DatagramSendError, "Something was wrong in send_datagram! Write returned #{count.inspect}!"
         end
 
         written += count
@@ -73,7 +70,7 @@ class Scarpe
         new_bytes = @from.read(10)
         if new_bytes.nil?
           # This is perfectly normal, if the connection closed
-          raise AppShutdownError, "Got an unexpected EOF reading datagram! " +
+          raise Scarpe::AppShutdownError, "Got an unexpected EOF reading datagram! " +
             "Did the #{@i_am == :child ? "parent" : "child"} process die?"
         end
         @readbuf << new_bytes
@@ -90,7 +87,7 @@ class Scarpe
         @readbuf << new_bytes
       end
     rescue
-      raise AppShutdownError, "Got exception #{$!.class} when receiving datagram... #{$!.inspect}"
+      raise Scarpe::AppShutdownError, "Got exception #{$!.class} when receiving datagram... #{$!.inspect}"
     end
 
     # Read a datagram from the internal buffer and then dispatch it to the
@@ -109,9 +106,9 @@ class Scarpe
           **kwargs_hash,
         )
       elsif m_data["type"] == "create"
-        raise "Parent process should never receive :create datagram!" if @i_am == :parent
+        raise Scarpe::InvalidOperationError, "Parent process should never receive :create datagram!" if @i_am == :parent
 
-        @wv_display.create_display_widget_for(m_data["class_name"], m_data["id"], m_data["properties"])
+        @wv_display.create_display_drawable_for(m_data["class_name"], m_data["id"], m_data["properties"])
       elsif m_data["type"] == "destroy"
         if @i_am == :parent
           @shutdown = true

data/lib/scarpe/wv/wv_display_worker.rb

@@ -38,11 +38,11 @@ class Scarpe::Webview::ContainedService < Shoes::Linkable
   # @param to [Socket] a writable socket on which to send output to the Shoes process
   def initialize(from, to)
     super()
-    log_init("WV::DisplayWorker")
+    log_init("Webview::DisplayWorker")
 
     @i_am = :child
     @event_subs = []
-    @wv_display = Scarpe::WebviewDisplayService.new
+    @wv_display = Scarpe::Webview::DisplayService.new
 
     @from = from
     @to = to

data/lib/scarpe/wv.rb

@@ -8,11 +8,26 @@ require "securerandom"
 require "json"
 
 require "bloops"
+require "scarpe/components/html" # HTML renderer
 require "scarpe/components/modular_logger"
 require "scarpe/components/promises"
+require "scarpe/components/string_helpers"
 
 # Module to contain the various Scarpe Webview classes
-module Scarpe::Webview; end
+module Scarpe::Webview
+  HTML = Scarpe::Components::HTML
+end
+
+# Set up Scarpe-Webview's HTML renderer
+ren = ENV["SCARPE_HTML_RENDERER"] || "calzini"
+# This should *not* be require_relative so that other gems can implement HTML renderers.
+require "scarpe/components/#{ren}"
+class Scarpe::Webview::Drawable < Shoes::Linkable
+  # By default it's Scarpe::Components::Calzini
+  comp = Scarpe::Components::StringHelpers.camelize(ENV["SCARPE_HTML_RENDERER"] || "calzini")
+  mod = Scarpe::Components.const_get(comp)
+  include mod
+end
 
 # Set up hierarchical logging using the SCARPE_LOG_CONFIG var for configuration
 log_config = if ENV["SCARPE_LOG_CONFIG"]
@@ -28,22 +43,42 @@ require "scarpe/components/segmented_file_loader"
 loader = Scarpe::Components::SegmentedFileLoader.new
 Shoes.add_file_loader loader
 
+# Fun trivia: listing the full set of available fonts is a fingerprinting attack, so it's not
+# available from JS. These are all commonly available web fonts, though.
+Shoes::FONTS.push(
+  "Helvetica",
+  "Arial",
+  "Arial Black",
+  "Verdana",
+  "Tahoma",
+  "Trebuchet MS",
+  "Impact",
+  "Gill Sans",
+  "Times New Roman",
+  "Georgia",
+  "Palatino",
+  "Baskerville",
+  "Courier",
+  "Lucida",
+  "Monaco",
+)
+
+Shoes::FEATURES.push(:html)
+Shoes::EXTENSIONS.push(:scarpe)
+
+require_relative "shoes_spec"
+Shoes::Spec.instance = Scarpe::Test
+
 require_relative "wv/web_wrangler"
 require_relative "wv/control_interface"
 
-require_relative "wv/widget"
-
-require_relative "wv/dimensions"
-require_relative "wv/html"
+require_relative "wv/drawable"
 
-require_relative "wv/spacing"
 require_relative "wv/star"
+require_relative "wv/oval"
 require_relative "wv/radio"
-require_relative "wv/background"
-require_relative "wv/border"
 
 require_relative "wv/arc"
-require_relative "wv/font"
 
 require_relative "wv/app"
 require_relative "wv/para"
@@ -57,12 +92,17 @@ require_relative "wv/image"
 require_relative "wv/edit_box"
 require_relative "wv/edit_line"
 require_relative "wv/list_box"
-require_relative "wv/alert"
-require_relative "wv/span"
 require_relative "wv/shape"
 
-require_relative "wv/text_widget"
+require_relative "wv/text_drawable"
 require_relative "wv/link"
 require_relative "wv/line"
+require_relative "wv/rect"
 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/lib/scarpe/wv_local.rb

@@ -3,4 +3,4 @@
 require_relative "wv"
 require_relative "wv/webview_local_display"
 
-Shoes::DisplayService.set_display_service_class(Scarpe::WebviewDisplayService)
+Shoes::DisplayService.set_display_service_class(Scarpe::Webview::DisplayService)

data/lib/scarpe/wv_relay.rb

@@ -3,4 +3,4 @@
 require_relative "wv"
 require_relative "wv/webview_relay_display"
 
-Shoes::DisplayService.set_display_service_class(Scarpe::WVRelayDisplayService)
+Shoes::DisplayService.set_display_service_class(Scarpe::Webview::RelayDisplayService)

data/lib/scarpe.rb

@@ -10,4 +10,5 @@ require "lacci/scarpe_core"
 
 d_s = ENV["SCARPE_DISPLAY_SERVICE"] || "wv_local"
 # This is require, not require_relative, to allow gems to supply a new display service
+require "scarpe/errors"
 require "scarpe/#{d_s}"

data/logger/debug_web_wrangler.json

@@ -1,4 +1,4 @@
 {
     "default": "warn",
-    "WV::WebWrangler": ["debug", "logger/web_wrangler.log"]
+    "Webview::WebWrangler": ["debug", "logger/web_wrangler.log"]
 }

data/logger/scarpe_wv_test.json

@@ -1,4 +1,4 @@
 {
     "default": ["debug", "logger/test_failure.log"],
-    "WebviewAPI": ["debug", "logger/test_failure_wv_api.log"]
+    "Webview::API": ["debug", "logger/test_failure_wv_api.log"]
 }

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

@@ -0,0 +1,85 @@
+PATH
+  remote: ../lacci
+  specs:
+    lacci (0.3.0)
+      scarpe-components
+
+PATH
+  remote: .
+  specs:
+    scarpe-components (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    builder (3.2.4)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    io-console (0.6.0)
+    irb (1.8.0)
+      rdoc (~> 6.5)
+      reline (>= 0.3.6)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.19.0)
+    minitest-reporters (1.6.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.0)
+      stringio
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.1)
+    reline (0.3.8)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    stringio (3.0.8)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  debug
+  lacci!
+  minitest (~> 5.0)
+  minitest-reporters
+  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