lacci 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef2126246f0ffc9b764bb40b2a3e4b020702b25a8198a6ba62dfbda69fe5db32
-  data.tar.gz: 61272a70f2591a4ed0b24aeedc8c3c2cfdfdc132fbcf0aea8c6816674c792d57
+  metadata.gz: aab735aab6fb64d87496b2ebefac1235a3858b1e14f176a2b165bf0c82c10260
+  data.tar.gz: 961b0b461164093bf51bf2ab7f79ae95e626a561548c7421bdcc75efe199e4e1
 SHA512:
-  metadata.gz: 97fa624c1e77eb7a54087d76dafc3c0ee2938bfdc99a60c56594061572860777c439b776f47de4a64f237ceaec215fe9561dc984e2b6aca3f3b8bec670dc4959
-  data.tar.gz: 485654866460c26497c49613d24a8fd6cc68ce8580f49246766b524c6c81cab77aa9b6a5a92733333d3ba39b70d7a7433337e2d1145a94f7f54f36eeb6219a38
+  metadata.gz: 3e3bffa1f9f822b082ed7268458f0a93c49614a3b6169f4648fe57c126d77a4131d5113a15ca2a7421fe3271746ba36eb10faed83a326c4eb9514ec0447eaecf
+  data.tar.gz: 7f2c9d2e4672faea8f3f5613a9b4bdc4c78b65e9443a669c166a76d95cee2c305095eda4688418bc4b8a3d804e9ea2662fa09f0a906b61435a9aa3d019367cce

data/Gemfile

@@ -2,10 +2,8 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in scarpe.gemspec
 gemspec
 
-gem "bloops", "~> 0.5" #path: "../bloopsaphone" #git: "https://github.com/scarpe-team/bloopsaphone"
 gem "rake", "~> 13.0"
 
 group :test do

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    lacci (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    io-console (0.6.0)
+    irb (1.7.2)
+      reline (>= 0.3.6)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
+    minitest-reporters (1.6.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redcarpet (3.6.0)
+    regexp_parser (2.8.1)
+    reline (0.3.6)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.54.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.0, < 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)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  debug
+  lacci!
+  minitest (~> 5.0)
+  minitest-reporters
+  rake (~> 13.0)
+  redcarpet
+  rubocop (~> 1.21)
+  rubocop-shopify
+  yard
+
+BUNDLED WITH
+   2.4.10

data/Rakefile

@@ -2,7 +2,6 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
-require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -10,6 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
-RuboCop::RakeTask.new
-
-task default: [:test, :rubocop]
+task default: [:test]

data/lib/lacci/scarpe_cli.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+class Scarpe
+  module CLI
+    DEFAULT_USAGE = <<~'USAGE'
+      Usage: scarpe_core [OPTIONS] <scarpe app file>           # Same as "scarpe run"
+             scarpe_core [OPTIONS] run <scarpe app file>
+             scarpe_core [OPTIONS] env                         # print Scarpe environment settings
+             scarpe_core -v                                    # print the Scarpe gem version and exit
+        Options:
+            --dev                          Use development local scarpe, not an installed gem
+            --debug                        Turn on application debug mode
+    USAGE
+
+    def version_check
+      if RUBY_VERSION[0..2] < "3.2"
+        raise "Scarpe and Lacci require Ruby 3.2 or higher!"
+      end
+    end
+
+    def env_or_default(env_var, default_val)
+      [env_var, ENV[env_var] ? ENV[env_var].inspect : default_val]
+    end
+
+    def default_env_categories
+      {
+        "Lacci" => [
+          env_or_default("SCARPE_DISPLAY_SERVICE", "(none)"),
+          env_or_default("SCARPE_LOG_CONFIG", "(default)#{Shoes::Log::DEFAULT_LOG_CONFIG.inspect}"),
+          env_or_default("SCARPE_APP_TEST", "(none)"),
+        ],
+        "Ruby and Shell" => [
+          ["RUBY_DESCRIPTION", RUBY_DESCRIPTION],
+          ["RUBY_PLATFORM", RUBY_PLATFORM],
+          ["RUBY_ENGINE", RUBY_ENGINE],
+          env_or_default("SHELL", "(none)"),
+          env_or_default("PATH", "(none)"),
+          env_or_default("LD_LIBRARY_PATH", "(none)"),
+          env_or_default("DYLD_LIBRARY_PATH", "(none)"),
+          env_or_default("GEM_ROOT", "(none)"),
+          env_or_default("GEM_HOME", "(none)"),
+          env_or_default("GEM_PATH", "(none)"),
+        ],
+      }
+    end
+
+    def env_categories
+      @env_categories ||= default_env_categories
+      @env_categories
+    end
+
+    def add_env_categories(categories)
+      unless categories.is_a?(Hash)
+        raise("Please supply a hash with categories names as keys and an array of two-elt arrays as values!")
+      end
+
+      # Try to get categories into the *start* of the hash, insertion-order-wise
+      @env_categories = categories.merge(env_categories)
+    end
+
+    def print_env
+      env_categories.each do |category, entries|
+        puts "#{category} environment:"
+        entries.each do |name, val|
+          puts "  #{name}: #{val}"
+        end
+      end
+    end
+  end
+end

data/lib/lacci/scarpe_core.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Lacci is one place we put components that have no hard gem requirements.
+# It needs to connect to Scarpe, mostly via the Shoes DisplayService.
+# Some display services, like Wasm, cannot install or otherwise tolerate
+# Scarpe's need for a variety of gems, especially those with native extensions.
+# So we need a simple require-able Scarpe core here in Lacci that can be
+# required from display services that cannot link with the base Scarpe gem.
+
+if RUBY_VERSION[0..2] < "3.2"
+  Shoes::Log.logger("Scarpe").error("Scarpe requires Ruby 3.2 or higher!")
+  exit(-1)
+end
+
+class Scarpe; end
+
+# The base error class for Scarpe errors, but not necessarily {Shoes::Error}s
+class Scarpe::Error < StandardError; end
+
+require "lacci/version"
+require "scarpe/components/version"

data/lib/lacci/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# The name "scarpe" means "shoes" in Italian. "Lacci"
+# means "laces." Lacci is the display-independent part
+# of Scarpe, tying the Shoes API to the display service
+# of your choice.
+#
+# Almost nothing is called Lacci in your program. It's
+# mostly invisible. Instead, look at the {Shoes} module
+# to see what's in Lacci.
+module Lacci
+  VERSION = "0.2.2"
+end

data/lib/shoes/app.rb

@@ -2,7 +2,7 @@
 
 module Shoes
   class App < Shoes::Widget
-    include Scarpe::Log
+    include Shoes::Log
 
     class << self
       attr_accessor :instance
@@ -10,16 +10,19 @@ module Shoes
 
     attr_reader :document_root
 
-    display_properties :title, :width, :height, :resizable, :debug
+    display_properties :title, :width, :height, :resizable
+
+    CUSTOM_EVENT_LOOP_TYPES = ["displaylib", "return", "wait"]
 
     def initialize(
-      title: "Scarpe!",
+      title: "Shoes!",
       width: 480,
       height: 420,
       resizable: true,
-      debug: ENV["SCARPE_DEBUG"] ? true : false,
       &app_code_body
     )
+      log_init("Shoes::App")
+
       if Shoes::App.instance
         @log.error("Trying to create a second Shoes::App in the same process! Fail!")
         raise "Cannot create multiple Shoes::App objects!"
@@ -27,14 +30,21 @@ module Shoes
         Shoes::App.instance = self
       end
 
-      log_init("Shoes::App")
-
       @do_shutdown = false
+      @event_loop_type = "displaylib" # the default
 
       super
 
+      # The draw context tracks current settings like fill and stroke,
+      # plus potentially other current state that changes from widget
+      # to widget and slot to slot.
+      @draw_context = {
+        "fill" => "",
+        "stroke" => "",
+      }
+
       # This creates the DocumentRoot, including its corresponding display widget
-      @document_root = Scarpe::DocumentRoot.new
+      @document_root = Shoes::DocumentRoot.new
 
       @slots = []
 
@@ -59,9 +69,15 @@ module Shoes
         self.destroy(send_event: false)
       end
 
+      @watch_for_event_loop = bind_shoes_event(event_name: "custom_event_loop") do |loop_type|
+        raise("Unknown event loop type: #{loop_type.inspect}!") unless CUSTOM_EVENT_LOOP_TYPES.include?(loop_type)
+
+        @event_loop_type = loop_type
+      end
+
       Signal.trap("INT") do
-        @log.warning("App interrupted by signal, stopping...")
-        puts "\nStopping Scarpe app..."
+        @log.warn("App interrupted by signal, stopping...")
+        puts "\nStopping Shoes app..."
         destroy
       end
     end
@@ -74,7 +90,7 @@ module Shoes
     end
 
     # "Container" widgets like flows, stacks, masks and the document root
-    # are considered "slots" in Scarpe parlance. When a new slot is created,
+    # are considered "slots" in Shoes parlance. When a new slot is created,
     # we push it here in order to track what widgets are found in that slot.
     def push_slot(slot)
       @slots.push(slot)
@@ -99,14 +115,37 @@ module Shoes
       pop_slot
     end
 
-    # This isn't supposed to return. The display service should take control
+    def current_draw_context
+      @draw_context.dup
+    end
+
+    # This usually doesn't return. The display service may take control
     # of the main thread. Local Webview even stops any background threads.
+    # However, some display libraries don't want to shut down and don't
+    # want to (and/or can't) take control of the event loop.
     def run
       if @do_shutdown
         $stderr.puts "Destroy has already been signaled, but we just called Shoes::App.run!"
         return
       end
+
+      # The display lib can send us an event to customise the event loop handling.
+      # But it must do so before the "run" event returns.
       send_shoes_event(event_name: "run")
+
+      case @event_loop_type
+      when "wait"
+        # Display lib wants us to busy-wait instead of it.
+        sleep 0.1 until @do_shutdown
+      when "displaylib"
+        # If run event returned, that means we're done.
+        destroy
+      when "return"
+        # We can just return to the main event loop. But we shouldn't call destroy.
+        # Presumably some event loop *outside* our event loop is handling things.
+      else
+        raise "Internal error! Incorrect event loop type: #{@event_loop_type.inspect}!"
+      end
     end
 
     def destroy(send_event: true)
@@ -120,7 +159,7 @@ module Shoes
       to_add = @document_root.children
       until to_add.empty?
         out.concat(to_add)
-        to_add = to_add.flat_map(&:children).compact
+        to_add = to_add.flat_map { |w| w.respond_to?(:children) ? w.children : [] }.compact
       end
 
       out
@@ -133,7 +172,7 @@ module Shoes
       specs.each do |spec|
         if spec.is_a?(Class)
           widgets.select! { |w| spec === w }
-        elsif spec.is_a?(Symbol)
+        elsif spec.is_a?(Symbol) || spec.is_a?(String)
           s = spec.to_s
           case s[0]
           when "$"
@@ -145,7 +184,7 @@ module Shoes
               raise "Error getting global variable: #{spec.inspect}"
             end
           when "@"
-            if app.instance_variables.include?(spec)
+            if Shoes::App.instance.instance_variables.include?(spec.to_sym)
               widgets &= [self.instance_variable_get(spec)]
             else
               raise "Can't find top-level instance variable: #{spec.inspect}!"
@@ -183,5 +222,43 @@ class Shoes::App
     subscription_item(shoes_api_name: "click", &block)
   end
 
+  # Draw context methods
+
+  def fill(color)
+    @draw_context["fill"] = color
+  end
+
+  def nofill
+    @draw_context["fill"] = ""
+  end
+
+  def stroke(color)
+    @draw_context["stroke"] = color
+  end
+
+  def nostroke
+    @draw_context["stroke"] = ""
+  end
+
+  # Shape DSL methods
+
+  def move_to(x, y)
+    raise("Pass only Numeric arguments to move_to!") unless x.is_a?(Numeric) && y.is_a?(Numeric)
+
+    if current_slot.is_a?(::Shoes::Shape)
+      current_slot.add_shape_command(["move_to", x, y])
+    end
+  end
+
+  def line_to(x, y)
+    raise("Pass only Numeric arguments to line_to!") unless x.is_a?(Numeric) && y.is_a?(Numeric)
+
+    if current_slot.is_a?(::Shoes::Shape)
+      current_slot.add_shape_command(["line_to", x, y])
+    end
+  end
+
+  # Not implemented yet: curve_to, arc_to
+
   alias_method :info, :puts
 end

data/lib/{scarpe → shoes}/background.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Scarpe
+module Shoes
   module Background
     def self.included(includer)
       includer.display_property(:background_color)

data/lib/{scarpe → shoes}/border.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Scarpe
+module Shoes
   module Border
     def self.included(includer)
       includer.display_properties :border_color, :options

data/lib/{scarpe → shoes}/colors.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Scarpe
+module Shoes
   module Colors
     COLORS = {
       aliceblue: [240, 248, 255],

data/lib/shoes/constants.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-require "tmpdir"
-
 module Shoes
   module Constants
     def self.find_lib_dir
+      begin
+        require "tmpdir"
+      rescue LoadError
+        return nil
+      end
       homes = [
         [ENV["LOCALAPPDATA"], "Shoes"],
         [ENV["APPDATA"], "Shoes"],

data/lib/{scarpe → shoes}/display_service.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# Scarpe Shoes apps operate in multiple layers. A Shoes widget tree exists as fairly
+# Lacci Shoes apps operate in multiple layers. A Shoes widget tree exists as fairly
 # plain, simple Ruby objects. And then a display-service widget tree integrates with
-# the display technology, initially Webview. This lets us use Ruby as our API while
-# not tying it too closely to the limitations of Webview.
+# the display technology. This lets us use Ruby as our API while
+# not tying it too closely to the limitations of Webview, WASM, LibUI, etc.
 #
 # ## Choosing Display Services
 #
-# Before running a Scarpe app, you can set SCARPE_DISPLAY_SERVICE. If you
+# Before running a Lacci app, you can set SCARPE_DISPLAY_SERVICE. If you
 # set it to "whatever_service", Scarpe will require "scarpe/whatever_service",
 # which can be supplied by the Scarpe gem or another Scarpe-based gem.
 # Currently leaving the environment variable empty is equivalent to requesting
@@ -17,7 +17,7 @@
 #
 # Events are a lot of what tie the Shoes widgets and the display service together.
 #
-# Scarpe widgets *expect* to operate in a fairly "hands off" mode where they record
+# Shoes widgets *expect* to operate in a fairly "hands off" mode where they record
 # to an event queue to send to the display service, and the display service records
 # events to send back.
 #
@@ -30,9 +30,7 @@ module Shoes
   class DisplayService
     class << self
       # This is in the eigenclass/metaclass, *not* instances of DisplayService
-      include Scarpe::Log
-
-      attr_accessor :json_debug_serialize
+      include Shoes::Log
 
       # An event_target may be nil, to indicate there is no target.
       def dispatch_event(event_name, event_target, *args, **kwargs)
@@ -46,7 +44,8 @@ module Shoes
 
         @log.debug("Dispatch event: #{event_name.inspect} T: #{event_target.inspect} A: #{args.inspect} KW: #{kwargs.inspect}")
 
-        if DisplayService.json_debug_serialize
+        # When true, this makes sure all events and properties are 100% strings, no symbols.
+        if ENV["SCARPE_DEBUG"]
           args = JSON.parse JSON.dump(args)
           new_kw = {}
           kwargs.each do |k, v|

data/lib/{scarpe → shoes}/download.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "net/http"
-require "openssl"
-require "nokogiri"
-
 module Shoes
   class Widget
     class ResponseWrapper
@@ -23,10 +19,14 @@ module Shoes
     end
 
     def download(url, method: "GET", save: nil, styles: {}, &block)
+      require "net/http"
+      require "openssl"
+      require "nokogiri"
+
       @block = block
 
       Thread.new do
-        logger = Scarpe::Logger.logger("Shoes::App#download")
+        logger = Shoes::Log.logger("Shoes::App#download")
         begin
           uri = URI(url)
           response = perform_request(uri, method, styles)

data/lib/shoes/log.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Old-style Shoes logging is really simple. We need more logging for our
+# framework, so we add a not-included-in-old-Shoes module for it. This adds
+# the *possibility* of logging, but Scarpe includes a much more
+# comprehensive solution that plugs into this one.
+
+# If used alone, this will fail because the @instance is nil. It needs
+# an implementation to be plugged in.
+
+module Shoes
+  LOG_LEVELS = [:debug, :info, :warn, :error, :fatal].freeze
+
+  # Include this module to get a @log instance variable to log as your
+  # configured component.
+  module Log
+    # These constants will wind up included in a lot of places. Should they move?
+    DEFAULT_COMPONENT = "default"
+    DEFAULT_LOG_CONFIG = {
+      "default" => "info",
+    }
+    DEFAULT_DEBUG_LOG_CONFIG = {
+      "default" => "debug",
+    }
+
+    class << self
+      attr_reader :instance
+      attr_reader :current_log_config
+
+      def instance=(impl_object)
+        raise(Shoes::Error, "Already have an instance for Shoes::Log!") if @instance
+
+        @instance = impl_object
+      end
+
+      def logger(component = self)
+        @instance.logger_for_component(component)
+      end
+
+      def configure_logger(log_config)
+        @instance.configure_logger(log_config)
+      end
+    end
+
+    def log_init(component = self)
+      @log = Shoes::Log.instance.logger_for_component(component)
+    end
+  end
+
+  class LoggedWrapper
+    include ::Shoes::Log
+    def initialize(instance, component = instance)
+      log_init(component)
+
+      @instance = instance
+    end
+
+    def method_missing(method, ...)
+      self.singleton_class.define_method(method) do |*args, **kwargs, &block|
+        ret = @instance.send(method, *args, **kwargs, &block)
+        @log.info("Method: #{method} Args: #{args.inspect} KWargs: #{kwargs.inspect} Block: #{block ? "y" : "n"} Return: #{ret.inspect}")
+        ret
+      end
+      send(method, ...)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @instance.respond_to_missing?(method_name, include_private)
+    end
+  end
+end

data/lib/{scarpe → shoes}/spacing.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Scarpe
+module Shoes
   module Spacing
     def self.included(includer)
       includer.display_properties :margin, :padding, :margin_top, :margin_left, :margin_right, :margin_bottom, :options