easol-canvas 0.1.1 → 1.2.0

data/lib/canvas/validators/schema_attributes/image.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to link-type variables.
+      class Image < Base
+        ALLOWED_DEFAULT_KEYS = %w[url asset].freeze
+
+        def validate
+          super && ensure_default_key_is_valid
+        end
+
+        private
+
+        def ensure_default_key_is_valid
+          return true unless attribute.key?("default")
+
+          if attribute["array"]
+            attribute["default"].all? { |value| default_value_is_validate(value) }
+          else
+            default_value_is_validate(attribute["default"])
+          end
+        end
+
+        # The default value can be one of 3 different formats:
+        # - A string (for backwards compatibility) e.g. "http://my-image.jpg"
+        # - A hash with "url" key" e.g. { "url": "http://my-image.jpg" }
+        # - A hash with "asset" key" e.g. { "asset": "http://my-image.jpg" }
+        def default_value_is_validate(value)
+          return true if value.is_a?(String)
+
+          return true if value.is_a?(Hash) &&
+                         value.keys.size == 1 &&
+                         ALLOWED_DEFAULT_KEYS.include?(value.keys.first) &&
+                         value.values.first.is_a?(String)
+
+          @errors << "\"default\" for image-type variables must include a single url or asset value"
+          false
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/link.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to link-type variables.
+      class Link < Base
+        ALLOWED_DEFAULT_KEYS = %w[url page post product].freeze
+        INVALID_DEFAULT_ERROR = "\"default\" for link-type variables must include "\
+                                "a single url, page, post or product value"
+
+        def validate
+          super &&
+            ensure_single_default_provided &&
+            ensure_default_key_is_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          Hash
+        end
+
+        def ensure_default_key_is_valid
+          return true unless attribute.key?("default")
+
+          key = attribute["default"].keys.first
+
+          unless ALLOWED_DEFAULT_KEYS.include?(key)
+            @errors << INVALID_DEFAULT_ERROR
+            return false
+          end
+
+          true
+        end
+
+        def ensure_single_default_provided
+          return true unless attribute.key?("default")
+
+          if attribute["default"].count != 1
+            @errors << INVALID_DEFAULT_ERROR
+            return false
+          end
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/number.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to number-type variables.
+      class Number < Base
+        private
+
+        def optional_keys
+          super.merge("unit" => String)
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/page.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to page-type variables.
+      class Page < Base
+        ALLOWED_DEFAULT_VALUES = %w[ random ].freeze
+
+        def validate
+          super &&
+            ensure_default_values_are_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          if attribute["array"]
+            Array
+          else
+            String
+          end
+        end
+
+        def ensure_default_values_are_valid
+          return true unless attribute.key?("default")
+
+          if attribute["array"]
+            attribute["default"].all? { |value| default_value_is_validate(value) }
+          else
+            default_value_is_validate(attribute["default"])
+          end
+        end
+
+        def default_value_is_validate(value)
+          value = value.downcase
+          if !ALLOWED_DEFAULT_VALUES.include?(value)
+            @errors << "\"default\" for page-type variables must be "\
+                       "one of: #{ALLOWED_DEFAULT_VALUES.join(', ')}"
+            false
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/post.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to post-type variables.
+      class Post < Base
+        ALLOWED_DEFAULT_VALUES = %w[random].freeze
+
+        def validate
+          super &&
+            ensure_default_values_are_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          if attribute["array"]
+            Array
+          else
+            String
+          end
+        end
+
+        def ensure_default_values_are_valid
+          return true unless attribute.key?("default")
+
+          if attribute["array"]
+            attribute["default"].all? { |value| default_value_is_valid?(value) }
+          else
+            default_value_is_valid?(attribute["default"])
+          end
+        end
+
+        def default_value_is_valid?(value)
+          value = value.downcase
+          if !ALLOWED_DEFAULT_VALUES.include?(value)
+            @errors << "\"default\" for post-type variables must be "\
+                       "one of: #{ALLOWED_DEFAULT_VALUES.join(', ')}"
+            false
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/product.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to product-type variables.
+      class Product < Base
+        ALLOWED_DEFAULT_VALUES = %w[random].freeze
+
+        def validate
+          super &&
+            ensure_default_values_are_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          if attribute["array"]
+            Array
+          else
+            String
+          end
+        end
+
+        def ensure_default_values_are_valid
+          return true unless attribute.key?("default")
+
+          if attribute["array"]
+            attribute["default"].all? { |value| default_value_is_valid?(value) }
+          else
+            default_value_is_valid?(attribute["default"])
+          end
+        end
+
+        def default_value_is_valid?(value)
+          value = value.downcase
+          if !ALLOWED_DEFAULT_VALUES.include?(value)
+            @errors << "\"default\" for product-type variables must be "\
+                       "one of: #{ALLOWED_DEFAULT_VALUES.join(', ')}"
+            false
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/radio.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to radio-type variables.
+      class Radio < Base
+        def validate
+          super &&
+            ensure_at_least_one_option &&
+            ensure_options_are_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          if attribute["options"].is_a?(Array)
+            attribute["options"].map { |option| option["value"] }
+          else
+            []
+          end
+        end
+
+        def required_keys
+          super.merge(
+            "options" => Array
+          )
+        end
+
+        def ensure_at_least_one_option
+          return true if attribute["options"].length.positive?
+
+          @errors << "Must provide at least 1 option for radio type variable"
+          false
+        end
+
+        def ensure_options_are_valid
+          return true if attribute["options"].all? { |option|
+            select_option_valid?(option)
+          }
+
+          @errors << "All options for radio type variable must specify a label and value"
+          false
+        end
+
+        def select_option_valid?(option)
+          option.is_a?(Hash) &&
+            option.key?("value") &&
+            option.key?("label")
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/range.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to range-type variables.
+      class Range < Base
+        private
+
+        def optional_keys
+          super.merge(
+            "min" => Object,
+            "max" => Object,
+            "step" => Object,
+            "unit" => String
+          )
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/select.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to select-type variables.
+      class Select < Base
+        def validate
+          super &&
+            ensure_at_least_one_option &&
+            ensure_options_are_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          if attribute["options"].is_a?(Array)
+            attribute["options"].map { |option|
+              option["value"] if option.is_a?(Hash)
+            }
+          else
+            []
+          end
+        end
+
+        def required_keys
+          super.merge(
+            "options" => Array
+          )
+        end
+
+        def ensure_at_least_one_option
+          return true if attribute["options"].length.positive?
+
+          @errors << "Must provide at least 1 option for select type variable"
+          false
+        end
+
+        def select_option_validate(option)
+          option.is_a?(Hash) &&
+            option.key?("value") &&
+            option.key?("label")
+        end
+
+        def ensure_options_are_valid
+          return true if attribute["options"].all? { |option|
+            select_option_validate(option)
+          }
+
+          @errors << "All options for select type variable must specify a label and value"
+          false
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/schema_attributes/variant.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Validator
+    class SchemaAttribute
+      # :documented:
+      # Attribute validations specific to variant-type variables.
+      class Variant < Base
+        ALLOWED_DEFAULT_VALUES = %w[random].freeze
+
+        def validate
+          super &&
+            ensure_default_values_are_valid
+        end
+
+        private
+
+        def permitted_values_for_default_key
+          if attribute["array"]
+            Array
+          else
+            String
+          end
+        end
+
+        def ensure_default_values_are_valid
+          return true unless attribute.key?("default")
+
+          if attribute["array"]
+            attribute["default"].all? { |value| default_value_is_valid?(value) }
+          else
+            default_value_is_valid?(attribute["default"])
+          end
+        end
+
+        def default_value_is_valid?(value)
+          value = value.downcase
+          if !ALLOWED_DEFAULT_VALUES.include?(value)
+            @errors << "\"default\" for variant-type variables must be "\
+                       "one of: #{ALLOWED_DEFAULT_VALUES.join(', ')}"
+            false
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/canvas/version.rb

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

data/lib/canvas.rb

@@ -1,17 +1,35 @@
-require_relative "canvas/version"
-require_relative "canvas/cli"
-require_relative "canvas/lint"
-require_relative "canvas/validators/html"
-require_relative "canvas/validators/liquid"
-require_relative "canvas/check"
-require_relative "canvas/offense"
-require_relative "canvas/checks"
+# frozen_string_literal: true
 
-Dir[__dir__ + "/canvas/{checks,services}/*.rb"].each { |file| require file }
+module Canvas
+  autoload :Check, "canvas/check"
+  autoload :Checks, "canvas/checks"
+  autoload :Cli, "canvas/cli"
+  autoload :Constants, "canvas/constants"
+  autoload :Lint, "canvas/lint"
+  autoload :Offense, "canvas/offense"
+  autoload :Version, "canvas/version"
+end
+
+# We need to ensure Canvas::Validator::SchemaAttribute::Base is required first
+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 do |file|
+  require file
+end
+
+files = Dir["#{__dir__}/canvas/{checks,services,validators}/*.rb"]
+files.each do |file|
+  require file
+end
 
 Canvas::Checks.register(Canvas::RequiredFilesCheck)
 Canvas::Checks.register(Canvas::ValidHtmlCheck)
 Canvas::Checks.register(Canvas::ValidLiquidCheck)
-
-module Canvas
-end
+Canvas::Checks.register(Canvas::ValidJsonCheck)
+Canvas::Checks.register(Canvas::ValidSassCheck)
+Canvas::Checks.register(Canvas::ValidBlockSchemasCheck)
+Canvas::Checks.register(Canvas::ValidMenuSchemaCheck)
+Canvas::Checks.register(Canvas::ValidFooterSchemaCheck)
+Canvas::Checks.register(Canvas::ValidCustomTypesCheck)

data/lib/easol/canvas.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Enables using this gem "as is"
+require_relative "../canvas"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,64 +9,78 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: cli-ui
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 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
@@ -83,16 +97,45 @@ files:
 - lib/canvas/check.rb
 - 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
 - lib/canvas/checks/valid_liquid_check.rb
+- lib/canvas/checks/valid_menu_schema_check.rb
+- lib/canvas/checks/valid_sass_check.rb
 - lib/canvas/cli.rb
+- lib/canvas/constants.rb
 - lib/canvas/lint.rb
 - lib/canvas/offense.rb
+- lib/canvas/services/expand_attributes.rb
+- 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
 - lib/canvas/validators/liquid.rb
+- lib/canvas/validators/menu_schema.rb
+- lib/canvas/validators/sass.rb
+- lib/canvas/validators/schema_attribute.rb
+- lib/canvas/validators/schema_attributes/base.rb
+- lib/canvas/validators/schema_attributes/color.rb
+- lib/canvas/validators/schema_attributes/image.rb
+- lib/canvas/validators/schema_attributes/link.rb
+- lib/canvas/validators/schema_attributes/number.rb
+- lib/canvas/validators/schema_attributes/page.rb
+- lib/canvas/validators/schema_attributes/post.rb
+- lib/canvas/validators/schema_attributes/product.rb
+- lib/canvas/validators/schema_attributes/radio.rb
+- lib/canvas/validators/schema_attributes/range.rb
+- lib/canvas/validators/schema_attributes/select.rb
+- lib/canvas/validators/schema_attributes/variant.rb
 - lib/canvas/version.rb
-homepage: 
+- lib/easol/canvas.rb
+homepage: https://rubygems.org/gems/easol-canvas
 licenses:
 - MIT
 metadata: {}