trileg/WebTeX

View on GitHub

Showing 47 of 47 total issues

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

function changePath() {
  if (!$("#redpen-path").val() || !$("#java-home").val()) {
    $("#result-change-path").empty();
    $("#result-change-path").append(
        '<p class="result bg-danger">Please input RedPen Path and/or JAVA_HOME</p>'
Severity: Major
Found in WebTeX/static/js/preference.js and 1 other location - About 1 day to fix
WebTeX/static/js/preference.js on lines 66..103

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 302.

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

function register() {
  if (!$("#username").val() || !$("#password").val()) {
    $("#result-user-registration").empty();
    $("#result-user-registration").append(
        '<p class="result bg-danger">Please input username and/or password</p>'
Severity: Major
Found in WebTeX/static/js/preference.js and 1 other location - About 1 day to fix
WebTeX/static/js/preference.js on lines 145..182

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 302.

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

File app.py has 346 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import configparser
import json
Severity: Minor
Found in WebTeX/app.py - About 4 hrs to fix

    Cyclomatic complexity is too high in function before_request. (9)
    Open

    @app.before_request
    def before_request():
        if 'username' not in session and request.path != '/login':
            return redirect('/login')
        elif 'username' not in session and request.path == '/login':
    Severity: Minor
    Found in WebTeX/app.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function compile has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

    function compile() {
      if (cwd !== "") {
        // エディタのテキストを読み出し,JSONに
        // これをpythonに投げて,コンパイルリザルト,ログを受け取る
        // コンパイルに成功すれば,PDFファイルをindex.htmlに追加する
    Severity: Minor
    Found in WebTeX/static/js/main.js - About 2 hrs 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

    File main.js has 260 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    var editor;
    var cwd = "";
    
    $(window).load(init());
    
    
    Severity: Minor
    Found in WebTeX/static/js/main.js - About 2 hrs to fix

      Cyclomatic complexity is too high in function check_csrf. (8)
      Open

      def check_csrf(request_, type_):
          config = configparser.ConfigParser()
          config.read(conf)
          if config['dev']['check_csrf'] == 'true':
              token = session['_csrf_token']
      Severity: Minor
      Found in WebTeX/app.py by radon

      Cyclomatic Complexity

      Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

      Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

      Construct Effect on CC Reasoning
      if +1 An if statement is a single decision.
      elif +1 The elif statement adds another decision.
      else +0 The else statement does not cause a new decision. The decision is at the if.
      for +1 There is a decision at the start of the loop.
      while +1 There is a decision at the while statement.
      except +1 Each except branch adds a new conditional path of execution.
      finally +0 The finally block is unconditionally executed.
      with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
      assert +1 The assert statement internally roughly equals a conditional statement.
      Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
      Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

      Source: http://radon.readthedocs.org/en/latest/intro.html

      Cyclomatic complexity is too high in function read_filelist. (6)
      Open

      @app.route('/readFilelist', methods=['POST'])
      def read_filelist():
          if not check_csrf(request, 'json'):
              abort(403)
      
      
      Severity: Minor
      Found in WebTeX/app.py by radon

      Cyclomatic Complexity

      Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

      Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

      Construct Effect on CC Reasoning
      if +1 An if statement is a single decision.
      elif +1 The elif statement adds another decision.
      else +0 The else statement does not cause a new decision. The decision is at the if.
      for +1 There is a decision at the start of the loop.
      while +1 There is a decision at the while statement.
      except +1 Each except branch adds a new conditional path of execution.
      finally +0 The finally block is unconditionally executed.
      with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
      assert +1 The assert statement internally roughly equals a conditional statement.
      Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
      Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

      Source: http://radon.readthedocs.org/en/latest/intro.html

      Cyclomatic complexity is too high in function read_directory. (6)
      Open

      @app.route('/readDirectory', methods=['POST'])
      def read_directory():
          if not check_csrf(request, 'json'):
              abort(403)
      
      
      Severity: Minor
      Found in WebTeX/app.py by radon

      Cyclomatic Complexity

      Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

      Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

      Construct Effect on CC Reasoning
      if +1 An if statement is a single decision.
      elif +1 The elif statement adds another decision.
      else +0 The else statement does not cause a new decision. The decision is at the if.
      for +1 There is a decision at the start of the loop.
      while +1 There is a decision at the while statement.
      except +1 Each except branch adds a new conditional path of execution.
      finally +0 The finally block is unconditionally executed.
      with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
      assert +1 The assert statement internally roughly equals a conditional statement.
      Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
      Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

      Source: http://radon.readthedocs.org/en/latest/intro.html

      Cyclomatic complexity is too high in function is_account_valid. (6)
      Open

      def is_account_valid():
          username = request.form['username']
          config = configparser.ConfigParser()
          config.read(conf)
      
      
      Severity: Minor
      Found in WebTeX/app.py by radon

      Cyclomatic Complexity

      Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

      Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

      Construct Effect on CC Reasoning
      if +1 An if statement is a single decision.
      elif +1 The elif statement adds another decision.
      else +0 The else statement does not cause a new decision. The decision is at the if.
      for +1 There is a decision at the start of the loop.
      while +1 There is a decision at the while statement.
      except +1 Each except branch adds a new conditional path of execution.
      finally +0 The finally block is unconditionally executed.
      with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
      assert +1 The assert statement internally roughly equals a conditional statement.
      Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
      Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

      Source: http://radon.readthedocs.org/en/latest/intro.html

      Function compile has 43 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function compile() {
        if (cwd !== "") {
          // エディタのテキストを読み出し,JSONに
          // これをpythonに投げて,コンパイルリザルト,ログを受け取る
          // コンパイルに成功すれば,PDFファイルをindex.htmlに追加する
      Severity: Minor
      Found in WebTeX/static/js/main.js - About 1 hr to fix

        Function readFilelist has 43 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function readFilelist(directoryItem) {
          var json = JSON.stringify({
            "_csrf_token": $("#_csrf_token").val()
          });
        
        
        Severity: Minor
        Found in WebTeX/static/js/main.js - About 1 hr to fix

          Function init has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
          Open

          function init() {
            editor = ace.edit("editor");
            readDirectory($("#username").text());
          
            $("#createDirectory").click(function () {
          Severity: Minor
          Found in WebTeX/static/js/main.js - 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

          Function readDirectory has 39 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          function readDirectory() {
            var json = JSON.stringify({
              "_csrf_token": $("#_csrf_token").val()
            });
          
          
          Severity: Minor
          Found in WebTeX/static/js/main.js - About 1 hr to fix

            Function check_csrf has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

            def check_csrf(request_, type_):
                config = configparser.ConfigParser()
                config.read(conf)
                if config['dev']['check_csrf'] == 'true':
                    token = session['_csrf_token']
            Severity: Minor
            Found in WebTeX/app.py - 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

            Function configureLdap has 35 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            function configureLdap() {
              if ((!$("#ldap-address").val() || !$("#ldap-port").val()) || !$("#ldap-basedn").val()) {
                $("#result-change-ldap").empty();
                $("#result-change-ldap").append(
                    '<p class="result bg-danger">Please input LDAP Address, Port, BaseDN correctly</p>'
            Severity: Minor
            Found in WebTeX/static/js/preference.js - About 1 hr to fix

              Function changePath has 34 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              function changePath() {
                if (!$("#redpen-path").val() || !$("#java-home").val()) {
                  $("#result-change-path").empty();
                  $("#result-change-path").append(
                      '<p class="result bg-danger">Please input RedPen Path and/or JAVA_HOME</p>'
              Severity: Minor
              Found in WebTeX/static/js/preference.js - About 1 hr to fix

                Function register has 34 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                function register() {
                  if (!$("#username").val() || !$("#password").val()) {
                    $("#result-user-registration").empty();
                    $("#result-user-registration").append(
                        '<p class="result bg-danger">Please input username and/or password</p>'
                Severity: Minor
                Found in WebTeX/static/js/preference.js - About 1 hr to fix

                  Function readFilelist has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                  Open

                  function readFilelist(directoryItem) {
                    var json = JSON.stringify({
                      "_csrf_token": $("#_csrf_token").val()
                    });
                  
                  
                  Severity: Minor
                  Found in WebTeX/static/js/main.js - 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

                  Function read_filelist has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                  Open

                  def read_filelist():
                      if not check_csrf(request, 'json'):
                          abort(403)
                  
                      dictionary = {}
                  Severity: Minor
                  Found in WebTeX/app.py - 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

                  Severity
                  Category
                  Status
                  Source
                  Language