Refactor topics controller

Refactor: 1) TopicsController to reduce code climate complexity.
2) Topic model, addressed comments

fix typo
This commit is contained in:
Manoj 2013-10-28 11:42:07 +05:30
parent c0d85fa6f9
commit 9650dbb97c
4 changed files with 70 additions and 42 deletions

View File

@ -29,8 +29,9 @@ class TopicsController < ApplicationController
return wordpress if params[:best].present? return wordpress if params[:best].present?
opts = params.slice(:username_filters, :filter, :page, :post_number) opts = params.slice(:username_filters, :filter, :page, :post_number)
username_filters = opts[:username_filters]
opts[:username_filters] = [opts[:username_filters]] if opts[:username_filters].is_a?(String) opts[:username_filters] = [username_filters] if username_filters.is_a?(String)
begin begin
@topic_view = TopicView.new(params[:id] || params[:topic_id], current_user, opts) @topic_view = TopicView.new(params[:id] || params[:topic_id], current_user, opts)
@ -46,7 +47,7 @@ class TopicsController < ApplicationController
# render workaround pseudo-static HTML page for old crawlers which ignores <noscript> # render workaround pseudo-static HTML page for old crawlers which ignores <noscript>
# (see http://meta.discourse.org/t/noscript-tag-and-some-search-engines/8078) # (see http://meta.discourse.org/t/noscript-tag-and-some-search-engines/8078)
return render 'topics/plain', layout: false if (SiteSetting.enable_escaped_fragments && params.has_key?('_escaped_fragment_')) return render 'topics/plain', layout: false if (SiteSetting.enable_escaped_fragments && params.key?('_escaped_fragment_'))
track_visit_to_topic track_visit_to_topic
@ -63,25 +64,21 @@ class TopicsController < ApplicationController
params.require(:best) params.require(:best)
params.require(:topic_id) params.require(:topic_id)
params.permit(:min_trust_level, :min_score, :min_replies, :bypass_trust_level_score, :only_moderator_liked) params.permit(:min_trust_level, :min_score, :min_replies, :bypass_trust_level_score, :only_moderator_liked)
opts = { best: params[:best].to_i,
min_trust_level: params[:min_trust_level] ? 1 : params[:min_trust_level].to_i,
min_score: params[:min_score].to_i,
min_replies: params[:min_replies].to_i,
bypass_trust_level_score: params[:bypass_trust_level_score].to_i, # safe cause 0 means ignore
only_moderator_liked: params[:only_moderator_liked].to_s == "true"
}
@topic_view = TopicView.new( @topic_view = TopicView.new(params[:topic_id], current_user, opts)
params[:topic_id],
current_user,
best: params[:best].to_i,
min_trust_level: params[:min_trust_level].nil? ? 1 : params[:min_trust_level].to_i,
min_score: params[:min_score].to_i,
min_replies: params[:min_replies].to_i,
bypass_trust_level_score: params[:bypass_trust_level_score].to_i, # safe cause 0 means ignore
only_moderator_liked: params[:only_moderator_liked].to_s == "true"
)
discourse_expires_in 1.minute discourse_expires_in 1.minute
wordpress_serializer = TopicViewWordpressSerializer.new(@topic_view, scope: guardian, root: false) wordpress_serializer = TopicViewWordpressSerializer.new(@topic_view, scope: guardian, root: false)
render_json_dump(wordpress_serializer) render_json_dump(wordpress_serializer)
end end
def posts def posts
params.require(:topic_id) params.require(:topic_id)
params.require(:post_ids) params.require(:post_ids)
@ -97,41 +94,31 @@ class TopicsController < ApplicationController
def update def update
topic = Topic.where(id: params[:topic_id]).first topic = Topic.where(id: params[:topic_id]).first
title, archetype = params[:title], params[:archetype]
guardian.ensure_can_edit!(topic) guardian.ensure_can_edit!(topic)
topic.title = params[:title] if params[:title].present?
topic.title = params[:title] if title.present?
# TODO: we may need smarter rules about converting archetypes # TODO: we may need smarter rules about converting archetypes
if current_user.admin? topic.archetype = "regular" if current_user.admin? && archetype == 'regular'
topic.archetype = "regular" if params[:archetype] == 'regular'
end
success = false success = false
Topic.transaction do Topic.transaction do
success = topic.save success = topic.save
success = topic.change_category(params[:category]) if success success = topic.change_category(params[:category]) if success
end end
# this is used to return the title to the client as it may have been # this is used to return the title to the client as it may have been
# changed by "TextCleaner" # changed by "TextCleaner"
if success success ? render_serialized(topic, BasicTopicSerializer) : render_json_error(topic)
render_serialized(topic, BasicTopicSerializer)
else
render_json_error(topic)
end
end end
def similar_to def similar_to
params.require(:title) params.require(:title)
params.require(:raw) params.require(:raw)
title, raw = params[:title], params[:raw] title, raw = params[:title], params[:raw]
[:title, :raw].each { |key| check_length_of(key, params[key]) }
raise Discourse::InvalidParameters.new(:title) if title.length < SiteSetting.min_title_similar_length
raise Discourse::InvalidParameters.new(:raw) if raw.length < SiteSetting.min_body_similar_length
# Only suggest similar topics if the site has a minimmum amount of topics present. # Only suggest similar topics if the site has a minimmum amount of topics present.
if Topic.count > SiteSetting.minimum_topics_similar topics = Topic.similar_to(title, raw, current_user).to_a if Topic.count_exceeds_minimum?
topics = Topic.similar_to(title, raw, current_user).to_a
end
render_serialized(topics, BasicTopicSerializer) render_serialized(topics, BasicTopicSerializer)
end end
@ -139,11 +126,13 @@ class TopicsController < ApplicationController
def status def status
params.require(:status) params.require(:status)
params.require(:enabled) params.require(:enabled)
status, topic_id = params[:status], params[:topic_id].to_i
enabled = (params[:enabled] == 'true')
raise Discourse::InvalidParameters.new(:status) unless %w(visible closed pinned archived).include?(params[:status]) check_for_status_presence(:status, status)
@topic = Topic.where(id: params[:topic_id].to_i).first @topic = Topic.where(id: topic_id).first
guardian.ensure_can_moderate!(@topic) guardian.ensure_can_moderate!(@topic)
@topic.update_status(params[:status], (params[:enabled] == 'true'), current_user) @topic.update_status(status, enabled, current_user)
render nothing: true render nothing: true
end end
@ -203,14 +192,7 @@ class TopicsController < ApplicationController
end end
def invite def invite
username_or_email = params[:user] username_or_email = params[:user] ? fetch_username : fetch_email
if username_or_email
# provides a level of protection for hashes
params.require(:user)
else
params.require(:email)
username_or_email = params[:email]
end
topic = Topic.where(id: params[:topic_id]).first topic = Topic.where(id: params[:topic_id]).first
guardian.ensure_can_invite_to!(topic) guardian.ensure_can_invite_to!(topic)
@ -347,4 +329,27 @@ class TopicsController < ApplicationController
topic.move_posts(current_user, post_ids_including_replies, args) topic.move_posts(current_user, post_ids_including_replies, args)
end end
def check_length_of(key, attr)
str = (key == :raw) ? "body" : key.to_s
invalid_param(key) if attr.length < SiteSetting.send("min_#{str}_similar_length")
end
def check_for_status_presence(key, attr)
invalid_param(key) unless %w(visible closed pinned archived).include?(attr)
end
def invalid_param(key)
raise Discourse::InvalidParameters.new(key.to_sym)
end
def fetch_username
params.require(:user)
params[:user]
end
def fetch_email
params.require(:email)
params[:email]
end
end end

View File

@ -183,6 +183,10 @@ class Topic < ActiveRecord::Base
end end
end end
def self.count_exceeds_minimum?
count > SiteSetting.minimum_topics_similar
end
def best_post def best_post
posts.order('score desc').limit(1).first posts.order('score desc').limit(1).first
end end

View File

@ -15,7 +15,7 @@ class TopicView
check_and_raise_exceptions check_and_raise_exceptions
options.each do |key, value| options.each do |key, value|
self.instance_variable_set("@#{key}".to_sym, value) self.instance_variable_set("@#{key}".to_sym, value)
end end
@page = @page.to_i @page = @page.to_i

View File

@ -1209,4 +1209,23 @@ describe Topic do
create_post(user: user, topic_id: topic_id) create_post(user: user, topic_id: topic_id)
}.should raise_exception }.should raise_exception
end end
describe ".count_exceeds_minimun?" do
before { SiteSetting.stubs(:minimum_topics_similar).returns(20) }
context "when Topic count is geater than minimum_topics_similar" do
it "should be true" do
Topic.stubs(:count).returns(30)
expect(Topic.count_exceeds_minimum?).to be_true
end
end
context "when topic's count is less than minimum_topics_similar" do
it "should be false" do
Topic.stubs(:count).returns(10)
expect(Topic.count_exceeds_minimum?).to_not be_true
end
end
end
end end