platformos-check 0.2.0 → 0.2.1

data/data/platformos_liquid/documentation/latest.json

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

data/docs/checks/undefined_object.md

@@ -45,13 +45,8 @@ The default configuration for this check is the following:
 ```yaml
 UndefinedObject:
   enabled: true
-  exclude_partials: true
 ```
 
-### `exclude_partials`
-
-The `exclude_partials` (Default: `true`) option determines whether to check for undefined objects in snippets file (as objects _may_ be defined as arguments)
-
 ## When Not To Use It
 
 It is discouraged to disable this rule.

data/lib/platformos_check/analyzer.rb

@@ -105,7 +105,7 @@ module PlatformosCheck
         end
 
         # Call checks that run on a single files, only on specified file
-        liquid_visitor = LiquidVisitor.new(@liquid_checks.single_file, @disabled_checks)
+        liquid_visitor = LiquidVisitor.new(@liquid_checks.single_file, @disabled_checks, only_single_file:)
         html_visitor = HtmlVisitor.new(@html_checks.single_file)
         files.each_with_index do |app_file, i|
           yield(app_file.relative_path.to_s, offset + i, total) if block_given?

data/lib/platformos_check/checks/undefined_object.rb

@@ -16,7 +16,7 @@ module PlatformosCheck
         @app_file = app_file
       end
 
-      attr_reader :all_assigns, :all_captures, :all_forloops, :app_file
+      attr_reader :all_assigns, :all_captures, :all_forloops, :app_file, :all_renders
 
       def add_render(name:, node:)
         @all_renders[name] = node
@@ -58,39 +58,32 @@ module PlatformosCheck
       end
     end
 
-    def initialize(config_type: :default, exclude_partials: true)
+    def self.single_file(**_args)
+      true
+    end
+
+    def initialize(config_type: :default)
       @config_type = config_type
-      @exclude_partials = exclude_partials
       @files = {}
     end
 
     def on_document(node)
-      return if ignore?(node)
-
       @files[node.app_file.name] = TemplateInfo.new(app_file: node.app_file)
     end
 
     def on_assign(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_capture(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_captures[node.value.instance_variable_get(:@to)] = node
     end
 
     def on_parse_json(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_captures[node.value.to] = node
     end
 
     def on_for(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_forloops[node.value.variable_name] = node
     end
 
@@ -99,7 +92,6 @@ module PlatformosCheck
     end
 
     def on_render(node)
-      return if ignore?(node)
       return unless node.value.template_name_expr.is_a?(String)
 
       partial_name = node.value.template_name_expr
@@ -110,45 +102,52 @@ module PlatformosCheck
     end
 
     def on_function(node)
-      return if ignore?(node)
+      @files[node.app_file.name].all_assigns[node.value.to] = node
+
+      return unless node.value.from.is_a?(String)
 
-      name = node.value.from.is_a?(String) ? node.value.from : node.value.from.name
       @files[node.app_file.name].add_render(
-        name:,
+        name: node.value.from,
         node:
       )
-
-      @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_graphql(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_background(node)
-      return if ignore?(node)
       return unless node.value.partial_syntax
+
+      @files[node.app_file.name].all_assigns[node.value.to] = node
+
       return unless node.value.partial_name.is_a?(String)
 
       @files[node.app_file.name].add_render(
         name: node.value.partial_name,
         node:
       )
-
-      @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_variable_lookup(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].add_variable_lookup(
         name: node.value.name,
         node:
       )
     end
 
+    def single_file_end_dependencies(app_file)
+      @files[app_file.name].all_renders.keys.map do |partial_name|
+        next if @files[partial_name]
+
+        partial_file = @platformos_app.partials.detect { |p| p.name == partial_name } # NOTE: undefined partial
+
+        next unless partial_file
+
+        partial_file
+      end.compact
+    end
+
     def on_end
       all_global_objects = PlatformosCheck::PlatformosLiquid::Object.labels
       all_global_objects.freeze
@@ -170,31 +169,28 @@ module PlatformosCheck
 
     attr_reader :config_type
 
-    def ignore?(node)
-      @exclude_partials && node.app_file.partial?
-    end
-
     def each_template
       @files.each do |(name, info)|
-        next if info.app_file.partial?
-
         yield [name, info]
       end
     end
 
-    def check_object(info, all_global_objects, render_node = nil, visited_partials = Set.new)
-      check_undefined(info, all_global_objects, render_node)
+    def check_object(info, all_global_objects, render_node = nil, visited_partials = Set.new, level = 0)
+      return if level > 1
+
+      check_undefined(info, all_global_objects, render_node) unless info.app_file.partial? && render_node.nil? # ||
 
       info.each_partial do |(partial_name, node)|
+        next if visited_partials.include?(partial_name)
+
         partial_info = @files[partial_name]
+
         next unless partial_info # NOTE: undefined partial
 
         partial_variables = node.value.attributes.keys +
                             [node.value.instance_variable_get(:@alias_name)]
-        unless visited_partials.include?(partial_name)
-          visited_partials << partial_name
-          check_object(partial_info, all_global_objects + partial_variables, node, visited_partials)
-        end
+        visited_partials << partial_name
+        check_object(partial_info, all_global_objects + partial_variables, node, visited_partials, level + 1)
       end
     end
 
@@ -213,7 +209,7 @@ module PlatformosCheck
 
         if render_node
           add_offense("Missing argument `#{name}`", node: render_node)
-        else
+        elsif !info.app_file.partial?
           add_offense("Undefined object `#{name}`", node:, line_number:)
         end
       end

data/lib/platformos_check/checks/unused_assign.rb

@@ -21,6 +21,10 @@ module PlatformosCheck
       end
     end
 
+    def self.single_file(**_args)
+      true
+    end
+
     def initialize
       @templates = {}
     end

data/lib/platformos_check/checks.rb

@@ -25,6 +25,12 @@ module PlatformosCheck
       @single_file ||= self.class.new(select(&:single_file?))
     end
 
+    def single_file_end_dependencies(app_file)
+      map do |check|
+        check.respond_to?(:single_file_end_dependencies) ? check.single_file_end_dependencies(app_file) : []
+      end.flatten.compact.uniq
+    end
+
     private
 
     def call_check_method(check, method, *args)

data/lib/platformos_check/liquid_visitor.rb

@@ -4,13 +4,20 @@ module PlatformosCheck
   class LiquidVisitor
     attr_reader :checks
 
-    def initialize(checks, disabled_checks)
+    def initialize(checks, disabled_checks, only_single_file: false)
       @checks = checks
       @disabled_checks = disabled_checks
+      @only_single_file = only_single_file
     end
 
     def visit_liquid_file(liquid_file)
       visit(LiquidNode.new(liquid_file.root, nil, liquid_file))
+
+      if @only_single_file
+        checks.single_file_end_dependencies(liquid_file).each do |file|
+          visit(LiquidNode.new(file.root, nil, file))
+        end
+      end
     rescue Liquid::Error => e
       e.template_name = liquid_file.relative_path
       call_checks(:on_error, e)

data/lib/platformos_check/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platformos-check
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Piotr Bliszczyk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql