Sign upLogin

symphonyoss/hubot-symphony

View on GitHub
Star
src/adapter.js

Summary

Maintainability
D
1 day
Test Coverage
A
94%

File adapter.js has 256 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/**
 *    Copyright 2017 Jon Freedman
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
Severity: Minor
Found in src/adapter.js - About 2 hrs to fix

    Function constructor has 52 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      constructor(robot: Robot, options: AdapterOptionsType) {
    super(robot);
    this.robot = robot;

    if (process.env.HUBOT_SYMPHONY_HOST === undefined || process.env.HUBOT_SYMPHONY_HOST === null) {
    Severity: Major
    Found in src/adapter.js - About 2 hrs to fix

      Function run has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        run() {
    this.robot.logger.info('Initialising...');

    const getEnv = function(key: string, defaultVal: ?string): string {
      const value = process.env[key];
      Severity: Minor
      Found in src/adapter.js - About 1 hr to fix

        Function send has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

          send(envelope: SimpleMessageEnvelopeType, ...messages: Array<MessageTypeOrString>) {
    this.robot.logger.debug(`Sending ${messages.length} messages to ${envelope.room}`);
    for (const message of messages) {
      if (typeof message === 'string') {
        let messageML = message;
        Severity: Minor
        Found in src/adapter.js - About 35 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

        Function constructor has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

          constructor(robot: Robot, options: AdapterOptionsType) {
    super(robot);
    this.robot = robot;

    if (process.env.HUBOT_SYMPHONY_HOST === undefined || process.env.HUBOT_SYMPHONY_HOST === null) {
        Severity: Minor
        Found in src/adapter.js - 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

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          sendDirectMessageToUsername(username: string, ...messages: Array<MessageTypeOrString>) {
    this.robot.logger.debug(`Sending direct message to username: ${username}`);
    this._userLookup({username: username}, undefined)
      .then((response) => {
        this.sendDirectMessageToUserId(response.id, ...messages);
        Severity: Major
        Found in src/adapter.js and 1 other location - About 3 hrs to fix
        src/adapter.js on lines 202..208

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 110.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

          sendDirectMessageToEmail(email: string, ...messages: Array<MessageTypeOrString>) {
    this.robot.logger.debug(`Sending direct message to email: ${email}`);
    this._userLookup({emailAddress: email}, undefined)
      .then((response) => {
        this.sendDirectMessageToUserId(response.id, ...messages);
        Severity: Major
        Found in src/adapter.js and 1 other location - About 3 hrs to fix
        src/adapter.js on lines 181..187

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 110.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        There are no issues that match your filters.

        Category
        Status