lacci 0.2.2 → 0.4.0

data/lib/shoes/errors.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class Shoes; end
+module Shoes::Errors
+  class InvalidAttributeValueError < Shoes::Error; end
+
+  class TooManyInstancesError < Shoes::Error; end
+
+  class NoSuchListItemError < Shoes::Error; end
+
+  class DuplicateCreateDrawableError < Shoes::Error; end
+
+  class MultipleDrawablesFoundError < Shoes::Error; end
+
+  class NoDrawablesFoundError < Shoes::Error; end
+
+  class NoSuchStyleError < Shoes::Error; end
+
+  class NoSuchLinkableIdError < Shoes::Error; end
+
+  class BadLinkableIdError < Shoes::Error; end
+
+  class UnregisteredShoesEventError < Shoes::Error; end
+
+  class BadArgumentListError < Shoes::Error; end
+
+  class SingletonError < Shoes::Error; end
+
+  class MultipleShoesSpecRunsError < Shoes::Error; end
+
+  class UnsupportedFeatureError < Shoes::Error; end
+
+  class BadFilenameError < Shoes::Error; end
+
+  class UnknownEventsForClassError < Shoes::Error; end
+
+  class DoubleRegisteredShoesEventError < Shoes::Error; end
+end

data/lib/shoes/log.rb

@@ -8,7 +8,7 @@
 # If used alone, this will fail because the @instance is nil. It needs
 # an implementation to be plugged in.
 
-module Shoes
+class Shoes
   LOG_LEVELS = [:debug, :info, :warn, :error, :fatal].freeze
 
   # Include this module to get a @log instance variable to log as your
@@ -28,7 +28,7 @@ module Shoes
       attr_reader :current_log_config
 
       def instance=(impl_object)
-        raise(Shoes::Error, "Already have an instance for Shoes::Log!") if @instance
+        raise(Shoes::Errors::TooManyInstancesError, "Already have an instance for Shoes::Log!") if @instance
 
         @instance = impl_object
       end

data/lib/shoes/margin_helper.rb

@@ -0,0 +1,79 @@
+module MarginHelper
+
+  def margin_parse(kwargs)
+
+      if kwargs[:margin]
+
+        if kwargs[:margin].is_a?(Numeric)
+
+          if !kwargs[:margin_top]
+            kwargs[:margin_top] = kwargs[:margin]
+          end
+          if !kwargs[:margin_bottom]
+            kwargs[:margin_bottom] = kwargs[:margin]
+          end
+          if !kwargs[:margin_left]
+            kwargs[:margin_left] = kwargs[:margin]
+          end
+          if !kwargs[:margin_right]
+            kwargs[:margin_right] = kwargs[:margin]
+          end
+
+        elsif kwargs[:margin].is_a?(Hash)
+
+          kwargs[:margin].each do |key,value|
+            kwargs[:"margin_#{key}"] = value
+          end
+
+        else
+          margin_props = kwargs[:margin].is_a?(String) ? kwargs[:margin].split(/\s+|\,|-/) : kwargs[:margin]
+          if margin_props.length == 1
+
+            if !kwargs[:margin_top]
+              kwargs[:margin_top] = margin_props[0]
+            end
+            if !kwargs[:margin_bottom]
+              kwargs[:margin_bottom] = margin_props[0]
+            end
+            if !kwargs[:margin_left]
+              kwargs[:margin_left] = margin_props[0]
+            end
+            if !kwargs[:margin_right]
+              kwargs[:margin_right] = margin_props[0]
+            end
+
+          elsif margin_props.length == 2
+  
+            raise(Shoes::Errors::InvalidAttributeValueError, "Margin don't support 2-3 values as Array/string input for using 2-3 input you can use the hash input method like '{left:value, right:value, top:value, bottom:value}'")
+  
+          elsif margin_props.length == 3
+  
+            raise(Shoes::Errors::InvalidAttributeValueError, "Margin don't support 2-3 values as Array/string input for using 2-3 input you can use the hash input method like '{left:value,right:value,top:value,bottom:value}'")
+          
+          else
+  
+            if !kwargs[:margin_top]
+              kwargs[:margin_top] = margin_props[1]
+            end
+            if !kwargs[:margin_bottom]
+              kwargs[:margin_bottom] = margin_props[3]
+            end
+            if !kwargs[:margin_left]
+              kwargs[:margin_left] = margin_props[0]
+            end
+            if !kwargs[:margin_right]
+              kwargs[:margin_right] = margin_props[2]
+            end
+  
+          end
+        end
+        kwargs[:margin] = nil
+      end
+      if kwargs["options"] && !kwargs[:margin] && !kwargs[:margin_left] && !kwargs[:margin_right] && !kwargs[:margin_top] && !kwargs[:margin_bottom]
+        kwargs[options].each do |key,value|
+          kwargs[key] = value
+        end
+      end
+      kwargs
+  end
+end

data/lib/shoes/ruby_extensions.rb

@@ -0,0 +1,15 @@
+
+class Range
+  def rand
+    conv = (Integer === self.end && Integer === self.begin ? :to_i : :to_f)
+    ((Kernel.rand * (self.end - self.begin)) + self.begin).send(conv)
+  end
+end
+
+unless Time.respond_to? :today
+  def Time.today
+    t = Time.now
+    t - (t.to_i % 86_400)
+  end
+end
+

data/lib/shoes-spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+class Shoes
+  # A Scarpe-compatible display service can set Shoes::Spec.instance to
+  # a ShoesSpec testing class, and use it to run Shoes-Spec code.
+  # A Shoes application should never do this. It's intended to be used
+  # by display services.
+  module Spec
+    def self.instance
+      @instance
+    end
+
+    def self.instance=(spec_inst)
+      if @instance && @instance != spec_inst
+        raise "Lacci can only use a single ShoesSpec implementation at one time!"
+      end
+
+      @instance = spec_inst
+    end
+  end
+
+  # ShoesSpec testing objects can optionally inherit from this object,
+  # which shows the ShoesSpec testing API.
+  #
+  # @see {Shoes::Spec.instance=}
+  class SpecInstance
+    # Once a Shoes app has been created, this method can be called to
+    # execute Shoes-Spec testing code for that application. Shoes-Spec
+    # uses Minitest for most of its APIs, and Minitest generally reports
+    # results with a class name and test name. If those aren't passed
+    # explicitly, the SpecInstance can choose reasonable defaults.
+    #
+    # The test code should be set up to run automatically from the
+    # display service's existing hooks. For instance, the code might
+    # run in response to the first heartbeat, if the display service
+    # uses heartbeats.
+    #
+    # The test code will export assertion data in its native format.
+    # Multiple display services choose to use the Scarpe-Component
+    # for Minitest data export, which is straightforward to import
+    # into the Shoes-Spec test harness.
+    #
+    # @param code [String] the ShoesSpec code to execute
+    # @param class_name [String|NilClass] the Minitest class name for reporting or nil
+    # @param test_name [String|NilClass] the Minitest test name for reporting or nil
+    # @return [void]
+    def run_shoes_spec_test_code(code, class_name: nil, test_name: nil)
+      raise "Child class should override this!"
+    end
+  end
+
+  # ShoesSpec instances support finder methods like button() that return
+  # a proxy to the corresponding drawable. Those proxies should support
+  # standard Shoes::Drawable methods, including the ones appropriate to
+  # the same drawable object. They should also support certain other
+  # testing-specific methods like "trigger_click" that are used to
+  # simulate display-side events during testing.
+  #
+  # Keep in mind that a proxy will often be in a different process from
+  # the Shoes app. So the proxy can't portably return the object or
+  # display object, though it could possibly return another proxy for such
+  # a thing.
+  class SpecProxy
+    # The proxy will have finder methods for all drawables, such as
+    # button(), edit_line(), etc. How to document those?
+
+    # Trigger a click on a button or button-like drawable. Not every
+    # drawable will support this operation.
+    def trigger_click()
+      raise "Child class should override this!"
+    end
+
+    # Trigger a hover over a hoverable drawable. Not every
+    # drawable will support this operation. A drawable that supports
+    # hover should support leave and vice-versa.
+    def trigger_hover()
+      raise "Child class should override this!"
+    end
+
+    # Trigger ending hover over a hoverable drawable. Not every
+    # drawable will support this operation. A drawable that supports
+    # hover should support leave and vice-versa.
+    def trigger_leave()
+      raise "Child class should override this!"
+    end
+
+    # Trigger a change in value for a drawable like a list_box
+    # with multiple values.
+    def trigger_change(value)
+      raise "Child class should override this!"
+    end
+  end
+end

data/lib/shoes.rb

@@ -12,38 +12,51 @@ if RUBY_VERSION[0..2] < "3.2"
   exit(-1)
 end
 
-module Shoes; end
+class Shoes; end
 class Shoes::Error < StandardError; end
+require_relative "shoes/errors"
 
 require_relative "shoes/constants"
+require_relative "shoes/ruby_extensions"
 
 # Shoes adds some top-level methods and constants that can be used everywhere. Kernel is where they go.
 module Kernel
   include Shoes::Constants
 end
 
-require_relative "shoes/log"
 require_relative "shoes/display_service"
+
+# Pre-declare classes that get referenced outside their own require file
+class Shoes::Drawable < Shoes::Linkable; end
+class Shoes::Slot < Shoes::Drawable; end
+class Shoes::Widget < Shoes::Slot; end
+
+require_relative "shoes/log"
 require_relative "shoes/colors"
 
+require_relative "shoes/builtins"
+
 require_relative "shoes/background"
-require_relative "shoes/border"
-require_relative "shoes/spacing"
 
-require_relative "shoes/widget"
+require_relative "shoes/drawable"
 require_relative "shoes/app"
-require_relative "shoes/widgets"
+require_relative "shoes/drawables"
 
 require_relative "shoes/download"
 
+# No easy way to tell at this point whether
+# we will later load Shoes-Spec code, e.g.
+# by running a segmented app with test code.
+require_relative "shoes-spec"
+
 # The module containing Shoes in all its glory.
 # Shoes is a platform-independent GUI library, designed to create
 # small visual applications in Ruby.
 #
-module Shoes
+class Shoes
   class << self
     # Creates a Shoes app with a new window. The block parameter is used to create
-    # widgets and set up handlers. Arguments are passed to Shoes::App.new internally.
+    # drawables and set up handlers. Arguments are passed to Shoes::App.new internally.
     #
     # @incompatibility In Shoes3, this method will return normally.
     #   In Scarpe, after the block is executed, the method will not return and Scarpe
@@ -61,6 +74,7 @@ module Shoes
     # @param width [Integer] The new app window width
     # @param height [Integer] The new app window height
     # @param resizable [Boolean] Whether the app window should be resizeable
+    # @param features [Symbol,Array<Symbol>] Additional Shoes extensions requested by the app
     # @return [void]
     # @see Shoes::App#new
     def app(
@@ -68,9 +82,11 @@ module Shoes
       width: 480,
       height: 420,
       resizable: true,
+      features: [],
       &app_code_body
     )
-      app = Shoes::App.new(title:, width:, height:, resizable:, &app_code_body)
+      f = [features].flatten # Make sure this is a list, not a single symbol
+      app = Shoes::App.new(title:, width:, height:, resizable:, features: f, &app_code_body)
       app.init
       app.run
       nil
@@ -81,11 +97,16 @@ module Shoes
     # more loaders, a Lacci-based display library can accept new file formats as
     # well, not just raw Shoes .rb files.
     #
-    # @param path [String] The current-dir-relative path to the file
+    # @param relative_path [String] The current-dir-relative path to the file
     # @return [void]
     # @see Shoes.add_file_loader
     def run_app(relative_path)
       path = File.expand_path relative_path
+      dir = File.dirname(path)
+
+      # Shoes assumes we're starting from the app code's path
+      Dir.chdir(dir)
+
       loaded = false
       file_loaders.each do |loader|
         if loader.call(path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lacci
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Marco Concetto Rudilosso
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
-dependencies: []
+date: 2024-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scarpe-components
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description:
 email:
 - marcoc.r@outlook.com
@@ -25,47 +39,60 @@ files:
 - lib/lacci/scarpe_cli.rb
 - lib/lacci/scarpe_core.rb
 - lib/lacci/version.rb
+- lib/scarpe/niente.rb
+- lib/scarpe/niente/app.rb
+- lib/scarpe/niente/display_service.rb
+- lib/scarpe/niente/drawable.rb
+- lib/scarpe/niente/shoes_spec.rb
+- lib/shoes-spec.rb
 - lib/shoes.rb
 - lib/shoes/app.rb
 - lib/shoes/background.rb
 - lib/shoes/border.rb
+- lib/shoes/builtins.rb
+- lib/shoes/changelog.rb
 - lib/shoes/colors.rb
 - lib/shoes/constants.rb
 - lib/shoes/display_service.rb
 - lib/shoes/download.rb
+- lib/shoes/drawable.rb
+- lib/shoes/drawables.rb
+- lib/shoes/drawables/arc.rb
+- lib/shoes/drawables/arrow.rb
+- lib/shoes/drawables/border.rb
+- lib/shoes/drawables/button.rb
+- lib/shoes/drawables/check.rb
+- lib/shoes/drawables/document_root.rb
+- lib/shoes/drawables/edit_box.rb
+- lib/shoes/drawables/edit_line.rb
+- lib/shoes/drawables/flow.rb
+- lib/shoes/drawables/font_helper.rb
+- lib/shoes/drawables/image.rb
+- lib/shoes/drawables/line.rb
+- lib/shoes/drawables/link.rb
+- lib/shoes/drawables/list_box.rb
+- lib/shoes/drawables/oval.rb
+- lib/shoes/drawables/para.rb
+- lib/shoes/drawables/progress.rb
+- lib/shoes/drawables/radio.rb
+- lib/shoes/drawables/rect.rb
+- lib/shoes/drawables/shape.rb
+- lib/shoes/drawables/slot.rb
+- lib/shoes/drawables/stack.rb
+- lib/shoes/drawables/star.rb
+- lib/shoes/drawables/subscription_item.rb
+- lib/shoes/drawables/text_drawable.rb
+- lib/shoes/drawables/video.rb
+- lib/shoes/drawables/widget.rb
+- lib/shoes/errors.rb
 - lib/shoes/log.rb
-- lib/shoes/spacing.rb
-- lib/shoes/widget.rb
-- lib/shoes/widgets.rb
-- lib/shoes/widgets/alert.rb
-- lib/shoes/widgets/arc.rb
-- lib/shoes/widgets/button.rb
-- lib/shoes/widgets/check.rb
-- lib/shoes/widgets/document_root.rb
-- lib/shoes/widgets/edit_box.rb
-- lib/shoes/widgets/edit_line.rb
-- lib/shoes/widgets/flow.rb
-- lib/shoes/widgets/font.rb
-- lib/shoes/widgets/image.rb
-- lib/shoes/widgets/line.rb
-- lib/shoes/widgets/link.rb
-- lib/shoes/widgets/list_box.rb
-- lib/shoes/widgets/para.rb
-- lib/shoes/widgets/radio.rb
-- lib/shoes/widgets/shape.rb
-- lib/shoes/widgets/slot.rb
-- lib/shoes/widgets/span.rb
-- lib/shoes/widgets/stack.rb
-- lib/shoes/widgets/star.rb
-- lib/shoes/widgets/subscription_item.rb
-- lib/shoes/widgets/text_widget.rb
-- lib/shoes/widgets/video.rb
+- lib/shoes/margin_helper.rb
+- lib/shoes/ruby_extensions.rb
 homepage: https://github.com/scarpe-team/scarpe
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/scarpe-team/scarpe
-  source_code_uri: https://github.com/scarpe-team/scarpe
   changelog_uri: https://github.com/scarpe-team/scarpe/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
@@ -82,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Lacci - a portable Shoes DSL with switchable display backends, part of Scarpe

data/lib/shoes/spacing.rb

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