Sign upLogin

Apipie/apipie-rails

View on GitHub
Star

Showing 91 of 91 total issues

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

          this.$element.on(eventIn + '.' + this.type, this.options.selector, $.proxy(this.enter, this))
Severity: Minor
Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 45 mins to fix
app/public/apipie/javascripts/bundled/bootstrap.js on lines 1109..1109

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

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

          this.$element.on(eventOut + '.' + this.type, this.options.selector, $.proxy(this.leave, this))
Severity: Minor
Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 45 mins to fix
app/public/apipie/javascripts/bundled/bootstrap.js on lines 1108..1108

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

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

Method initialize has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def initialize(method_description, code, options, scope, block, adapter)
Severity: Minor
Found in lib/apipie/response_description.rb - About 45 mins to fix

    Method initialize has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def initialize(controller_name, method_name, response_code, error_messages, schema, returned_object)
    Severity: Minor
    Found in lib/apipie/errors.rb - About 45 mins to fix

      Method reformat_multipart_data has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

            def reformat_multipart_data(form)
        form.empty? and return ''
        lines = ["Content-Type: multipart/form-data; boundary=#{MULTIPART_BOUNDARY}",'']
        boundary = "--#{MULTIPART_BOUNDARY}"
        form.each do |key, attrs|
      Severity: Minor
      Found in lib/apipie/extractor/recorder.rb - About 45 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 body_params_schema has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

        def body_params_schema
    if params_in_body? && body_allowed_for_current_method?
      composite = Apipie::Generator::Swagger::ParamDescription::Composite.new(
        body_param_descriptions,
        Apipie::Generator::Swagger::Context.new(
      Severity: Minor
      Found in lib/apipie/generator/swagger/method_description/parameters_service.rb - About 45 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

            this.$element
        .on('focus',    $.proxy(this.focus, this))
        .on('blur',     $.proxy(this.blur, this))
      Severity: Minor
      Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 40 mins to fix
      app/public/apipie/javascripts/bundled/bootstrap.js on lines 294..296

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

      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

          this.options.pause == 'hover' && this.$element
      .on('mouseenter', $.proxy(this.pause, this))
      .on('mouseleave', $.proxy(this.cycle, this))
      Severity: Minor
      Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 40 mins to fix
      app/public/apipie/javascripts/bundled/bootstrap.js on lines 2002..2004

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

      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

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

        , destroy: function () {
      this.hide().$element.off('.' + this.type).removeData(this.type)
    }
      Severity: Minor
      Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 40 mins to fix
      app/public/apipie/javascripts/bundled/bootstrap.js on lines 1365..1367

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

      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

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

        , destroy: function () {
      this.hide().$element.off('.' + this.type).removeData(this.type)
    }
      Severity: Minor
      Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 40 mins to fix
      app/public/apipie/javascripts/bundled/bootstrap.js on lines 1484..1486

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

      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

      Method property has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

            def property(param_name, validator, desc_or_options = nil, options = {}, &block) #:doc:
      Severity: Minor
      Found in lib/apipie/dsl_definition.rb - About 35 mins to fix

        Method to_swagger_json has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def to_swagger_json(version, resource_id, method_name, language, clear_warnings = false)
        Severity: Minor
        Found in lib/apipie/application.rb - About 35 mins to fix

          Method param has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

                def param(param_name, validator, desc_or_options = nil, options = {}, &block) #:doc:
          Severity: Minor
          Found in lib/apipie/dsl_definition.rb - About 35 mins to fix

            Method json_schema_for_method_response has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                def json_schema_for_method_response(version, controller_name, method_name, return_code, allow_nulls)
            Severity: Minor
            Found in lib/apipie/application.rb - About 35 mins to fix

              Method to_swagger_json has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                def self.to_swagger_json(version = nil, resource_id = nil, method_name = nil, lang = nil, clear_warnings = true)
              Severity: Minor
              Found in lib/apipie/apipie_module.rb - About 35 mins to fix

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

                  , blur: function (e) {
      this.focused = false
      if (!this.mousedover && this.shown) this.hide()
    }
                Severity: Minor
                Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 35 mins to fix
                app/public/apipie/javascripts/bundled/bootstrap.js on lines 2111..2114

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

                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

                  , mouseleave: function (e) {
      this.mousedover = false
      if (!this.focused && this.shown) this.hide()
    }
                Severity: Minor
                Found in app/public/apipie/javascripts/bundled/bootstrap.js and 1 other location - About 35 mins to fix
                app/public/apipie/javascripts/bundled/bootstrap.js on lines 2093..2096

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

                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

                Method ensure_line_breaks has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                      def ensure_line_breaks(lines)
        if lines.to_a.size > 1 && lines.first !~ /\n\Z/
          lines.map { |l| !/\n\Z/.match?(l) ? (l << "\n") : l }.to_enum
        else
          lines
                Severity: Minor
                Found in lib/apipie/extractor/writer.rb - 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

                Method merge_old_new_examples has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                      def merge_old_new_examples
        new_examples = self.load_new_examples
        old_examples = self.load_recorded_examples
        merged_examples = []
        (new_examples.keys + old_examples.keys).uniq.each do |key|
                Severity: Minor
                Found in lib/apipie/extractor/writer.rb - 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

                Method render_from_cache has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    def render_from_cache
      path = Apipie.configuration.doc_base_url.dup
      path << "/" << params[:version] if params[:version].present?
      path << "/" << params[:resource] if params[:resource].present?
      path << "/" << params[:method] if params[:method].present?
                Severity: Minor
                Found in app/controllers/apipie/apipies_controller.rb - 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

                Severity
                Category
                Status
                Source
                Language