lacci 0.2.2 → 0.4.0

data/lib/shoes/background.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module Shoes
+class Shoes
   module Background
     def self.included(includer)
-      includer.display_property(:background_color)
+      includer.shoes_style(:background_color)
     end
 
     # NOTE: this needs to be passed through in order for the styling to work

data/lib/shoes/border.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module Shoes
+class Shoes
   module Border
     def self.included(includer)
-      includer.display_properties :border_color, :options
+      includer.shoes_styles :border_color, :options
     end
 
     # Considering a signature like this:

data/lib/shoes/builtins.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Shoes has a number of built-in methods that are intended to be available everywhere,
+# in every Shoes and non-Shoes class, for every Shoes app.
+module Shoes::Builtins
+  # Register the given font with Shoes so that text that wants it can use it.
+  # Also add it to the FONTS constant.
+  #
+  # @param font_file_or_url [String] the filename or URL for the font
+  # @return [void]
+  def font(font_file_or_url)
+    shoes_builtin("font", font_file_or_url)
+
+    font_name = File.basename(font_file_or_url, ".*")
+    Shoes::FONTS << font_name
+  end
+
+  def ask(message_string)
+    shoes_builtin("ask", message_string)
+  end
+
+  def alert(message)
+    shoes_builtin("alert", message)
+  end
+
+  def ask_color(title_bar)
+    shoes_builtin("ask_color", title_bar)
+  end
+
+  def ask_open_file()
+    shoes_builtin("ask_open_file")
+  end
+
+  def ask_save_file()
+    shoes_builtin("ask_save_file")
+  end
+
+  def ask_open_folder()
+    shoes_builtin("ask_open_folder")
+  end
+
+  def ask_save_folder()
+    shoes_builtin("ask_save_folder")
+  end
+
+  def confirm(question)
+    shoes_builtin("confirm", question)
+  end
+
+  # TO ADD: debug, error, info, warn
+  # TO VERIFY OR ADD: gradient, gray, rgb
+
+  private
+
+  def shoes_builtin(cmd_name, *args)
+    Shoes::DisplayService.dispatch_event("builtin", nil, cmd_name, args)
+    nil
+  end
+end
+
+module Kernel
+  include Shoes::Builtins
+end

data/lib/shoes/changelog.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "log"
+# require "scarpe/components/modular_logger"
+
+class Shoes
+  class Changelog
+    # include Shoes::Log
+
+    def initialize
+      #TODO : refer to  https://github.com/scarpe-team/scarpe/pull/400
+      #       and figure out how to use scarpe logger here without getting duplicate or nil error
+      # Shoes::Log.instance = Scarpe::Components::ModularLogImpl.new
+      # log_init("Changelog")
+    end
+
+    def get_latest_release_info
+      root_dir = File.dirname(__FILE__, 4) # this duplicates constants.rb, but how to share?
+
+      git_dir = "#{root_dir}/.git"
+      revision = nil
+      if File.exist?(git_dir)
+        revision = `git rev-parse HEAD`.chomp
+      end
+
+      changelog_file = "#{root_dir}/CHANGELOG.md"
+      if File.exist?(changelog_file)
+        changelog_content = File.read(changelog_file)
+        release_name_pattern = /^## \[(\d+\.\d+\.\d+)\] - (\d{4}-\d{2}-\d{2}) - (\w+)$/m
+        release_matches = changelog_content.scan(release_name_pattern)
+        latest_release = release_matches.max_by { |version, _date, _name| Gem::Version.new(version) }
+
+        if latest_release
+          #puts "Found release #{latest_release[0]} in CHANGELOG.md"
+          # @log.debug("Found release #{latest_release[0]} in CHANGELOG.md") # Logger isn't initialized yet
+          version_parts = latest_release[0].split(".").map(&:to_i)
+          rel_id = ("%02d%02d%02d" % version_parts).to_i
+
+          return({
+            RELEASE_NAME: latest_release[2],
+            RELEASE_BUILD_DATE: latest_release[1],
+            RELEASE_ID: rel_id,
+            REVISION: revision,
+          })
+        end
+      end
+
+      puts "No release found in CHANGELOG.md"
+      { RELEASE_NAME: nil, RELEASE_BUILD_DATE: nil, RELEASE_ID: nil, REVISION: revision }
+    end
+  end
+end

data/lib/shoes/colors.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-module Shoes
+class Shoes
   module Colors
+    extend self
+
     COLORS = {
       aliceblue: [240, 248, 255],
       antiquewhite: [250, 235, 215],

data/lib/shoes/constants.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-module Shoes
+require_relative "changelog"
+class Shoes
   module Constants
     def self.find_lib_dir
       begin
@@ -12,18 +13,56 @@ module Shoes
         [ENV["LOCALAPPDATA"], "Shoes"],
         [ENV["APPDATA"], "Shoes"],
         [ENV["HOME"], ".shoes"],
-        [Dir.tmpdir, "shoes"],
       ]
+
       top, file = homes.detect { |home_top, _| home_top && File.exist?(home_top) }
+      return nil if top.nil?
       File.join(top, file)
     end
 
+    # A temp dir for Shoes app files
     LIB_DIR = find_lib_dir
 
+    # the Shoes library dir
+    DIR = File.dirname(__FILE__, 4)
+
     # Math constants from Shoes3
     RAD2PI = 0.01745329251994329577
     TWO_PI = 6.28318530717958647693
     HALF_PI = 1.57079632679489661923
     PI = 3.14159265358979323846
+
+    # These should be set up by the Display Service when it loads. They are intentionally
+    # *not* frozen so that the Display Service can add to them (and then optionally
+    # freeze them.)
+
+    # Fonts currently loaded and available
+    FONTS = []
+
+    # Standard features available in this display service - see KNOWN_FEATURES.
+    # These may or may not require the Shoes.app requesting them per-app.
+    FEATURES = []
+
+    # Nonstandard extensions, e.g. Scarpe extensions, supported by this display lib.
+    # An application may have to request the extensions for them to be available so
+    # that a casual reader can see Shoes.app(features: :scarpe) and realize why
+    # there are nonstandard styles or drawables.
+    EXTENSIONS = []
+
+    # These are all known features supported by this version of Lacci.
+    # Features on this list are allowed to be in FEATURES. Anything else
+    # goes in EXTENSIONS and is nonstandard.
+    KNOWN_FEATURES = [
+      :html, # Supports .to_html on display objects, HTML classes on drawables, etc.
+    ].freeze
   end
+
+  # Access and assign the release constants
+  changelog_instance = Shoes::Changelog.new
+  RELEASE_INFO = changelog_instance.get_latest_release_info
+  RELEASE_NAME = RELEASE_INFO[:RELEASE_NAME]
+  RELEASE_ID = RELEASE_INFO[:RELEASE_ID]
+  RELEASE_BUILD_DATE = RELEASE_INFO[:RELEASE_BUILD_DATE]
+  RELEASE_TYPE = "LOOSE_SHOES" # This isn't really a thing any more
+  REVISION = RELEASE_INFO[:REVISION]
 end

data/lib/shoes/display_service.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# 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
+# Lacci Shoes apps operate in multiple layers. A Shoes drawable tree exists as fairly
+# plain, simple Ruby objects. And then a display-service drawable tree integrates with
 # 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.
 #
@@ -15,24 +15,31 @@
 #
 # ## Events
 #
-# Events are a lot of what tie the Shoes widgets and the display service together.
+# Events are a lot of what tie the Shoes drawables and the display service together.
 #
-# Shoes widgets *expect* to operate in a fairly "hands off" mode where they record
+# Shoes drawables *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.
 #
 # When a Shoes handler takes an action (e.g. some_para.replace(),) the relevant
 # call will be dispatched as a :display event, to be sent to the display service.
 # And when a display-side event occurs (e.g. user pushes a button,) it will be
-# dispatched as a :shoes event, to be sent to the Shoes tree of widgets.
+# dispatched as a :shoes event, to be sent to the Shoes tree of drawables.
 #
-module Shoes
+class Shoes
   class DisplayService
     class << self
       # This is in the eigenclass/metaclass, *not* instances of DisplayService
       include Shoes::Log
 
+      # Send a Shoes event to all subscribers.
       # An event_target may be nil, to indicate there is no target.
+      #
+      # @param event_name [String] the name of the event
+      # @param event_target [String] the specific target, if any
+      # @param args [Array] arguments to pass to the subscribing block
+      # @param args [Array] keyword arguments to pass to the subscribing block
+      # @return [void]
       def dispatch_event(event_name, event_target, *args, **kwargs)
         @@display_event_handlers ||= {}
 
@@ -69,10 +76,20 @@ module Shoes
         kwargs[:event_name] = event_name
         kwargs[:event_target] = event_target if event_target
         handlers.each { |h| h[:handler].call(*args, **kwargs) }
+        nil
       end
 
-      # It's permitted to subscribe to event_name :any for all event names, and event_target :any for all targets.
-      # An event_target of nil means "no target", and only matches events dispatched with a nil target.
+      # Subscribe to the given event name and target.
+      # It's permitted to subscribe to event_name :any for all event names,
+      # and event_target :any for all targets. An event_target of nil means
+      # "no target", and only matches events dispatched with a nil target.
+      # The subscription will return an unsubscribe ID, which can be used
+      # later to unsubscribe from the notification.
+      #
+      # @param event_name [String,Symbol] the event name to subscribe to, or :any for all event names
+      # @param event_target [String,Symbol,NilClass] the event target to subscribe to, or :any for all targets - nil is a valid target
+      # @block the block to call when the event occurs - it will receive arguments from the event-dispatch call
+      # @return [Integer] an unsubscription ID which can be used later to cancel the subscription
       def subscribe_to_event(event_name, event_target, &handler)
         @@display_event_handlers ||= {}
         @@display_event_unsub_id ||= 0
@@ -96,6 +113,10 @@ module Shoes
         id
       end
 
+      # Unsubscribe from any event subscriptions matching the unsub ID.
+      #
+      # @param unsub_id [Integer] the unsub ID returned when subscribing
+      # @return [void]
       def unsub_from_events(unsub_id)
         raise "Must provide an unsubscribe ID!" if unsub_id.nil?
 
@@ -106,17 +127,32 @@ module Shoes
         end
       end
 
+      # Reset the display service, for instance between unit tests.
+      # This destroys all existing subscriptions.
+      #
+      # @return [void]
       def full_reset!
         @@display_event_handlers = {}
         @json_debug_serialize = nil
       end
 
+      # Set the Display Service class which will handle display service functions
+      # for this process. This can only be set once. The display service can be
+      # a subclass of Shoes::DisplayService, but isn't required to be.
+      #
+      # Shoes will create an instance of this class with no arguments passed to
+      # initialize, and use it as the display service for the lifetime of the
+      # process.
+      #
+      # @param klass [Class] the class for the display service
       def set_display_service_class(klass)
         raise "Can only set a single display service class!" if @display_service_klass
 
         @display_service_klass = klass
       end
 
+      # Get the current display service instance. This requires a display service
+      # class having been set first. @see set_display_service_class
       def display_service
         return @service if @service
 
@@ -126,24 +162,38 @@ module Shoes
       end
     end
 
+    def initialize
+      @display_drawable_for = {}
+    end
+
     # These methods are an interface to DisplayService objects.
 
-    def create_display_widget_for(widget_class_name, widget_id, properties)
+    def create_display_drawable_for(drawable_class_name, drawable_id, properties, parent_id:, is_widget:)
       raise "Override in DisplayService implementation!"
     end
 
-    def set_widget_pairing(id, display_widget)
-      @display_widget_for ||= {}
-      @display_widget_for[id] = display_widget
+    def set_drawable_pairing(id, display_drawable)
+      if id.nil?
+        raise Shoes::Errors::BadLinkableIdError, "Linkable ID may not be nil!"
+      end
+
+      @display_drawable_for ||= {}
+      if @display_drawable_for[id]
+        raise Shoes::Errors::DuplicateCreateDrawableError, "There is already a drawable for #{id.inspect}! Not setting a new one."
+      end
+
+      @display_drawable_for[id] = display_drawable
+      nil
     end
 
-    def query_display_widget_for(id, nil_ok: false)
-      display_widget = @display_widget_for[id]
-      unless display_widget || nil_ok
-        raise "Could not find display widget for linkable ID #{id.inspect}!"
+    def query_display_drawable_for(id, nil_ok: false)
+      @display_drawable_for ||= {}
+      display_drawable = @display_drawable_for[id]
+      unless display_drawable || nil_ok
+        raise "Could not find display drawable for linkable ID #{id.inspect}!"
       end
 
-      display_widget
+      display_drawable
     end
 
     def destroy
@@ -163,6 +213,7 @@ module Shoes
 
     def initialize(linkable_id: object_id)
       @linkable_id = linkable_id
+      @subscriptions = {}
     end
 
     def send_self_event(*args, event_name:, **kwargs)
@@ -174,11 +225,22 @@ module Shoes
     end
 
     def bind_shoes_event(event_name:, target: nil, &handler)
-      DisplayService.subscribe_to_event(event_name, target, &handler)
+      sub = DisplayService.subscribe_to_event(event_name, target, &handler)
+      @subscriptions[sub] = true
+      sub
     end
 
     def unsub_shoes_event(unsub_id)
+      unless @subscriptions[unsub_id]
+        $stderr.puts "Unsubscribing from event that isn't in subscriptions! #{unsub_id.inspect}"
+      end
       DisplayService.unsub_from_events(unsub_id)
+      @subscriptions.delete unsub_id
+    end
+
+    def unsub_all_shoes_events
+      @subscriptions.keys.each { |k| DisplayService.unsub_from_events(k) }
+      @subscriptions.clear
     end
   end
 end

data/lib/shoes/download.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Shoes
-  class Widget
+class Shoes
+  class Drawable
     class ResponseWrapper
       attr_reader :response