easol-canvas 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8570c1c4d1a8f7097f621722730ca8c882b633b901c8d22fb13f7dcbcb2ac8df
-  data.tar.gz: d10b1319c6e1be3e0e43a77575fbf73f71f4a9f77582486d5b34d374d9c42105
+  metadata.gz: 5fe5e6dba572cf93a26d99560c7f36cd3f7f2188c019f5c5bd2429c6b897dd20
+  data.tar.gz: df34c9f374a73b17f47e4486345d6f6c21f4f184640d72976f664e3bf873e4ee
 SHA512:
-  metadata.gz: 2dbfd55872ab41728e9243392a02c64551379cf42b99f59e455ade832fc028aa154b78e93600ec8bba8ac4fdcc52001850f2fd9cead452d64b896e1a997a0c63
-  data.tar.gz: d6507b81b2fe0f72aad4407601606fa305b45e0d2142753eccc03cda5760277ceeaf54f83b6d8468274490e33afa4360da7174dd23599b4e5aa0a9fe484ab5d3
+  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_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_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

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

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!

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :documented:
+# This file is used to define globally accessible constants.
 module Canvas
   module Constants
     COLOR_PALETTE_VALUES = %w[
@@ -8,5 +10,22 @@ module Canvas
       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)
@@ -29,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/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/custom_type.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    # :documented:
+    # This class is used to validate the JSON defining a custom type.
+    #
+    # An example of a valid custom type:
+    # {
+    #   "key": "faq",
+    #   "name": "Faq",
+    #   "attributes": [
+    #     {
+    #       "name": "question",
+    #       "label": "Question",
+    #       "type": "string"
+    #     },
+    #     {
+    #       "name": "answer",
+    #       "label": "Answer",
+    #       "type": "text"
+    #     }
+    #   ]
+    # }
+    #
+    class CustomType
+      REQUIRED_KEYS = %w[key name attributes].freeze
+
+      attr_reader :schema, :errors
+
+      def initialize(schema:)
+        @schema = schema
+        @errors = []
+      end
+
+      def validate
+        ensure_valid_format &&
+          ensure_has_required_keys &&
+          ensure_no_unrecognized_keys &&
+          ensure_keys_are_correct_types &&
+          ensure_no_duplicate_attributes &&
+          ensure_attributes_are_valid &&
+          ensure_first_attribute_not_array
+
+        errors.empty?
+      end
+
+      private
+
+      def ensure_valid_format
+        return true if schema.is_a?(Hash)
+
+        @errors << "Schema is not in a valid format"
+        false
+      end
+
+      def ensure_has_required_keys
+        missing_keys = REQUIRED_KEYS - schema.keys
+        return true if missing_keys.empty?
+
+        @errors << "Missing required keys: #{missing_keys.join(', ')}"
+        false
+      end
+
+      def ensure_no_unrecognized_keys
+        unrecognized_keys = schema.keys - REQUIRED_KEYS
+        return true if unrecognized_keys.empty?
+
+        @errors << "Unrecognized keys: #{unrecognized_keys.join(', ')}"
+        false
+      end
+
+      def ensure_keys_are_correct_types
+        if !schema["key"].is_a?(String)
+          @errors << "\"key\" must be a string"
+          return false
+        end
+
+        if !schema["name"].is_a?(String)
+          @errors << "\"name\" must be a string"
+          return false
+        end
+
+        if !schema["attributes"].is_a?(Array) ||
+            schema["attributes"].empty? ||
+            schema["attributes"].any? { |a| !a.is_a?(Hash) }
+            @errors << "\"attributes\" must be an array of objects"
+          return false
+        end
+
+        true
+      end
+
+      def ensure_no_duplicate_attributes
+        attribute_names = schema["attributes"].map { |a| a["name"] }
+        duplicated_names = attribute_names.select { |a| attribute_names.count(a) > 1 }.uniq
+
+        return true if duplicated_names.empty?
+
+        @errors << "Some attributes are duplicated: #{duplicated_names.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: []
+          )
+          next if attr_validator.validate
+
+          @errors << "Attribute \"#{attribute_schema['name']}\" is invalid "\
+                     "- #{attr_validator.errors.join(', ')}"
+        end
+      end
+
+      def ensure_first_attribute_not_array
+        first_attribute = schema.fetch("attributes").first
+
+        return true if first_attribute.nil? || first_attribute["array"] != true
+
+        @errors << "The first attribute cannot be an array"
+        false
+      end
+    end
+  end
+end

data/lib/canvas/validators/html.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require "nokogiri"
 require "liquid"
 
 module Canvas
   module Validator
+    # :documented:
     class Html
       LIQUID_TAG = /#{::Liquid::TagStart}.*?#{::Liquid::TagEnd}/om
       LIQUID_VARIABLE = /#{::Liquid::VariableStart}.*?#{::Liquid::VariableEnd}/om

data/lib/canvas/validators/json.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require "json"
 
 module Canvas
   module Validator
+    # :documented:
     class Json
       attr_reader :errors
 

data/lib/canvas/validators/liquid.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require "nokogiri"
 require "liquid"
 
 module Canvas
   module Validator
+    # :documented:
     class Liquid
       attr_reader :errors
 

data/lib/canvas/validators/schema_attribute.rb

@@ -34,7 +34,6 @@ module Canvas
         "radio" => SchemaAttribute::Radio,
         "variant" => SchemaAttribute::Variant,
       }.freeze
-      PRIMITIVE_TYPES = VALIDATORS.keys
       RESERVED_NAMES = %w[
         page
         company
@@ -71,7 +70,7 @@ module Canvas
       end
 
       def valid_types
-        PRIMITIVE_TYPES + custom_type_keys
+        Constants::PRIMITIVE_TYPES + custom_type_keys
       end
 
       def validator_for_type

data/lib/canvas/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Canvas
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/canvas.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "canvas/version"
 require_relative "canvas/constants"
 require_relative "canvas/cli"
@@ -11,18 +13,23 @@ require_relative "canvas/validators/schema_attributes/base"
 
 # The attribute validators need to be required before Canvas::Validator::SchemaAttribute
 attribute_validators = Dir["#{__dir__}/canvas/validators/schema_attributes/*.rb"]
-attribute_validators.each { |file| require file }
+attribute_validators.each do |file|
+  require file
+end
 
 files = Dir["#{__dir__}/canvas/{checks,services,validators}/*.rb"]
-files.each { |file| require file }
+files.each do |file|
+  require file
+end
 
 Canvas::Checks.register(Canvas::RequiredFilesCheck)
 Canvas::Checks.register(Canvas::ValidHtmlCheck)
 Canvas::Checks.register(Canvas::ValidLiquidCheck)
+Canvas::Checks.register(Canvas::ValidJsonCheck)
 Canvas::Checks.register(Canvas::ValidBlockSchemasCheck)
 Canvas::Checks.register(Canvas::ValidMenuSchemaCheck)
 Canvas::Checks.register(Canvas::ValidFooterSchemaCheck)
-Canvas::Checks.register(Canvas::ValidJsonCheck)
+Canvas::Checks.register(Canvas::ValidCustomTypesCheck)
 
 module Canvas
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -84,6 +84,7 @@ files:
 - lib/canvas/checks.rb
 - lib/canvas/checks/required_files_check.rb
 - lib/canvas/checks/valid_block_schemas_check.rb
+- lib/canvas/checks/valid_custom_types_check.rb
 - lib/canvas/checks/valid_footer_schema_check.rb
 - lib/canvas/checks/valid_html_check.rb
 - lib/canvas/checks/valid_json_check.rb
@@ -97,6 +98,7 @@ files:
 - lib/canvas/services/fetch_custom_types.rb
 - lib/canvas/services/front_matter_extractor.rb
 - lib/canvas/validators/block_schema.rb
+- lib/canvas/validators/custom_type.rb
 - lib/canvas/validators/footer_schema.rb
 - lib/canvas/validators/html.rb
 - lib/canvas/validators/json.rb