projectblacklight/blacklight

View on GitHub

Showing 74 of 74 total issues

Method attribute has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

      def attribute(name, type = :value, deprecated_field = name, field: nil, default: nil, **kwargs)
        field ||= deprecated_field

        define_method name do
          if type.respond_to?(:coerce) && !(type < Blacklight::Types::Value)
Severity: Minor
Found in app/models/concerns/blacklight/document/attributes.rb - 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

Method add has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

      def add(item)
        new_state = search_state.reset_search

        if item.try(:missing)
          # if this is a 'missing' facet value, the :fq is only for backwards compatibility
Severity: Minor
Found in lib/blacklight/search_state/filter_field.rb - 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 Modal has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

const Modal = (() => {
  const modal = {}

  // a Bootstrap modal div that should be already on the page hidden
  modal.modalSelector = '#blacklight-modal';
Severity: Minor
Found in app/javascript/blacklight/modal.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

Method link_back_to_catalog has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

  def link_back_to_catalog(opts = { label: nil })
    scope = opts.delete(:route_set) || self
    query_params = search_state.reset(current_search_session.try(:query_params)).to_hash

    if search_session['counter']
Severity: Minor
Found in app/helpers/blacklight/url_helper_behavior.rb - 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

Method label has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def label
      label_source = facet_item.respond_to?(:label) ? facet_item.label : facet_item
      if facet_config.helper_method
        view_context.public_send(facet_config.helper_method, label_source)
      else
Severity: Minor
Found in app/presenters/blacklight/facet_item_pivot_presenter.rb - 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

Method _deep_merge_permitted_param_hashes has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    private_class_method def self._deep_merge_permitted_param_hashes(h1, h2)
      h1.merge(h2) do |_key, old_value, new_value|
        if (old_value.is_a?(Hash) && old_value.empty?) || (new_value.is_a?(Hash) && new_value.empty?)
          {}
        elsif old_value.is_a?(Hash) && new_value.is_a?(Hash)
Severity: Minor
Found in lib/blacklight/parameters.rb - 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

Method add has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def add(item)
        new_state = search_state.reset_search

        if item.try(:missing)
          # if this is a 'missing' facet value, the :fq is only for backwards compatibility
Severity: Minor
Found in lib/blacklight/search_state/filter_field.rb - About 1 hr to fix

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

    const Blacklight = function() {
      const buffer = new Array;
      return {
        onLoad: function(func) {
          buffer.push(func);
    Severity: Minor
    Found in app/javascript/blacklight/core.js - About 1 hr to fix

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

            def add_blacklight_field config_key, *args, &block
              field_config = case args.first
                             when String
                               field_config_from_key_and_hash(config_key, *args)
                             when Symbol
      Severity: Minor
      Found in lib/blacklight/configuration/fields.rb - About 1 hr to fix

        Method blacklight_yml has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          def self.blacklight_yml
            require 'erb'
            require 'yaml'
        
            return @blacklight_yml if @blacklight_yml
        Severity: Minor
        Found in lib/blacklight.rb - About 55 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 has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

              def render
                options = config.separator_options || {}
                if values.one? || values.none?
                  next_step(values.first)
                elsif !html?
        Severity: Minor
        Found in app/presenters/blacklight/rendering/join.rb - About 55 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 destroy has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          def destroy
            @bookmarks =
              if params[:bookmarks]
                permit_bookmarks[:bookmarks]
              else
        Severity: Minor
        Found in app/controllers/concerns/blacklight/bookmarks.rb - About 55 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 find_search_session has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          def find_search_session
            if agent_is_crawler?
              nil
            elsif params[:search_context].present?
              find_or_initialize_search_session_from_params JSON.parse(params[:search_context])
        Severity: Minor
        Found in app/controllers/concerns/blacklight/search_context.rb - About 55 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 facet_query_aggregations has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          def facet_query_aggregations
            return {} unless blacklight_config
        
            blacklight_config.facet_fields.select { |_k, v| v.query }.each_with_object({}) do |(field_name, facet_field), hash|
              salient_facet_queries = facet_field.query.map { |_k, x| x[:fq] }
        Severity: Minor
        Found in lib/blacklight/solr/response/facets.rb - About 55 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 fetch has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

          def fetch key, default = NO_DEFAULT_PROVIDED
            if key? key
              self[key]
            elsif block_given?
              yield(self) if block_given?
        Severity: Minor
        Found in app/models/concerns/blacklight/document.rb - About 55 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

              def self.yaml_load(payload)
                if ActiveRecord.try(:use_yaml_unsafe_load) || ActiveRecord::Base.try(:use_yaml_unsafe_load)
                  YAML.load(payload)
                else
                  permitted_classes = (ActiveRecord.try(:yaml_column_permitted_classes) || ActiveRecord::Base.try(:yaml_column_permitted_classes) || []) +
        Severity: Minor
        Found in app/services/blacklight/search_params_yaml_coder.rb and 1 other location - About 45 mins to fix
        app/services/blacklight/search_params_yaml_coder.rb on lines 26..33

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

        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

              def self.yaml_load(payload)
                if ActiveRecord.try(:use_yaml_unsafe_load) || ActiveRecord::Base.try(:use_yaml_unsafe_load)
                  YAML.unsafe_load(payload)
                else
                  permitted_classes = (ActiveRecord.try(:yaml_column_permitted_classes) || ActiveRecord::Base.try(:yaml_column_permitted_classes) || []) +
        Severity: Minor
        Found in app/services/blacklight/search_params_yaml_coder.rb and 1 other location - About 45 mins to fix
        app/services/blacklight/search_params_yaml_coder.rb on lines 36..43

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

        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 collation has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def collation
              # FIXME: DRY up with words
              spellcheck = response[:spellcheck]
              return unless spellcheck && spellcheck[:suggestions]
        
        
        Severity: Minor
        Found in lib/blacklight/solr/response/spelling.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 action_config has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def action_config(action, default: :index)
              action_config = action_mapping[action]
              action_config ||= action_mapping[:default]
        
              if action_config.parent_config && action_config.parent_config != :default
        Severity: Minor
        Found in lib/blacklight/configuration.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 add_adv_search_clauses has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def add_adv_search_clauses(solr_parameters)
              return if search_state.clause_params.blank?
        
              defaults = { must: [], must_not: [], should: [] }
              default_op = blacklight_params[:op]&.to_sym || :must
        Severity: Minor
        Found in lib/blacklight/solr/search_builder_behavior.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

        Severity
        Category
        Status
        Source
        Language