platformos-check 0.0.1

data/lib/platformos_check/tags/log.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Log < Base
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.value_expr
+          ].compact + @node.attributes_expr.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/parse_json.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class ParseJson < Liquid::Block
+      SYNTAX = /(#{Liquid::VariableSignature}+)/o
+
+      attr_reader :to
+
+      def initialize(tag_name, markup, options)
+        super
+        raise Liquid::SyntaxError, "Syntax Error in 'parse_json' - Valid syntax: parse_json [var]" unless markup =~ SYNTAX
+
+        @to = Regexp.last_match(1)
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          super + [@node.to]
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/print.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Print < Liquid::Tag
+      attr_reader :var
+
+      def initialize(tag_name, markup, options)
+        super
+        @var = Liquid::Variable.new(markup, options)
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [@node.var]
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/redirect_to.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class RedirectTo < Base
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.value_expr
+          ].compact + @node.attributes_expr.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/render.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Render < Liquid::Tag
+      SYNTAX = /
+      (
+        ## for {% render "snippet" %}
+          #{Liquid::QuotedString}+ |
+        ## for {% render block %}
+        ## We require the variable # segment to be at the beginning of the
+        ## string (with \A). This is to prevent code like {% render !foo! %}
+        ## from parsing
+        \A#{Liquid::VariableSegment}+
+      )
+      ## for {% render "snippet" with product as p %}
+      ## or {% render "snippet" for products p %}
+      (\s+(with|#{Liquid::Render::FOR})\s+(#{Liquid::QuotedFragment}+))?
+        (\s+(?:as)\s+(#{Liquid::VariableSegment}+))?
+        ## variables passed into the tag (e.g. {% render "snippet", var1: value1, var2: value2 %}
+        ## are not matched by this regex and are handled by Liquid::Render.initialize
+        /xo
+
+      disable_tags "include"
+
+      attr_reader :template_name_expr, :variable_name_expr, :attributes, :duplicated_attrs
+
+      def initialize(tag_name, markup, options)
+        super
+
+        raise Liquid::SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
+
+        template_name = Regexp.last_match(1)
+        with_or_for = Regexp.last_match(3)
+        variable_name = Regexp.last_match(4)
+
+        @alias_name = Regexp.last_match(6)
+        @variable_name_expr = variable_name ? parse_expression(variable_name) : nil
+        @template_name_expr = parse_expression(template_name)
+        @for = (with_or_for == Liquid::Render::FOR)
+
+        @attributes = {}
+        @duplicated_attrs = []
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          @duplicated_attrs << key if @attributes.key?(key)
+          @attributes[key] = parse_expression(value)
+        end
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.template_name_expr,
+            @node.variable_name_expr
+          ] + @node.attributes.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/response_headers.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class ResponseHeaders < Liquid::Tag
+      attr_reader :var
+
+      def initialize(tag_name, markup, options)
+        super
+        @var = Liquid::Variable.new(markup, options)
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [@node.var]
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/response_status.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class ResponseStatus < Liquid::Tag
+      attr_reader :var
+
+      def initialize(tag_name, markup, options)
+        super
+        @var = Liquid::Variable.new(markup, options)
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [@node.var]
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/return.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Return < Liquid::Tag
+      attr_reader :var
+
+      def initialize(tag_name, markup, options)
+        super
+        @var = Liquid::Variable.new(markup, options)
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [@node.var]
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/session.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Session < Liquid::Tag
+      SYNTAX = /(#{Liquid::VariableSignature}+)\s*=\s*(.*)\s*/om
+
+      attr_reader :from
+
+      def initialize(tag_name, markup, options)
+        super
+        raise Liquid::SyntaxError, "Syntax Error in 'session' - Valid syntax: session [var1] = [var2]" unless markup =~ SYNTAX
+
+        @to = Regexp.last_match(1)
+        @from = Liquid::Variable.new(Regexp.last_match(2), options)
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.from
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/sign_in.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class SignIn < Base
+      SYNTAX = /\A([\w-]+[\s,]*[\w\s,]*)\s*(user_id:\s*(.+))?\z/
+      VALID_ATTRUBTES = %w[user_id timeout_in_minutes].freeze
+
+      def initialize(tag_name, markup, options)
+        super
+
+        raise Liquid::SyntaxError, "Syntax Error in 'sign_in' - Valid syntax: sign_in user_id: [user_id], timeout_in_minutes: [timeout_in_minutes]" if attributes_expr['user_id'].nil?
+
+        wrong_attributes = attributes_expr.keys - VALID_ATTRUBTES
+        raise Liquid::SyntaxError, "Syntax Error in 'sign_in' - Unknown argument(s): #{wrong_attributes.join(', ')}. Valid arguments: #{VALID_ATTRUBTES}" unless wrong_attributes.empty?
+      end
+
+      def parse_main_value(_tag_name, _markup); end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          @node.attributes_expr.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/spam_protection.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class SpamProtection < Base
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.value_expr
+          ].compact + @node.attributes_expr.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/theme_render.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class ThemeRender < Liquid::Tag
+      SYNTAX = /
+      (
+        ## for {% render "snippet" %}
+          #{Liquid::QuotedString}+ |
+        ## for {% render block %}
+        ## We require the variable # segment to be at the beginning of the
+        ## string (with \A). This is to prevent code like {% render !foo! %}
+        ## from parsing
+        \A#{Liquid::VariableSegment}+
+      )
+      ## for {% render "snippet" with product as p %}
+      ## or {% render "snippet" for products p %}
+      (\s+(with|#{Liquid::Render::FOR})\s+(#{Liquid::QuotedFragment}+))?
+        (\s+(?:as)\s+(#{Liquid::VariableSegment}+))?
+        ## variables passed into the tag (e.g. {% render "snippet", var1: value1, var2: value2 %}
+        ## are not matched by this regex and are handled by Liquid::Render.initialize
+        /xo
+
+      disable_tags "include"
+
+      attr_reader :template_name_expr, :variable_name_expr, :attributes
+
+      def initialize(tag_name, markup, options)
+        super
+
+        raise Liquid::SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
+
+        template_name = Regexp.last_match(1)
+        with_or_for = Regexp.last_match(3)
+        variable_name = Regexp.last_match(4)
+
+        @alias_name = Regexp.last_match(6)
+        @variable_name_expr = variable_name ? parse_expression(variable_name) : nil
+        @template_name_expr = parse_expression(template_name)
+        @for = (with_or_for == Liquid::Render::FOR)
+
+        @attributes = {}
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          @attributes[key] = parse_expression(value)
+        end
+      end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.template_name_expr,
+            @node.variable_name_expr
+          ] + @node.attributes.values
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags/try.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    class Try < BaseBlock
+      SYNTAX = /(#{::Liquid::VariableSignature}+)/o
+
+      attr_reader :error_var
+
+      def initialize(tag_name, markup, options)
+        super
+        @try_block = new_body
+        @catch_block = nil
+        @ensure_block = nil
+      end
+
+      def parse(tokens)
+        if parse_body(@try_block, tokens)
+          parse_body(@catch_block, tokens) if @catch_block
+          parse_body(@ensure_block, tokens) if @ensure_block
+        end
+        if blank?
+          @try_block.remove_blank_strings
+          @catch_block&.remove_blank_strings
+          @ensure_block&.remove_blank_strings
+        end
+        @try_block.freeze
+        @catch_block&.freeze
+        @ensure_block&.freeze
+      end
+
+      def nodelist
+        [@try_block, @catch_block, @ensure_block].compact
+      end
+
+      def unknown_tag(tag, markup, tokens)
+        if tag == 'catch'
+          raise Liquid::SyntaxError, "Syntax Error in 'try' - Valid syntax: try ... catch [var] ... endtry" unless markup =~ SYNTAX
+
+          @error_var = Regexp.last_match(1)
+
+          @catch_block = new_body
+        elsif tag == 'ensure'
+          @ensure_block = new_body
+        else
+          super
+        end
+      end
+
+      def parse_main_value(tag_name, markup); end
+
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          @node.nodelist
+        end
+      end
+    end
+  end
+end

data/lib/platformos_check/tags.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module Tags
+    # Copied tags parsing code from storefront-renderer
+
+    class ContentFor < BaseBlock; end
+
+    class Yield < Base; end
+
+    class IncludeForm < Base
+      class ParseTreeVisitor < Liquid::ParseTreeVisitor
+        def children
+          [
+            @node.main_value
+          ] + @node.attributes_expr.values
+        end
+      end
+    end
+
+    class << self
+      attr_writer :register_tags
+
+      def register_tags?
+        @register_tags
+      end
+
+      def register_tag(name, klass)
+        Liquid::Template.register_tag(name, klass)
+      end
+
+      def register_tags!
+        return if !register_tags? || (defined?(@registered_tags) && @registered_tags)
+
+        @registered_tags = true
+        register_tag('form', Form)
+        register_tag('include_form', IncludeForm)
+        register_tag('render', Render)
+        register_tag('theme_render', ThemeRender)
+        register_tag('theme_render_rc', ThemeRender)
+        register_tag('log', Log)
+        register_tag('cache', Cache)
+        register_tag('print', Print)
+        register_tag('parse_json', ParseJson)
+        register_tag('try_rc', Try)
+        register_tag('try', Try)
+        register_tag('export', Export)
+        register_tag('return', Return)
+        register_tag('redirect_to', RedirectTo)
+        register_tag('response_headers', ResponseHeaders)
+        register_tag('response_status', ResponseStatus)
+        register_tag('hash_assign', HashAssign)
+        register_tag('background', Background)
+        register_tag('content_for', ContentFor)
+        register_tag('session', Session)
+        register_tag('sign_in', SignIn)
+        register_tag('yield', Yield)
+        register_tag('graphql', Graphql)
+        register_tag('function', Function)
+        register_tag('spam_protection', SpamProtection)
+      end
+    end
+    self.register_tags = true
+  end
+end

data/lib/platformos_check/translation_file.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  class TranslationFile < YamlFile
+  end
+end

data/lib/platformos_check/user_schema_file.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  class UserSchemaFile < YamlFile
+  end
+end

data/lib/platformos_check/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  VERSION = "0.0.1"
+end

data/lib/platformos_check/yaml_check.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  class YamlCheck < Check
+    extend ChecksTracking
+
+    def add_offense(message, markup: nil, line_number: nil, app_file: nil, &block)
+      offenses << Offense.new(check: self, message:, markup:, line_number:, app_file:, correction: block)
+    end
+  end
+end

data/lib/platformos_check/yaml_file.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module PlatformosCheck
+  class YamlFile < AppFile
+    def initialize(relative_path, storage)
+      super
+      @loaded = false
+      @content = nil
+      @parser_error = nil
+    end
+
+    def content
+      load!
+      @content
+    end
+
+    def parse_error
+      load!
+      @parser_error
+    end
+
+    def update_contents(new_content = {})
+      raise ArgumentError if new_content.is_a?(String)
+
+      @content = new_content
+    end
+
+    def write
+      pretty = YAML.dump(@content)
+      return unless source.rstrip != pretty.rstrip
+
+      # Most editors add a trailing \n at the end of files. Here we
+      # try to maintain the convention.
+      eof = source.end_with?("\n") ? "\n" : ""
+      @storage.write(@relative_path, pretty.gsub("\n", @eol) + eof)
+      @source = pretty
+    end
+
+    def yaml?
+      true
+    end
+
+    private
+
+    def load!
+      return if @loaded
+
+      @content = YAML.load(source, aliases: true) || {}
+    rescue Psych::SyntaxError => e
+      @parser_error = e
+    ensure
+      @loaded = true
+    end
+  end
+end

data/lib/platformos_check.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "liquid"
+
+require_relative "platformos_check/version"
+require_relative "platformos_check/bug"
+require_relative "platformos_check/exceptions"
+require_relative "platformos_check/json_helper"
+require_relative "platformos_check/app_file_rewriter"
+require_relative "platformos_check/app_file"
+require_relative "platformos_check/yaml_file"
+require_relative "platformos_check/translation_file"
+require_relative "platformos_check/schema_file"
+require_relative "platformos_check/config_file"
+require_relative "platformos_check/user_schema_file"
+require_relative "platformos_check/graphql_file"
+require_relative "platformos_check/liquid_file"
+require_relative "platformos_check/page_file"
+require_relative "platformos_check/partial_file"
+require_relative "platformos_check/layout_file"
+require_relative "platformos_check/migration_file"
+require_relative "platformos_check/sms_file"
+require_relative "platformos_check/email_file"
+require_relative "platformos_check/api_call_file"
+require_relative "platformos_check/asset_file"
+require_relative "platformos_check/json_file"
+require_relative "platformos_check/analyzer"
+require_relative "platformos_check/check"
+require_relative "platformos_check/checks_tracking"
+require_relative "platformos_check/liquid_check"
+require_relative "platformos_check/html_check"
+require_relative "platformos_check/yaml_check"
+require_relative "platformos_check/cli"
+require_relative "platformos_check/disabled_check"
+require_relative "platformos_check/disabled_checks"
+require_relative "platformos_check/regex_helpers"
+require_relative "platformos_check/json_helpers"
+require_relative "platformos_check/position_helper"
+require_relative "platformos_check/position"
+require_relative "platformos_check/checks"
+require_relative "platformos_check/config"
+require_relative "platformos_check/node"
+require_relative "platformos_check/tags/base_tag_methods"
+require_relative "platformos_check/tags/base"
+require_relative "platformos_check/tags/base_block"
+require_relative "platformos_check/tags/background"
+require_relative "platformos_check/tags/cache"
+require_relative "platformos_check/tags/export"
+require_relative "platformos_check/tags/form"
+require_relative "platformos_check/tags/function"
+require_relative "platformos_check/tags/graphql"
+require_relative "platformos_check/tags/hash_assign"
+require_relative "platformos_check/tags/log"
+require_relative "platformos_check/tags/parse_json"
+require_relative "platformos_check/tags/print"
+require_relative "platformos_check/tags/redirect_to"
+require_relative "platformos_check/tags/render"
+require_relative "platformos_check/tags/response_headers"
+require_relative "platformos_check/tags/response_status"
+require_relative "platformos_check/tags/return"
+require_relative "platformos_check/tags/session"
+require_relative "platformos_check/tags/sign_in"
+require_relative "platformos_check/tags/spam_protection"
+require_relative "platformos_check/tags/theme_render"
+require_relative "platformos_check/tags/try"
+require_relative "platformos_check/tags"
+require_relative "platformos_check/liquid_node"
+require_relative "platformos_check/html_node"
+require_relative "platformos_check/offense"
+require_relative "platformos_check/printer"
+require_relative "platformos_check/json_printer"
+require_relative "platformos_check/platformos_liquid"
+require_relative "platformos_check/string_helpers"
+require_relative "platformos_check/storage"
+require_relative "platformos_check/file_system_storage"
+require_relative "platformos_check/in_memory_storage"
+require_relative "platformos_check/app"
+require_relative "platformos_check/corrector"
+require_relative "platformos_check/liquid_visitor"
+require_relative "platformos_check/html_visitor"
+require_relative "platformos_check/language_server"
+
+Dir[__dir__ + "/platformos_check/checks/*.rb"].each { |file| require file }
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+module PlatformosCheck
+  def self.debug?
+    ENV["PLATFORMOS_CHECK_DEBUG"] == "true"
+  end
+
+  def self.debug_log_file
+    ENV.fetch("PLATFORMOS_CHECK_DEBUG_LOG_FILE", nil)
+  end
+
+  def self.with_liquid_c_disabled
+    if defined?(Liquid::C)
+      was_enabled = Liquid::C.enabled
+      Liquid::C.enabled = false if was_enabled
+    end
+    yield
+  ensure
+    Liquid::C.enabled = true if defined?(Liquid::C) && was_enabled
+  end
+end