rubocop-dev_doc 0.5.0.beta1 → 0.5.0

data/lib/rubocop/cop/dev_doc/i18n/require_translation.rb

@@ -1,116 +0,0 @@
-module RuboCop
-  module Cop
-    module DevDoc
-      module I18n
-        # Flag hardcoded user-facing strings in glib JSON-UI component props.
-        #
-        # ## Rationale
-        # Glib components render text from props like `text:`, `label:`, and
-        # `title:`. Passing a string literal ships untranslatable copy — it can
-        # never be localized and bypasses the I18n catalog. Pass `t('...')` (or
-        # any non-literal) so the text resolves through the locale files.
-        #
-        # Only the hash form is checked (`view.p text: '...'`). Empty/whitespace
-        # strings are ignored — they carry no user-facing text. An interpolated
-        # string (`"Hi #{name}"`) is flagged because its literal portions are
-        # still hardcoded copy — unless it interpolates a `t(...)` (or
-        # `translate`/`I18n.t`) call, which is treated as positive localization
-        # and left alone.
-        #
-        # The watched method names and localizable keys are configurable via
-        # `WatchedMethods:` and `LocalizableKeys:`.
-        #
-        #   ❌ Hardcoded — can't be translated
-        #   view.p text: 'Welcome'
-        #   view.fields_text label: 'Email'
-        #
-        #   ✔️ Resolved through I18n
-        #   view.p text: t('home.welcome')
-        #   view.fields_text label: t('user.email')
-        #   view.p text: "#{t('home.welcome')}, #{user.name}"
-        #
-        # @example
-        #   # bad
-        #   view.p text: 'Welcome'
-        #
-        #   # bad
-        #   view.fields_text label: 'Email'
-        #
-        #   # bad (interpolation, but no translation call)
-        #   view.p text: "Hi #{name}"
-        #
-        #   # good
-        #   view.p text: t('home.welcome')
-        #
-        #   # good (interpolates a translation call)
-        #   view.p text: "#{t('home.greeting')} #{user.name}"
-        #
-        #   # good (non-literal — not flagged)
-        #   view.p text: user.name
-        class RequireTranslation < Base
-          MSG = 'Localize this string: pass `t(...)` instead of a hardcoded ' \
-                'string for `%<key>s:`.'.freeze
-
-          DEFAULT_WATCHED_METHODS = %w[
-            h1 h2 h3 h4 h5 p label markdown
-            fields_text fields_number fields_select fields_password
-            fields_textarea fields_check fields_checkGroup fields_chipGroup
-            fields_timeZone fields_radioGroup fields_date fields_datetime
-          ].freeze
-
-          DEFAULT_LOCALIZABLE_KEYS = %w[
-            title subtitle subsubtitle label placeholder text
-          ].freeze
-
-          TRANSLATION_METHODS = %i[t translate].freeze
-
-          def on_send(node)
-            return unless watched_methods.include?(node.method_name.to_s)
-
-            node.arguments.each do |arg|
-              next unless arg.hash_type?
-
-              arg.pairs.each { |pair| check_pair(pair) }
-            end
-          end
-          alias on_csend on_send
-
-          private
-
-          def check_pair(pair)
-            key = pair.key
-            return unless key.sym_type?
-            return unless localizable_keys.include?(key.value.to_s)
-            return unless hardcoded_string?(pair.value)
-
-            add_offense(pair.value, message: format(MSG, key: key.value))
-          end
-
-          # A plain string literal is hardcoded copy unless it's blank. A `dstr`
-          # (interpolated string) is hardcoded copy too — unless it interpolates
-          # a translation call, which counts as positive localization.
-          def hardcoded_string?(node)
-            return !localized_interpolation?(node) if node.dstr_type?
-            return false unless node.str_type?
-
-            !node.value.strip.empty?
-          end
-
-          def localized_interpolation?(node)
-            node.each_descendant(:send, :csend).any? do |call|
-              TRANSLATION_METHODS.include?(call.method_name)
-            end
-          end
-
-          def watched_methods
-            cop_config.fetch('WatchedMethods', DEFAULT_WATCHED_METHODS)
-          end
-
-          def localizable_keys
-            cop_config.fetch('LocalizableKeys', DEFAULT_LOCALIZABLE_KEYS)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/dev_doc/i18n/translation_key_prefix.rb

@@ -1,89 +0,0 @@
-module RuboCop
-  module Cop
-    module DevDoc
-      module I18n
-        # Require translation keys to start with an allowed namespace prefix.
-        #
-        # ## Rationale
-        # A flat translation catalog drifts into collisions and dead keys.
-        # Requiring every `t(...)` key to start with an agreed namespace (e.g.
-        # `hotel.`, `general.`) keeps the locale files organized and makes it
-        # obvious which feature owns a key.
-        #
-        # The allowed prefixes are project-specific, so `AllowedPrefixes:`
-        # defaults to empty and the cop does nothing until a project configures
-        # it. Matches `t`, `translate`, and `I18n.t` (the receiver is ignored).
-        #
-        # Only statically-literal keys are checked. A key built from
-        # interpolation (`t("#{prefix}.foo")`) or a variable (`t(key)`) can't be
-        # verified and is skipped. A key that begins with a literal segment
-        # (`t("hotel.#{id}")`) is checked against that leading segment.
-        #
-        #   ❌ No recognized prefix
-        #   t('welcome.title')
-        #
-        #   ✔️ Namespaced
-        #   t('general.welcome.title')
-        #   t('hotel.rooms.heading')
-        #
-        # @example AllowedPrefixes: ['hotel.', 'general.']
-        #   # bad
-        #   t('welcome.title')
-        #
-        #   # bad (lazy key has no namespace)
-        #   t('.title')
-        #
-        #   # good
-        #   t('hotel.rooms.heading')
-        #
-        #   # good (variable suffix, literal prefix is checked)
-        #   t("general.#{key}")
-        #
-        #   # not checked (fully dynamic key)
-        #   t("#{prefix}.title")
-        class TranslationKeyPrefix < Base
-          MSG = 'Translation key `%<key>s` must start with an allowed ' \
-                'prefix: %<prefixes>s.'.freeze
-
-          RESTRICT_ON_SEND = %i[t translate].freeze
-
-          def on_send(node)
-            prefixes = allowed_prefixes
-            return if prefixes.empty?
-
-            key_node = node.first_argument
-            return unless key_node
-
-            leading = leading_literal(key_node)
-            return if leading.nil?
-            return if prefixes.any? { |prefix| leading.start_with?(prefix) }
-
-            add_offense(key_node, message: format(MSG, key: key_node.source, prefixes: prefixes_display(prefixes)))
-          end
-
-          private
-
-          # The statically-known leading portion of the key, or nil when the key
-          # is dynamic (a variable, or a string that begins with interpolation).
-          def leading_literal(node)
-            case node.type
-            when :str then node.value
-            when :sym then node.value.to_s
-            when :dstr
-              first = node.children.first
-              first&.str_type? ? first.value : nil
-            end
-          end
-
-          def allowed_prefixes
-            Array(cop_config['AllowedPrefixes'])
-          end
-
-          def prefixes_display(prefixes)
-            prefixes.map { |prefix| "`#{prefix}`" }.join(', ')
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/dev_doc/i18n/unverified_translation.rb

@@ -1,106 +0,0 @@
-module RuboCop
-  module Cop
-    module DevDoc
-      module I18n
-        # Warn when a glib text prop is set from a non-literal value that isn't
-        # a `t(...)` call — it may be an unlocalized string.
-        #
-        # ## Rationale
-        # `DevDoc/I18n/RequireTranslation` only catches string literals written
-        # at the call site. A value passed through a variable or method
-        # (`label: label_text`) escapes it — the literal could be one hop away.
-        # This cop flags those values so a human can confirm they resolve
-        # through I18n.
-        #
-        # It can't tell a stashed literal from genuinely dynamic data
-        # (`user.name`) or a translation reached via a variable, so it's a
-        # review aid, not a clean lint: it's **disabled by default** and runs at
-        # `info` severity. Run it during a localization pass, not on every
-        # commit. Values that are obviously translated (`t(...)`, `translate`,
-        # `I18n.t`) are excluded; literals are left to `RequireTranslation`.
-        #
-        #   ⚠️ Can't be verified — confirm it's localized
-        #   view.fields_text label: label_text
-        #   view.p text: user.name
-        #
-        #   ✔️ Obviously localized — not flagged
-        #   view.p text: t('home.welcome')
-        #
-        # @example
-        #   # warning (non-literal — may be unlocalized)
-        #   view.fields_text label: label_text
-        #
-        #   # warning (attribute — may be unlocalized)
-        #   view.p text: user.name
-        #
-        #   # good (obviously localized — not flagged)
-        #   view.p text: t('home.welcome')
-        #
-        #   # ignored (literal — handled by RequireTranslation)
-        #   view.p text: 'Welcome'
-        class UnverifiedTranslation < Base
-          MSG = 'Possibly unlocalized: `%<key>s:` is set from a non-literal. ' \
-                'Use `t(...)` if this is user-facing text.'.freeze
-
-          DYNAMIC_TYPES = %i[lvar ivar send csend].freeze
-          TRANSLATION_METHODS = %i[t translate].freeze
-
-          DEFAULT_WATCHED_METHODS = %w[
-            h1 h2 h3 h4 h5 p label markdown
-            fields_text fields_number fields_select fields_password
-            fields_textarea fields_check fields_checkGroup fields_chipGroup
-            fields_timeZone fields_radioGroup fields_date fields_datetime
-          ].freeze
-
-          DEFAULT_LOCALIZABLE_KEYS = %w[
-            title subtitle subsubtitle label placeholder text
-          ].freeze
-
-          def on_send(node)
-            return unless watched_methods.include?(node.method_name.to_s)
-
-            node.arguments.each do |arg|
-              next unless arg.hash_type?
-
-              arg.pairs.each { |pair| check_pair(pair) }
-            end
-          end
-          alias on_csend on_send
-
-          private
-
-          def check_pair(pair)
-            key = pair.key
-            return unless key.sym_type?
-            return unless localizable_keys.include?(key.value.to_s)
-            return unless unverified?(pair.value)
-
-            add_offense(pair.value, message: format(MSG, key: key.value))
-          end
-
-          # A value we can neither confirm nor deny is localized: a variable or
-          # method result (but not an obvious `t(...)`/`translate` call). String
-          # and other literals are excluded — those are RequireTranslation's job.
-          def unverified?(node)
-            return false unless DYNAMIC_TYPES.include?(node.type)
-
-            !translation_call?(node)
-          end
-
-          def translation_call?(node)
-            (node.send_type? || node.csend_type?) &&
-              TRANSLATION_METHODS.include?(node.method_name)
-          end
-
-          def watched_methods
-            cop_config.fetch('WatchedMethods', DEFAULT_WATCHED_METHODS)
-          end
-
-          def localizable_keys
-            cop_config.fetch('LocalizableKeys', DEFAULT_LOCALIZABLE_KEYS)
-          end
-        end
-      end
-    end
-  end
-end