armandofox/audience1st

View on GitHub
app/controllers/reports_controller.rb

Summary

Maintainability
B
5 hrs
Test Coverage
D
64%

Unsafe reflection method const_get called with parameter value
Open

    entity = Object.const_get(params[:klass])
Severity: Critical
Found in app/controllers/reports_controller.rb by brakeman

Brakeman reports on several cases of remote code execution, in which a user is able to control and execute code in ways unintended by application authors.

The obvious form of this is the use of eval with user input.

However, Brakeman also reports on dangerous uses of send, constantize, and other methods which allow creation of arbitrary objects or calling of arbitrary methods.

Method has too many lines. [45/30]
Open

  def run_special
    return unless (klass = validate_report_type params[:report_name])
    action = params[:what]
    full_report_url = request.fullpath
    @report = klass.__send__(:new, params[:output])

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Cyclomatic complexity for run_special is too high. [13/6]
Open

  def run_special
    return unless (klass = validate_report_type params[:report_name])
    action = params[:what]
    full_report_url = request.fullpath
    @report = klass.__send__(:new, params[:output])

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Cyclomatic complexity for revenue_by_payment_method is too high. [8/6]
Open

  def revenue_by_payment_method
    # report may be by date range or by production
    case params[:txn_report_by]
    when 'date'
      from,to = Time.range_from_params(params[:txn_report_dates])

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method run_special has 45 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def run_special
    return unless (klass = validate_report_type params[:report_name])
    action = params[:what]
    full_report_url = request.fullpath
    @report = klass.__send__(:new, params[:output])
Severity: Minor
Found in app/controllers/reports_controller.rb - About 1 hr to fix

    Method run_special has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

      def run_special
        return unless (klass = validate_report_type params[:report_name])
        action = params[:what]
        full_report_url = request.fullpath
        @report = klass.__send__(:new, params[:output])
    Severity: Minor
    Found in app/controllers/reports_controller.rb - About 1 hr 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

    Method revenue_by_payment_method has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

      def revenue_by_payment_method
        # report may be by date range or by production
        case params[:txn_report_by]
        when 'date'
          from,to = Time.range_from_params(params[:txn_report_dates])
    Severity: Minor
    Found in app/controllers/reports_controller.rb - About 55 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

    Method mark_fulfilled has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

      def mark_fulfilled
        i = 0
        flash[:notice] = ''
        params[:voucher].each_pair do |vid,do_update|
          next if do_update.to_i.zero?
    Severity: Minor
    Found in app/controllers/reports_controller.rb - About 55 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 == if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition.
    Open

        return unless report_subclass = validate_report_type(report_name)

    This cop checks for assignments in the conditions of if/while/until.

    Example:

    # bad
    
    if some_var = true
      do_something
    end

    Example:

    # good
    
    if some_var == true
      do_something
    end

    Useless assignment to variable - csv.
    Open

          return ((csv = @report.csv) ?

    This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

    assigned but unused variable - foo

    Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

    Example:

    # bad
    
    def some_method
      some_var = 1
      do_something
    end

    Example:

    # good
    
    def some_method
      some_var = 1
      do_something(some_var)
    end

    There are no issues that match your filters.

    Category
    Status