platformos-check 0.0.3 → 0.1.0

data/lib/platformos_check/app.rb

@@ -39,29 +39,32 @@ module PlatformosCheck
       CONFIG_REGEX => ConfigFile
     }
 
-    attr_reader :storage
+    attr_reader :storage, :grouped_files
 
     def initialize(storage)
       @storage = storage
+      @grouped_files = {}
+      REGEXP_MAP.each_value { |v| @grouped_files[v] ||= {} }
+      process_files(storage.files)
     end
 
-    def grouped_files
-      @grouped_files ||= begin
-        hash = {}
-        REGEXP_MAP.each_value { |v| hash[v] = {} }
-        storage.files.each do |path|
-          regexp, klass = REGEXP_MAP.detect { |k, _v| k.match?(path) }
-          if regexp
-            f = klass.new(path, storage)
-            hash[klass][f.name] = f
-          elsif /\.liquid$/i.match?(path)
-            hash[LiquidFile] ||= {}
-            f = LiquidFile.new(path, storage)
-            hash[LiquidFile][f.name] = f
-          end
+    def update(files, remove: false)
+      process_files(files, remove:)
+    end
+
+    def process_files(files, remove: false)
+      files.each do |path|
+        regexp, klass = REGEXP_MAP.detect { |k, _v| k.match?(path) }
+        next unless regexp
+
+        f = klass.new(path, storage)
+        if remove
+          @grouped_files[klass].delete(f.name)
+        else
+          @grouped_files[klass][f.name] = f
         end
-        hash
       end
+      @grouped_files
     end
 
     def assets
@@ -121,7 +124,7 @@ module PlatformosCheck
     end
 
     def all
-      @all ||= grouped_files.values.map(&:values).flatten
+      grouped_files.values.map(&:values).flatten
     end
 
     def [](name_or_relative_path)
@@ -129,7 +132,7 @@ module PlatformosCheck
       when Pathname
         all.find { |t| t.relative_path == name_or_relative_path }
       else
-        all.find { |t| t.name == name_or_relative_path }
+        all.find { |t| t.relative_path.to_s == name_or_relative_path }
       end
     end
   end

data/lib/platformos_check/checks/invalid_args.rb

@@ -2,33 +2,6 @@
 
 module PlatformosCheck
   class InvalidArgs < LiquidCheck
-    class ParsedGraphQL
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def required_arguments
-        variables.each_with_object([]) do |v, vars|
-          vars << v.name if v.type.is_a?(GraphQL::Language::Nodes::NonNullType)
-        end
-      end
-
-      def defined_arguments
-        variables.map(&:name)
-      end
-
-      private
-
-      attr_reader :ast
-
-      def variables
-        @variables ||= definition&.variables || []
-      end
-
-      def definition
-        @definition ||= ast.definitions.detect { |d| d.is_a?(GraphQL::Language::Nodes::OperationDefinition) }
-      end
-    end
     severity :error
     category :liquid, :graphql
     doc docs_url(__FILE__)
@@ -49,27 +22,22 @@ module PlatformosCheck
       graphql_partial = node.value.partial_name
       return unless graphql_partial.is_a?(String)
 
-      graqphql_file = platformos_app.grouped_files[GraphqlFile][graphql_partial]
-      return unless graqphql_file
+      graphql_file = platformos_app.grouped_files[GraphqlFile][graphql_partial]
+      return unless graphql_file
 
       provided_arguments = node.value.attributes
 
       return if provided_arguments.include?('args')
 
-      parsed_graphql = ParsedGraphQL.new(graqphql_file.parse)
-
-      required_arguments = parsed_graphql.required_arguments
-      defined_arguments = parsed_graphql.defined_arguments
-
-      (provided_arguments - defined_arguments).each do |name|
-        add_offense("Undefined argument `#{name}` provided to `#{graqphql_file.relative_path}`", node:)
+      (provided_arguments - graphql_file.defined_arguments).each do |name|
+        add_offense("Undefined argument `#{name}` provided to `#{graphql_file.relative_path}`", node:)
       end
 
-      (required_arguments - provided_arguments).each do |name|
-        add_offense("Required argument `#{name}` not provided to `#{graqphql_file.relative_path}`", node:)
+      (graphql_file.required_arguments - provided_arguments).each do |name|
+        add_offense("Required argument `#{name}` not provided to `#{graphql_file.relative_path}`", node:)
       end
     rescue GraphQL::ParseError => e
-      add_offense("GraphQL Parse error triggered by `#{graqphql_file.relative_path}`: #{e.message}", node:)
+      add_offense("GraphQL Parse error triggered by `#{graphql_file.relative_path}`: #{e.message}", node:)
     end
 
     def add_duplicated_key_offense(node)

data/lib/platformos_check/cli.rb

@@ -190,13 +190,12 @@ module PlatformosCheck
 
       warn "Checking #{@config.root} ..."
       storage = PlatformosCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
-      platformos_app = PlatformosCheck::App.new(storage)
-      raise Abort, "No platformos_app files found." if platformos_app.all.empty?
+      raise Abort, "No platformos_app files found." if storage.platformos_app.all.empty?
 
-      analyzer = PlatformosCheck::Analyzer.new(platformos_app, @config.enabled_checks, @config.auto_correct)
+      analyzer = PlatformosCheck::Analyzer.new(storage.platformos_app, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_platformos_app
       analyzer.correct_offenses
-      print_with_format(platformos_app, analyzer, out_stream)
+      print_with_format(storage.platformos_app, analyzer, out_stream)
       # corrections are committed after printing so that the
       # source_excerpts are still pointing to the uncorrected source.
       analyzer.write_corrections

data/lib/platformos_check/file_system_storage.rb

@@ -31,10 +31,13 @@ module PlatformosCheck
 
       file(relative_path).dirname.mkpath unless file(relative_path).dirname.directory?
       file(relative_path).write(content, mode: 'w+b', encoding: 'UTF-8')
+      @platformos_app&.update([relative_path])
     end
 
     def remove(relative_path)
       file(relative_path).delete
+
+      @platformos_app&.update([relative_path], remove: true)
       reset_memoizers
     end
 
@@ -60,12 +63,6 @@ module PlatformosCheck
                       .map { |path| path.relative_path_from(@root).to_s }
     end
 
-    def directories
-      @directories ||= glob('**/')
-                       .select { |f| File.directory?(f) }
-                       .map { |f| f.relative_path_from(@root).to_s }
-    end
-
     private
 
     def file_exists?(relative_path)
@@ -74,7 +71,6 @@ module PlatformosCheck
 
     def reset_memoizers
       @file_array = nil
-      @directories = nil
     end
 
     def glob(pattern)

data/lib/platformos_check/graphql_file.rb

@@ -13,6 +13,12 @@ module PlatformosCheck
       @storage.write(@relative_path, content.gsub("\n", @eol))
       @source = content
       @rewriter = nil
+      @ast = nil
+      @variables = nil
+      @definition = nil
+      @parse = nil
+      @required_arguments = nil
+      @defined_arguments = nil
     end
 
     def rewriter
@@ -48,7 +54,7 @@ module PlatformosCheck
     end
 
     def warnings
-      @ast.warnings
+      parse.warnings
     end
 
     def root
@@ -59,8 +65,26 @@ module PlatformosCheck
       Struct.new(:warnings, :root)
     end
 
+    def required_arguments
+      @required_arguments ||= variables.each_with_object([]) do |v, vars|
+        vars << v.name if v.type.is_a?(GraphQL::Language::Nodes::NonNullType)
+      end
+    end
+
+    def defined_arguments
+      @defined_arguments ||= variables.map(&:name)
+    end
+
     private
 
+    def variables
+      @variables ||= definition&.variables || []
+    end
+
+    def definition
+      @definition ||= parse.definitions.detect { |d| d.is_a?(GraphQL::Language::Nodes::OperationDefinition) }
+    end
+
     def bounded(lower, x, upper)
       [lower, [x, upper].min].max
     end

data/lib/platformos_check/in_memory_storage.rb

@@ -22,47 +22,25 @@ module PlatformosCheck
     end
 
     def write(relative_path, content)
+      @platformos_app&.update([relative_path])
       @files[relative_path] = content
     end
 
     def remove(relative_path)
+      @platformos_app&.update([relative_path], remove: true)
       @files.delete(relative_path)
     end
 
     def mkdir(relative_path)
       @files[relative_path] = nil
-      reset_memoizers
     end
 
-    # TODO: Fix corrector
-    # def rename(old_path, new_path)
-    #   old_path += '/' if old_path[-1] != '/'
-    #   new_path += '/' if new_path[-1] != '/'
-    #   @files.transform_keys! { |k| k.sub(/\A#{old_path}/, new_path) }
-    #
-    #   reset_memoizers
-    # end
-
     def files
       @files.keys
     end
 
-    def directories
-      @directories ||= @files
-                       .keys
-                       .flat_map { |relative_path| Pathname.new(relative_path).ascend.to_a }
-                       .map(&:to_s)
-                       .uniq
-    end
-
     def relative_path(absolute_path)
       Pathname.new(absolute_path).relative_path_from(@root).to_s
     end
-
-    private
-
-    def reset_memoizers
-      @directories = nil
-    end
   end
 end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class BackgroundPartialCompletionProvider < CompletionProvider
+      include PartialCompletionProvider
+
+      private
+
+      def files
+        @storage.platformos_app.partials
+      end
+
+      def regexp
+        PARTIAL_BACKGROUND
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class FunctionPartialCompletionProvider < CompletionProvider
+      include PartialCompletionProvider
+
+      private
+
+      def files
+        @storage.platformos_app.partials
+      end
+
+      def regexp
+        PARTIAL_FUNCTION
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class GraphqlPartialCompletionProvider < CompletionProvider
+      include PartialCompletionProvider
+
+      private
+
+      def files
+        @storage.platformos_app.graphqls
+      end
+
+      def regexp
+        PARTIAL_GRAPHQL
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class IncludePartialCompletionProvider < CompletionProvider
+      include PartialCompletionProvider
+
+      private
+
+      def files
+        @storage.platformos_app.partials
+      end
+
+      def regexp
+        PARTIAL_INCLUDE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class RenderPartialCompletionProvider < CompletionProvider
+      include PartialCompletionProvider
+
+      private
+
+      def files
+        @storage.platformos_app.partials
+      end
+
+      def regexp
+        PARTIAL_RENDER
+      end
+    end
+  end
+end

data/lib/platformos_check/language_server/constants.rb

@@ -15,7 +15,7 @@ module PlatformosCheck
 
     def self.partial_tag_with_result(tag)
       /
-        \{%-?\s*#{tag}\s+(?<var>[\w]+)+\s*=\s*'(?<partial>[^']*)'|
+        \{%-?\s*#{tag}\s+(?<var>[\w]+)\s*=\s*'(?<partial>[^']*)'|
         \{%-?\s*#{tag}\s+(?<var>[\w]+)\s*=\s*"(?<partial>[^"]*)"|
 
         # in liquid tags the whole line is white space until the tag

data/lib/platformos_check/language_server/diagnostics_engine.rb

@@ -21,13 +21,12 @@ module PlatformosCheck
       def analyze_and_send_offenses(absolute_path_or_paths, config, force: false, only_single_file: false)
         return unless @diagnostics_lock.try_lock
 
-        platformos_app = PlatformosCheck::App.new(storage)
-        analyzer = PlatformosCheck::Analyzer.new(platformos_app, config.enabled_checks)
+        analyzer = PlatformosCheck::Analyzer.new(storage.platformos_app, config.enabled_checks)
 
         if !only_single_file && (@diagnostics_manager.first_run? || force)
           run_full_platformos_check(analyzer)
         else
-          run_partial_platformos_check(absolute_path_or_paths, platformos_app, analyzer, only_single_file)
+          run_partial_platformos_check(absolute_path_or_paths, storage.platformos_app, analyzer, only_single_file)
         end
 
         @diagnostics_lock.unlock

data/lib/platformos_check/language_server/document_link_engine.rb

@@ -12,10 +12,8 @@ module PlatformosCheck
         buffer = @storage.read(relative_path)
         return [] unless buffer
 
-        platformos_app = PlatformosCheck::App.new(@storage)
-
         @providers.flat_map do |p|
-          p.document_links(buffer, platformos_app)
+          p.document_links(buffer, @storage.platformos_app)
         end
       end
     end

data/lib/platformos_check/language_server/hover_providers/filter_hover_provider.rb

@@ -18,7 +18,10 @@ module PlatformosCheck
         variable_lookup = VariableLookupFinder.lookup(context)
         denied_filters = denied_filters_for(variable_lookup)
         available_filters_for(determine_input_type(variable_lookup))
-          .select { |filter| (filter.name == partial(content, cursor)) && denied_filters.none?(filter.name) }
+          .select do |filter|
+            partial_name = partial(content, cursor)
+            (filter.name == partial_name || filter.aliases.any? { |a| a == partial_name }) && denied_filters.none?(filter.name)
+          end
           .map { |filter| filter_to_completion(filter) }
           .first
       end
@@ -88,23 +91,14 @@ module PlatformosCheck
         partial_match[1]
       end
 
-      def param_to_doc(param)
-        "#{param&.name || 'object'}:#{param&.return_type&.downcase || 'untyped'}"
-      end
-
       def filter_to_completion(filter)
         content = PlatformosLiquid::Documentation.render_doc(filter)
-        first_param, *other_params = filter.parameters
-        other_params = other_params.map { |param| param_to_doc(param) }
-        other_params = other_params.any? ? ": #{other_params.join(', ')}" : ""
-        content += "  \n\n#{param_to_doc(first_param)} | #{filter.name}#{other_params} => #{filter.return_type}"
-
         {
-          contents: content
-          # label: filter.name,
-          # kind: CompletionItemKinds::FUNCTION,
-          # **format_hash(filter),
-          # **doc_hash(content)
+          contents: content,
+          label: filter.name,
+          kind: CompletionItemKinds::FUNCTION,
+          **format_hash(filter),
+          **doc_hash(content)
         }
       end
     end

data/lib/platformos_check/language_server/partial_completion_provider.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    module PartialCompletionProvider
+      def completions(context)
+        content = context.buffer.lines[context.line]
+        cursor = context.col
+        @file_name = nil
+
+        return [] if content.nil?
+        return [] unless cursor_on_quoted_argument?(content, cursor)
+
+        files
+          .select { |x| x.name.start_with?(@file_name) }
+          .map { |x| file_to_completion(x) }
+      end
+
+      private
+
+      def cursor_on_quoted_argument?(content, cursor)
+        match = content.match(regexp)
+        return false if match.nil?
+
+        return false unless match.begin(:partial) <= cursor && cursor <= match.end(:partial)
+
+        @file_name = match[:partial]
+        true
+      end
+
+      def files
+        raise NotImplementedError
+      end
+
+      def regexp
+        raise NotImplementedError
+      end
+
+      def file_to_completion(file)
+        {
+          label: file.name,
+          kind: CompletionItemKinds::SNIPPET,
+          detail: file.source
+        }
+      end
+    end
+  end
+end

data/lib/platformos_check/language_server.rb

@@ -32,6 +32,7 @@ require_relative "language_server/completion_context"
 require_relative "language_server/completion_helper"
 require_relative "language_server/completion_provider"
 require_relative "language_server/completion_engine"
+require_relative "language_server/partial_completion_provider"
 Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file
 end

data/lib/platformos_check/liquid_visitor.rb

@@ -12,7 +12,7 @@ module PlatformosCheck
     def visit_liquid_file(liquid_file)
       visit(LiquidNode.new(liquid_file.root, nil, liquid_file))
     rescue Liquid::Error => e
-      e.template_name = liquid_file.name
+      e.template_name = liquid_file.relative_path
       call_checks(:on_error, e)
     end
 

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

@@ -1,12 +1,45 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 module PlatformosCheck
   module PlatformosLiquid
     class SourceIndex
       class FilterEntry < BaseEntry
         def parameters
-          (hash['parameters'] || [])
-            .map { |hash| ParameterEntry.new(hash) }
+          @parameters ||= (hash['parameters'] || []).map { |hash| ParameterEntry.new(hash) }
+        end
+
+        def summary
+          hash['summary']&.strip == 'returns' ? nil : hash['summary']
+        end
+
+        def description
+          @descritpion = begin
+            desc = hash['description']&.strip || ''
+            desc = '' if desc == 'returns'
+            if parameters.any?
+              desc += "Parameters:"
+              parameters.each { |p| desc += "\n- #{p.full_summary}" }
+            end
+            if hash['return_type']&.any?
+              rt = hash['return_type'].first
+              rt['description'] = nil if rt['description']&.strip == ''
+              desc += "\n\nReturns:"
+              desc += "\n- #{[rt['type'], rt['description']].compact.join(': ')}\n"
+            end
+            if hash['examples']
+              desc += "\n\n---\n\n"
+              hash['examples'].each_with_index do |e, i|
+                example = e['raw_liquid'].gsub(/[\n]+/, "\n").strip.split('=>')
+                input = example[0].strip
+                output = example[1]&.strip
+                desc += "\n  - Example #{i}:\n\n```liquid\n#{input}\n```"
+                desc += "\n##\nOutput: #{output}" if output
+              end
+            end
+          end
+          desc
         end
 
         def aliases

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

@@ -12,6 +12,10 @@ module PlatformosCheck
           "#{PLATFORMOS_DOCUMENTATION_URL}/api-reference/liquid/filters/#{hash['name']}"
         end
 
+        def full_summary
+          "#{hash['name']} - #{hash['description']}"
+        end
+
         private
 
         def return_type_hash

data/lib/platformos_check/storage.rb

@@ -18,8 +18,8 @@ module PlatformosCheck
       raise NotImplementedError
     end
 
-    def directories
-      raise NotImplementedError
+    def platformos_app
+      @platformos_app ||= PlatformosCheck::App.new(self)
     end
 
     def versioned?

data/lib/platformos_check/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platformos-check
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Piotr Bliszczyk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -205,10 +205,14 @@ files:
 - lib/platformos_check/language_server/completion_helper.rb
 - lib/platformos_check/language_server/completion_provider.rb
 - lib/platformos_check/language_server/completion_providers/assignments_completion_provider.rb
+- lib/platformos_check/language_server/completion_providers/background_partial_completion_provider.rb
 - lib/platformos_check/language_server/completion_providers/filter_completion_provider.rb
+- lib/platformos_check/language_server/completion_providers/function_partial_completion_provider.rb
+- lib/platformos_check/language_server/completion_providers/graphql_partial_completion_provider.rb
+- lib/platformos_check/language_server/completion_providers/include_partial_completion_provider.rb
 - lib/platformos_check/language_server/completion_providers/object_attribute_completion_provider.rb
 - lib/platformos_check/language_server/completion_providers/object_completion_provider.rb
-- lib/platformos_check/language_server/completion_providers/render_snippet_completion_provider.rb
+- lib/platformos_check/language_server/completion_providers/render_partial_completion_provider.rb
 - lib/platformos_check/language_server/completion_providers/tag_completion_provider.rb
 - lib/platformos_check/language_server/configuration.rb
 - lib/platformos_check/language_server/constants.rb
@@ -235,6 +239,7 @@ files:
 - lib/platformos_check/language_server/hover_providers/filter_hover_provider.rb
 - lib/platformos_check/language_server/io_messenger.rb
 - lib/platformos_check/language_server/messenger.rb
+- lib/platformos_check/language_server/partial_completion_provider.rb
 - lib/platformos_check/language_server/protocol.rb
 - lib/platformos_check/language_server/server.rb
 - lib/platformos_check/language_server/tokens.rb