Sign upLogin

ngtk/open_api_annotator

View on GitHub
Star

Showing 5 of 7 total issues

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

    def build_path_item(routes)
      path_item = OpenApi::PathItem.new
      routes.each do |route|
        media_type = resolve_media_type(route.controller_name, route.action_name)
        description = build_description(route.controller_name, route.action_name)
Severity: Minor
Found in lib/open_api_annotator/paths_builder.rb - About 1 hr to fix

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

    def build_path_item(routes)
      path_item = OpenApi::PathItem.new
      routes.each do |route|
        media_type = resolve_media_type(route.controller_name, route.action_name)
        description = build_description(route.controller_name, route.action_name)
Severity: Minor
Found in lib/open_api_annotator/paths_builder.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 build_has_many_association_properties has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    def build_has_many_association_properties(serializer)
      properties = {}
      serializer.open_api_has_many_associations.each do |association|
        next unless association.valid?
        content = association.type.first
Severity: Minor
Found in lib/open_api_annotator/components_builder.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 build_has_one_and_belongs_to_association_properties has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    def build_has_one_and_belongs_to_association_properties(serializer)
      properties = {}
      associations = serializer.open_api_has_one_associations + serializer.open_api_belongs_to_associations
      associations.each do |association|
        next unless association.valid?
Severity: Minor
Found in lib/open_api_annotator/components_builder.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 build_attribute_properties has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def build_attribute_properties(serializer)
      properties = {}
      serializer.open_api_attributes.each do |attribute|
        next unless attribute.valid?
        properties[attribute.name.to_sym] = if attribute.type.is_a?(Array)
Severity: Minor
Found in lib/open_api_annotator/components_builder.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