cerebris/jsonapi-resources

View on GitHub
lib/jsonapi/basic_resource.rb

Summary

Maintainability
F
6 days
Test Coverage

Class BasicResource has 136 methods (exceeds 20 allowed). Consider refactoring.
Open

  class BasicResource
    include Callbacks

    @abstract = true
    @immutable = true
Severity: Major
Found in lib/jsonapi/basic_resource.rb - About 2 days to fix

    File basic_resource.rb has 863 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require 'jsonapi/callbacks'
    require 'jsonapi/configuration'
    
    module JSONAPI
      class BasicResource
    Severity: Major
    Found in lib/jsonapi/basic_resource.rb - About 2 days to fix

      Method verify_key has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
      Open

            def verify_key(key, context = nil)
              key_type = resource_key_type
      
              case key_type
              when :integer
      Severity: Minor
      Found in lib/jsonapi/basic_resource.rb - 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

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

            def attribute(attribute_name, options = {})
              _clear_cached_attribute_options
              _clear_fields_cache
      
              attr = attribute_name.to_sym
      Severity: Minor
      Found in lib/jsonapi/basic_resource.rb - 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

      Method _replace_fields has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          def _replace_fields(field_data)
            field_data[:attributes].each do |attribute, value|
              begin
                send "#{attribute}=", value
                @save_needed = true
      Severity: Minor
      Found in lib/jsonapi/basic_resource.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 change has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          def change(callback)
            completed = false
      
            if @changing
              run_callbacks callback do
      Severity: Minor
      Found in lib/jsonapi/basic_resource.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 _replace_to_many_links has 31 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def _replace_to_many_links(relationship_type, relationship_key_values, options)
            relationship = self.class._relationship(relationship_type)
      
            reflect = reflect_relationship?(relationship, options)
      
      
      Severity: Minor
      Found in lib/jsonapi/basic_resource.rb - About 1 hr to fix

        Method inherited has 28 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

              def inherited(subclass)
                super
                subclass.abstract(false)
                subclass.immutable(false)
                subclass.caching(_caching)
        Severity: Minor
        Found in lib/jsonapi/basic_resource.rb - About 1 hr to fix

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

              def _create_to_many_links(relationship_type, relationship_key_values, options)
                relationship = self.class._relationships[relationship_type]
                relation_name = relationship.relation_name(context: @context)
          
                if options[:reflected_source]
          Severity: Minor
          Found in lib/jsonapi/basic_resource.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 _create_to_many_links has 26 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              def _create_to_many_links(relationship_type, relationship_key_values, options)
                relationship = self.class._relationships[relationship_type]
                relation_name = relationship.relation_name(context: @context)
          
                if options[:reflected_source]
          Severity: Minor
          Found in lib/jsonapi/basic_resource.rb - About 1 hr to fix

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

                def _save(validation_context = nil)
                  unless @model.valid?(validation_context)
                    fail JSONAPI::Exceptions::ValidationErrors.new(self)
                  end
            
            
            Severity: Minor
            Found in lib/jsonapi/basic_resource.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 verify_filter has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                  def verify_filter(filter, raw, context = nil)
                    filter_values = []
                    if raw.present?
                      begin
                        filter_values += raw.is_a?(String) ? CSV.parse_line(raw) : [raw]
            Severity: Minor
            Found in lib/jsonapi/basic_resource.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 _remove_to_many_link has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                def _remove_to_many_link(relationship_type, key, options)
                  relationship = self.class._relationships[relationship_type]
            
                  reflect = reflect_relationship?(relationship, options)
            
            
            Severity: Minor
            Found in lib/jsonapi/basic_resource.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 inherited has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

                  def inherited(subclass)
                    super
                    subclass.abstract(false)
                    subclass.immutable(false)
                    subclass.caching(_caching)
            Severity: Minor
            Found in lib/jsonapi/basic_resource.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 attribute_to_model_field has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                  def attribute_to_model_field(attribute)
                    field_name = if attribute == :_cache_field
                                   _cache_field
                                 else
                                   # Note: this will allow the returning of model attributes without a corresponding
            Severity: Minor
            Found in lib/jsonapi/basic_resource.rb - 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

            Method _model_name has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                  def _model_name
                    if _abstract
                       ''
                    else
                      return @_model_name.to_s if defined?(@_model_name)
            Severity: Minor
            Found in lib/jsonapi/basic_resource.rb - 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

            Method _replace_to_many_links has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                def _replace_to_many_links(relationship_type, relationship_key_values, options)
                  relationship = self.class._relationship(relationship_type)
            
                  reflect = reflect_relationship?(relationship, options)
            
            
            Severity: Minor
            Found in lib/jsonapi/basic_resource.rb - 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

            Method construct_order_options has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                  def construct_order_options(sort_params)
                    sort_params = default_sort if sort_params.blank?
            
                    return {} unless sort_params
            
            
            Severity: Minor
            Found in lib/jsonapi/basic_resource.rb - 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

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

                          klass.reflect_on_all_associations(:has_many).select{|r| r.options[:as] }.each do |reflection|
                            (hash[reflection.options[:as]] ||= []) << klass.name.downcase
            Severity: Minor
            Found in lib/jsonapi/basic_resource.rb and 1 other location - About 15 mins to fix
            lib/jsonapi/relationship.rb on lines 67..68

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

            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