RubyGems - scarpe-components - Versions diffs - 0.1.0 → 0.3.0 - Mend

scarpe-components 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

checksums.yaml +4 -4
data/Gemfile +22 -0
data/Gemfile.lock +86 -0
data/lib/scarpe/components/base64.rb +25 -0
data/lib/scarpe/components/calzini/alert.rb +49 -0
data/lib/scarpe/components/calzini/art_widgets.rb +203 -0
data/lib/scarpe/components/calzini/button.rb +39 -0
data/lib/scarpe/components/calzini/misc.rb +146 -0
data/lib/scarpe/components/calzini/para.rb +35 -0
data/lib/scarpe/components/calzini/slots.rb +155 -0
data/lib/scarpe/components/calzini/text_widgets.rb +65 -0
data/lib/scarpe/components/calzini.rb +149 -0
data/lib/scarpe/components/errors.rb +20 -0
data/lib/scarpe/components/file_helpers.rb +66 -0
data/lib/scarpe/components/html.rb +131 -0
data/lib/scarpe/components/minitest_export_reporter.rb +75 -0
data/lib/scarpe/components/minitest_import_runnable.rb +98 -0
data/lib/scarpe/components/minitest_result.rb +86 -0
data/lib/scarpe/{logger.rb → components/modular_logger.rb} +11 -6
data/lib/scarpe/components/print_logger.rb +47 -0
data/lib/scarpe/components/promises.rb +454 -0
data/lib/scarpe/components/segmented_file_loader.rb +189 -0
data/lib/scarpe/components/string_helpers.rb +10 -0
data/lib/scarpe/components/tiranti.rb +225 -0
data/lib/scarpe/components/unit_test_helpers.rb +257 -0
data/lib/scarpe/components/version.rb +7 -0
metadata +28 -4

data/lib/scarpe/components/tiranti.rb ADDED Viewed

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+# In Italian, tiranti are bootstraps -- the literal pull-on-a-boot kind, not a step to something better.
+# Tiranti.rb builds on calzini.rb, but renders a Bootstrap-decorated version of the HTML output.
+# You would ordinarily set either Calzini or Tiranti as the top-level HTML renderer, not both.
+# You'll include both if you use Tiranti, because it falls back to Calzini for a lot of its rendering.
+require "scarpe/components/calzini"
+# The Tiranti module expects to be included by a class defining
+# the following methods:
+#
+#     * html_id - the HTML ID for the specific rendered DOM object
+#     * handler_js_code(event_name) - the JS handler code for this DOM object and event name
+#     * (optional) display_properties - the display properties for this object, unless overridden in render()
+module Scarpe::Components::Tiranti
+  include Scarpe::Components::Calzini
+  extend self
+  # Currently we're using Bootswatch 5
+  BOOTSWATCH_THEMES = [
+    "cerulean",
+    "cosmo",
+    "cyborg",
+    "darkly",
+    "flatly",
+    "journal",
+    "litera",
+    "lumen",
+    "lux",
+    "materia",
+    "minty",
+    "morph",
+    "pulse",
+    "quartz",
+    "sandstone",
+    "simplex",
+    "sketchy",
+    "slate",
+    "solar",
+    "spacelab",
+    "superhero",
+    "united",
+    "vapor",
+    "yeti",
+    "zephyr",
+  ]
+  BOOTSWATCH_THEME = ENV["SCARPE_BOOTSTRAP_THEME"] || "sketchy"
+  def empty_page_element
+    <<~HTML
+      <html>
+        <head id='head-wvroot'>
+          <meta charset="utf-8">
+          <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+          <link rel="stylesheet" href="https://bootswatch.com/5/#{BOOTSWATCH_THEME}/bootstrap.css">
+          <link rel="stylesheet" href="https://bootswatch.com/_vendor/bootstrap-icons/font/bootstrap-icons.min.css">
+          <style id='style-wvroot'>
+            /** Style resets **/
+            body {
+              height: 100%;
+              overflow: hidden;
+            }
+          </style>
+        </head>
+        <body id='body-wvroot'>
+          <div id='wrapper-wvroot'></div>
+          <script src="https://bootswatch.com/_vendor/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
+        </body>
+      </html>
+    HTML
+  end
+  # def render_stack
+  # end
+  # def render_flow
+  # end
+  # How do we want to handle theme-specific colours and primary/secondary buttons in Bootstrap?
+  # "Disabled" could be checked in properties. Is there any way we can/should use "outline" buttons?
+  def button_element(props)
+    HTML.render do |h|
+      h.button(id: html_id, type: "button", class: "btn btn-primary", onclick: handler_js_code("click"), style: button_style(props)) do
+        props["text"]
+      end
+    end
+  end
+  private
+  def button_style(props)
+    styles = drawable_style(props)
+    styles[:"background-color"] = props["color"] if props["color"]
+    styles[:"padding-top"] = props["padding_top"] if props["padding_top"]
+    styles[:"padding-bottom"] = props["padding_bottom"] if props["padding_bottom"]
+    styles[:color] = props["text_color"] if props["text_color"]
+    styles[:width] = dimensions_length(props["width"]) if props["width"]
+    styles[:height] = dimensions_length(props["height"]) if props["height"]
+    styles[:"font-size"] = props["font_size"] if props["font_size"]
+    styles[:top] = dimensions_length(props["top"]) if props["top"]
+    styles[:left] = dimensions_length(props["left"]) if props["left"]
+    styles[:position] = "absolute" if props["top"] || props["left"]
+    styles[:"font-size"] = dimensions_length(text_size(props["size"])) if props["size"]
+    styles[:"font-family"] = props["font"] if props["font"]
+    styles
+  end
+  public
+  def alert_element(props)
+    onclick = handler_js_code(props["event_name"] || "click")
+    HTML.render do |h|
+      h.div(id: html_id, class: "modal", tabindex: -1, role: "dialog", style: alert_overlay_style(props)) do
+        h.div(class: "modal-dialog", role: "document") do
+          h.div(class: "modal-content", style: alert_modal_style) do
+            h.div(class: "modal-header") do
+              h.h5(class: "modal-title") { "Alert" }
+              h.button(type: "button", class: "close", data_dismiss: "modal", aria_label: "Close") do
+                h.span(aria_hidden: "true") { "&times;" }
+              end
+            end
+            h.div(class: "modal-body") do
+              h.p { props["text"] }
+            end
+            h.div(class: "modal-footer") do
+              h.button(type: "button", onclick:, class: "btn btn-primary") { "OK" }
+              #h.button(type: "button", class: "btn btn-secondary") { "Close" }
+            end
+          end
+        end
+      end
+    end
+  end
+  def check_element(props)
+    HTML.render do |h|
+      h.div class: "form-check" do
+        h.input type: :checkbox,
+          id: html_id,
+          class: "form-check-input",
+          onclick: handler_js_code("click"),
+          value: props["text"],
+          checked: props["checked"],
+          style: drawable_style(props)
+      end
+    end
+  end
+  def progress_element(props)
+    HTML.render do |h|
+      h.div(class: "progress", style: "width: 90%") do
+        pct = "%.1f" % ((props["fraction"] || 0.0) * 100.0)
+        h.div(
+          class: "progress-bar progress-bar-striped progress-bar-animated",
+          role: "progressbar",
+          "aria-valuenow": pct,
+          "aria-valuemin": 0,
+          "aria-valuemax": 100,
+          style: "width: #{pct}%",
+        )
+      end
+    end
+  end
+  # para_element is a bit of a hard one, since it does not-entirely-trivial
+  # mapping between display objects and IDs. But we don't want Calzini
+  # messing with the display service or display objects.
+  def para_element(props, &block)
+    tag, opts = para_elt_and_opts(props)
+    HTML.render do |h|
+      h.send(tag, **opts, &block)
+    end
+  end
+  private
+  ELT_AND_SIZE = {
+    inscription: [:p, 10],
+    ins: [:p, 10],
+    para: [:p, 12],
+    caption: [:p, 14],
+    tagline: [:p, 18],
+    subtitle: [:h3, 26],
+    title: [:h2, 34],
+    banner: [:h1, 48],
+  }.freeze
+  def para_elt_and_opts(props)
+    elt, size = para_elt_and_size(props)
+    size = dimensions_length(size)
+    para_style = drawable_style(props).merge({
+      color: rgb_to_hex(props["stroke"]),
+      "font-size": para_font_size(props),
+      "font-family": props["font"],
+    }.compact)
+    opts = (props["html_attributes"] || {}).merge(id: html_id, style: para_style)
+    [elt, opts]
+  end
+  def para_elt_and_size(props)
+    return [:p, nil] unless props["size"]
+    ps = props["size"].to_s.to_sym
+    if ELT_AND_SIZE.key?(ps)
+      ELT_AND_SIZE[ps]
+    else
+      sz = props["size"].to_i
+      if sz > 18
+        [:h2, sz]
+      else
+        [:p, sz]
+      end
+    end
+  end
+end

data/lib/scarpe/components/unit_test_helpers.rb ADDED Viewed

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+require "tempfile"
+require "json"
+require "fileutils"
+require "scarpe/components/file_helpers"
+module Scarpe::Test; end
+# We want test failures set up once *total*, not per Minitest::Test. So an instance var
+# doesn't do it.
+ALREADY_SET_UP_LOGGED_TEST_FAILURES = { setup: false }
+# General helpers for general usage.
+# Helpers here should *not* use Webview-specific functionality.
+# The intention is that these are helpers for various Scarpe display
+# services that do *not* necessarily use Webview.
+module Scarpe::Test::Helpers
+  # Very useful for tests
+  include Scarpe::Components::FileHelpers
+  # Temporarily set env vars for the block of code inside. The old environment
+  # variable values will be restored after the block finishes.
+  #
+  # @param envs [Hash<String,String>] A hash of environment variable names and values
+  def with_env_vars(envs)
+    old_env = {}
+    envs.each do |k, v|
+      old_env[k] = ENV[k]
+      ENV[k] = v
+    end
+    yield
+  ensure
+    old_env.each { |k, v| ENV[k] = v }
+  end
+end
+# This test will save extensive logs in case of test failure.
+# Note that it defines setup/teardown methods. If you want
+# multiple setup/teardowns from multiple places to happen you
+# may need to explictly call (e.g. with logged_test_setup/teardown)
+# to ensure everything you want happens.
+module Scarpe::Test::LoggedTest
+  def self.included(includer)
+    class << includer
+      attr_accessor :logger_dir
+    end
+  end
+  def file_id
+    "#{self.class.name}_#{self.name}"
+  end
+  # This should be called by the test during setup to make sure that
+  # failure logs will be saved if this test fails. It makes sure the
+  # log config will save all logs from all sources, but keeps a copy
+  # of the old log config to restore after the test is finished.
+  #
+  # @return [void]
+  def logged_test_setup
+    # Make sure test failures will be saved at the end of the run.
+    # Delete stale test failures and logging only the *first* time this is called.
+    set_up_test_failures
+    @normal_log_config = Shoes::Log.current_log_config
+    Shoes::Log.configure_logger(log_config_for_test)
+    Shoes::Log.logger("LoggedScarpeTest").info("Test: #{self.class.name}##{self.name}")
+  end
+  # If you include this module and don't override setup/teardown, everything will
+  # work fine. But if you need more setup/teardown steps, you can do that too.
+  #
+  # The setup method guarantees that just including this module will do setup
+  # automatically. If you override it, be sure to call `super` or `logged_test_setup`.
+  #
+  # @return [void]
+  def setup
+    logged_test_setup
+  end
+  # After the test has finished, this will restore the old log configuration.
+  # It will also save the logfiles, but only if the test failed, not if it
+  # succeeded or was skipped.
+  #
+  # @return [void]
+  def logged_test_teardown
+    # Restore previous log config
+    Shoes::Log.configure_logger(@normal_log_config)
+    if self.failure
+      save_failure_logs
+    else
+      remove_unsaved_logs
+    end
+  end
+  # Make sure that, by default, #logged_test_teardown will be called for teardown.
+  # If a class overrides teardown, it should also call `super` or `logged_test_teardown`
+  # to make sure this still happens.
+  #
+  # @return [void]
+  def teardown
+    logged_test_teardown
+  end
+  # Set additional LoggedTest configuration for specific logs to separate or save.
+  # This is normally going to be display-service-specific log components.
+  # Note that this only really works with the modular logger or another logger
+  # that does something useful with the log config. The simple print logger
+  # doesn't do a lot with it.
+  def extra_log_config=(additional_log_config)
+    @additional_log_config = additional_log_config
+  end
+  # This is the log config that LoggedTests use. It makes sure all components keep all
+  # logs, but also splits the logs into several different files for later ease of scanning.
+  #
+  # TODO: this shouldn't directly include any Webview entries like WebviewAPI or
+  #     CatsCradle. Those should be overridden in Webview.
+  #
+  # @return [Hash] the log config
+  def log_config_for_test
+    {
+      "default" => ["debug", "logger/test_failure_#{file_id}.log"],
+      "DisplayService" => ["debug", "logger/test_failure_display_service_#{file_id}.log"],
+    }.merge(@additional_log_config || {})
+  end
+  # The list of logfiles that should be saved. Normally this is called internally by the
+  # class, not externally from elsewhere.
+  #
+  # This could be a lot simpler except I want to only update the file list in one place,
+  # log_config_for_test(). Having a single spot should (I hope) make it a lot friendlier to
+  # add more logfiles for different components, logged API objects, etc.
+  def saved_log_files
+    lc = log_config_for_test
+    log_outfiles = lc.values.map { |_level, loc| loc }
+    log_outfiles.select { |s| s.start_with?("logger/") }.map { |s| s.delete_prefix("logger/") }
+  end
+  # Make sure that test failure logs will be noticed, and a message will be printed,
+  # if any logged tests fail. This needs to be called at least once in any Minitest-enabled
+  # process using logged tests.
+  #
+  # @return [void]
+  def set_up_test_failures
+    return if ALREADY_SET_UP_LOGGED_TEST_FAILURES[:setup]
+    log_dir = self.class.logger_dir
+    raise(Scarpe::MustOverrideMethod, "Must set logger directory!") unless log_dir
+    raise(Scarpe::NoSuchFile, "Can't find logger directory!") unless File.directory?(log_dir)
+    ALREADY_SET_UP_LOGGED_TEST_FAILURES[:setup] = true
+    # Delete stale test failures, if any, before starting the first failure-logged test
+    Dir["#{log_dir}/test_failure*.log"].each { |fn| File.unlink(fn) }
+    Minitest.after_run do
+      # Print test failure notice to console
+      unless Dir["#{log_dir}/test_failure*.out.log"].empty?
+        puts "Some tests have failed! See #{log_dir}/test_failure*.out.log for test logs!"
+      end
+      # Remove un-saved test logs
+      Dir["#{log_dir}/test_failure*.log"].each do |f|
+        next if f.include?(".out.log")
+        File.unlink(f) if File.exist?(f)
+      end
+    end
+  end
+  # Failure log output location for a given file path. This is normally used internally to this
+  # class, not externally.
+  #
+  # @return [String] the output path
+  def logfail_out_loc(filepath)
+    # Add a .out prefix before final .log
+    out_loc = filepath.gsub(%r{.log\Z}, ".out.log")
+    if out_loc == filepath
+      raise Shoes::Errors::InvalidAttributeValueError, "Something is wrong! Could not figure out failure-log output path for #{filepath.inspect}!"
+    end
+    if File.exist?(out_loc)
+      raise Scarpe::DuplicateFileError, "Duplicate test file #{out_loc.inspect}? This file should *not* already exist!"
+    end
+    out_loc
+  end
+  # Save the failure logs in the appropriate place(s). This is normally used internally, not externally.
+  #
+  # @return [void]
+  def save_failure_logs
+    saved_log_files.each do |log_file|
+      full_loc = File.expand_path("#{self.class.logger_dir}/#{log_file}")
+      # TODO: we'd like to skip 0-length logfiles. But also Logging doesn't flush. For now, ignore.
+      next unless File.exist?(full_loc)
+      FileUtils.mv full_loc, logfail_out_loc(full_loc)
+    end
+  end
+  # Remove unsaved failure logs. This is normally used internally, not externally.
+  #
+  # @return [void]
+  def remove_unsaved_logs
+    Dir["#{self.class.logger_dir}/test_failure*.log"].each do |f|
+      next if f.include?(".out.log") # Don't delete saved logs
+      File.unlink(f)
+    end
+  end
+end
+module Scarpe::Test::HTMLAssertions
+  # Assert that `actual_html` is the same as `expected_tag` with `opts`.
+  # This uses Scarpe's HTML tag-based renderer to render the tag and options
+  # into text, and valides that the text is the same.
+  #
+  # @see Scarpe::Components::HTML.render
+  #
+  # @param actual_html [String] the html to compare to
+  # @param expected_tag [String,Symbol] the HTML tag, used to send a method call
+  # @param opts keyword options passed to the tag method call
+  # @yield block passed to the tag method call.
+  # @return [void]
+  def assert_html(actual_html, expected_tag, **opts, &block)
+    expected_html = Scarpe::Components::HTML.render do |h|
+      h.public_send(expected_tag, opts, &block)
+    end
+    assert_equal expected_html, actual_html
+  end
+  # Assert that `actual_html` includes `expected_tag` with `opts`.
+  # This uses Scarpe's HTML tag-based renderer to render the tag and options
+  # into text, and valides that the full HTML contains that tag.
+  #
+  # @see Scarpe::Components::HTML.render
+  #
+  # @param actual_html [String] the html to compare to
+  # @param expected_tag [String,Symbol] the HTML tag, used to send a method call
+  # @param opts keyword options passed to the tag method call
+  # @yield block passed to the tag method call.
+  # @return [void]
+  def assert_contains_html(actual_html, expected_tag, **opts, &block)
+    expected_html = Scarpe::Components::HTML.render do |h|
+      h.public_send(expected_tag, opts, &block)
+    end
+    assert actual_html.include?(expected_html), "Expected #{actual_html.inspect} to include #{expected_html.inspect}!"
+  end
+end

data/lib/scarpe/components/version.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Scarpe
+  module Components
+    VERSION = "0.3.0"
+  end
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scarpe-components
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marco Concetto Rudilosso
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,9 +19,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
-- lib/scarpe/logger.rb
+- lib/scarpe/components/base64.rb
+- lib/scarpe/components/calzini.rb
+- lib/scarpe/components/calzini/alert.rb
+- lib/scarpe/components/calzini/art_widgets.rb
+- lib/scarpe/components/calzini/button.rb
+- lib/scarpe/components/calzini/misc.rb
+- lib/scarpe/components/calzini/para.rb
+- lib/scarpe/components/calzini/slots.rb
+- lib/scarpe/components/calzini/text_widgets.rb
+- lib/scarpe/components/errors.rb
+- lib/scarpe/components/file_helpers.rb
+- lib/scarpe/components/html.rb
+- lib/scarpe/components/minitest_export_reporter.rb
+- lib/scarpe/components/minitest_import_runnable.rb
+- lib/scarpe/components/minitest_result.rb
+- lib/scarpe/components/modular_logger.rb
+- lib/scarpe/components/print_logger.rb
+- lib/scarpe/components/promises.rb
+- lib/scarpe/components/segmented_file_loader.rb
+- lib/scarpe/components/string_helpers.rb
+- lib/scarpe/components/tiranti.rb
+- lib/scarpe/components/unit_test_helpers.rb
+- lib/scarpe/components/version.rb
 homepage: https://github.com/scarpe-team/scarpe
 licenses:
 - MIT
@@ -44,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Reusable components for Scarpe display libraries