3scale/porta

View on GitHub
lib/developer_portal/app/mailers/user_mailer.rb

Summary

Maintainability
A
1 hr
Test Coverage

Method signup_notification has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def signup_notification(user)
    provider = self.provider_account = user.account.provider_account

    subject = user.account.provider? ? "3scale account confirmation" : "#{account_name(user)} API account confirmation"

Severity: Minor
Found in lib/developer_portal/app/mailers/user_mailer.rb - About 1 hr to fix

    UserMailer#signup_notification has approx 8 statements
    Open

      def signup_notification(user)

    A method with Too Many Statements is any method that has a large number of lines.

    Too Many Statements warns about any method that has more than 5 statements. Reek's smell detector for Too Many Statements counts +1 for every simple statement in a method and +1 for every statement within a control structure (if, else, case, when, for, while, until, begin, rescue) but it doesn't count the control structure itself.

    So the following method would score +6 in Reek's statement-counting algorithm:

    def parse(arg, argv, &error)
      if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
        return nil, block, nil                                         # +1
      end
      opt = (val = parse_arg(val, &error))[1]                          # +2
      val = conv_arg(*val)                                             # +3
      if opt and !arg
        argv.shift                                                     # +4
      else
        val[0] = nil                                                   # +5
      end
      val                                                              # +6
    end

    (You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)

    UserMailer#signup_notification calls 'account_name(user)' 2 times
    Open

        subject = user.account.provider? ? "3scale account confirmation" : "#{account_name(user)} API account confirmation"
    
        headers(
          'Return-Path' => from_address(user),
          'X-SMTPAPI' => '{"category": "Signup Notification"}'

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#signup_notification calls 'user.account' 5 times
    Open

        provider = self.provider_account = user.account.provider_account
    
        subject = user.account.provider? ? "3scale account confirmation" : "#{account_name(user)} API account confirmation"
    
        headers(

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#signup_notification calls 'user.activation_code' 3 times
    Open

        if user.activation_code
          activate_url = if user.account.provider?
                           provider_activate_url(activation_code: user.activation_code, host: domain(user))
                         else
                           developer_portal.activate_url(activation_code: user.activation_code, host: domain(user))

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#lost_password calls 'domain(user)' 3 times
    Open

                developer_portal.admin_account_password_url password_reset_token: user.lost_password_token, host: domain(user)
              else
                provider_password_url password_reset_token: user.lost_password_token, host: domain(user)
              end
    
    

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#signup_notification calls 'domain(user)' 3 times
    Open

                           provider_activate_url(activation_code: user.activation_code, host: domain(user))
                         else
                           developer_portal.activate_url(activation_code: user.activation_code, host: domain(user))
                         end
        end

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#lost_password calls 'user.lost_password_token' 2 times
    Open

                developer_portal.admin_account_password_url password_reset_token: user.lost_password_token, host: domain(user)
              else
                provider_password_url password_reset_token: user.lost_password_token, host: domain(user)

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#lost_password calls 'from_address(user)' 2 times
    Open

                'Return-Path' => from_address(user),
                'X-SMTPAPI' => '{"category": "Lost password"}'
        )
    
        # TODO: make lost_password and provider_lost_password mailer method

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#signup_notification calls 'user.account.provider_account' 2 times
    Open

        provider = self.provider_account = user.account.provider_account
    
        subject = user.account.provider? ? "3scale account confirmation" : "#{account_name(user)} API account confirmation"
    
        headers(

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#signup_notification calls 'user.account.provider?' 2 times
    Open

        subject = user.account.provider? ? "3scale account confirmation" : "#{account_name(user)} API account confirmation"
    
        headers(
          'Return-Path' => from_address(user),
          'X-SMTPAPI' => '{"category": "Signup Notification"}'

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#signup_notification calls 'from_address(user)' 2 times
    Open

          'Return-Path' => from_address(user),
          'X-SMTPAPI' => '{"category": "Signup Notification"}'
        )
    
        if user.activation_code

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

    UserMailer#lost_password calls 'user.account' 2 times
    Open

        self.provider_account = user.account.provider_account
    
        subject = "#{provider.name} Lost password recovery. (Valid for 24 hours)"
    
        headers(

    Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

    Reek implements a check for Duplicate Method Call.

    Example

    Here's a very much simplified and contrived example. The following method will report a warning:

    def double_thing()
      @other.thing + @other.thing
    end

    One quick approach to silence Reek would be to refactor the code thus:

    def double_thing()
      thing = @other.thing
      thing + thing
    end

    A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

    class Other
      def double_thing()
        thing + thing
      end
    end

    The approach you take will depend on balancing other factors in your code.

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

      def signup_notification(user)
        provider = self.provider_account = user.account.provider_account
    
        subject = user.account.provider? ? "3scale account confirmation" : "#{account_name(user)} API account confirmation"
    
    
    Severity: Minor
    Found in lib/developer_portal/app/mailers/user_mailer.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

    There are no issues that match your filters.

    Category
    Status