rubocop-openproject 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cfe3bab3bbbc3032190c71f7e824eb2d451f854248d076aca30db79723f346b
-  data.tar.gz: b265782c32033cd8315f9a0b3bef3cb4cf7c0bdcf01d3fb85de59559fa9a9935
+  metadata.gz: 821ee2f0425e32049c380dd582471e37feb47c8565b1a8b05e2746809e498993
+  data.tar.gz: b8c1b464b25dbb3f0c07dcd5d7f20fd8bd331b91565f31782c7d27920a6148be
 SHA512:
-  metadata.gz: cde9e717e29db386ab61514b4533f0861956fe2aefe5eeadc9b5baf0c12fb4fa3851f565c0cab2ca9919ed652c27623a45ef1f41ed9c6f2f9bce81fcf2f9aff7
-  data.tar.gz: 690ebd432e8719ba28f5bd2e146304883626dde1cdd8fab45a6dc518cf16401615c3cdab7382c258db7cc166b40baac9e512c915a26a59aafe5fbb0897d74d22
+  metadata.gz: 20ea7aec95cb84472a6e145dfc71e31a542a3cda8e6a126ea5f6adf8832c6852aff30d506c624bb930fca6ef4a2fb324ecf777b88a2afb3d7d9e2e227c7a436e
+  data.tar.gz: 240bcf2a89496e23e73ca909171b754eb92e417bb86d67c07cf3dc2415ca1404879d59fabff2c829bec58d40484b8c49e833a719749c95a2b1b1828b5b0de294

data/.ruby-version

@@ -0,0 +1 @@
+4.0.2

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## [Unreleased]
+# rubocop-openproject
+
+## 0.6.0
+
+### Minor Changes
+
+- 6e7b812: Add `OpenProject/UseRenderModeInsteadOfPrimitives` cop to flag `format_text` calls that pass the external-rendering primitive flags (`static_html: true`, `plain_text: true`, `only_path: false`) instead of the canonical `render_mode:` API or the `format_mail_html` / `format_mail_text` mailer view helpers.
+
+## [0.5.0] - 2026-05-05
+
+- Add `OpenProject/NoParamsInWorkPackageWhereId` cop to catch
+  `WorkPackage.where(id: params[...])` patterns that silently drop semantic
+  identifiers (e.g. `"PROJ-42"`) when PostgreSQL casts the string to integer 0.
 
 ## [0.4.0] - 2026-03-27
 

data/README.md

@@ -24,16 +24,19 @@ require:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+When working on a change, add a changeset describing it: run `npx changeset`
+(or `./node_modules/.bin/changeset` after `npm install`), pick the bump
+(`patch` / `minor` / `major`), and write a short summary. This adds a file under
+`.changeset/`; commit it with your PR. The release automation turns accumulated
+changesets into the next version bump and `CHANGELOG.md` entry.
 
 ## Releasing
 
-1. Update the version in `lib/rubocop/open_project/version.rb`
-2. Update the changelog in `CHANGELOG.md`
-3. Run `bundle install` to update `Gemfile.lock`
-4. Run `rake` to check everything is fine and fix any issues
-5. Commit your changes (`git commit -am 'Prepare release X.Y.Z'`)
-6. Run `bundle exec rake release`
+Releases are driven by [changesets](https://github.com/changesets/changesets) and
+GitHub Actions, so no RubyGems credentials are needed on your machine. See
+[.github/RELEASING.md](.github/RELEASING.md) for the flow and one-time setup.
 
 ## Contributing
 

data/config/default.yml

@@ -13,11 +13,21 @@ OpenProject/NoNotImplementedError:
   Enabled: true
   VersionAdded: '0.4.0'
 
+OpenProject/NoParamsInWorkPackageWhereId:
+  Description: 'Avoid `WorkPackage.where(id: params[...])`; use `where_display_id_in` to honour semantic identifiers.'
+  Enabled: true
+  VersionAdded: '0.5.0'
+
 OpenProject/NoSleepInFeatureSpecs:
   Description: 'Avoid using `sleep` greater than 1 second in feature specs.'
   Enabled: true
   VersionAdded: '0.1.0'
 
+OpenProject/UseRenderModeInsteadOfPrimitives:
+  Description: 'Use `render_mode:` instead of `static_html:`/`plain_text:`/`only_path:` on `format_text`.'
+  Enabled: true
+  VersionAdded: '0.6.0'
+
 OpenProject/UseServiceResultFactoryMethods:
   Description: 'Use ServiceResult factory methods instead of ServiceResult.new.'
   Enabled: true

data/lib/rubocop/cop/open_project/no_params_in_work_package_where_id.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenProject
+      # Flags `WorkPackage.where(id: params[...])` patterns. With semantic work
+      # package identifiers enabled, params may carry strings like "PROJ-42"
+      # that PostgreSQL silently casts to integer 0 inside `where(id: ...)`,
+      # producing an empty result set instead of an error. Use the dedicated
+      # resolver `WorkPackage.where_display_id_in(...)` which partitions
+      # numeric and semantic inputs and consults the alias table.
+      #
+      # The cop fires when the receiver chain demonstrably resolves to a
+      # WorkPackage relation — either rooted at the `WorkPackage` constant or
+      # passing through an association call whose name ends in
+      # `work_packages` (e.g. `project.work_packages`,
+      # `user.assigned_work_packages`) — and the value is derived from
+      # `params[...]`. Internal subquery composition
+      # (`where(id: scope.pluck(:id))`) and primary-key literals are left
+      # alone.
+      #
+      # @example
+      #   # bad
+      #   WorkPackage.where(id: params[:work_package_id])
+      #
+      #   # bad
+      #   WorkPackage.where(id: params[:work_package_id] || params[:ids])
+      #
+      #   # bad
+      #   WorkPackage.includes(:project).where(id: params[:ids])
+      #
+      #   # bad
+      #   project.work_packages.where(id: params[:work_package_id])
+      #
+      #   # bad
+      #   current_user.assigned_work_packages.where(id: params[:ids])
+      #
+      #   # good
+      #   WorkPackage.where_display_id_in(params[:work_package_id])
+      #
+      #   # good
+      #   project.work_packages.where_display_id_in(params[:work_package_id])
+      #
+      #   # good (primary key, not user input)
+      #   WorkPackage.where(id: 42)
+      #
+      #   # good (subquery, not user input)
+      #   WorkPackage.where(id: other_scope.select(:id))
+      class NoParamsInWorkPackageWhereId < Base
+        extend AutoCorrector
+
+        MSG = "Avoid `WorkPackage.where(id: params[...])` — semantic identifiers like " \
+              '"PROJ-42" are silently coerced to 0 by the SQL cast. ' \
+              "Use `WorkPackage.where_display_id_in(...)` instead."
+
+        RESTRICT_ON_SEND = %i[where].freeze
+
+        def_node_matcher :params_access?, <<~PATTERN
+          (send (send nil? :params) :[] _)
+        PATTERN
+
+        # A receiver that traces back through any chain of sends to either:
+        #   - the `WorkPackage` constant: `WorkPackage`, `WorkPackage.foo`, ...
+        #   - an association call whose name ends in `work_packages`:
+        #     `project.work_packages`, `user.assigned_work_packages`, ...
+        # The recursion handles arbitrarily deep chains in either form.
+        def_node_matcher :work_package_relation?, <<~PATTERN
+          {
+            (const nil? :WorkPackage)
+            (send _ #work_package_association? ...)
+            (send #work_package_relation? _ ...)
+          }
+        PATTERN
+
+        def on_send(node)
+          return unless work_package_relation?(node.receiver)
+
+          hash_arg = node.first_argument
+          id_value = id_value_from_hash(hash_arg)
+          return unless id_value && value_uses_params?(id_value)
+
+          add_offense(node) do |corrector|
+            next unless autocorrectable_value?(id_value) && sole_id_predicate?(hash_arg)
+
+            corrector.replace(node, "#{node.receiver.source}.where_display_id_in(#{id_value.source})")
+          end
+        end
+
+        private
+
+        def id_value_from_hash(arg)
+          return unless arg&.hash_type?
+
+          pair = arg.pairs.find { |p| p.key.sym_type? && p.key.value == :id }
+          pair&.value
+        end
+
+        # Refuse to autocorrect when the hash carries additional predicates
+        # (e.g. `where(id: params[:id], project_id: 5)`); rewriting to
+        # `where_display_id_in(params[:id])` would silently drop them.
+        def sole_id_predicate?(hash_arg)
+          hash_arg.pairs.size == 1
+        end
+
+        def value_uses_params?(node)
+          return true if params_access?(node)
+
+          node.each_descendant(:send).any? { |descendant| params_access?(descendant) }
+        end
+
+        def autocorrectable_value?(node)
+          return true if params_access?(node)
+          return false unless node.or_type?
+
+          node.children.all? { |child| autocorrectable_value?(child) }
+        end
+
+        def work_package_association?(method_name)
+          method_name.to_s.end_with?("work_packages")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/open_project/use_render_mode_instead_of_primitives.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenProject
+      # Flags `format_text` calls that pass the external-rendering primitive
+      # flags (`static_html: true`, `plain_text: true`, `only_path: false`)
+      # instead of the canonical `render_mode:` API.
+      #
+      # `format_text` renders trusted Markdown for two distinct audiences:
+      # in-app HTML (the default) and external surfaces such as mailer
+      # bodies or feeds. The external surface needs absolute URLs and a
+      # subset of macros pre-resolved to static HTML / plain text, because
+      # the recipient has no JavaScript runtime to hydrate the rest. The
+      # primitive flags express that requirement as three loosely coupled
+      # toggles, which makes call sites easy to get partially right (and
+      # silently wrong — see openproject#74762, where a mailer view skipped
+      # `static_html: true` and rendered numeric work package IDs instead of
+      # their semantic identifiers).
+      #
+      # The canonical API is `render_mode: :external_html` /
+      # `render_mode: :external_text`, with the mailer view helpers
+      # `format_mail_html` and `format_mail_text` as the preferred form
+      # inside mailer templates. The cop fires on both `.rb` and `.erb`
+      # sources via OpenProject's erb_lint Rubocop bridge.
+      #
+      # @example
+      #   # bad
+      #   format_text("hi", static_html: true, only_path: false)
+      #
+      #   # bad
+      #   format_text("hi", plain_text: true, only_path: false)
+      #
+      #   # bad
+      #   format_text("hi", only_path: false)
+      #
+      #   # bad (two-arg form)
+      #   format_text(@user, :name, only_path: false)
+      #
+      #   # good (canonical API)
+      #   format_text("hi", render_mode: :external_html)
+      #
+      #   # good (mailer view helper)
+      #   format_mail_html("hi")
+      #
+      #   # good (in-app default; no external flags)
+      #   format_text("hi", only_path: true)
+      #
+      #   # good (render_mode present — primitive override is an explicit escape hatch)
+      #   format_text("hi", render_mode: :external_html, only_path: false)
+      class UseRenderModeInsteadOfPrimitives < Base
+        MSG_HTML = "Use `render_mode: :external_html` (or `format_mail_html` in mailer views) " \
+                   "instead of the primitive flags `static_html: true` / `only_path: false`. " \
+                   "The `render_mode:` API documents intent and bundles the coupled toggles " \
+                   "that silently produced numeric IDs in watcher notifications (openproject#74762)."
+
+        MSG_TEXT = "Use `render_mode: :external_text` (or `format_mail_text` in mailer views) " \
+                   "instead of the primitive flags `plain_text: true` / `only_path: false`. " \
+                   "The `render_mode:` API documents intent and bundles the coupled toggles " \
+                   "that silently produced numeric IDs in watcher notifications (openproject#74762)."
+
+        MSG_ONLY_PATH = "Use `render_mode: :external_html` (or `format_mail_html` in mailer views) " \
+                        "instead of passing `only_path: false` on its own. The bare flag is " \
+                        "an under-specified external render that silently produced numeric IDs " \
+                        "in watcher notifications (openproject#74762)."
+
+        RESTRICT_ON_SEND = %i[format_text].freeze
+
+        def on_send(node)
+          hash_arg = node.last_argument
+          return unless hash_arg&.hash_type?
+
+          pairs = symbol_keyed_pairs(hash_arg)
+          return if render_mode_present?(pairs)
+
+          static_html = pair_with_value(pairs, :static_html, true)
+          plain_text  = pair_with_value(pairs, :plain_text, true)
+          only_path_false = pair_with_value(pairs, :only_path, false)
+
+          return unless static_html || plain_text || only_path_false
+
+          add_offense(node, message: message_for(static_html, plain_text, only_path_false))
+        end
+
+        private
+
+        def symbol_keyed_pairs(hash_arg)
+          hash_arg.pairs.select { |p| p.key.sym_type? }
+        end
+
+        def render_mode_present?(pairs)
+          pairs.any? { |p| p.key.value == :render_mode }
+        end
+
+        def pair_with_value(pairs, key, value)
+          pairs.find { |p| p.key.value == key && literal_equals?(p.value, value) }
+        end
+
+        def literal_equals?(node, value)
+          case value
+          when true then node.true_type?
+          when false then node.false_type?
+          end
+        end
+
+        def message_for(static_html, plain_text, only_path_false)
+          return MSG_HTML if static_html
+          return MSG_TEXT if plain_text
+
+          MSG_ONLY_PATH if only_path_false
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/open_project_cops.rb

@@ -2,5 +2,7 @@
 
 require_relative "open_project/add_preview_for_view_component"
 require_relative "open_project/no_not_implemented_error"
+require_relative "open_project/no_params_in_work_package_where_id"
 require_relative "open_project/use_service_result_factory_methods"
 require_relative "open_project/no_sleep_in_feature_specs"
+require_relative "open_project/use_render_mode_instead_of_primitives"

data/lib/rubocop/open_project/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module OpenProject
-    VERSION = "0.4.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-openproject
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - OpenProject GmbH
@@ -32,6 +32,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -40,7 +41,9 @@ files:
 - lib/rubocop-openproject.rb
 - lib/rubocop/cop/open_project/add_preview_for_view_component.rb
 - lib/rubocop/cop/open_project/no_not_implemented_error.rb
+- lib/rubocop/cop/open_project/no_params_in_work_package_where_id.rb
 - lib/rubocop/cop/open_project/no_sleep_in_feature_specs.rb
+- lib/rubocop/cop/open_project/use_render_mode_instead_of_primitives.rb
 - lib/rubocop/cop/open_project/use_service_result_factory_methods.rb
 - lib/rubocop/cop/open_project_cops.rb
 - lib/rubocop/open_project.rb
@@ -68,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: RuboCop cops for OpenProject
 test_files: []