easol-canvas 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe5e6dba572cf93a26d99560c7f36cd3f7f2188c019f5c5bd2429c6b897dd20
-  data.tar.gz: df34c9f374a73b17f47e4486345d6f6c21f4f184640d72976f664e3bf873e4ee
+  metadata.gz: 97ee44a992eb400c6fe2eedd35e6bb395ebc05e2f59f039ea9335194ff64fe83
+  data.tar.gz: 2684ff4ca3910fab9f0cd3bc36cb0c847f31565b1d3f8576964102a28773f247
 SHA512:
-  metadata.gz: d42d0a2cecd8040521956b2bb2a7380c08471e1aebfaf162a652b61a532bda67de5426ffba517b75bbc50449ac65eccbc6df78e009103c6ccc5e86874184c732
-  data.tar.gz: b4590073ce09eef3e258f924b66bfb0f996b88dacfbfbc72c1d0120f8fe96fafc30911015ae31df76836d665efea529db0af9bf3184cd6212747993f8c3a5d1e
+  metadata.gz: 28c155af546e6898977757280894cba8ab26942aa1883c5b3ff752f3d7256b68c0631b9d18b6e29df8629d79e94a488739d2c9d0d1d1563dc8f4672f91d164ff
+  data.tar.gz: 3f743a067e8621d1b0893fe41afa8746b60dcc87a4398214b7d8b45ae66648088c22db84e2ed23b26df72c586f19b0547df3a6c8c354f36a005556262fef5a98

data/lib/canvas/checks/valid_sass_check.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Canvas
+  # :documented:
+  #
+  # This check will find all files ending in .css, .scss or .sass
+  # and run them through the sass validator - {Canvas::Validator::Sass}.
+  class ValidSassCheck < Check
+    def run
+      sass_files.each do |filename|
+        file = File.read(filename)
+        validator = Validator::Sass.new(file)
+
+        next if validator.validate
+
+        validator.errors.each do |message|
+          @offenses << Offense.new(
+            message: "Invalid Sass: #{filename} - \n#{message}"
+          )
+        end
+      end
+    end
+
+    private
+
+    def sass_files
+      Dir.glob("**/*.{css,scss,sass}")
+    end
+  end
+end

data/lib/canvas/validators/custom_type.rb

@@ -38,6 +38,7 @@ module Canvas
           ensure_has_required_keys &&
           ensure_no_unrecognized_keys &&
           ensure_keys_are_correct_types &&
+          ensure_key_value_is_not_reserved &&
           ensure_no_duplicate_attributes &&
           ensure_attributes_are_valid &&
           ensure_first_attribute_not_array
@@ -91,6 +92,17 @@ module Canvas
         true
       end
 
+      # Ensuring the value for key doesn't clash with our primitive type keys.
+      # See {Canvas::Constants::PRIMITIVE_TYPES}
+      def ensure_key_value_is_not_reserved
+        if schema["key"] && Constants::PRIMITIVE_TYPES.include?(schema["key"].downcase)
+          @errors << "\"key\" can't be one of these reserved words: #{Constants::PRIMITIVE_TYPES.join(', ')}"
+          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

data/lib/canvas/validators/sass.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "sassc"
+
+module Canvas
+  module Validator
+    # :documented:
+    #
+    # This validator can be used to validate Sass.
+    class Sass
+      attr_reader :errors
+
+      def initialize(file)
+        @file = file
+      end
+
+      def validate
+        SassC::Engine.new(@file, style: :compressed).render
+        true
+      rescue SassC::SyntaxError => e
+        @errors = [e.message]
+        false
+      end
+    end
+  end
+end

data/lib/canvas/version.rb

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

data/lib/canvas.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "canvas/version"
-require_relative "canvas/constants"
-require_relative "canvas/cli"
-require_relative "canvas/lint"
-require_relative "canvas/check"
-require_relative "canvas/offense"
-require_relative "canvas/checks"
+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"
@@ -26,10 +28,8 @@ Canvas::Checks.register(Canvas::RequiredFilesCheck)
 Canvas::Checks.register(Canvas::ValidHtmlCheck)
 Canvas::Checks.register(Canvas::ValidLiquidCheck)
 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)
-
-module Canvas
-end

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: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-01 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -90,6 +104,7 @@ files:
 - 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
@@ -104,6 +119,7 @@ files:
 - 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
@@ -118,6 +134,7 @@ files:
 - lib/canvas/validators/schema_attributes/select.rb
 - lib/canvas/validators/schema_attributes/variant.rb
 - lib/canvas/version.rb
+- lib/easol/canvas.rb
 homepage: https://rubygems.org/gems/easol-canvas
 licenses:
 - MIT