easol-canvas 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3adb680aaee894634145000781ac9b4fbc7d4429f165bd70482c04f3fbdb7c6b
-  data.tar.gz: b787e246b9be34acebcb80454504632a4b56e48dbd3e7c79755e33bf2272398a
+  metadata.gz: 5fe5e6dba572cf93a26d99560c7f36cd3f7f2188c019f5c5bd2429c6b897dd20
+  data.tar.gz: df34c9f374a73b17f47e4486345d6f6c21f4f184640d72976f664e3bf873e4ee
 SHA512:
-  metadata.gz: 7d6db23a8b543fbace909d12fae0c4293ea040dccc11180d12f0265afb0b89f405b8d35fb5d957ac8f4a1c4de0e084c6bc82ebfe79bd809669634678863a9220
-  data.tar.gz: 92323781eab651622fc54fe94f43305075ebcdfb9046c056152d62cc4645d77b03f65a2bf569739ad8d74e22366fc814a19d8bbce41a16a8aed9ab02e00d6ddb
+  metadata.gz: d42d0a2cecd8040521956b2bb2a7380c08471e1aebfaf162a652b61a532bda67de5426ffba517b75bbc50449ac65eccbc6df78e009103c6ccc5e86874184c732
+  data.tar.gz: b4590073ce09eef3e258f924b66bfb0f996b88dacfbfbc72c1d0120f8fe96fafc30911015ae31df76836d665efea529db0af9bf3184cd6212747993f8c3a5d1e

data/lib/canvas/check.rb

@@ -1,6 +1,9 @@
-require 'cli/ui'
+# frozen_string_literal: true
+
+require "cli/ui"
 
 module Canvas
+  # :documented:
   class Check
     attr_reader :offenses
 

data/lib/canvas/checks/required_files_check.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Canvas
+  # :documented:
   class RequiredFilesCheck < Check
     REQUIRED_FILES = [
       "templates/product/index.{html,liquid}",

data/lib/canvas/checks/valid_block_schemas_check.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  # This check will validate the schema defined in the front matter
+  # within each block template file.
+  #
+  # Example of block Liquid with valid front matter:
+  #
+  # ---
+  # my_title:
+  #   type: string
+  # my_color:
+  #   type: color
+  #   label: My color
+  #   hint: "Select your favourite color"
+  # ---
+  #
+  # <p>My block HTML</p>
+  #
+  class ValidBlockSchemasCheck < Check
+    def run
+      custom_types = Canvas::FetchCustomTypes.call
+      block_files.each do |filename|
+        file = File.read(filename)
+        front_matter = extract_front_matter(file)
+        validate_format(filename, front_matter) &&
+          validate_schema(filename, front_matter, custom_types)
+      end
+    end
+
+    private
+
+    def block_files
+      Dir.glob("blocks/**/*.{html,liquid}")
+    end
+
+    def validate_format(filename, front_matter)
+      return true if front_matter.is_a?(Hash) &&
+                     front_matter.values.all? { |attr| attr.is_a?(Hash) }
+
+      @offenses << Offense.new(
+        message: "Invalid Block Schema: #{filename} - \nSchema is not in a valid format"
+      )
+      false
+    end
+
+    def validate_schema(filename, front_matter, custom_types)
+      schema = extract_schema(front_matter)
+      validator = Validator::BlockSchema.new(schema: schema, custom_types: custom_types)
+      return if validator.validate
+
+      validator.errors.each do |message|
+        @offenses << Offense.new(
+          message: "Invalid Block Schema: #{filename} - \n#{message}"
+        )
+      end
+    end
+
+    def extract_front_matter(file)
+      extractor = Canvas::FrontMatterExtractor.new(file)
+      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/checks/valid_custom_types_check.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  # This check will validate the JSON objects that represent the
+  # custom types that are defined in the /types directory.
+  class ValidCustomTypesCheck < Check
+    def run
+      custom_type_files.each do |filename|
+        schema = extract_json(filename)
+        validator = Validator::CustomType.new(schema: schema)
+
+        next if validator.validate
+
+        validator.errors.each do |message|
+          @offenses << Offense.new(
+            message: "Invalid Custom Type: #{filename} - \n#{message}"
+          )
+        end
+      end
+    end
+
+    private
+
+    def custom_type_files
+      Dir.glob("types/*.json")
+    end
+
+    def extract_json(filename)
+      file = File.read(filename)
+      JSON.parse(file)
+    rescue JSON::ParserError
+      nil
+    end
+  end
+end

data/lib/canvas/checks/valid_footer_schema_check.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  # This check will validate the schema defined in the front matter
+  # within each footer template file.
+  #
+  # Example of footer Liquid with valid front matter:
+  #
+  # ---
+  # max_item_levels: 2
+  # supports_open_new_tab: true
+  # attributes:
+  #   my_title:
+  #     type: string
+  #   my_color:
+  #     type: color
+  #     label: My color
+  #     hint: "Select your favourite color"
+  # ---
+  #
+  # <p>My footer HTML</p>
+  #
+  class ValidFooterSchemaCheck < Check
+    def run
+      file = File.read(footer_filename)
+      front_matter = extract_front_matter(file)
+      validate_format(front_matter) &&
+        validate_schema(front_matter)
+    end
+
+    private
+
+    def footer_filename
+      Dir.glob("partials/footer/index.{html,liquid}").first
+    end
+
+    def validate_format(front_matter)
+      return true if front_matter.is_a?(Hash) && attributes_valid_format(front_matter)
+
+      @offenses << Offense.new(
+        message: "Invalid Footer Schema: #{footer_filename} - \nSchema is not in a valid format"
+      )
+      false
+    end
+
+    def attributes_valid_format(front_matter)
+      return true unless front_matter.key?("attributes")
+
+      front_matter["attributes"].is_a?(Hash) &&
+        front_matter["attributes"].values.all? { |attr| attr.is_a?(Hash) }
+    end
+
+    def validate_schema(front_matter)
+      schema = extract_schema(front_matter)
+      validator = Validator::FooterSchema.new(
+        schema: schema,
+        custom_types: Canvas::FetchCustomTypes.call
+      )
+      return if validator.validate
+
+      validator.errors.each do |message|
+        @offenses << Offense.new(
+          message: "Invalid Footer Schema: #{footer_filename} - \n#{message}"
+        )
+      end
+    end
+
+    def extract_front_matter(file)
+      extractor = Canvas::FrontMatterExtractor.new(file)
+      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_html_check.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Canvas
+  # :documented:
   class ValidHtmlCheck < Check
     def run
       html_files.each do |filename|

data/lib/canvas/checks/valid_json_check.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  class ValidJsonCheck < Check
+    def run
+      json_files.each do |filename|
+        file = File.read(filename)
+        validator = Validator::Json.new(file)
+
+        next if validator.validate
+
+        validator.errors.each do |message|
+          @offenses << Offense.new(
+            message: "Invalid JSON: #{filename} - \n#{message}"
+          )
+        end
+      end
+    end
+
+    private
+
+    def json_files
+      Dir.glob("**/*.json")
+    end
+  end
+end

data/lib/canvas/checks/valid_liquid_check.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Canvas
+  # :documented:
   class ValidLiquidCheck < Check
     def run
       register_tags!
@@ -9,7 +12,7 @@ module Canvas
 
         next if validator.validate
 
-        validator.errors.map(&:message).each do |message|
+        validator.errors.each do |message|
           @offenses << Offense.new(
             message: "Invalid Liquid: #{filename} - \n#{message}"
           )

data/lib/canvas/checks/valid_menu_schema_check.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  # This check will validate the schema defined in the front matter
+  # within each menu template file.
+  #
+  # Example of menu Liquid with valid front matter:
+  #
+  # ---
+  # max_item_levels: 2
+  # supports_open_new_tab: true
+  # attributes:
+  #   my_title:
+  #     type: string
+  #   my_color:
+  #     type: color
+  #     label: My color
+  #     hint: "Select your favourite color"
+  # ---
+  #
+  # <p>My menu HTML</p>
+  #
+  class ValidMenuSchemaCheck < Check
+    def run
+      file = File.read(menu_filename)
+      front_matter = extract_front_matter(file)
+      validate_format(front_matter) &&
+        validate_schema(front_matter)
+    end
+
+    private
+
+    def menu_filename
+      Dir.glob("partials/menu/index.{html,liquid}").first
+    end
+
+    def validate_format(front_matter)
+      return true if front_matter.is_a?(Hash) && attributes_valid_format(front_matter)
+
+      @offenses << Offense.new(
+        message: "Invalid Menu Schema: #{menu_filename} - \nSchema is not in a valid format"
+      )
+      false
+    end
+
+    def attributes_valid_format(front_matter)
+      return true unless front_matter.key?("attributes")
+
+      front_matter["attributes"].is_a?(Hash) &&
+        front_matter["attributes"].values.all? { |attr| attr.is_a?(Hash) }
+    end
+
+    def validate_schema(front_matter)
+      schema = extract_schema(front_matter)
+      validator = Validator::MenuSchema.new(
+        schema: schema,
+        custom_types: Canvas::FetchCustomTypes.call
+      )
+      return if validator.validate
+
+      validator.errors.each do |message|
+        @offenses << Offense.new(
+          message: "Invalid Menu Schema: #{menu_filename} - \n#{message}"
+        )
+      end
+    end
+
+    def extract_front_matter(file)
+      extractor = Canvas::FrontMatterExtractor.new(file)
+      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.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Canvas
+  # :documented:
   class Checks
     class << self
       def registered
@@ -10,7 +13,7 @@ module Canvas
         return if @checks.include?(klass)
         @checks << klass
       end
-      
+
       def deregister_all!
         @checks = []
       end

data/lib/canvas/cli.rb

@@ -1,12 +1,21 @@
+# frozen_string_literal: true
+
 require "thor"
-require 'cli/ui'
+require "cli/ui"
 
 module Canvas
+  # :documented:
   class Cli < Thor
     desc "lint", "Prints a hello world message"
     def lint
       CLI::UI::StdoutRouter.enable
       Canvas::Lint.new.run
     end
+
+    map %w[--version -v] => :__print_version
+    desc "--version, -v", "print the version"
+    def __print_version
+      puts Canvas::VERSION
+    end
   end
 end

data/lib/canvas/constants.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# :documented:
+# This file is used to define globally accessible constants.
+module Canvas
+  module Constants
+    COLOR_PALETTE_VALUES = %w[
+      primary
+      secondary
+      body-bg
+      body-color
+    ].freeze
+
+    PRIMITIVE_TYPES = %w[
+      image
+      product
+      post
+      page
+      link
+      text
+      string
+      boolean
+      number
+      color
+      select
+      range
+      radio
+      variant
+    ].freeze
+  end
+end

data/lib/canvas/lint.rb

@@ -1,6 +1,9 @@
-require 'cli/ui'
+# frozen_string_literal: true
+
+require "cli/ui"
 
 module Canvas
+  #:documented:
   class Lint
     def run
       output_context = CLI::UI::SpinGroup.new(auto_debrief: false)
@@ -15,6 +18,7 @@ module Canvas
 
       if @checks.any?(&:failed?)
         puts debrief_message
+        exit 1
       end
     end
 
@@ -28,13 +32,13 @@ module Canvas
     end
 
     def debrief_message
-      CLI::UI::Frame.open('Failures', color: :red) do
+      CLI::UI::Frame.open("Failures", color: :red) do
         failed_checks = @checks.filter(&:failed?)
         failed_checks.map do |check|
           CLI::UI::Frame.open(check.class.name, color: :red) do
-            output = check.offenses.map do |offense|
+            output = check.offenses.map { |offense|
               CLI::UI.fmt "{{x}} #{offense.message}"
-            end
+            }
             puts output.join("\n")
           end
         end

data/lib/canvas/offense.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Canvas
+  # :documented:
   class Offense
     attr_reader :message
 

data/lib/canvas/services/expand_attributes.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  # This service will convert the attributes from a hash, as they are defined in the front matter,
+  # into an array of hashes that the {Canvas::Validator::SchemaAttribute} class expects.
+  # e.g. the following front matter:
+  #
+  # my_title:
+  #   type: string
+  # my_color:
+  #   type: color
+  #
+  # will get converted to:
+  #
+  # [
+  #   {
+  #     "name" => "my_title",
+  #     "type" => "string"
+  #   },
+  #   {
+  #     "name" => "my_color",
+  #     "type" => "color"
+  #   }
+  # ]
+  #
+  class ExpandAttributes
+    class << self
+      # @param attributes_hash [Hash] hash of attributes pulled from front matter
+      # @return [Array<Hash>] array of hashes that represent each attribute
+      def call(attributes_hash)
+        return [] if attributes_hash.nil?
+
+        attributes_hash.each_with_object([]) do |(name, attribute_hash), attrs|
+          attrs << attribute_hash.merge("name" => name)
+        end
+      end
+    end
+  end
+end

data/lib/canvas/services/fetch_custom_types.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Canvas
+  # :documented:
+  # This service can be used to fetch the custom types from the /types directory.
+  class FetchCustomTypes
+    class << self
+      # @return [Array<Hash>] a list of all the custom types defined in the
+      # theme within the /types directory.
+      def call
+        filenames = Dir.glob("types/*.json")
+        filenames.map { |filename| extract_json(filename) }.compact
+      end
+
+      private
+
+      def extract_json(filename)
+        file = File.read(filename)
+        JSON.parse(file)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

data/lib/canvas/services/front_matter_extractor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Canvas
   # :documented:
   # This service can be used to extract front matter from a liquid string.

data/lib/canvas/validators/block_schema.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "liquid"
+
+module Canvas
+  module Validator
+    # :documented:
+    # This class is used to validate a schema for a block.
+    # Example of a valid block schema:
+    # {
+    #   "attributes" => [
+    #     {
+    #       "name" => "my_title",
+    #       "type" => "string"
+    #     },
+    #     {
+    #       "name" => "my_color",
+    #       "type" => "color",
+    #       "label" => "My color",
+    #       "hint" => "Select your favourite color"
+    #     }
+    #   ]
+    # }
+    class BlockSchema
+      PERMITTED_KEYS = %w[attributes].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
+        @custom_types = custom_types
+        @errors = []
+      end
+
+      def validate
+        if ensure_valid_format
+          ensure_no_unrecognized_keys
+          ensure_attributes_are_valid
+        end
+
+        @errors.empty?
+      end
+
+      private
+
+      def ensure_valid_format
+        return true if schema.is_a?(Hash) &&
+                       (schema["attributes"].nil? || attributes_array_of_hashes?(schema))
+
+        @errors << "Schema is not in a valid format"
+        false
+      end
+
+      def ensure_no_unrecognized_keys
+        unrecognized_keys = schema.keys - PERMITTED_KEYS
+        return true if unrecognized_keys.empty?
+
+        @errors << "Unrecognized keys: #{unrecognized_keys.join(', ')}"
+        false
+      end
+
+      def ensure_attributes_are_valid
+        return true unless schema["attributes"]
+
+        schema["attributes"].each do |attribute_schema|
+          attr_validator = Validator::SchemaAttribute.new(
+            attribute: attribute_schema,
+            custom_types: @custom_types
+          )
+          next if attr_validator.validate
+
+          @errors << "Attribute \"#{attribute_schema['name']}\" is invalid "\
+                     "- #{attr_validator.errors.join(', ')}"
+        end
+      end
+
+      def attributes_array_of_hashes?(schema)
+        schema["attributes"].is_a?(Array) &&
+          schema["attributes"].all? { |attr| attr.is_a?(Hash) }
+      end
+    end
+  end
+end