easol-canvas 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c61a6785fbf34da110e1fe2b01a9f096ff4aaf8ea3cfbef780491b5e94e68998
-  data.tar.gz: 3acb2a3215a5fd874ad5e54cc719204cb0a4698218935f2546ce5cacf3f73777
+  metadata.gz: 5446d70b87d779a13b4a5b3f132b91a29722d84167fcc2ac9b61a142e7b5a45c
+  data.tar.gz: ccc2f5bc197c2f7ec72969289989742f3400f69e2a2eb468c001fd994237f2bc
 SHA512:
-  metadata.gz: 660512a56bea758cae95483fdaefd41a75156a7c15723e661749a64feb6dbc847bab31e279fecd733af807c33491a138b9c4afc850bfd2db84e8b1ae5d3c848a
-  data.tar.gz: 75fdbbefd7cfccc1849bf26e1c42e9f24f274c1d1ed27774d6b1a5085a5caafd30b4b8a0499d418686320157b6335116e0a25bf973b24fedee60210bb64c8d0d
+  metadata.gz: a1b2ab985beac4aef8812c35fcda2707c52fc204c26435d7bf9dd7b33441dc9666739e4a9319e64e1fab31fab8f46d73e7af79c63b14ae21a084f517c0e7f9ea
+  data.tar.gz: f57a9566ebb142092e574dc0889a636c673342e5a71e5ccc1f111951c4ac1fa78995dbbe090cd2de7d5c3cd073dbecd3999aca06889a3beb5419d72616547090

data/lib/canvas/checks/valid_block_schemas_check.rb

@@ -22,8 +22,9 @@ module Canvas
     def run
       custom_types = Canvas::FetchCustomTypes.call
       block_files.each do |filename|
-        file = File.read(filename)
-        front_matter = extract_front_matter(file)
+        front_matter = extract_front_matter(filename)
+        next unless front_matter
+
         validate_format(filename, front_matter) &&
           validate_schema(filename, front_matter, custom_types)
       end
@@ -57,10 +58,18 @@ module Canvas
       end
     end
 
-    def extract_front_matter(file)
+    def extract_front_matter(filename)
+      file = File.read(filename)
+
       extractor = Canvas::FrontMatterExtractor.new(file)
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
+    rescue Psych::SyntaxError
+      @offenses << Offense.new(
+        message: "Invalid Block Schema: #{filename} - \nFront matter's YAML is not in a valid format"
+      )
+
+      nil
     end
   end
 end

data/lib/canvas/checks/valid_footer_schema_check.rb

@@ -51,8 +51,7 @@ module Canvas
         front_matter["attributes"].values.all? { |attr| attr.is_a?(Hash) }
     end
 
-    def validate_schema(front_matter)
-      schema = extract_schema(front_matter)
+    def validate_schema(schema)
       validator = Validator::FooterSchema.new(
         schema: schema,
         custom_types: Canvas::FetchCustomTypes.call
@@ -71,11 +70,5 @@ module Canvas
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
     end
-
-    def extract_schema(front_matter)
-      front_matter.merge(
-        "attributes" => Canvas::ExpandAttributes.call(front_matter["attributes"])
-      )
-    end
   end
 end

data/lib/canvas/checks/valid_menu_schema_check.rb

@@ -51,8 +51,7 @@ module Canvas
         front_matter["attributes"].values.all? { |attr| attr.is_a?(Hash) }
     end
 
-    def validate_schema(front_matter)
-      schema = extract_schema(front_matter)
+    def validate_schema(schema)
       validator = Validator::MenuSchema.new(
         schema: schema,
         custom_types: Canvas::FetchCustomTypes.call
@@ -71,11 +70,5 @@ module Canvas
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
     end
-
-    def extract_schema(front_matter)
-      front_matter.merge(
-        "attributes" => Canvas::ExpandAttributes.call(front_matter["attributes"])
-      )
-    end
   end
 end

data/lib/canvas/validators/block_schema.rb

@@ -9,17 +9,25 @@ module Canvas
     # This class is used to validate a schema for a block.
     # Example of a valid block schema:
     # {
-    #   "attributes" => [
-    #     {
-    #       "name" => "my_title",
+    #   "attributes" => {
+    #     "my_title" => {
     #       "type" => "string"
     #     },
-    #     {
-    #       "name" => "my_color",
+    #     "my_color" => {
     #       "type" => "color",
     #       "label" => "My color",
     #       "hint" => "Select your favourite color"
     #     }
+    #   },
+    #   "layout" => [
+    #     {
+    #       "type" => "tab",
+    #       "label" => "Content",
+    #       "elements" => [
+    #         "my_title",
+    #         "my_color"
+    #       ]
+    #     }
     #   ]
     # }
     class BlockSchema
@@ -51,7 +59,7 @@ module Canvas
 
       def ensure_valid_format
         return true if schema.is_a?(Hash) &&
-                       (schema["attributes"].nil? || attributes_array_of_hashes?(schema))
+                       (schema["attributes"].nil? || attributes_hash_of_hashes?(schema))
 
         @errors << "Schema is not in a valid format"
         false
@@ -78,7 +86,8 @@ module Canvas
       def ensure_attributes_are_valid
         return true unless schema["attributes"]
 
-        schema["attributes"].each do |attribute_schema|
+        attributes = Canvas::ExpandAttributes.call(schema["attributes"])
+        attributes.each do |attribute_schema|
           attr_validator = Validator::SchemaAttribute.new(
             attribute: attribute_schema,
             custom_types: @custom_types
@@ -90,22 +99,17 @@ module Canvas
         end
       end
 
-      def attributes_array_of_hashes?(schema)
-        schema["attributes"].is_a?(Array) &&
-          schema["attributes"].all? { |attr| attr.is_a?(Hash) }
+      def attributes_hash_of_hashes?(schema)
+        schema["attributes"].is_a?(Hash) &&
+          schema["attributes"].values.all? { |attr| attr.is_a?(Hash) }
       end
 
+      # To support older schemas that do not nest the attributes
+      # under the `attributes` key.
       def normalize_schema(schema)
-        if schema.key?("attributes")
-          {
-            **schema,
-            "attributes" => Canvas::ExpandAttributes.call(schema["attributes"])
-          }
-        else
-          {
-            "attributes" => Canvas::ExpandAttributes.call(schema)
-          }
-        end
+        return schema if schema.key?("attributes")
+
+        { "attributes" => schema }
       end
     end
   end

data/lib/canvas/validators/footer_schema.rb

@@ -11,19 +11,27 @@ module Canvas
     #
     # Example:
     # {
-    #   "max_item_levels": 2,
-    #   "supports_open_new_tab": "true",
-    #   "attributes": {
-    #      "fixed": {
-    #         "group": "design",
-    #         "label": "Fixed when scrolling",
-    #         "hint": "The menu will stay fixed to the top when scrolling down the page.",
-    #         "type": "boolean",
-    #         "default: "false"
+    #   "max_item_levels" => 2,
+    #   "supports_open_new_tab" => "true",
+    #   "attributes" => {
+    #      "text_color" => {
+    #        "type" => "color"
+    #      },
+    #      "background_color" => {
+    #        "type" => "color"
     #      }
-    #   }
+    #   },
+    #   "layout" => [
+    #     {
+    #       "type" => "tab",
+    #       "label" => "Content",
+    #       "elements" => [
+    #         "text_color",
+    #         "background_color"
+    #       ]
+    #     }
+    #   ]
     # }
-    #
     class FooterSchema < MenuSchema; end
   end
 end

data/lib/canvas/validators/layout_schema.rb

@@ -9,13 +9,12 @@ module Canvas
     # This class is used to validate a layout definition, part of block schema.
     # Example of a valid layout definition:
     # {
-    #   "attributes" => [
-    #     {
-    #       "name" => "title",
+    #   "attributes" => {
+    #     "title" => {
     #       "type" => "string"
     #     }
     #     ...
-    #   ],
+    #   },
     #   "layout" => [
     #     {
     #       "label" => "Design",
@@ -83,7 +82,7 @@ module Canvas
 
       def ensure_no_unrecognized_keys
         attributes = fetch_all_attribute_names
-        defined_attributes = schema["attributes"]&.map { |definition| normalize_attribute(definition["name"]) } || []
+        defined_attributes = expanded_attributes.map { |definition| normalize_attribute(definition["name"]) } || []
 
         attributes.each do |attribute, location|
           @errors << "Unrecognized attribute `#{attribute}`. Location: #{location}" unless defined_attributes.include?(attribute)
@@ -144,13 +143,13 @@ module Canvas
       def ensure_accordion_toggles_are_valid
         accordion_toggles = fetch_elements_of_type("accordion_toggle")
         accordion_toggles.each do |accordion_toggle, location|
-          toggle_attribute = schema["attributes"]&.detect { |attr|
+          toggle_attribute = expanded_attributes.detect { |attr|
             attr["name"] == accordion_toggle["toggle_attribute"]
           }
 
           if toggle_attribute.nil?
             @errors << "The toggle_attribute in accordion_toggle is unrecognized. Location: #{location}"
-          elsif toggle_attribute["type"] != "boolean"
+          elsif toggle_attribute["type"]&.downcase != "boolean"
             @errors << "The toggle_attribute in accordion_toggle must be a boolean. Location: #{location}"
           end
         end
@@ -162,13 +161,19 @@ module Canvas
 
       def schema_definition
         File.read(
-          File.join(File.dirname(__FILE__), "../../../", "schema_definitions", "block_layout.json")
+          File.join(File.dirname(__FILE__), "../../../", "schema_definitions", "layout.json")
         )
       end
 
       def normalize_attribute(name)
         name.strip.downcase
       end
+
+      def expanded_attributes
+        return [] if schema["attributes"].nil?
+
+        @_expanded_attributes ||= Canvas::ExpandAttributes.call(schema["attributes"])
+      end
     end
   end
 end

data/lib/canvas/validators/menu_schema.rb

@@ -7,21 +7,33 @@ module Canvas
     #
     # Example:
     # {
-    #   "max_item_levels": 2,
-    #   "supports_open_new_tab": "true",
-    #   "attributes": {
-    #      "fixed": {
-    #         "group": "design",
-    #         "label": "Fixed when scrolling",
-    #         "hint": "The menu will stay fixed to the top when scrolling down the page.",
-    #         "type": "boolean",
-    #         "default: "false"
+    #   "max_item_levels" => 2,
+    #   "supports_open_new_tab" => "true",
+    #   "attributes" => {
+    #      "fixed" => {
+    #         "group" => "design",
+    #         "label" => "Fixed when scrolling",
+    #         "hint" => "The menu will stay fixed to the top when scrolling down the page.",
+    #         "type" => "boolean",
+    #         "default" => "false"
+    #      },
+    #      "background_color" => {
+    #        "type" => "color"
     #      }
-    #   }
+    #   },
+    #   "layout" => [
+    #     {
+    #       "type" => "tab",
+    #       "label" => "Content",
+    #       "elements" => [
+    #         "fixed",
+    #         "background_color"
+    #       ]
+    #     }
+    #   ]
     # }
-    #
     class MenuSchema
-      PERMITTED_KEYS = %w[max_item_levels supports_open_new_tab attributes].freeze
+      PERMITTED_KEYS = %w[max_item_levels supports_open_new_tab attributes layout].freeze
       ADDITIONAL_RESERVED_NAMES = %w[items type].freeze
 
       attr_reader :schema, :errors
@@ -38,6 +50,7 @@ module Canvas
         if ensure_valid_format
           ensure_no_unrecognized_keys
           ensure_max_item_levels_is_valid
+          ensure_layout_is_valid
           ensure_attributes_are_valid
         end
 
@@ -48,7 +61,7 @@ module Canvas
 
       def ensure_valid_format
         return true if schema.is_a?(Hash) &&
-                       (schema["attributes"].nil? || attributes_array_of_hashes?(schema))
+                       (schema["attributes"].nil? || attributes_hash_of_hashes?(schema))
 
         @errors << "Schema is not in a valid format"
         false
@@ -70,10 +83,21 @@ module Canvas
         false
       end
 
+      def ensure_layout_is_valid
+        return true unless schema["layout"]
+
+        layout_validator = LayoutSchema.new(schema: @schema)
+        return true if layout_validator.validate
+
+        @errors += layout_validator.errors
+        false
+      end
+
       def ensure_attributes_are_valid
         return true unless schema["attributes"]
 
-        schema["attributes"].each do |attribute_schema|
+        attributes = Canvas::ExpandAttributes.call(schema["attributes"])
+        attributes.each do |attribute_schema|
           attr_validator = Validator::SchemaAttribute.new(
             attribute: attribute_schema,
             custom_types: @custom_types,
@@ -86,9 +110,9 @@ module Canvas
         end
       end
 
-      def attributes_array_of_hashes?(schema)
-        schema["attributes"].is_a?(Array) &&
-          schema["attributes"].all? { |attr| attr.is_a?(Hash) }
+      def attributes_hash_of_hashes?(schema)
+        schema["attributes"].is_a?(Hash) &&
+          schema["attributes"].values.all? { |attr| attr.is_a?(Hash) }
       end
     end
   end

data/lib/canvas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Canvas
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -150,7 +150,7 @@ files:
 - lib/canvas/validators/schema_attributes/variant.rb
 - lib/canvas/version.rb
 - lib/easol/canvas.rb
-- schema_definitions/block_layout.json
+- schema_definitions/layout.json
 homepage: https://rubygems.org/gems/easol-canvas
 licenses:
 - MIT