platformos-check 0.4.9 → 0.4.11

data/lib/platformos_check/checks/missing_template.rb

@@ -34,7 +34,6 @@ module PlatformosCheck
     severity :suggestion
     category :liquid
     doc docs_url(__FILE__)
-    single_file false
 
     def initialize(ignore_missing: [])
       @ignore_missing = ignore_missing
@@ -44,30 +43,37 @@ module PlatformosCheck
       partial = node.value.template_name_expr
       return unless partial.is_a?(String)
 
-      add_missing_partial_offense(partial, node:)
+      add_missing_template_offense(partial, file_type: PartialFile, node:)
     end
 
     def on_render(node)
       partial = node.value.template_name_expr
       return unless partial.is_a?(String)
 
-      add_missing_partial_offense(partial, node:)
+      add_missing_template_offense(partial, file_type: PartialFile, node:)
+    end
+
+    def on_background(node)
+      partial = node.value.partial_name
+      return unless partial.is_a?(String)
+
+      add_missing_template_offense(partial, file_type: PartialFile, node:)
     end
 
     def on_function(node)
       partial = node.value.from
       return unless partial.is_a?(String)
 
-      add_missing_function_offense(partial, node:)
+      add_missing_template_offense(partial, file_type: PartialFile, node:)
     end
 
     def on_graphql(node)
       return if node.value.inline_query
 
-      graphql_partial = node.value.partial_name
-      return unless graphql_partial.is_a?(String)
+      path = node.value.partial_name
+      return unless path.is_a?(String)
 
-      add_missing_graphql_offense(graphql_partial, node:)
+      add_missing_template_offense(path, file_type: GraphqlFile, node:)
     end
 
     private
@@ -80,28 +86,15 @@ module PlatformosCheck
       @all_ignored_patterns ||= @ignore_missing + ignored_patterns
     end
 
-    def add_missing_partial_offense(path, node:)
-      return if ignore?(path) || platformos_app.grouped_files[PartialFile][path]
+    def add_missing_template_offense(path, file_type:, node:)
+      return if ignore?(path)
 
-      add_offense("'#{path}' is not found", node:) # do |corrector|
-      # corrector.create_file(@platformos_app.storage, MissingFileCorrection.new(path:, directory: 'views/partials', extension: '.liquid').full_relative_path, "")
-      # end
-    end
-
-    def add_missing_function_offense(path, node:)
-      return if ignore?(path) || platformos_app.grouped_files[PartialFile][path]
-
-      add_offense("'#{path}' is not found", node:) # do |corrector|
-      # corrector.create_file(@platformos_app.storage, MissingFileCorrection.new(path:, directory: 'lib', extension: '.liquid').full_relative_path, "")
-      # end
-    end
+      file = platformos_app.grouped_files[file_type][path]
 
-    def add_missing_graphql_offense(path, node:)
-      return if ignore?(path) || platformos_app.grouped_files[GraphqlFile][path]
+      return add_offense("'#{path}' is missing", node:) if file.nil?
+      return add_offense("'#{path}' is blank", node:) if file.source.strip == ''
 
-      add_offense("'#{path}' is not found", node:) # do |corrector|
-      # corrector.create_file(@platformos_app.storage, MissingFileCorrection.new(path:, directory: 'graphql', extension: '.graphql').full_relative_path, "")
-      # end
+      nil
     end
   end
 end

data/lib/platformos_check/checks/translation_files_match.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  class TranslationFilesMatch < YamlCheck
+    severity :error
+    category :translation
+    doc docs_url(__FILE__)
+
+    PLURALIZATION_KEYS = Set.new(%w[zero one two few many other])
+
+    def on_file(file)
+      return unless file.translation?
+      return if file.parse_error
+      return add_offense_wrong_language_in_file(file) if file.language != file.language_from_path
+      return check_if_file_exists_for_all_other_languages(file) if file.language == @platformos_app.default_language
+
+      default_language_file = @platformos_app.grouped_files[PlatformosCheck::TranslationFile][file.name.sub(file.language, @platformos_app.default_language)]
+
+      return add_offense_missing_file(file) if default_language_file.nil?
+
+      add_offense_different_structure(file, default_language_file) unless same_structure?(default_language_file.content[@platformos_app.default_language], file.content[file.language])
+    end
+
+    protected
+
+    def add_offense_wrong_language_in_file(file)
+      add_offense("Mismatch detected - file inside #{file.language_from_path} directory defines translations for `#{file.language}`", app_file: file) do |_corrector|
+        file.update_contents(file.content[file.language_from_path] = file.content.delete(file.content[file.language]))
+        file.write
+      end
+    end
+
+    def add_offense_missing_file(file)
+      add_offense("Mismatch detected - missing `#{file.relative_path.to_s.sub(file.language, @platformos_app.default_language)}` to define translations the  default language", app_file: file)
+    end
+
+    def check_if_file_exists_for_all_other_languages(file)
+      @platformos_app.translations_hash.each_key do |lang|
+        next if lang == @platformos_app.default_language
+
+        language_file = @platformos_app.grouped_files[PlatformosCheck::TranslationFile][file.name.sub(file.language, lang)]
+        add_offense_missing_translation_file(file, lang) if language_file.nil?
+      end
+    end
+
+    def add_offense_missing_translation_file(file, lang)
+      missing_file_path = file.relative_path.to_s.sub(file.language, lang)
+      add_offense("Mismatch detected - missing `#{missing_file_path}` file to define translations for `#{lang}`", app_file: file) do |corrector|
+        missing_file_content = file.content.clone
+        missing_file_content[lang] = missing_file_content.delete(file.language)
+        corrector.create_file(@platformos_app.storage, missing_file_path, YAML.dump(missing_file_content))
+      end
+    end
+
+    def same_structure?(hash1, hash2)
+      if !hash1.is_a?(Hash) && !hash2.is_a?(Hash)
+        true
+      elsif (hash1.is_a?(Hash) && !hash2.is_a?(Hash)) || (!hash1.is_a?(Hash) && hash2.is_a?(Hash))
+        false
+      elsif pluralization?(hash1) && pluralization?(hash2)
+        true
+      elsif hash1.keys.map(&:to_s).sort != hash2.keys.map(&:to_s).sort
+        false
+      else
+        hash1.keys.all? { |key| same_structure?(hash1[key], hash2[key]) }
+      end
+    end
+
+    def add_offense_different_structure(file, default_language_file)
+      add_offense("Mismatch detected - structure differs from the default language file #{default_language_file.relative_path}", app_file: file) do |_corrector|
+        file.content[file.language].transform_values! { |v| v.nil? ? {} : v }
+        file.content[file.language] = default_language_file.content[default_language_file.language].deep_merge(file.content[file.language])
+        file.write
+      end
+    end
+
+    def pluralization?(hash)
+      hash.all? do |key, value|
+        PLURALIZATION_KEYS.include?(key) && !value.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/platformos_check/checks/translation_key_exists.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  # Recommends using {% liquid ... %} if 5 or more consecutive {% ... %} are found.
+  class TranslationKeyExists < LiquidCheck
+    severity :error
+    categories :translation, :liquid
+    doc docs_url(__FILE__)
+
+    def on_variable(node)
+      return unless node.value.name.is_a?(String)
+      return unless node.filters.size == 1
+
+      translation_filter = node.filters.detect { |f| TranslationFile::TRANSLATION_FILTERS.include?(f[0]) }
+      return unless translation_filter
+      return unless translation_filter
+
+      filter_attributes = translation_filter[2] || {}
+
+      return unless filter_attributes['default'].nil?
+      return if !filter_attributes['scope'].nil? && !filter_attributes['scope'].is_a?(String)
+
+      lang = filter_attributes['language'].is_a?(String) ? filter_attributes['language'] : @platformos_app.default_language
+      translation_components = node.value.name.split('.')
+
+      translation_components = filter_attributes['scope'].split('.') + translation_components if filter_attributes['scope']
+
+      return add_translation_offense(node:, lang:) if @platformos_app.translations_hash.empty?
+
+      hash = @platformos_app.translations_hash[lang] || {}
+      index = 0
+      while translation_components[index]
+        hash = hash[translation_components[index]]
+        if hash.nil?
+          add_translation_offense(node:, lang:)
+          break
+        end
+        index += 1
+      end
+    end
+
+    protected
+
+    def add_translation_offense(node:, lang:)
+      add_offense("Translation `#{lang}.#{node.value.name}` does not exists", node:)
+    end
+  end
+end

data/lib/platformos_check/checks/undefined_object.rb

@@ -64,7 +64,7 @@ module PlatformosCheck
       end
 
       def first_declaration(name)
-        [all_assigns[name], all_captures[name]].compact.sort_by(&:line_number).first
+        [all_assigns[name], all_captures[name]].compact.min_by(&:line_number)
       end
     end
 

data/lib/platformos_check/ext/hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Hash
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block
+        yield(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def deep_merge(other_hash, &)
+    dup.deep_merge!(other_hash, &)
+  end
+end

data/lib/platformos_check/graphql_file.rb

@@ -50,15 +50,15 @@ module PlatformosCheck
     end
 
     def parse
-      @parse ||= GraphQL.parse(source)
+      @parse ||= source && source.strip != '' ? GraphQL.parse(source) : nil
     end
 
     def warnings
-      parse.warnings
+      parse&.warnings || {}
     end
 
     def root
-      parse.root
+      parse&.root || {}
     end
 
     def self.parse(_source)
@@ -80,11 +80,15 @@ module PlatformosCheck
     end
 
     def selections
-      definition.selections
+      definition&.selections
     end
 
     def fragments
-      @fragments ||= parse.definitions.select { |d| d.is_a?(GraphQL::Language::Nodes::FragmentDefinition) }
+      @fragments ||= parse&.definitions&.select { |d| d.is_a?(GraphQL::Language::Nodes::FragmentDefinition) } || []
+    end
+
+    def graphql?
+      true
     end
 
     private
@@ -94,7 +98,7 @@ module PlatformosCheck
     end
 
     def definition
-      @definition ||= parse.definitions.detect { |d| d.is_a?(GraphQL::Language::Nodes::OperationDefinition) }
+      @definition ||= parse&.definitions&.detect { |d| d.is_a?(GraphQL::Language::Nodes::OperationDefinition) }
     end
 
     def bounded(lower, x, upper)

data/lib/platformos_check/language_server/constants.rb

@@ -32,13 +32,29 @@ module PlatformosCheck
     PARTIAL_GRAPHQL = partial_tag_with_result('graphql')
     PARTIAL_BACKGROUND = partial_tag_with_result('background')
 
+    TAGS_FOR_FILTERS = 'echo|print|log|hash_assign|assign'
+    TRANSLATION_FILTERS_NAMES = 'translate|t_escape|translate_escape|t[^\\w]'
+    OPTIONAL_SCOPE_ARGUMENT = %((:?([\\w:'"\\s]*)\\s*(scope:\\s*['"](?<scope>[^'"]*)['"]))?)
+
+    LOCALIZE_FILTERS_NAMES = ''
+
     ASSET_INCLUDE = /
       \{\{-?\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
       \{\{-?\s*"(?<partial>[^"]*)"\s*\|\s*asset_url|
 
       # in liquid tags the whole line is white space until the asset partial
-      ^\s*(?:echo|assign[^=]*=)\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
-      ^\s*(?:echo|assign[^=]*=)\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
+      ^\s*(?:#{TAGS_FOR_FILTERS}[^=]*=)\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      ^\s*(?:#{TAGS_FOR_FILTERS}[^=]*=)\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
+    /mix
+
+    TRANSLATION_FILTER = /
+      '(?<key>[^']*)'\s*\|\s*(#{TRANSLATION_FILTERS_NAMES})#{OPTIONAL_SCOPE_ARGUMENT}|
+      "(?<key>[^"]*)"\s*\|\s*(#{TRANSLATION_FILTERS_NAMES})#{OPTIONAL_SCOPE_ARGUMENT}
+    /mix
+
+    LOCALIZE_FILTER = /
+      [\s\w'"-:.]+\|\s*(localize|l):\s*'(?<key>[^']*)'|
+      [\s\w'"-:.]+\|\s*(localize|l):\s*"(?<key>[^"]*)"
     /mix
   end
 end

data/lib/platformos_check/language_server/document_link_provider.rb

@@ -7,6 +7,16 @@ module PlatformosCheck
       include PositionHelper
       include URIHelper
 
+      class DefaultTranslationFile
+        def initialize(default_language)
+          @default_language = default_language
+        end
+
+        def relative_path
+          Pathname.new(@default_language, "#{@default_language}.yml")
+        end
+      end
+
       class << self
         attr_accessor :partial_regexp, :app_file_type, :default_dir, :default_extension
 
@@ -41,18 +51,12 @@ module PlatformosCheck
 
       def document_links(buffer, platformos_app)
         matches(buffer, partial_regexp).map do |match|
-          start_row, start_column = from_index_to_row_column(
-            buffer,
-            match.begin(:partial)
-          )
+          start_row, start_column = start_coordinates(buffer, match)
 
-          end_row, end_column = from_index_to_row_column(
-            buffer,
-            match.end(:partial)
-          )
+          end_row, end_column = end_coordinates(buffer, match)
 
           {
-            target: file_link(match[:partial], platformos_app),
+            target: file_link(match, platformos_app),
             range: {
               start: {
                 line: start_row,
@@ -67,13 +71,66 @@ module PlatformosCheck
         end
       end
 
-      def file_link(partial, platformos_app)
+      def start_coordinates(buffer, match)
+        from_index_to_row_column(
+          buffer,
+          match.begin(:partial)
+        )
+      end
+
+      def end_coordinates(buffer, match)
+        from_index_to_row_column(
+          buffer,
+          match.end(:partial)
+        )
+      end
+
+      def file_link(match, platformos_app)
+        partial = match[:partial]
         relative_path = platformos_app.send(app_file_type).detect { |f| f.name == partial }&.relative_path
         relative_path ||= default_relative_path(partial)
 
         file_uri(@storage.path(relative_path))
       end
 
+      def translation_file_link(match, platformos_app)
+        @current_best_fit = platformos_app.translations.first || DefaultTranslationFile.new(platformos_app.default_language)
+        @current_best_fit_level = 0
+        array_of_translation_components = translation_components_for_match(match)
+        platformos_app.translations.each do |translation_file|
+          array_of_translation_components.each do |translation_components|
+            exact_match_level = translation_components.size
+            component_result = translation_file.content[platformos_app.default_language]
+            next if component_result.nil?
+
+            i = 0
+            while i < exact_match_level
+              component_result = yaml(component_result, translation_components[i])
+
+              break if component_result.nil?
+
+              i += 1
+              if i > @current_best_fit_level
+                @current_best_fit = translation_file
+                @current_best_fit_level = i
+              end
+
+              break unless component_result.is_a?(Hash)
+            end
+          end
+        end
+
+        file_uri(@storage.path(@current_best_fit&.relative_path))
+      end
+
+      def translation_components_for_match(match)
+        raise NotImplementedError
+      end
+
+      def yaml(component_result, component)
+        component_result[component]
+      end
+
       def default_relative_path(partial)
         return Pathname.new("app/#{default_dir}/#{partial}#{default_extension}") unless partial.start_with?('modules/')
 

data/lib/platformos_check/language_server/document_link_providers/localize_document_link_provider.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class LocalizeDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = LOCALIZE_FILTER
+      @app_file_type = :translations
+      @default_dir = 'translations'
+      @default_extension = '.yml'
+
+      def file_link(match, platformos_app)
+        translation_file_link(match, platformos_app)
+      end
+
+      def translation_components_for_match(match)
+        key = match[:key].split('.')
+        [
+          %w[time formats] + key,
+          %w[date formats] + key
+        ]
+      end
+
+      def start_coordinates(buffer, match)
+        from_index_to_row_column(
+          buffer,
+          match.begin(:key)
+        )
+      end
+
+      def end_coordinates(buffer, match)
+        from_index_to_row_column(
+          buffer,
+          match.end(:key)
+        )
+      end
+    end
+  end
+end

data/lib/platformos_check/language_server/document_link_providers/theme_render_document_link_provider.rb

@@ -8,7 +8,8 @@ module PlatformosCheck
       @default_dir = 'views/partials'
       @default_extension = '.liquid'
 
-      def file_link(partial, platformos_app)
+      def file_link(match, platformos_app)
+        partial = match[:partial]
         relative_path = nil
         path_prefixes(platformos_app).each do |prefix|
           prefix ||= ''

data/lib/platformos_check/language_server/document_link_providers/translation_document_link_provider.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class TranslationDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = TRANSLATION_FILTER
+      @app_file_type = :translations
+      @default_dir = 'translations'
+      @default_extension = '.yml'
+
+      def file_link(match, platformos_app)
+        translation_file_link(match, platformos_app)
+      end
+
+      def translation_components_for_match(match)
+        translation_components = match[:key].split('.')
+        translation_components = match[:scope].split('.') + translation_components if match[:scope]
+        [translation_components]
+      end
+
+      def start_coordinates(buffer, match)
+        from_index_to_row_column(
+          buffer,
+          match.begin(:key)
+        )
+      end
+
+      def end_coordinates(buffer, match)
+        from_index_to_row_column(
+          buffer,
+          match.end(:key)
+        )
+      end
+    end
+  end
+end

data/lib/platformos_check/translation_file.rb

@@ -2,5 +2,45 @@
 
 module PlatformosCheck
   class TranslationFile < YamlFile
+    DIR_PREFIX = %r{\A/?((marketplace_builder|app)/(translations)/|modules/((\w|-)*)/(private|public)/(translations)/)}
+    TRANSLATION_FILTERS = Set.new(%w[t t_escape translate translate_escape]).freeze
+    attr_reader :language
+
+    def load!
+      before_load
+      super
+      after_load
+    end
+
+    def before_load
+      @storage.platformos_app.instance_variable_set(:@translations_hash, nil) unless @loaded
+    end
+
+    def after_load
+      @language = @content&.keys&.first
+      return if module_name.nil?
+
+      @content[@language].transform_keys! { |key| key.start_with?(module_prefix) ? key : "#{module_prefix}#{key}" }
+    end
+
+    def language_from_path
+      @language_from_path ||= name.sub(module_prefix, '').split(File::SEPARATOR).first
+    end
+
+    def update_contents(new_content = {})
+      before_load
+      super(new_content)
+      @loaded = true
+
+      after_load
+    end
+
+    def dir_prefix
+      DIR_PREFIX
+    end
+
+    def translation?
+      true
+    end
   end
 end

data/lib/platformos_check/version.rb

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

data/lib/platformos_check/yaml_file.rb

@@ -28,14 +28,19 @@ module PlatformosCheck
     end
 
     def write
+      pretty = content_to_string
+      @storage.write(@relative_path, pretty)
+      @source = pretty
+    end
+
+    def content_to_string
       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
+      pretty.gsub("\n", @eol) + eof
     end
 
     def yaml?

data/lib/platformos_check.rb

@@ -5,6 +5,7 @@ require "liquid"
 require_relative "platformos_check/version"
 require_relative "platformos_check/bug"
 require_relative "platformos_check/exceptions"
+require_relative "platformos_check/ext/hash"
 require_relative "platformos_check/json_helper"
 require_relative "platformos_check/app_file_rewriter"
 require_relative "platformos_check/app_file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platformos-check
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.11
 platform: ruby
 authors:
 - Piotr Bliszczyk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -134,6 +134,8 @@ files:
 - docs/checks/space_inside_braces.md
 - docs/checks/syntax_error.md
 - docs/checks/template_length.md
+- docs/checks/translation_files_match.md
+- docs/checks/translation_key_exists.md
 - docs/checks/undefined_object.md
 - docs/checks/unknown_filter.md
 - docs/checks/unreachable_code.md
@@ -148,7 +150,7 @@ files:
 - docs/language_server/code-action-problem.png
 - docs/language_server/code-action-quickfix.png
 - docs/language_server/how_to_correct_code_with_code_actions_and_execute_command.md
-- docs/preview.png
+- docs/platformos-check.jpg
 - exe/platformos-check
 - exe/platformos-check-language-server
 - lib/platformos_check.rb
@@ -181,6 +183,8 @@ files:
 - lib/platformos_check/checks/space_inside_braces.rb
 - lib/platformos_check/checks/syntax_error.rb
 - lib/platformos_check/checks/template_length.rb
+- lib/platformos_check/checks/translation_files_match.rb
+- lib/platformos_check/checks/translation_key_exists.rb
 - lib/platformos_check/checks/undefined_object.rb
 - lib/platformos_check/checks/unknown_filter.rb
 - lib/platformos_check/checks/unreachable_code.rb
@@ -196,6 +200,7 @@ files:
 - lib/platformos_check/disabled_checks.rb
 - lib/platformos_check/email_file.rb
 - lib/platformos_check/exceptions.rb
+- lib/platformos_check/ext/hash.rb
 - lib/platformos_check/file_system_storage.rb
 - lib/platformos_check/form_file.rb
 - lib/platformos_check/graphql_file.rb
@@ -244,8 +249,10 @@ files:
 - lib/platformos_check/language_server/document_link_providers/graphql_document_link_provider.rb
 - lib/platformos_check/language_server/document_link_providers/include_document_link_provider.rb
 - lib/platformos_check/language_server/document_link_providers/include_form_document_link_provider.rb
+- lib/platformos_check/language_server/document_link_providers/localize_document_link_provider.rb
 - lib/platformos_check/language_server/document_link_providers/render_document_link_provider.rb
 - lib/platformos_check/language_server/document_link_providers/theme_render_document_link_provider.rb
+- lib/platformos_check/language_server/document_link_providers/translation_document_link_provider.rb
 - lib/platformos_check/language_server/execute_command_engine.rb
 - lib/platformos_check/language_server/execute_command_provider.rb
 - lib/platformos_check/language_server/execute_command_providers/correction_execute_command_provider.rb
@@ -366,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: A platformOS App Linter