IntenseWebs/discourse
3
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2026-09-05 04:40:41 -05:00
Code Issues Packages Projects Releases Wiki Activity

DEV: Enable Style/AccessModifierDeclarations (#43247)

Browse Source 
This PR enables the `Style/AccessModifierDeclarations` RuboCop rule.
This commit is contained in:
Alan Guo Xiang Tan
2026-09-04 14:12:01 +08:00
committed by GitHub
parent cc17833746
commit dfba7a628b
6 changed files with 189 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.rubocop.yml
+4
View File
@@ -51,6 +51,10 @@ RSpec/InstanceVariable:
Include:
- spec/models/**/*
Style/AccessModifierDeclarations:
Enabled: true
AllowModifiersOnSymbols: false
Style/RedundantFreeze:
Enabled: true
app/controllers/admin/themes_controller.rb
+13 -15
View File
@@ -128,21 +128,6 @@ class Admin::ThemesController < Admin::AdminController
render_json_error err.message
end
def create_remote_theme_placeholder(remote, branch:, private_key:)
Theme.transaction do
remote_theme =
RemoteTheme.create!(remote_url: remote, branch: branch, private_key: private_key)
Theme.create!(
user_id: theme_user&.id || -1,
name: remote.gsub(/\.git\z/, "").split("/").last,
remote_theme: remote_theme,
)
end
end
private :create_remote_theme_placeholder
def index
@themes = Theme.strict_loading.include_relations.order(:name)
@@ -437,6 +422,19 @@ class Admin::ThemesController < Admin::AdminController
private
def create_remote_theme_placeholder(remote, branch:, private_key:)
Theme.transaction do
remote_theme =
RemoteTheme.create!(remote_url: remote, branch: branch, private_key: private_key)
Theme.create!(
user_id: theme_user&.id || -1,
name: remote.gsub(/\.git\z/, "").split("/").last,
remote_theme: remote_theme,
)
end
end
def ban_in_allowlist_mode!
raise Discourse::InvalidAccess if !Theme.allowed_remote_theme_ids.nil?
end
app/helpers/application_helper.rb
+19 -19
View File
@@ -407,25 +407,6 @@ module ApplicationHelper
result.join("\n")
end
private def generate_twitter_card_metadata(result, opts)
img_url = opts[:x_summary_large_image].presence || opts[:image]
# Twitter does not allow SVGs, see https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup
if img_url.ends_with?(".svg")
img_url = SiteSetting.site_logo_url.ends_with?(".svg") ? nil : SiteSetting.site_logo_url
end
if opts[:x_summary_large_image].present? && img_url.present?
result << tag(:meta, name: "twitter:card", content: "summary_large_image")
result << tag(:meta, name: "twitter:image", content: img_url)
elsif opts[:image].present? && img_url.present?
result << tag(:meta, name: "twitter:card", content: "summary")
result << tag(:meta, name: "twitter:image", content: img_url)
else
result << tag(:meta, name: "twitter:card", content: "summary")
end
end
def render_sitelinks_search_tag
if current_page?("/") || current_page?(Discourse.base_path)
json = {
@@ -579,6 +560,25 @@ module ApplicationHelper
private
def generate_twitter_card_metadata(result, opts)
img_url = opts[:x_summary_large_image].presence || opts[:image]
# Twitter does not allow SVGs, see https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup
if img_url.ends_with?(".svg")
img_url = SiteSetting.site_logo_url.ends_with?(".svg") ? nil : SiteSetting.site_logo_url
end
if opts[:x_summary_large_image].present? && img_url.present?
result << tag(:meta, name: "twitter:card", content: "summary_large_image")
result << tag(:meta, name: "twitter:image", content: img_url)
elsif opts[:image].present? && img_url.present?
result << tag(:meta, name: "twitter:card", content: "summary")
result << tag(:meta, name: "twitter:image", content: img_url)
else
result << tag(:meta, name: "twitter:card", content: "summary")
end
end
def build_splash_screen_image
@splash_screen_image_svg = nil
lib/csrf_token_verifier.rb
+1 -1
View File
@@ -22,7 +22,7 @@ class CSRFTokenVerifier
raise InvalidCSRFToken unless verified_request?
end
public :form_authenticity_token
public :form_authenticity_token # rubocop:disable Style/AccessModifierDeclarations
private
plugins/discourse-ai/lib/completions/endpoints/base.rb
+151 -155
View File
@@ -203,6 +203,157 @@ module DiscourseAi
)
end
def final_log_update(log)
# for people that need to override
end
def estimated_cost_for(log)
llm_model.estimated_cost_for_tokens(
request_tokens: log.request_tokens,
response_tokens: log.response_tokens,
cache_read_tokens: log.cache_read_tokens,
cache_write_tokens: log.cache_write_tokens,
)
end
def default_options
raise NotImplementedError
end
def provider_id
raise NotImplementedError
end
def prompt_size(prompt)
tokenizer.size(extract_prompt_for_tokenizer(prompt))
end
attr_reader :llm_model
# Extra HTTP headers contributed by registered providers for this
# request. Endpoints that want them merge the result into their request
# headers. Provider failures are isolated so they can never break a
# completion.
def extra_request_headers
providers = self.class.request_headers_providers
return {} if providers.blank?
context =
RequestHeaderContext.new(
llm_model: llm_model,
feature_name: @feature_name,
feature_context: @feature_context,
has_images: @request_has_images,
streaming: @streaming_mode,
)
providers.each_with_object({}) do |provider, headers|
result = provider.call(context)
headers.merge!(result.stringify_keys) if result.is_a?(Hash)
rescue StandardError => e
Discourse.warn_exception(
e,
message: "Discourse AI request header provider raised an error; skipping it",
)
end
end
protected
def tokenizer
llm_model.tokenizer_class
end
# Detects whether the translated prompt carries image content, so
# providers can flag vision requests. Mirrors the OpenAI-compatible
# shape (messages with an array content holding "image_url" parts) used
# by the providers that consume this; degrades to false otherwise.
def prompt_has_images?(translated_prompt)
return false if !translated_prompt.is_a?(Array)
translated_prompt.any? do |message|
content = message[:content] if message.is_a?(Hash)
content.is_a?(Array) &&
content.any? { |part| part.is_a?(Hash) && part[:type] == "image_url" }
end
rescue StandardError
false
end
# should normalize temperature, max_tokens, stop_words to endpoint specific values
def normalize_model_params(model_params)
raise NotImplementedError
end
def resolve_thinking_config(_model_params)
DiscourseAi::Completions::ThinkingConfig.disabled
end
def apply_thinking_config_to_model_params(model_params)
return model_params if thinking_config.blank?
if thinking_config.reserved_output_tokens
model_params[:reserved_output_tokens] = thinking_config.reserved_output_tokens
end
model_params
end
def thinking_configured?
thinking_config.present? && !thinking_config.unsupported? &&
(thinking_config.enabled? || thinking_config.explicit_none?)
end
def strip_sampling_params_for_thinking!(model_params)
return model_params if thinking_config.blank?
model_params.delete(:temperature) if thinking_config.strip_temperature?
model_params.delete(:top_p) if thinking_config.strip_top_p?
model_params
end
def model_uri
raise NotImplementedError
end
def prepare_payload(_prompt, _model_params)
raise NotImplementedError
end
def provider_model_params(model_params)
model_params.except(:thinking_effort, :reserved_output_tokens, :provider_output_tokens)
end
def prepare_request(_payload)
raise NotImplementedError
end
def decode(_response_raw)
raise NotImplementedError
end
def decode_chunk_finish
[]
end
def decode_chunk(_chunk)
raise NotImplementedError
end
def extract_prompt_for_tokenizer(prompt)
prompt.map { |message| message[:content] || message["content"] || "" }.join("\n")
end
def xml_tools_enabled?
raise NotImplementedError
end
def disable_streaming?
@disable_streaming = !!llm_model.lookup_custom_param("disable_streaming")
end
private
def replay_non_streaming_as_streaming!(
dialect,
user,
@@ -501,161 +652,6 @@ module DiscourseAi
raise if !cancelled
end
private :replay_non_streaming_as_streaming!,
:build_structured_output,
:perform_completion_request_with_retries
def final_log_update(log)
# for people that need to override
end
def estimated_cost_for(log)
llm_model.estimated_cost_for_tokens(
request_tokens: log.request_tokens,
response_tokens: log.response_tokens,
cache_read_tokens: log.cache_read_tokens,
cache_write_tokens: log.cache_write_tokens,
)
end
def default_options
raise NotImplementedError
end
def provider_id
raise NotImplementedError
end
def prompt_size(prompt)
tokenizer.size(extract_prompt_for_tokenizer(prompt))
end
attr_reader :llm_model
# Extra HTTP headers contributed by registered providers for this
# request. Endpoints that want them merge the result into their request
# headers. Provider failures are isolated so they can never break a
# completion.
def extra_request_headers
providers = self.class.request_headers_providers
return {} if providers.blank?
context =
RequestHeaderContext.new(
llm_model: llm_model,
feature_name: @feature_name,
feature_context: @feature_context,
has_images: @request_has_images,
streaming: @streaming_mode,
)
providers.each_with_object({}) do |provider, headers|
result = provider.call(context)
headers.merge!(result.stringify_keys) if result.is_a?(Hash)
rescue StandardError => e
Discourse.warn_exception(
e,
message: "Discourse AI request header provider raised an error; skipping it",
)
end
end
protected
def tokenizer
llm_model.tokenizer_class
end
# Detects whether the translated prompt carries image content, so
# providers can flag vision requests. Mirrors the OpenAI-compatible
# shape (messages with an array content holding "image_url" parts) used
# by the providers that consume this; degrades to false otherwise.
def prompt_has_images?(translated_prompt)
return false if !translated_prompt.is_a?(Array)
translated_prompt.any? do |message|
content = message[:content] if message.is_a?(Hash)
content.is_a?(Array) &&
content.any? { |part| part.is_a?(Hash) && part[:type] == "image_url" }
end
rescue StandardError
false
end
# should normalize temperature, max_tokens, stop_words to endpoint specific values
def normalize_model_params(model_params)
raise NotImplementedError
end
def resolve_thinking_config(_model_params)
DiscourseAi::Completions::ThinkingConfig.disabled
end
def apply_thinking_config_to_model_params(model_params)
return model_params if thinking_config.blank?
if thinking_config.reserved_output_tokens
model_params[:reserved_output_tokens] = thinking_config.reserved_output_tokens
end
model_params
end
def thinking_configured?
thinking_config.present? && !thinking_config.unsupported? &&
(thinking_config.enabled? || thinking_config.explicit_none?)
end
def strip_sampling_params_for_thinking!(model_params)
return model_params if thinking_config.blank?
model_params.delete(:temperature) if thinking_config.strip_temperature?
model_params.delete(:top_p) if thinking_config.strip_top_p?
model_params
end
def model_uri
raise NotImplementedError
end
def prepare_payload(_prompt, _model_params)
raise NotImplementedError
end
def provider_model_params(model_params)
model_params.except(:thinking_effort, :reserved_output_tokens, :provider_output_tokens)
end
def prepare_request(_payload)
raise NotImplementedError
end
def decode(_response_raw)
raise NotImplementedError
end
def decode_chunk_finish
[]
end
def decode_chunk(_chunk)
raise NotImplementedError
end
def extract_prompt_for_tokenizer(prompt)
prompt.map { |message| message[:content] || message["content"] || "" }.join("\n")
end
def xml_tools_enabled?
raise NotImplementedError
end
def disable_streaming?
@disable_streaming = !!llm_model.lookup_custom_param("disable_streaming")
end
private
def start_completion_log(
request_body:,
dialect:,
spec/fabricators/published_page_fabricator.rb
+1 -1
View File
@@ -3,5 +3,5 @@
Fabricator(:published_page) do
topic
slug "published-page-test-#{SecureRandom.hex}"
public false
public false # rubocop:disable Style/AccessModifierDeclarations
end