ece517-p3/expertiza

View on GitHub
app/controllers/advice_controller.rb

Summary

Maintainability
A
25 mins
Test Coverage

Unprotected mass assignment
Open

          QuestionAdvice.update(advice_key, advice: params[:advice][advice_key.to_sym][:advice])
Severity: Critical
Found in app/controllers/advice_controller.rb by brakeman

Mass assignment is a feature of Rails which allows an application to create a record from the values of a hash.

Example:

User.new(params[:user])

Unfortunately, if there is a user field called admin which controls administrator access, now any user can make themselves an administrator.

attr_accessible and attr_protected can be used to limit mass assignment. However, Brakeman will warn unless attr_accessible is used, or mass assignment is completely disabled.

There are two different mass assignment warnings which can arise. The first is when mass assignment actually occurs, such as the example above. This results in a warning like

Unprotected mass assignment near line 61: User.new(params[:user])

The other warning is raised whenever a model is found which does not use attr_accessible. This produces generic warnings like

Mass assignment is not restricted using attr_accessible

with a list of affected models.

In Rails 3.1 and newer, mass assignment can easily be disabled:

config.active_record.whitelist_attributes = true

Unfortunately, it can also easily be bypassed:

User.new(params[:user], :without_protection => true)

Brakeman will warn on uses of without_protection.

Assignment Branch Condition size for edit_advice is too high. [27.62/15]
Open

  def edit_advice
    @questionnaire = Questionnaire.find(params[:id])

    @questionnaire.questions.each do |question|
      num_questions = if question.is_a?(ScoredQuestion)

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for save_advice is too high. [22.18/15]
Open

  def save_advice
    @questionnaire = Questionnaire.find(params[:id])
    begin
      unless params[:advice].nil?
        params[:advice].each_key do |advice_key|

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method edit_advice has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

  def edit_advice
    @questionnaire = Questionnaire.find(params[:id])

    @questionnaire.questions.each do |question|
      num_questions = if question.is_a?(ScoredQuestion)
Severity: Minor
Found in app/controllers/advice_controller.rb - About 25 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Use next to skip iteration.
Open

      if question.question_advices.length != num_questions or
        sorted_advice.empty? or
        sorted_advice[0].score != @questionnaire.min_question_score or
        sorted_advice[sorted_advice.length - 1] != @questionnaire.max_question_score

Use next to skip iteration instead of a condition at the end.

Example: EnforcedStyle: skipmodifierifs (default)

# bad
[1, 2].each do |a|
  if a == 1
    puts a
  end
end

# good
[1, 2].each do |a|
  next unless a == 1
  puts a
end

# good
[1, 2].each do |o|
  puts o unless o == 1
end

Example: EnforcedStyle: always

# With `always` all conditions at the end of an iteration needs to be
# replaced by next - with `skip_modifier_ifs` the modifier if like
# this one are ignored: `[1, 2].each { |a| return 'yes' if a == 1 }`

# bad
[1, 2].each do |o|
  puts o unless o == 1
end

# bad
[1, 2].each do |a|
  if a == 1
    puts a
  end
end

# good
[1, 2].each do |a|
  next unless a == 1
  puts a
end

There are no issues that match your filters.

Category
Status