platformos-check 0.4.3 → 0.4.5

data/data/platformos_liquid/documentation/latest.json

@@ -1,2 +1,2 @@
 
-{"revision":"949281126d705b543c2fa4e5f328c13ed411351a"}
+{"revision":"131bcc176b04bbd3cd19a57ac57395a74b949760"}

data/docker/lsp.Dockerfile

@@ -1,5 +1,6 @@
 FROM ruby:3.2-alpine
 
+ARG VERSION
 ENV WORKDIR /app
 ENV PLATFORMOS_CHECK_DEBUG true
 ENV PLATFORMOS_CHECK_DEBUG_LOG_FILE /tmp/platformos-check-debug.log
@@ -9,13 +10,12 @@ RUN apk add --update bash git openssh build-base && mkdir $WORKDIR
 WORKDIR $WORKDIR
 
 RUN git clone https://github.com/Platform-OS/platformos-lsp.git && \
-  touch $PLATFORMOS_CHECK_DEBUG_LOG_FILE && \
   cd platformos-lsp && \
   bundle install && \
-  gem build && gem install platformos-check-0.0.0.gem
+  gem build && gem install platformos-check-$VERSION.gem
 
 RUN adduser --disabled-password --gecos '' platformos && chown platformos:platformos -R /app
 
-ENTRYPOINT ["/app/platformos-lsp/exe/platformos-check-language-server"]
+ENTRYPOINT ["/app/platformos-lsp/bin/platformos-check-language-server"]
 
 USER platformos

data/docs/checks/form_action.md

@@ -0,0 +1,56 @@
+# Form action (`FormAction`)
+
+Form action defines the endpoint to which browser will make a request after submitting it.
+
+As a general rule you should use relative path like `action="/my/path"` instead of for example `action="my/path"` to avoid errors.
+
+## Check Details
+
+This check is aimed at ensuring you have not forgotten to start the path with /.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<form action="dummy/create">
+ ...
+</form>
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+<form action="/dummy/create">
+ ...
+</form>
+```
+
+```liquid
+<form action="{{ var }}">
+ ...
+</form>
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+FormAction:
+  enabled: true
+```
+
+## When Not To Use It
+
+There should be no cases where disabling this rule is needed.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.45.0.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/form_action.rb
+[docsource]: /docs/checks/form_action.md

data/lib/platformos_check/checks/form_action.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  class FormAction < HtmlCheck
+    severity :error
+    categories :html
+    doc docs_url(__FILE__)
+
+    def on_form(node)
+      action = node.attributes["action"]&.strip
+      return if action.nil?
+      return if action.empty?
+      return if action.start_with?('/', '{{')
+
+      add_offense("Use action=\"/#{action}\" (start with /) to ensure the form can be submitted multiple times in case of validation errors", node:)
+    end
+  end
+end

data/lib/platformos_check/checks/unused_assign.rb

@@ -34,6 +34,8 @@ module PlatformosCheck
     end
 
     def on_assign(node)
+      return if ignore_underscored?(node)
+
       @templates[node.app_file.name].assign_nodes[node.value.to] = node
     end
 
@@ -42,13 +44,13 @@ module PlatformosCheck
     end
 
     def on_function(node)
-      return if node.value.to.start_with?('_')
+      return if ignore_underscored?(node)
 
       @templates[node.app_file.name].assign_nodes[node.value.to] = node
     end
 
     def on_graphql(node)
-      return if node.value.to.start_with?('_')
+      return if ignore_underscored?(node)
 
       @templates[node.app_file.name].assign_nodes[node.value.to] = node
     end
@@ -101,5 +103,11 @@ module PlatformosCheck
         end
       end
     end
+
+    private
+
+    def ignore_underscored?(node)
+      node.value.to.start_with?('_')
+    end
   end
 end

data/lib/platformos_check/graphql_file.rb

@@ -75,6 +75,14 @@ module PlatformosCheck
       @defined_arguments ||= variables.map(&:name)
     end
 
+    def selections
+      definition.selections
+    end
+
+    def fragments
+      @fragments ||= parse.definitions.select { |d| d.is_a?(GraphQL::Language::Nodes::FragmentDefinition) }
+    end
+
     private
 
     def variables

data/lib/platformos_check/graphql_traverser.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module PlatformosCheck
+  class GraphqlTraverser
+    def initialize(graphql_file)
+      @graphql_file = graphql_file
+    end
+
+    def fields
+      pickup_fields(@graphql_file.selections, '')
+    end
+
+    private
+
+    def pickup_fields(selections, path = '')
+      selections = expand_fragments(selections)
+      fields = {}
+      fields['/'] = map_names_from_selections(selections) if path.empty?
+      selections.map do |selection|
+        current_path = File.join(path, name_from_selection(selection))
+        fields[current_path] = map_names_from_selections(expand_fragments(selection.selections))
+
+        child_fields = pickup_fields(selection.selections, current_path)
+        fields = fields.merge(child_fields)
+      end
+      fields
+    end
+
+    def map_names_from_selections(selections)
+      selections.map { |selection| name_from_selection(selection) }
+    end
+
+    def name_from_selection(selection)
+      selection.alias || selection.name
+    end
+
+    def expand_fragments(selections)
+      selections.map do |selection|
+        if selection.is_a?(GraphQL::Language::Nodes::FragmentSpread)
+          find_fragment(selection.name).selections
+        else
+          selection
+        end
+      end.flatten.uniq { |s| name_from_selection(s) }
+    end
+
+    def find_fragment(fragment_name)
+      @graphql_file.fragments.detect { |definition| definition.name == fragment_name }
+    end
+  end
+end

data/lib/platformos_check/in_memory_storage.rb

@@ -39,6 +39,10 @@ module PlatformosCheck
       @files.keys
     end
 
+    def files_with_content
+      @files
+    end
+
     def relative_path(absolute_path)
       Pathname.new(absolute_path).relative_path_from(@root).to_s
     end

data/lib/platformos_check/language_server/completion_providers/object_attribute_completion_provider.rb

@@ -3,7 +3,7 @@
 module PlatformosCheck
   module LanguageServer
     class ObjectAttributeCompletionProvider < CompletionProvider
-      def completions(context)
+      def completions(context, child_lookup = nil)
         content = context.content
         cursor = context.cursor
 
@@ -11,19 +11,27 @@ module PlatformosCheck
         return [] unless (variable_lookup = VariableLookupFinder.lookup(context))
         return [] if content[cursor - 1] == "." && content[cursor - 2] == "."
 
-        # Navigate through lookups until the last valid [object, property] level
-        object, property = VariableLookupTraverser.lookup_object_and_property(variable_lookup)
+        variable_lookup.lookups = variable_lookup.lookups + child_lookup.lookups if child_lookup&.lookups&.any?
 
-        # If the last lookup level is incomplete/invalid, use the partial term
-        # to filter object properties.
-        partial = partial_property_name(property, variable_lookup)
+        if variable_lookup.file_path
+          function_completion(variable_lookup)
+        elsif variable_lookup.lookups.first&.start_with?('graphql/')
+          graphql_completion(variable_lookup)
+        else
+          # Navigate through lookups until the last valid [object, property] level
+          object, property = VariableLookupTraverser.lookup_object_and_property(variable_lookup)
 
-        return [] unless object
+          # If the last lookup level is incomplete/invalid, use the partial term
+          # to filter object properties.
+          partial = partial_property_name(property, variable_lookup)
 
-        object
-          .properties
-          .select { |prop| partial.nil? || prop.name.start_with?(partial) }
-          .map { |prop| property_to_completion(prop) }
+          return [] unless object
+
+          object
+            .properties
+            .select { |prop| partial.nil? || prop.name.start_with?(partial) }
+            .map { |prop| property_to_completion(prop) }
+        end
       end
 
       private
@@ -43,6 +51,47 @@ module PlatformosCheck
           **doc_hash(content)
         }
       end
+
+      def find_file(file_name)
+        @storage
+          .platformos_app
+          .all
+          .find { |t| t.name == file_name }
+      end
+
+      def graphql_completion(variable_lookup)
+        graphql_file_name = variable_lookup.lookups.first.sub("graphql/", '')
+        graphql_file = find_file(graphql_file_name)
+        fields = GraphqlTraverser.new(graphql_file).fields
+        variable_path = File.join('', variable_lookup.lookups.slice(1..-1))
+        variable_properties = fields[variable_path]
+
+        variable_properties.map { |property| graphql_to_property_completion(property) }
+      end
+
+      def graphql_to_property_completion(property)
+        hash = {
+          'name' => property
+        }
+        object_entry = PlatformosLiquid::SourceIndex::ObjectEntry.new(hash)
+        property_to_completion(object_entry)
+      end
+
+      def function_completion(variable_lookup)
+        liquid_file = find_file(variable_lookup.file_path)
+        partial_content = liquid_file.source
+        lines = partial_content.split("\n")
+        partial_provider = ObjectAttributeCompletionProvider.new(@storage)
+
+        line_number_with_return = lines.rindex { |x| x.include?('return') }
+        partial_context = CompletionContext.new(
+          @storage,
+          liquid_file.relative_path.to_s,
+          line_number_with_return,
+          lines[line_number_with_return].size
+        )
+        partial_provider.completions(partial_context, variable_lookup)
+      end
     end
   end
 end

data/lib/platformos_check/language_server/variable_lookup_finder/assignments_finder/node_handler.rb

@@ -30,27 +30,7 @@ module PlatformosCheck
           end
 
           def on_function(node, scope)
-            # When a variable is redefined in a new scope we
-            # no longer can guarantee the type in the global scope
-            #
-            # Example:
-            # ```liquid
-            # {%- liquid
-            #   assign var1 = some_value
-            #
-            #   if condition
-            #     function var1 = 'another_value'
-            #            ^^^^ from here we no longer can guarantee
-            #                 the type of `var1` in the global scope
-            # -%}
-            # ```
-            p_scope = scope
-            while (p_scope = p_scope.parent)
-              p_scope.variables.delete(node.value.to)
-            end
-
-            scope << node
-            scope
+            on_assign(node, scope)
           end
 
           def on_graphql(node, scope)

data/lib/platformos_check/language_server/variable_lookup_finder/assignments_finder/scope.rb

@@ -21,9 +21,13 @@ module PlatformosCheck
             when Liquid::Assign
               variable_name = tag.to
               variables[variable_name] = as_potential_lookup(tag.from.name)
-            when Tags::Function, Tags::Graphql
+            when Tags::Function
               variable_name = tag.to
-              variables[variable_name] = literal_lookup(tag.from)
+              variables[variable_name] = as_potential_lookup_function_result(tag)
+            when Tags::Graphql
+              variable_name = tag.to
+              potential = as_potential_lookup_graphql(tag)
+              variables[variable_name] = potential
             when Liquid::For, Liquid::TableRow
               variable_name = tag.variable_name
               variables[variable_name] = as_potential_lookup(tag.collection_name, ['first'])
@@ -56,6 +60,19 @@ module PlatformosCheck
 
             PotentialLookup.new(name, lookups, variables)
           end
+
+          def as_potential_lookup_graphql(tag)
+            variable_lookup = tag.from.name
+            name = variable_lookup
+            variable_lookup.lookups.push
+
+            # TODO: this is smelly
+            PotentialLookup.new(name, ["graphql/#{tag.partial_name}"], variables)
+          end
+
+          def as_potential_lookup_function_result(tag)
+            PotentialLookup.new(tag.from, [], variables, tag.from)
+          end
         end
       end
     end

data/lib/platformos_check/language_server/variable_lookup_finder/constants.rb

@@ -27,6 +27,8 @@ module PlatformosCheck
             \s(?:
               if|elsif|unless|and|or|#{Liquid::Condition.operators.keys.join("|")}
               |echo
+              |return
+              |log
               |paginate
               |case|when
               |cycle

data/lib/platformos_check/language_server/variable_lookup_finder/potential_lookup.rb

@@ -3,7 +3,7 @@
 module PlatformosCheck
   module LanguageServer
     module VariableLookupFinder
-      class PotentialLookup < Struct.new(:name, :lookups, :scope)
+      class PotentialLookup < Struct.new(:name, :lookups, :scope, :file_path)
       end
     end
   end

data/lib/platformos_check/language_server/variable_lookup_finder.rb

@@ -15,7 +15,7 @@ module PlatformosCheck
 
         return if cursor_is_on_bracket_position_that_cant_be_completed(content, cursor)
 
-        variable_lookup = lookup_liquid_variable(content, cursor) || lookup_liquid_tag(content, cursor)
+        variable_lookup = lookup_liquid_variable(content, cursor) || lookup_liquid_variable_inside_liquid_tag(content, cursor) || lookup_liquid_tag(content, cursor)
 
         return variable_lookup if variable_lookup.is_a?(PotentialLookup)
         return unless variable_lookup.is_a?(Liquid::VariableLookup)
@@ -54,14 +54,20 @@ module PlatformosCheck
       end
 
       def as_potential_lookup(variable, lookups: nil)
-        PotentialLookup.new(variable.name, lookups || variable.lookups)
+        PotentialLookup.new(
+          variable.name,
+          lookups || variable.lookups,
+          nil,
+          variable.respond_to?(:file_path) ? variable.file_path : nil
+        )
       end
 
       def cursor_is_on_bracket_position_that_cant_be_completed(content, cursor)
         content_before_cursor = content[0..cursor - 1]
         return false unless /[\[\]]/.match?(content_before_cursor)
 
-        content_before_cursor =~ ENDS_IN_BRACKET_POSITION_THAT_CANT_BE_COMPLETED
+        line_with_cursor = content_before_cursor.split("\n").last
+        line_with_cursor =~ ENDS_IN_BRACKET_POSITION_THAT_CANT_BE_COMPLETED
       end
 
       def cursor_is_on_liquid_variable_lookup_position(content, cursor)
@@ -77,6 +83,50 @@ module PlatformosCheck
         )
       end
 
+      def lookup_liquid_variable_inside_liquid_tag(content, cursor)
+        return unless content.strip.start_with?(/{%\s*liquid/)
+
+        previous_char = content[cursor - 1]
+        is_in_variable_segment = previous_char =~ VARIABLE_LOOKUP_CHARACTERS
+        return unless is_in_variable_segment
+
+        start_index = content.slice(0, cursor).rindex("\n") + 1
+        end_index = cursor - 1
+
+        # We take the following content
+        # - start after the first two {{
+        # - end at cursor position
+        #
+        # That way, we'll have a partial liquid variable that
+        # can be parsed such that the "last" variable_lookup
+        # will be the one we're trying to complete.
+        markup = content[start_index..end_index]
+
+        # Early return for incomplete variables
+        return empty_lookup if /\s+$/.match?(markup)
+
+        # Now we go to hack city... The cursor might be in the middle
+        # of a string/square bracket lookup. We need to close those
+        # otherwise the variable parse won't work.
+        markup += "'" if markup.count("'").odd?
+        markup += '"' if markup.count('"').odd?
+        markup += "]" if UNCLOSED_SQUARE_BRACKET.match?(markup)
+
+        if markup.strip.split(' ').size > 1
+          begin
+            template = LiquidFile.parse(parseable_markup(content, cursor))
+            current_tag = template.root.nodelist[0]
+            return if current_tag.is_a?(Liquid::Tag)
+          rescue Liquid::SyntaxError
+            return
+          end
+        end
+
+        variable = variable_from_markup(markup)
+
+        variable_lookup_for_liquid_variable(variable)
+      end
+
       def lookup_liquid_variable(content, cursor)
         return unless cursor_is_on_liquid_variable_lookup_position(content, cursor)
 
@@ -139,7 +189,7 @@ module PlatformosCheck
         markup = parseable_markup(content, cursor)
         return empty_lookup if markup.empty?
 
-        template = Liquid::Template.parse(markup)
+        template = LiquidFile.parse(markup)
         current_tag = template.root.nodelist[0]
 
         case current_tag&.tag_name
@@ -159,6 +209,12 @@ module PlatformosCheck
           variable_lookup_for_assign_tag(current_tag)
         when "echo"
           variable_lookup_for_echo_tag(current_tag)
+        when "function"
+          variable_lookup_for_function_tag(current_tag)
+        when "return"
+          variable_lookup_for_return_tag(current_tag)
+        when "log"
+          variable_lookup_for_log_tag(current_tag)
         else
           empty_lookup
         end
@@ -219,6 +275,20 @@ module PlatformosCheck
         variable_lookup_for_liquid_variable(echo_tag.variable)
       end
 
+      def variable_lookup_for_function_tag(function_tag)
+        return empty_lookup if /:\s*$/.match?(function_tag.raw)
+
+        function_tag.attributes.values.last
+      end
+
+      def variable_lookup_for_return_tag(return_tag)
+        return_tag.variable
+      end
+
+      def variable_lookup_for_log_tag(log_tag)
+        log_tag.variable
+      end
+
       def variable_lookup_for_liquid_variable(variable)
         has_filters = !variable.filters.empty?
 

data/lib/platformos_check/platformos_liquid/source_index/filter_entry.rb

@@ -16,9 +16,11 @@ module PlatformosCheck
 
         def description
           @descritpion = begin
-            desc = hash['description']&.strip || ''
+            desc = hash['description'].is_a?(Array) ? hash['description'].first : hash['description']
+            desc = desc&.strip || ''
             desc = '' if desc == 'returns'
             if parameters.any?
+              desc += "\n\n" unless desc.empty?
               desc += "Parameters:"
               parameters.each { |p| desc += "\n- #{p.full_summary}" }
             end

data/lib/platformos_check/tags/log.rb

@@ -3,6 +3,10 @@
 module PlatformosCheck
   module Tags
     class Log < Base
+      def variable
+        @value_expr
+      end
+
       class ParseTreeVisitor < Liquid::ParseTreeVisitor
         def children
           [

data/lib/platformos_check/tags/return.rb

@@ -10,6 +10,10 @@ module PlatformosCheck
         @var = Liquid::Variable.new(markup, options)
       end
 
+      def variable
+        @var.name
+      end
+
       class ParseTreeVisitor < Liquid::ParseTreeVisitor
         def children
           [@node.var]

data/lib/platformos_check/version.rb

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

data/lib/platformos_check.rb

@@ -14,6 +14,7 @@ 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/graphql_traverser"
 require_relative "platformos_check/liquid_file"
 require_relative "platformos_check/page_file"
 require_relative "platformos_check/partial_file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platformos-check
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Piotr Bliszczyk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -93,6 +93,11 @@ files:
 - TROUBLESHOOTING.md
 - bin/platformos-check
 - bin/platformos-check-language-server
+- build/windows/Gemfile
+- build/windows/README.md
+- build/windows/build.sh
+- build/windows/lsp.exe
+- build/windows/run.rb
 - config/default.yml
 - config/nothing.yml
 - data/platformos_liquid/built_in_liquid_objects.json
@@ -112,6 +117,7 @@ files:
 - docs/checks/TEMPLATE.md.erb
 - docs/checks/convert_include_to_render.md
 - docs/checks/deprecated_filter.md
+- docs/checks/form_action.md
 - docs/checks/html_parsing_error.md
 - docs/checks/img_lazy_loading.md
 - docs/checks/img_width_and_height.md
@@ -154,6 +160,7 @@ files:
 - lib/platformos_check/checks/TEMPLATE.rb.erb
 - lib/platformos_check/checks/convert_include_to_render.rb
 - lib/platformos_check/checks/deprecated_filter.rb
+- lib/platformos_check/checks/form_action.rb
 - lib/platformos_check/checks/html_parsing_error.rb
 - lib/platformos_check/checks/img_lazy_loading.rb
 - lib/platformos_check/checks/img_width_and_height.rb
@@ -184,6 +191,7 @@ files:
 - lib/platformos_check/file_system_storage.rb
 - lib/platformos_check/form_file.rb
 - lib/platformos_check/graphql_file.rb
+- lib/platformos_check/graphql_traverser.rb
 - lib/platformos_check/html_check.rb
 - lib/platformos_check/html_node.rb
 - lib/platformos_check/html_visitor.rb
@@ -349,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: A platformOS App Linter