easol-canvas 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b413ee9262a5f7b363a8f53950da655c1c85aaf71474a331b412c62d5ae8f62
-  data.tar.gz: ecae8f840fffee09e161857beb61cb002d3006f63e00e7e52283342c228234a9
+  metadata.gz: 5cc9522b87ab434f7121dfd557aa987b820c9934486da6c96e8c7706ac4f92b4
+  data.tar.gz: e922ef25a0d8a916a82a7b9c4d8b4faf342088f6da65077518d72b68bf64eeab
 SHA512:
-  metadata.gz: 42fe4d0cdede7d029e2e4c6ced43c23defb19a109bf11df3a4933d9411d2c6c83173042f4f2fee148573042760e62645eeb44b2e3af53e28b9bc91588c23d0a1
-  data.tar.gz: 492e9fbeb71dfc80b56874d83e441ec799ae7ab04dedd668dc3e47c0cdfaabb0c9c9312fdeff2b792039ca44fb127af1eb1d876072c12d4c468567c6e20b6d6a
+  metadata.gz: c33da855f7ad39a4dad8172fc0942c9c60d4af81acf6c677bddb9c55dcacd9759392fa9c24e65910d76228a760bad31c244b865e8f83e52623ffdf26282f99b6
+  data.tar.gz: e4d2f3ebae85a1ed14716a1f5514bd3211ae130b973475bbcaf3b52c946cb25db90cdcfbd75143db9984600e3604071d153eb1766e79388e172a2307e09abcfb

data/lib/canvas/checks/valid_block_schemas_check.rb

@@ -37,7 +37,8 @@ module Canvas
 
     def validate_format(filename, front_matter)
       return true if front_matter.is_a?(Hash) &&
-                     front_matter.values.all? { |attr| attr.is_a?(Hash) }
+                     (front_matter.key?("attributes") ? front_matter["attributes"] : front_matter).values.all? { |attr| attr.is_a?(Hash) }
+
 
       @offenses << Offense.new(
         message: "Invalid Block Schema: #{filename} - \nSchema is not in a valid format"
@@ -45,8 +46,7 @@ module Canvas
       false
     end
 
-    def validate_schema(filename, front_matter, custom_types)
-      schema = extract_schema(front_matter)
+    def validate_schema(filename, schema, custom_types)
       validator = Validator::BlockSchema.new(schema: schema, custom_types: custom_types)
       return if validator.validate
 
@@ -62,11 +62,5 @@ module Canvas
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
     end
-
-    def extract_schema(front_matter)
-      {
-        "attributes" => Canvas::ExpandAttributes.call(front_matter)
-      }
-    end
   end
 end

data/lib/canvas/services/expand_attributes.rb

@@ -30,6 +30,7 @@ module Canvas
       # @return [Array<Hash>] array of hashes that represent each attribute
       def call(attributes_hash)
         return [] if attributes_hash.nil?
+        return attributes_hash if attributes_hash.is_a?(Array)
 
         attributes_hash.each_with_object([]) do |(name, attribute_hash), attrs|
           attrs << attribute_hash.merge("name" => name)

data/lib/canvas/validators/block_schema.rb

@@ -23,21 +23,24 @@ module Canvas
     #   ]
     # }
     class BlockSchema
-      PERMITTED_KEYS = %w[attributes].freeze
+      PERMITTED_KEYS = %w[attributes layout].freeze
 
       attr_reader :errors, :schema
 
       # @param schema [Hash] the schema to be validated
       # @param custom_types [Array<Hash>] a list of custom types
       def initialize(schema:, custom_types: [])
-        @schema = schema
+        @schema = normalize_schema(schema)
         @custom_types = custom_types
         @errors = []
       end
 
       def validate
+        @errors = []
+
         if ensure_valid_format
           ensure_no_unrecognized_keys
+          ensure_layout_is_valid
           ensure_attributes_are_valid
         end
 
@@ -54,6 +57,16 @@ 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_no_unrecognized_keys
         unrecognized_keys = schema.keys - PERMITTED_KEYS
         return true if unrecognized_keys.empty?
@@ -81,6 +94,19 @@ module Canvas
         schema["attributes"].is_a?(Array) &&
           schema["attributes"].all? { |attr| attr.is_a?(Hash) }
       end
+
+      def normalize_schema(schema)
+        if schema.key?("attributes")
+          {
+            **schema,
+            "attributes" => Canvas::ExpandAttributes.call(schema["attributes"])
+          }
+        else
+          {
+            "attributes" => Canvas::ExpandAttributes.call(schema)
+          }
+        end
+      end
     end
   end
 end

data/lib/canvas/validators/layout_schema.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "json"
+require "json-schema"
+
+module Canvas
+  module Validator
+    # :documented:
+    # This class is used to validate a layout definition, part of block schema.
+    # Example of a valid layout definition:
+    # {
+    #   "layout" => [
+    #   {
+    #      "label" => "Design",
+    #      "type" => "tab",
+    #     "elements" => [
+    #       "heading",
+    #       {
+    #         "type" => "accordion",
+    #         "label" => "Logo",
+    #         "elements" => [
+    #           "description",
+    #           { "type" => "attribute", "name" => "logo_alt" },
+    #           "title"
+    #         ]
+    #       }
+    #     ]
+    #   }]
+    # }
+    class LayoutSchema
+      attr_reader :errors
+
+      def initialize(schema:)
+        @schema = schema
+        @errors = []
+      end
+
+      def validate
+        @errors = []
+
+        if ensure_valid_format
+          ensure_no_unrecognized_keys
+          ensure_no_duplicate_keys
+        end
+
+        @errors.empty?
+      end
+
+      private
+
+      def ensure_no_duplicate_keys
+        attributes = gather_attributes_from_layout_schema
+        duplicates =
+          attributes
+          .group_by { |(key)| key }
+          .filter { |key, usage| usage.size > 1 }
+
+        unless duplicates.empty?
+          duplicates.each do |attribute, usage|
+            @errors << "Duplicated attribute key `#{attribute}` found. Location: #{usage.map { |(_, location)| location }.join(", ")}"
+          end
+        end
+      end
+
+      def ensure_no_unrecognized_keys
+        attributes = gather_attributes_from_layout_schema
+        defined_attributes = @schema["attributes"]&.map { |definition| normalize_attribute(definition["name"]) } || []
+
+        attributes.each do |attribute, location|
+          @errors << "Unrecognized attribute `#{attribute}`. Location: #{location}" unless defined_attributes.include?(attribute)
+        end
+      end
+
+      def gather_attributes_from_layout_schema
+        attribute_keys = []
+
+        fetch_attribute_type = ->(node, path) {
+          if node.is_a?(Hash) && node.key?("elements")
+            node["elements"].each_with_index do |element, i|
+              current_path = "#{path}/elements/#{i}"
+              fetch_attribute_type.call(element, current_path)
+            end
+          else
+            attribute_keys << [
+              normalize_attribute(node.is_a?(Hash) ? node["name"] : node),
+              path
+            ]
+          end
+        }
+
+        layout_schema.each_with_index do |tab, i|
+          current_path = "layout/#{i}"
+          fetch_attribute_type.call(tab, current_path)
+        end
+
+        attribute_keys
+      end
+
+      def ensure_valid_format
+        result = JSON::Validator.fully_validate(schema_definition, { "layout" => layout_schema }, strict: true, clear_cache: true)
+
+        return true if result.empty?
+
+        @errors += result
+        false
+      end
+
+      def layout_schema
+        @schema["layout"] || []
+      end
+
+      def schema_definition
+        File.read(
+          File.join(File.dirname(__FILE__), "../../../", "schema_definitions", "block_layout.json")
+        )
+      end
+
+      def normalize_attribute(name)
+        name.strip.downcase
+      end
+    end
+  end
+end

data/lib/canvas/version.rb

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

data/schema_definitions/block_layout.json

@@ -0,0 +1,67 @@
+{
+  "type": "object",
+  "properties": {
+    "layout": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/tab" }
+    }
+  },
+  "$defs": {
+    "tab": {
+      "type": "object",
+      "required": ["type", "label"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "tab"
+        },
+        "label": {
+          "type": "string"
+        },
+        "elements": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "oneOf": [
+              { "type": "string" },
+              { "$ref": "#/$defs/component" },
+              { "$ref": "#/$defs/attribute" }
+            ]
+          }
+        }
+      }
+    },
+    "component": {
+      "type": "object",
+      "required": ["label", "type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["accordion"]
+        },
+        "label": {
+          "type": "string"
+        },
+        "elements": {
+          "type": "array",
+          "items": {
+            "oneOf": [{ "type": "string" }, { "$ref": "#/$defs/attribute" }]
+          }
+        }
+      }
+    },
+    "attribute": {
+      "type": "object",
+      "required": ["name", "type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "attribute"
+        },
+        "name": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: |
   Canvas is a command line tool to help with building themes for Easol.
   It provides tooling to check theme directories for errors and to make sure
@@ -117,6 +131,7 @@ files:
 - lib/canvas/validators/footer_schema.rb
 - lib/canvas/validators/html.rb
 - lib/canvas/validators/json.rb
+- lib/canvas/validators/layout_schema.rb
 - lib/canvas/validators/liquid.rb
 - lib/canvas/validators/menu_schema.rb
 - lib/canvas/validators/sass.rb
@@ -135,6 +150,7 @@ files:
 - lib/canvas/validators/schema_attributes/variant.rb
 - lib/canvas/version.rb
 - lib/easol/canvas.rb
+- schema_definitions/block_layout.json
 homepage: https://rubygems.org/gems/easol-canvas
 licenses:
 - MIT
@@ -154,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: CLI to help with building themes for Easol