prismicio/javascript-kit

View on GitHub
lib/api.js

Summary

Maintainability
F
3 days
Test Coverage

File api.js has 526 lines of code (exceeds 250 allowed). Consider refactoring.
Open

'use strict';

var Requests = require('./requests'),
    Cookies = require('./cookies'),
    documents = require('./documents'),
Severity: Major
Found in lib/api.js - About 1 day to fix

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

      submit: function(callback) {
        var self = this;
        var url = this.form.action;
    
        if (this.data) {
    Severity: Minor
    Found in lib/api.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

    Function parse has 56 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      parse: function(data) {
        var refs,
            master,
            forms = {},
            form,
    Severity: Major
    Found in lib/api.js - About 2 hrs to fix

      prototype has 21 functions (exceeds 20 allowed). Consider refactoring.
      Open

      Api.prototype = {
      
        // Predicates
        AT: "at",
        ANY: "any",
      Severity: Minor
      Found in lib/api.js - About 2 hrs to fix

        Function previewSession has 40 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          previewSession: function(token, linkResolver, defaultUrl, callback) {
            var api = this;
            return new Promise(function(resolve, reject) {
              var cb = function(err, value, xhr) {
                if (callback) callback(err, value, xhr);
        Severity: Minor
        Found in lib/api.js - About 1 hr to fix

          Function request has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            request: function(url, callback) {
              var api = this;
              var cacheKey = url + (this.accessToken ? ('#' + this.accessToken) : '');
              var cache = this.apiCache;
              function run(cb) {
          Severity: Minor
          Found in lib/api.js - About 1 hr to fix

            Function get has 26 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              get: function(callback) {
                var self = this;
                var cacheKey = this.apiCacheKey;
            
                return new Promise(function (resolve, reject) {
            Severity: Minor
            Found in lib/api.js - About 1 hr to fix

              Function Response has 8 arguments (exceeds 4 allowed). Consider refactoring.
              Open

              function Response(page, results_per_page, results_size, total_results_size, total_pages, next_page, prev_page, results) {
              Severity: Major
              Found in lib/api.js - About 1 hr to fix

                Function Form has 6 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                function Form(name, fields, form_method, rel, enctype, action) {
                Severity: Minor
                Found in lib/api.js - About 45 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                              for (var i = 0; i < values.length; i++) {
                                url += sep + key + '=' + encodeURIComponent(values[i]);
                                sep = '&';
                              }
                  Severity: Major
                  Found in lib/api.js - About 45 mins to fix

                    Function Ref has 5 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                    function Ref(ref, label, isMaster, scheduledAt, id) {
                    Severity: Minor
                    Found in lib/api.js - About 35 mins to fix

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

                        query: function(q, options, callback) {
                          if (typeof options === 'function') {
                            callback = options;
                            options = undefined;
                          }
                      Severity: Minor
                      Found in lib/api.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 set has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                      Open

                        set: function(field, value) {
                          var fieldDesc = this.form.fields[field];
                          if(!fieldDesc) throw new Error("Unknown field " + field);
                          var values= this.data[field] || [];
                          if(value === '' || value === undefined) {
                      Severity: Minor
                      Found in lib/api.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 parse has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                      Open

                        parse: function(data) {
                          var refs,
                              master,
                              forms = {},
                              form,
                      Severity: Minor
                      Found in lib/api.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 getBookmark has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                      Open

                        getBookmark: function(bookmark, options, callback) {
                          return new Promise(function(resolve, reject) {
                            var id = this.bookmarks[bookmark];
                            if (id) {
                              resolve(id);
                      Severity: Minor
                      Found in lib/api.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

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

                        query: function(query) {
                          if (typeof query === 'string') {
                            return this.set("q", query);
                          } else {
                            var predicates;
                      Severity: Minor
                      Found in lib/api.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

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

                      function Api(url, options) {
                        var opts = options || {};
                        this.accessToken = opts.accessToken;
                        this.url = url + (this.accessToken ? (url.indexOf('?') > -1 ? '&' : '?') + 'access_token=' + this.accessToken : '');
                        this.req = opts.req;
                      Severity: Minor
                      Found in lib/api.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

                      function Ref(ref, label, isMaster, scheduledAt, id) {
                        /**
                         * @field
                         * @description the ID of the ref
                         */
                      Severity: Major
                      Found in lib/api.js and 1 other location - About 2 hrs to fix
                      lib/fragments.js on lines 581..607

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

                      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

                        fetchLinks: function(fields) {
                          if (fields instanceof Array) {
                            fields = fields.join(",");
                          }
                          return this.set("fetchLinks", fields);
                      Severity: Minor
                      Found in lib/api.js and 1 other location - About 50 mins to fix
                      lib/api.js on lines 687..692

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

                      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

                        fetch: function(fields) {
                          if (fields instanceof Array) {
                            fields = fields.join(",");
                          }
                          return this.set("fetch", fields);
                      Severity: Minor
                      Found in lib/api.js and 1 other location - About 50 mins to fix
                      lib/api.js on lines 700..705

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

                      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