easol-canvas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3adb680aaee894634145000781ac9b4fbc7d4429f165bd70482c04f3fbdb7c6b
+  data.tar.gz: b787e246b9be34acebcb80454504632a4b56e48dbd3e7c79755e33bf2272398a
+SHA512:
+  metadata.gz: 7d6db23a8b543fbace909d12fae0c4293ea040dccc11180d12f0265afb0b89f405b8d35fb5d957ac8f4a1c4de0e084c6bc82ebfe79bd809669634678863a9220
+  data.tar.gz: 92323781eab651622fc54fe94f43305075ebcdfb9046c056152d62cc4645d77b03f65a2bf569739ad8d74e22366fc814a19d8bbce41a16a8aed9ab02e00d6ddb

data/bin/canvas

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/canvas'
+
+Canvas::Cli.start(ARGV)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/canvas/check.rb

@@ -0,0 +1,19 @@
+require 'cli/ui'
+
+module Canvas
+  class Check
+    attr_reader :offenses
+
+    def initialize
+      @offenses = []
+    end
+
+    def run
+      raise NotImplementedError
+    end
+
+    def failed?
+      @offenses.any?
+    end
+  end
+end

data/lib/canvas/checks/required_files_check.rb

@@ -0,0 +1,22 @@
+module Canvas
+  class RequiredFilesCheck < Check
+    REQUIRED_FILES = [
+      "templates/product/index.{html,liquid}",
+      "templates/blog_overview/index.{html,liquid}",
+      "templates/blog_post/index.{html,liquid}",
+      "partials/footer/index.{html,liquid}",
+      "partials/menu/index.{html,liquid}",
+      "assets/index.css"
+    ].freeze
+
+    def run
+      REQUIRED_FILES.each do |filename|
+        next unless Dir.glob(filename).empty?
+
+        @offenses << Offense.new(
+          message: "Missing file: #{filename}"
+        )
+      end
+    end
+  end
+end

data/lib/canvas/checks/valid_html_check.rb

@@ -0,0 +1,22 @@
+module Canvas
+  class ValidHtmlCheck < Check
+    def run
+      html_files.each do |filename|
+        file = File.read(filename)
+        validator = Validator::Html.new(file)
+
+        next if validator.validate
+
+        validator.errors.map(&:message).each do |message|
+          @offenses << Offense.new(
+            message: "Invalid HTML: #{filename} - \n#{message}"
+          )
+        end
+      end
+    end
+
+    def html_files
+      Dir.glob("**/*.{html,liquid}")
+    end
+  end
+end

data/lib/canvas/checks/valid_liquid_check.rb

@@ -0,0 +1,40 @@
+module Canvas
+  class ValidLiquidCheck < Check
+    def run
+      register_tags!
+
+      liquid_files.each do |filename|
+        file = File.read(filename)
+        validator = Validator::Liquid.new(file)
+
+        next if validator.validate
+
+        validator.errors.map(&:message).each do |message|
+          @offenses << Offense.new(
+            message: "Invalid Liquid: #{filename} - \n#{message}"
+          )
+        end
+      end
+    end
+
+    private
+
+    def liquid_files
+      Dir.glob("**/*.{html,liquid}")
+    end
+
+    def register_tag(name, klass)
+      ::Liquid::Template.register_tag(name, klass)
+    end
+
+    # These are the tags that we define in the Rails app. If we add a new custom tag
+    # in the Rails app, we'll need to register it here.
+    def register_tags!
+      register_tag("form", ::Liquid::Block)
+      register_tag("product_search", ::Liquid::Block)
+      register_tag("easol_badge", ::Liquid::Tag)
+      register_tag("accommodation_availability", ::Liquid::Block)
+      register_tag("cache", ::Liquid::Block)
+    end
+  end
+end

data/lib/canvas/checks.rb

@@ -0,0 +1,19 @@
+module Canvas
+  class Checks
+    class << self
+      def registered
+        @checks ||= []
+      end
+
+      def register(klass)
+        @checks ||= []
+        return if @checks.include?(klass)
+        @checks << klass
+      end
+      
+      def deregister_all!
+        @checks = []
+      end
+    end
+  end
+end

data/lib/canvas/cli.rb

@@ -0,0 +1,12 @@
+require "thor"
+require 'cli/ui'
+
+module Canvas
+  class Cli < Thor
+    desc "lint", "Prints a hello world message"
+    def lint
+      CLI::UI::StdoutRouter.enable
+      Canvas::Lint.new.run
+    end
+  end
+end

data/lib/canvas/lint.rb

@@ -0,0 +1,44 @@
+require 'cli/ui'
+
+module Canvas
+  class Lint
+    def run
+      output_context = CLI::UI::SpinGroup.new(auto_debrief: false)
+
+      @checks = Checks.registered.map(&:new)
+
+      @checks.each do |check|
+        run_check(check, output_context)
+      end
+
+      output_context.wait
+
+      if @checks.any?(&:failed?)
+        puts debrief_message
+      end
+    end
+
+    private
+
+    def run_check(check, output_context)
+      output_context.add(check.class.name) do
+        check.run
+        raise if check.offenses.any?
+      end
+    end
+
+    def debrief_message
+      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|
+              CLI::UI.fmt "{{x}} #{offense.message}"
+            end
+            puts output.join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/canvas/offense.rb

@@ -0,0 +1,9 @@
+module Canvas
+  class Offense
+    attr_reader :message
+
+    def initialize(message:)
+      @message = message
+    end
+  end
+end

data/lib/canvas/services/front_matter_extractor.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module Canvas
+  # :documented:
+  # This service can be used to extract front matter from a liquid string.
+  class FrontMatterExtractor
+    attr_accessor :front_matter, :html
+
+    def initialize(full_markup)
+      @front_matter = extract_front_matter(full_markup)
+      @html = extract_html(full_markup)
+    end
+
+    private
+
+    # @return [String] the front matter, with the rest of the HTML stripped out
+    def extract_front_matter(full_markup)
+      return if full_markup.nil?
+
+      front_matter, body = scan(full_markup)
+      front_matter unless [nil, ""].include?(body)
+    end
+
+    # @return [String] the HTML, with the front matter stripped out
+    def extract_html(full_markup)
+      return if full_markup.nil?
+
+      liquid_markup_stripped = full_markup.gsub("\n\n", "\n")
+      _, body = scan(liquid_markup_stripped)
+      body || full_markup
+    end
+
+    # @return [Array<String>] an array consisting of two items: the front matter
+    # and the HTML content.
+    def scan(markup)
+      markup = markup.gsub(/\t/, "  ")
+      [*markup.match(/(?:---\s+(.*?)\s+---\s+)(.*\s?)$/m)&.captures]
+    end
+  end
+end

data/lib/canvas/validators/html.rb

@@ -0,0 +1,52 @@
+require "nokogiri"
+require "liquid"
+
+module Canvas
+  module Validator
+    class Html
+      LIQUID_TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
+      LIQUID_VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+      LIQUID_TAG_OR_VARIABLE = /#{LIQUID_TAG}|#{LIQUID_VARIABLE}/om
+
+      attr_reader :errors
+
+      def initialize(file)
+        @file = file
+      end
+
+      def validate
+        doc = Nokogiri::HTML5.fragment(extracted_html, max_errors: 1)
+        @errors = doc.errors
+        doc.errors.empty?
+      end
+
+      private
+
+      def extracted_html
+        html = strip_out_front_matter(@file)
+        strip_out_liquid(html)
+      end
+
+      # We want to strip out the liquid tags and replace them with the
+      # same number of empty space characters, so that the linter
+      # reports the correct character number.
+      def strip_out_liquid(html)
+        html.gsub(LIQUID_TAG_OR_VARIABLE) { |tag| " " * tag.size }
+      end
+
+      # We want to strip out the front matter and replace it
+      # with empty new lines, so that linter output reports the
+      # correct line numbers
+      def strip_out_front_matter(html)
+        extractor = Canvas::FrontMatterExtractor.new(html)
+
+        if extractor.front_matter
+          num_lines = extractor.front_matter.lines.size - 1
+          html.sub(extractor.front_matter, "\n" * num_lines)
+        else
+          html
+        end
+      end
+    end
+  end
+end

data/lib/canvas/validators/liquid.rb

@@ -0,0 +1,43 @@
+require "nokogiri"
+require "liquid"
+
+module Canvas
+  module Validator
+    class Liquid
+      attr_reader :errors
+
+      def initialize(file)
+        @file = file
+      end
+
+      def validate
+        liquid = strip_out_front_matter(@file)
+        ::Liquid::Template.parse(
+          liquid,
+          line_numbers: true,
+          error_mode: :warn
+        )
+        true
+      rescue ::Liquid::SyntaxError => e
+        @errors = [e]
+        false
+      end
+
+      private
+
+      # We want to strip out the front matter and replace it
+      # with empty new lines, so that linter output reports the
+      # correct line numbers
+      def strip_out_front_matter(html)
+        extractor = Canvas::FrontMatterExtractor.new(html)
+
+        if extractor.front_matter
+          num_lines = extractor.front_matter.lines.size - 1
+          html.sub(extractor.front_matter, "\n" * num_lines)
+        else
+          html
+        end
+      end
+    end
+  end
+end

data/lib/canvas/version.rb

@@ -0,0 +1,3 @@
+module Canvas
+  VERSION = "0.1.0"
+end

data/lib/canvas.rb

@@ -0,0 +1,17 @@
+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"
+
+Dir[__dir__ + "/canvas/{checks,services}/*.rb"].each { |file| require file }
+
+Canvas::Checks.register(Canvas::RequiredFilesCheck)
+Canvas::Checks.register(Canvas::ValidHtmlCheck)
+Canvas::Checks.register(Canvas::ValidLiquidCheck)
+
+module Canvas
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: easol-canvas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Byrne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+  they confirm with the Easol theme spec.
+email: kyle@easol.com
+executables:
+- canvas
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/canvas
+- bin/rspec
+- lib/canvas.rb
+- lib/canvas/check.rb
+- lib/canvas/checks.rb
+- lib/canvas/checks/required_files_check.rb
+- lib/canvas/checks/valid_html_check.rb
+- lib/canvas/checks/valid_liquid_check.rb
+- lib/canvas/cli.rb
+- lib/canvas/lint.rb
+- lib/canvas/offense.rb
+- lib/canvas/services/front_matter_extractor.rb
+- lib/canvas/validators/html.rb
+- lib/canvas/validators/liquid.rb
+- lib/canvas/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: CLI to help with building themes for Easol
+test_files: []