lacci 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e32d4245e4dc24e8098d8626ca2ad9ba7d4417b6e392d0c0d43c1b003dece24e
-  data.tar.gz: dea4cd304311e63c498e2c679e8d61ec9b550c56c5a87d33bb4c7b499a08b875
+  metadata.gz: 3bf9fa7d8c25eece259eb65e02ac680c3004762fa86951597ae1721010a8af52
+  data.tar.gz: b997f33fc1f63480f38144f89c54af16a3f99c7eafaf960b53770ea4894b51e6
 SHA512:
-  metadata.gz: 360b04b248cc6011c5a37ca50d284d37d1aebd42f60aa15b7eb3f8b47933faca0d5b6738ae462b3cc67bf9b56b3bd426cb375fa8640111ec00a42a01a5aeaf55
-  data.tar.gz: 7ef67d55690c0b3ffe845edf747a86a1561dd2aced210d2a870df87f0140eb8aaaab8abbe03212da9557488de655944ecc9d54637679420dc1d8b5594143a5a6
+  metadata.gz: 7eb784a865dfd9add9ade9861a62cfa2192e407d1371e49cdd23eb6205c55c36f67d6a31347775ee6b3d43c6e025ea1788e6c51dedf4251a562dcb62f2cda1e5
+  data.tar.gz: ea5b4aef895ee41ea78699bac827f8404ebbef97f0d7e8ed93b41382076c3188538e70aa32016b5ff90bd81b05feca8effc977f5452efe30744f25a7d3fe845f

data/lib/lacci/scarpe_cli.rb

@@ -28,7 +28,6 @@ module Scarpe
         "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],

data/lib/lacci/version.rb

@@ -9,5 +9,5 @@
 # mostly invisible. Instead, look at the {Shoes} module
 # to see what's in Lacci.
 module Lacci
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/scarpe/niente/display_service.rb

@@ -29,7 +29,7 @@ module Niente
     # @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}.")
@@ -47,6 +47,10 @@ module Niente
       display_drawable.shoes_type = drawable_class_name
       set_drawable_pairing(drawable_id, display_drawable)
 
+      # Nil parent is okay for DocumentRoot and TextDrawables, so we have to specify it.
+      parent = DisplayService.instance.query_display_drawable_for(parent_id, nil_ok: true)
+      display_drawable.set_parent(parent)
+
       return display_drawable
     end
 

data/lib/scarpe/niente/drawable.rb

@@ -12,6 +12,7 @@ module Niente
 
       super(linkable_id: @shoes_linkable_id)
 
+      # This should only be used for reparenting after a drawable was initially created.
       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
@@ -28,6 +29,7 @@ module Niente
       end
 
       bind_shoes_event(event_name: "destroy", target: shoes_linkable_id) do
+        set_parent(nil)
       end
     end
 

data/lib/scarpe/niente/shoes_spec.rb

@@ -30,7 +30,6 @@ class Niente::Test
     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
-      STDERR.puts "Started running #{class_name.inspect}::#{test_name.inspect}"
       eval(code)
     end
   end
@@ -50,6 +49,13 @@ class Niente::ShoesSpecTest < Minitest::Test
       Niente::ShoesSpecProxy.new(drawables[0])
     end
   end
+
+  def drawable(*specs)
+    drawables = Shoes::App.instance.find_drawables_by(*specs)
+    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?
+    Niente::ShoesSpecProxy.new(drawables[0])
+  end
 end
 
 class Niente::ShoesSpecProxy

data/lib/scarpe/niente.rb

@@ -6,8 +6,16 @@
 # how a real display service should act.
 module Niente; end
 
-require_relative "niente/logger"
-Shoes::Log.instance = Niente::LogImpl.new
+require "scarpe/components/print_logger"
+Shoes::Log.instance = Scarpe::Components::PrintLogImpl.new
+if ENV["NIENTE_LOG_LEVEL"]
+  pl = Scarpe::Components::PrintLogImpl::PrintLogger
+  level = ENV["NIENTE_LOG_LEVEL"].strip.downcase.to_sym
+  unless pl::LEVELS.key?(level)
+    raise "Unrecognized Niente log level: #{level.inspect}!"
+  end
+  pl.min_level = pl::LEVELS[level]
+end
 
 require_relative "niente/drawable"
 require_relative "niente/app"
@@ -16,5 +24,9 @@ require_relative "niente/display_service"
 require_relative "niente/shoes_spec"
 Shoes::Spec.instance = Niente::Test
 
+require "scarpe/components/segmented_file_loader"
+loader = Scarpe::Components::SegmentedFileLoader.new
+Shoes.add_file_loader loader
+
 Shoes::DisplayService.set_display_service_class(Niente::DisplayService)
 

data/lib/shoes/app.rb

@@ -8,17 +8,29 @@ class Shoes
       attr_accessor :instance
     end
 
+    # The Shoes root of the drawable tree
     attr_reader :document_root
 
-    shoes_styles :title, :width, :height, :resizable
+    # The application directory for this app. Often this will be the directory
+    # containing the launched application file.
+    attr_reader :dir
+
+    shoes_styles :title, :width, :height, :resizable, :features
+
+    # This is defined to avoid the linkable-id check in the Shoes-style method_missing def'n
+    def features
+      @features
+    end
 
     CUSTOM_EVENT_LOOP_TYPES = ["displaylib", "return", "wait"]
 
+    init_args
     def initialize(
       title: "Shoes!",
       width: 480,
       height: 420,
       resizable: true,
+      features: [],
       &app_code_body
     )
       log_init("Shoes::App")
@@ -30,36 +42,35 @@ class Shoes
         Shoes::App.instance = self
       end
 
+      # We cd to the app's containing dir when running the app
+      @dir = Dir.pwd
+
       @do_shutdown = false
       @event_loop_type = "displaylib" # the default
 
-      super
+      @features = features
+
+      unknown_ext = features - Shoes::FEATURES - Shoes::EXTENSIONS
+      unsupported_features = unknown_ext & Shoes::KNOWN_FEATURES
+      unless unsupported_features.empty?
+        @log.error("Shoes app requires feature(s) not supported by this display service: #{unsupported_features.inspect}!")
+        raise Shoes::Errors::UnsupportedFeatureError, "Shoes app needs features: #{unsupported_features.inspect}"
+      end
+      unless unknown_ext.empty?
+        @log.warn("Shoes app requested unknown features #{unknown_ext.inspect}! Known: #{(Shoes::FEATURES + Shoes::EXTENSIONS).inspect}")
+      end
+
+      @slots = []
 
-      # The draw context tracks current settings like fill and stroke,
-      # plus potentially other current state that changes from drawable
-      # to drawable and slot to slot.
-      @draw_context = {
-        "fill" => "",
-        "stroke" => "",
-        "rotate" => 0,
-      }
+      super
 
       # This creates the DocumentRoot, including its corresponding display drawable
       @document_root = Shoes::DocumentRoot.new
 
-      @slots = []
-
       # Now create the App display drawable
       create_display_drawable
 
-      # Set up testing events *after* Display Service basic objects exist
-      if ENV["SCARPE_APP_TEST"]
-        test_code = File.read ENV["SCARPE_APP_TEST"]
-        if test_code != ""
-          @test_obj = Object.new
-          @test_obj.instance_eval test_code
-        end
-      end
+      # Set up testing *after* Display Service basic objects exist
 
       if ENV["SHOES_SPEC_TEST"]
         test_code = File.read ENV["SHOES_SPEC_TEST"]
@@ -133,22 +144,17 @@ class Shoes
       return super unless klass
 
       ::Shoes::App.define_method(name) do |*args, **kwargs, &block|
-        # Look up the Shoes drawable and create it...
-        drawable_instance = klass.new(*args, **kwargs, &block)
-
-        unless klass.ancestors.include?(::Shoes::TextDrawable)
-          # Create this drawable in the current app slot
-          drawable_instance.set_parent ::Shoes::App.instance.current_slot
-        end
-
-        drawable_instance
+        klass.new(*args, **kwargs, &block)
       end
 
       send(name, *args, **kwargs, &block)
     end
 
+    # Get the current draw context for the current slot
+    #
+    # @return [Hash] a hash of Shoes styles for the current draw context
     def current_draw_context
-      @draw_context.dup
+      current_slot&.current_draw_context
     end
 
     # This usually doesn't return. The display service may take control
@@ -190,7 +196,7 @@ class Shoes
     def all_drawables
       out = []
 
-      to_add = @document_root.children
+      to_add = [@document_root, @document_root.children]
       until to_add.empty?
         out.concat(to_add)
         to_add = to_add.flat_map { |w| w.respond_to?(:children) ? w.children : [] }.compact
@@ -256,30 +262,21 @@ end
 
 # These methods will need to be defined on Slots too, but probably need a rework in general.
 class Shoes::App < Shoes::Drawable
+  # This is going to go away. See issue #496
   def background(...)
     current_slot.background(...)
   end
 
+  # This is going to go away. See issue #498
   def border(...)
     current_slot.border(...)
   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"] = ""
+  # Draw Context methods -- forward to the current slot
+  [:fill, :nofill, :stroke, :strokewidth, :nostroke, :rotate].each do |dc_method|
+    define_method(dc_method) do |*args|
+      current_slot.send(dc_method, *args)
+    end
   end
 
   # Shape DSL methods
@@ -300,9 +297,6 @@ class Shoes::App < Shoes::Drawable
     end
   end
 
-  def rotate(angle)
-    @draw_context["rotate"] = angle
-  end
   # Not implemented yet: curve_to, arc_to
 
   alias_method :info, :puts

data/lib/shoes/constants.rb

@@ -13,10 +13,10 @@ class 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
 
@@ -32,8 +32,29 @@ class Shoes
     HALF_PI = 1.57079632679489661923
     PI = 3.14159265358979323846
 
-    # This should be set up by the Display Service when it loads
+    # 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

data/lib/shoes/display_service.rb

@@ -32,7 +32,14 @@ class Shoes
       # 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 @@ class 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 @@ class 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 @@ class 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,9 +162,13 @@ class Shoes
       end
     end
 
+    def initialize
+      @display_drawable_for = {}
+    end
+
     # These methods are an interface to DisplayService objects.
 
-    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:)
       raise "Override in DisplayService implementation!"
     end
 
@@ -174,7 +214,6 @@ class Shoes
     def initialize(linkable_id: object_id)
       @linkable_id = linkable_id
       @subscriptions = {}
-      @display_drawable_for ||= {}
     end
 
     def send_self_event(*args, event_name:, **kwargs)