platformos-check 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea3d461ba94a5e68217d4c8ce7143172fbc2a1c47e22b634f75e9895b2448906
-  data.tar.gz: 69cb278ff4ac062866d0d9aea988e1df20a43b2fb401df8d804965ede6502d3e
+  metadata.gz: b962e236b71ab785e3e566413ae86c64c6d767d26d8871606cc639b1eae7023e
+  data.tar.gz: 0df29d550f5779ebe29ac285809144998d49cd7a8d8049769ac023d65cdde3de
 SHA512:
-  metadata.gz: fe07f6ef18cfe1fffb5216799c69557f01e95b86feb6d55543ab1012051c428a6d56902df123d8c1a034d4f2f8de5e662c1053192b0e4870d3e4d221df6a21e2
-  data.tar.gz: 5f957eebbbb846239191230408645c0487e8a9da01f6d3be5d79d8c173402718cda2ff6a1ad2bc6c077d0a007871d99e2a4daf23ae1b0fb42a76fc8f505ca73f
+  metadata.gz: a8bcd3931092d2621dd74f174790ecc13213db17c56d11a9a174bdda6b5e7e22f8526b93553225fa6d884eb4af74e5249c2f78da2e88ad794f3b4064f935be33
+  data.tar.gz: ba1ca314fc5d0a154f2f74f52002204da03ce80edae7763e633b46fca31e56329f63f8e7343c52093c081c304c31e9462e5c8f52add1d328cf372e63005826fb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.4.0 / 2023-09-17
+==================
+
+  * Add unused attributes messages in render/function/background tags invocations
+
 v0.3.3 / 2023-09-16
 ==================
 

data/docs/checks/undefined_object.md

@@ -4,12 +4,11 @@ This check prevents errors by making sure that no undefined variables are being
 
 ## Check Details
 
-This check is aimed at eliminating undefined object errors.
+This check is aimed at eliminating undefined object errors. Additionally it reports any missing or unused attributes in render, function and background tags.
 
 :-1: Examples of **incorrect** code for this check:
 
 ```liquid
-{% assign greetings = "Hello" %}
 {% if greeting == "Hello" %}
   Hello
 {% endif %}
@@ -31,7 +30,7 @@ This check is aimed at eliminating undefined object errors.
 ```liquid
 {% liquid
   # my_function body
-  assign my_arg = my_arg: default nil
+  assign my_arg = my_arg | default: nil
   return my_arg
 %}
 ```

data/lib/platformos_check/checks/undefined_object.rb

@@ -196,9 +196,12 @@ module PlatformosCheck
 
     def check_undefined(info, all_global_objects, render_node)
       all_variables = info.all_variables
-
+      potentially_unused_variables = render_node.value.attributes.keys if render_node
       info.each_variable_lookup(!!render_node) do |(key, node)|
         name, line_number = key
+
+        potentially_unused_variables&.delete(name)
+
         next if all_variables.include?(name)
         next if all_global_objects.include?(name)
 
@@ -213,6 +216,11 @@ module PlatformosCheck
           add_offense("Undefined object `#{name}`", node:, line_number:)
         end
       end
+
+      potentially_unused_variables -= render_node.value.internal_attributes if render_node && render_node.value.respond_to?(:internal_attributes)
+      potentially_unused_variables&.each do |name|
+        add_offense("Unused argument `#{name}`", node: render_node)
+      end
     end
   end
 end

data/lib/platformos_check/tags/background.rb

@@ -5,6 +5,7 @@ module PlatformosCheck
     class Background < Base
       PARTIAL_SYNTAX = /(#{Liquid::VariableSignature}+)\s*=\s*(.*)\s*/om
       CLOSE_TAG_SYNTAX = /\A(.*)(?-mix:\{%-?)\s*(\w+)\s*(.*)?(?-mix:%\})\z/m # based on Liquid::Raw::FullTokenPossiblyInvalid
+      INTERNAL_ATTRIBUTES = %w[delay priority max_attempts source_name]
 
       attr_reader :to, :from, :attributes, :value_expr, :partial_syntax, :partial_name
 
@@ -27,6 +28,10 @@ module PlatformosCheck
         @attributes = attributes_expr
       end
 
+      def internal_attributes
+        INTERNAL_ATTRIBUTES
+      end
+
       def parse(tokens)
         return super if @partial_syntax
 

data/lib/platformos_check/version.rb

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

metadata

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