scarpe 0.1.0 → 0.2.1

data/examples/timmy.rb

@@ -0,0 +1,109 @@
+# Timmy 1
+
+# Shoes.app do
+#   para "You've downloaded a virus!"
+# end
+
+# Timmy 2
+
+# Shoes.app title: "Cookies Recipe", height: 1000, width: 1000 do
+#   banner "You've downloaded a virus!", :align => "center"
+# end
+
+# Timmy 3
+
+# Shoes.app title: "Cookies Recipe", height: 1000, width: 1000 do
+#   background "black"
+#   @header = banner "You've downloaded a virus!", align: "center", stroke: red
+
+#   flow height: "30%" do
+#     stack width: "100%" do
+#       background "white"
+#       title "You thought this was a recipe for cookies, but it was me, your arch nemesis!\n\n", align: "center"
+#       para "I have taken over your computer and will not give it back until you pay me $1,000,000.",
+#         align: "center",
+#         size: 30
+#     end
+#   end
+#   flow height: "20%" do
+#     stack width: "100%" do
+#       background "white"
+#       para "Pay me now or I will delete all your files!\n",
+#         "Courtesy, your friends in the Mafia",
+#         align: "center", size: 30
+#       banner "💰", align: "center"
+#     end
+#   end
+#   flow height: "45%" do
+#     border "black", strokewidth: 10
+#     background "black"
+#     stack width: "33.33%" do
+#       background "green"
+#     end
+#     stack width: "33.33%" do
+#       background "white"
+#     end
+#     stack width: "33.33%" do
+#       background "red"
+#     end
+#   end
+# end
+
+
+# Timmy 4 (more interactive)
+# Timmy hasn't quite learned about variables yet, so he's using global variables.
+
+Shoes.app title: "Cookies Recipe", height: 1000, width: 1000 do
+  $main_background = background "black"
+  $header = banner "You've downloaded a virus!", align: "center", stroke: red
+
+  flow height: "30%" do
+    stack width: "100%" do
+      background "white"
+      $header_one = title "You thought this was a recipe for cookies, but it was me, your arch nemesis!\n\n", align: "center"
+      $header_two = para "I have taken over your computer and will not give it back until you pay me $1,000,000.",
+        align: "center",
+        size: 30
+    end
+  end
+  flow height: "30%" do
+    stack width: "33.33%" do
+      background "blue"
+      star 230, 100, 6, 150, 50
+    end
+    stack width: "33.33%" do
+      background "white"
+      $body_one = para "Pay me now or I will delete all your files!\n",
+        "Courtesy, the Pirates of the Highlands 🏴‍☠️",
+        align: "center", size: 30
+      $body_two = banner "💰", align: "center"
+    end
+    stack width: "33.33%" do
+      background "blue"
+      star 230, 100, 6, 150, 50
+    end
+  end
+  flow height: "30%" do
+    stack width: "33.33%" do
+      $pirate_image = image "https://i.imgur.com/mIaqQaF.png"
+    end
+    stack width: "33.33%" do
+      @push = button "Pay up 💸", width: 335, height: 300, size: 80 do
+        $header.replace "Just kidding Grandma! I love you! ❤️❤️❤️"
+        $header.stroke = white
+        $body_one.replace "I'm sorry for scaring you. I hope you have a great day!"
+        $body_two.replace "🍪"
+        $header_one.replace "❤️"
+        $header_two.replace ""
+        $pirate_image.replace "https://media.tenor.com/ZVJxuXJOczIAAAAd/kazoo-kid.gif"
+        $pirate_image_two.replace "https://media.tenor.com/ZVJxuXJOczIAAAAd/kazoo-kid.gif"
+        @push.text = "🍪"
+      end
+    end
+    stack width: "33.33%" do
+      $pirate_image_two = image "https://i.imgur.com/mIaqQaF.png"
+    end
+  end
+end
+
+

data/examples/title_and_resize.rb

@@ -0,0 +1,3 @@
+Shoes.app(title: "Schwad's app!", width: 1000, height: 800) do
+  para "Boy howdy! Now we're talking!"
+end

data/exe/scarpe

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+# We need to not use syntactic features of very recent Rubies in this file, so that it parses
+# correctly in earlier Rubies and can successfully give the version-check error.
+if RUBY_VERSION[0..2] < "3.2"
+  STDERR.puts("Scarpe requires Ruby 3.2 or higher!")
+  exit(-1)
+end
+
+def print_usage
+  puts <<USAGE
+Usage: scarpe [OPTIONS] <scarpe app file>           # Same as "scarpe run"
+       scarpe [OPTIONS] run <scarpe app file>
+       scarpe [OPTIONS] env                         # print Scarpe environment settings
+       scarpe -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
+end
+
+def env_or_default(env_var, default_val)
+  "#{env_var}: #{ENV[env_var] || default_val}"
+end
+
+def env_or_none(env_var)
+  env_or_default(env_var, "(none)")
+end
+
+def print_env
+  puts <<~SCARPE_ENV
+    Scarpe environment:
+      #{env_or_default("SCARPE_DISPLAY_SERVICE", "(default)wv_local")}
+      #{env_or_default("SCARPE_LOG_CONFIG", "(default)#{Scarpe::Log::DEFAULT_LOG_CONFIG.inspect}")}
+    Scarpe::WV environment:
+      #{env_or_none("SCARPE_TEST_CONTROL")}
+      #{env_or_none("SCARPE_TEST_RESULTS")}
+      #{env_or_none("SCARPE_DEBUG")}
+    Ruby and shell environment:
+      RUBY_DESCRIPTION: #{RUBY_DESCRIPTION.inspect}
+      RUBY_PLATFORM: #{RUBY_PLATFORM.inspect}
+      RUBY_ENGINE: #{RUBY_ENGINE.inspect}
+      #{env_or_none("SHELL")}
+      #{env_or_none("PATH")}
+      #{env_or_none("LD_LIBRARY_PATH")}
+      #{env_or_none("DYLD_LIBRARY_PATH")}
+      #{env_or_none("GEM_ROOT")}
+      #{env_or_none("GEM_HOME")}
+      #{env_or_none("GEM_PATH")}
+  SCARPE_ENV
+end
+
+# --dev option applies to all actions
+use_dev = ARGV.delete("--dev") ? true : false
+use_debug = ARGV.delete("--debug") ? true : false
+
+verb = "run"
+verb_target = nil
+
+case ARGV[0]
+when "-v"
+  # This will be fine, pass it through.
+  verb = "-v"
+when "env"
+  if ARGV.length != 1
+    print_usage
+    exit -1
+  end
+
+  verb = "env"
+when "run"
+  if ARGV.length != 2
+    print_usage
+    exit -1
+  end
+  verb_target = ARGV[1]
+else
+  # Default to run
+  if ARGV.length != 1
+    print_usage
+    exit -1
+  end
+  verb_target = ARGV[0]
+end
+
+if use_debug
+  ENV['SCARPE_DEBUG'] = 'true'
+end
+if use_dev
+  dev_path = File.expand_path("../lib", __dir__)
+  $LOAD_PATH.prepend dev_path
+end
+# We mustn't require Scarpe sooner than this so that the --dev setting is respected
+require "scarpe"
+
+Shoes = Scarpe unless defined?(Shoes)
+
+case verb
+  when "-v"
+    puts "Scarpe #{Scarpe::VERSION}"
+  when "run"
+    # Run the Scarpe app file
+    load ARGV[0]
+  when "env"
+    print_env
+  else
+    raise "Internal error! Unknown ./exe/scarpe verb!"
+end

data/lib/constants.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Constants
+  LIB_DIR = File.join(Dir.home, "Desktop")
+end

data/lib/scarpe/alert.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Scarpe
+  class Alert < Scarpe::Widget
+    display_property :text
+
+    def initialize(text)
+      @text = text
+
+      super
+
+      bind_self_event("click") do
+        destroy_self
+      end
+
+      create_display_widget
+    end
+  end
+end

data/lib/scarpe/app.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class Scarpe
+  class App < Scarpe::Widget
+    class << self
+      attr_accessor :next_test_code
+    end
+    include Scarpe::Log
+
+    display_properties :title, :width, :height, :resizable, :debug
+
+    def initialize(
+      title: "Scarpe!",
+      width: 480,
+      height: 420,
+      resizable: true,
+      debug: ENV["SCARPE_DEBUG"] ? true : false,
+      test_code: nil,
+      &app_code_body
+    )
+      log_init("Scarpe::App")
+
+      @do_shutdown = false
+
+      if Scarpe::App.next_test_code
+        test_code = Scarpe::App.next_test_code
+        Scarpe::App.next_test_code = nil
+      end
+
+      super
+
+      test_code&.call(self)
+
+      # This creates the DocumentRoot, including its corresponding display widget
+      @document_root = Scarpe::DocumentRoot.new
+
+      create_display_widget
+
+      @app_code_body = app_code_body
+
+      # Try to de-dup as much as possible and not send repeat or multiple
+      # destroy events
+      @watch_for_destroy = bind_shoes_event(event_name: "destroy") do
+        DisplayService.unsub_from_events(@watch_for_destroy) if @watch_for_destroy
+        @watch_for_destroy = nil
+        self.destroy(send_event: false)
+      end
+
+      Signal.trap("INT") do
+        @log.warning("App interrupted by signal, stopping...")
+        puts "\nStopping Scarpe app..."
+        destroy
+      end
+    end
+
+    def init
+      send_shoes_event(event_name: "init")
+      return if @do_shutdown
+
+      @document_root.instance_eval(&@app_code_body)
+    end
+
+    # This isn't supposed to return. The display service should take control
+    # of the main thread. Local Webview even stops any background threads.
+    def run
+      if @do_shutdown
+        $stderr.puts "Destroy has already been signaled, but we just called Shoes::App.run!"
+        return
+      end
+      send_shoes_event(event_name: "run")
+    end
+
+    def destroy(send_event: true)
+      @do_shutdown = true
+      send_shoes_event(event_name: "destroy") if send_event
+    end
+  end
+end

data/lib/scarpe/arc.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Scarpe
+  class InvalidAttributeValueError < Scarpe::Error; end
+
+  class Arc < Scarpe::Widget
+    display_properties :left, :top, :width, :height, :angle1, :angle2
+
+    def initialize(*args)
+      @left, @top, @width, @height, @angle1, @angle2 = args
+
+      @left = convert_to_integer(@left, "left")
+      @top = convert_to_integer(@top, "top")
+      @width = convert_to_integer(@width, "width")
+      @height = convert_to_integer(@height, "height")
+      @angle1 = convert_to_float(@angle1, "angle1")
+      @angle2 = convert_to_float(@angle2, "angle2")
+
+      super()
+      create_display_widget
+    end
+
+    private
+
+    def convert_to_integer(value, attribute_name)
+      begin
+        value = Integer(value)
+        raise InvalidAttributeValueError, "Negative number '#{value}' not allowed for attribute '#{attribute_name}'" if value < 0
+
+        value
+      rescue ArgumentError
+        error_message = "Invalid value '#{value}' provided for attribute '#{attribute_name}'. The value should be a number."
+        raise InvalidAttributeValueError, error_message
+      end
+    end
+
+    def convert_to_float(value, attribute_name)
+      begin
+        value = Float(value)
+        raise InvalidAttributeValueError, "Negative number '#{value}' not allowed for attribute '#{attribute_name}'" if value < 0
+
+        value
+      rescue ArgumentError
+        error_message = "Invalid value '#{value}' provided for attribute '#{attribute_name}'. The value should be a number."
+        raise InvalidAttributeValueError, error_message
+      end
+    end
+  end
+end

data/lib/scarpe/background.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Scarpe
+  module Background
+    def self.included(includer)
+      includer.display_property(:background_color)
+    end
+
+    # NOTE: this needs to be passed through in order for the styling to work
+    def background(color, options = {})
+      self.background_color = color
+    end
+  end
+end

data/lib/scarpe/border.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Scarpe
+  module Border
+    def self.included(includer)
+      includer.display_properties :border_color, :options
+    end
+
+    # Considering a signature like this:
+    # border "#00D0FF", :strokewidth => 3, :curve => 12
+    def border(color, options = {})
+      self.border_color = color
+      self.options = options
+    end
+  end
+end

data/lib/scarpe/button.rb

@@ -1,27 +1,35 @@
-module Scarpe
-  class Button
-    def initialize(app, text, &block)
-      @app = app
+# frozen_string_literal: true
+
+class Scarpe
+  class Button < Scarpe::Widget
+    include Scarpe::Log
+    display_properties :text, :width, :height, :top, :left, :color, :padding_top, :padding_bottom, :text_color, :size, :font_size
+
+    def initialize(text, width: nil, height: nil, top: nil, left: nil, color: nil, padding_top: nil, padding_bottom: nil, size: 12, text_color: nil,
+      font_size: nil, & block)
+
+      log_init("Button")
+
+      # Properties passed as positional args, not keywords, don't get auto-set
       @text = text
+      @color = color
+
       @block = block
-      @app.append(render)
-    end
 
-    def function_name
-      object_id
+      super
+
+      # Bind to a handler named "click"
+      bind_self_event("click") do
+        @log.debug("Button clicked, calling handler") if @block
+        @block&.call
+      end
+
+      create_display_widget
     end
 
+    # Set the click handler
     def click(&block)
       @block = block
     end
-
-    def render
-      @app.bind(function_name) do
-        if @block
-          @block.call
-        end
-      end
-      "<button id=#{object_id} onclick='scarpeHandler(#{function_name})'>#{@text}</button>"
-    end
   end
-end
+end

data/lib/scarpe/colors.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+class Scarpe
+  module Colors
+    COLORS = {
+      aliceblue: [240, 248, 255],
+      antiquewhite: [250, 235, 215],
+      aqua: [0, 255, 255],
+      aquamarine: [127, 255, 212],
+      azure: [240, 255, 255],
+      beige: [245, 245, 220],
+      bisque: [255, 228, 196],
+      black: [0, 0, 0],
+      blanchedalmond: [255, 235, 205],
+      blue: [0, 0, 255],
+      blueviolet: [138, 43, 226],
+      brown: [165, 42, 42],
+      burlywood: [222, 184, 135],
+      cadetblue: [95, 158, 160],
+      chartreuse: [127, 255, 0],
+      chocolate: [210, 105, 30],
+      coral: [255, 127, 80],
+      cornflowerblue: [100, 149, 237],
+      cornsilk: [255, 248, 220],
+      crimson: [220, 20, 60],
+      cyan: [0, 255, 255],
+      darkblue: [0, 0, 139],
+      darkcyan: [0, 139, 139],
+      darkgoldenrod: [184, 134, 11],
+      darkgray: [169, 169, 169],
+      darkgreen: [0, 100, 0],
+      darkkhaki: [189, 183, 107],
+      darkmagenta: [139, 0, 139],
+      darkolivegreen: [85, 107, 47],
+      darkorange: [255, 140, 0],
+      darkorchid: [153, 50, 204],
+      darkred: [139, 0, 0],
+      darksalmon: [233, 150, 122],
+      darkseagreen: [143, 188, 143],
+      darkslateblue: [72, 61, 139],
+      darkslategray: [47, 79, 79],
+      darkturquoise: [0, 206, 209],
+      darkviolet: [148, 0, 211],
+      deeppink: [255, 20, 147],
+      deepskyblue: [0, 191, 255],
+      dimgray: [105, 105, 105],
+      dodgerblue: [30, 144, 255],
+      firebrick: [178, 34, 34],
+      floralwhite: [255, 250, 240],
+      forestgreen: [34, 139, 34],
+      fuchsia: [255, 0, 255],
+      gainsboro: [220, 220, 220],
+      ghostwhite: [248, 248, 255],
+      gold: [255, 215, 0],
+      goldenrod: [218, 165, 32],
+      green: [0, 128, 0],
+      greenyellow: [173, 255, 47],
+      honeydew: [240, 255, 240],
+      hotpink: [255, 105, 180],
+      indianred: [205, 92, 92],
+      indigo: [75, 0, 130],
+      ivory: [255, 255, 240],
+      khaki: [240, 230, 140],
+      lavender: [230, 230, 250],
+      lavenderblush: [255, 240, 245],
+      lawngreen: [124, 252, 0],
+      lemonchiffon: [255, 250, 205],
+      lightblue: [173, 216, 230],
+      lightcoral: [240, 128, 128],
+      lightcyan: [224, 255, 255],
+      lightgoldenrodyellow: [250, 250, 210],
+      lightgreen: [144, 238, 144],
+      lightgrey: [211, 211, 211],
+      lightpink: [255, 182, 193],
+      lightsalmon: [255, 160, 122],
+      lightseagreen: [32, 178, 170],
+      lightskyblue: [135, 206, 250],
+      lightslategray: [119, 136, 153],
+      lightsteelblue: [176, 196, 222],
+      lightyellow: [255, 255, 224],
+      lime: [0, 255, 0],
+      limegreen: [50, 205, 50],
+      linen: [250, 240, 230],
+      magenta: [255, 0, 255],
+      maroon: [128, 0, 0],
+      mediumaquamarine: [102, 205, 170],
+      mediumblue: [0, 0, 205],
+      mediumorchid: [186, 85, 211],
+      mediumpurple: [147, 112, 219],
+      mediumseagreen: [60, 179, 113],
+      mediumslateblue: [123, 104, 238],
+      mediumspringgreen: [0, 250, 154],
+      mediumturquoise: [72, 209, 204],
+      mediumvioletred: [199, 21, 133],
+      midnightblue: [25, 25, 112],
+      mintcream: [245, 255, 250],
+      mistyrose: [255, 228, 225],
+      moccasin: [255, 228, 181],
+      navajowhite: [255, 222, 173],
+      navy: [0, 0, 128],
+      oldlace: [253, 245, 230],
+      olive: [128, 128, 0],
+      olivedrab: [107, 142, 35],
+      orange: [255, 165, 0],
+      orangered: [255, 69, 0],
+      orchid: [218, 112, 214],
+      palegoldenrod: [238, 232, 170],
+      palegreen: [152, 251, 152],
+      paleturquoise: [175, 238, 238],
+      palevioletred: [219, 112, 147],
+      papayawhip: [255, 239, 213],
+      peachpuff: [255, 218, 185],
+      peru: [205, 133, 63],
+      pink: [255, 192, 203],
+      plum: [221, 160, 221],
+      powderblue: [176, 224, 230],
+      purple: [128, 0, 128],
+      red: [255, 0, 0],
+      rosybrown: [188, 143, 143],
+      royalblue: [65, 105, 225],
+      saddlebrown: [139, 69, 19],
+      salmon: [250, 128, 114],
+      sandybrown: [244, 164, 96],
+      seagreen: [46, 139, 87],
+      seashell: [255, 245, 238],
+      sienna: [160, 82, 45],
+      silver: [192, 192, 192],
+      skyblue: [135, 206, 235],
+      slateblue: [106, 90, 205],
+      slategray: [112, 128, 144],
+      snow: [255, 250, 250],
+      springgreen: [0, 255, 127],
+      steelblue: [70, 130, 180],
+      tan: [210, 180, 140],
+      teal: [0, 128, 128],
+      thistle: [216, 191, 216],
+      tomato: [255, 99, 71],
+      turquoise: [64, 224, 208],
+      violet: [238, 130, 238],
+      wheat: [245, 222, 179],
+      white: [255, 255, 255],
+      whitesmoke: [245, 245, 245],
+      yellow: [255, 255, 0],
+      yellowgreen: [154, 205, 50],
+    }
+    private_constant :COLORS
+
+    class << self
+      def included(base)
+        COLORS.each do |color, rgb|
+          base.define_method(color) do |alpha = 255|
+            rgb + [alpha]
+          end
+        end
+      end
+    end
+
+    # https://github.com/shoes/shoes3/blob/b856f28795112ecb64bc8f891ac166675f059beb/static/manual-en.txt#L839-L847
+    def gray(darkness = 128, alpha = nil)
+      alpha ||= (darkness.is_a?(Integer) ? 255 : 1.0)
+      [darkness, darkness, darkness, alpha]
+    end
+
+    # Shoes allows RGB values to be Floats between 0 and 1 or Integers between 0 and 255
+    def rgb(r, g, b, a = nil)
+      if r.is_a?(Float)
+        [r, g, b, a || 1.0]
+      elsif r.is_a?(Integer)
+        [r, g, b, a || 255]
+      else
+        raise("RGB values should be Float or Integer!")
+      end
+    end
+
+    def to_rgb(color)
+      case color
+      when nil
+        nil
+      when Array
+        color # Already an RGB array
+      when Symbol
+        if COLORS[color]
+          rgb(*COLORS[color])
+        else
+          raise("Unrecognised color name: #{color}")
+        end
+      when String
+        if color[0] == "#"
+          if color.length == 4
+            r = color[1].to_i(16)
+            g = color[2].to_i(16)
+            b = color[3].to_i(16)
+            rgb(16 * r, 16 * g, 16 * b)
+          elsif color.length == 7
+            r = color[1..2].to_i(16)
+            g = color[3..4].to_i(16)
+            b = color[5..6].to_i(16)
+            rgb(r, g, b)
+          else
+            raise("Don't know how to convert #{color.inspect} to RGB! (wrong number of digits)")
+          end
+        else
+          rgb_value = COLORS[color.to_sym]
+          if rgb_value
+            rgb(*rgb_value)
+          else
+            raise("Unrecognised color name: #{color}")
+          end
+        end
+      else
+        raise("Don't know how to convert #{color.inspect} to RGB!")
+      end
+    end
+  end
+end