prismicio/ruby-kit

View on GitHub
lib/prismic/json_parsers.rb

Summary

Maintainability
C
1 day
Test Coverage

File json_parsers.rb has 310 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'cgi'
require 'time'

module Prismic
  module JsonParser
Severity: Minor
Found in lib/prismic/json_parsers.rb - About 3 hrs to fix

    Method structured_text_parser has 61 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def structured_text_parser(json)
            def self.span_parser(span)
              case span['type']
              when 'em'
                Prismic::Fragments::StructuredText::Span::Em.new(span['start'], span['end'])
    Severity: Major
    Found in lib/prismic/json_parsers.rb - About 2 hrs to fix

      Method document_parser has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def document_parser(json)
              data_json = json['data'].values.first  # {"doc_type": data}
      
              # Removing the unknown types + sending a warning, once
              data_json.select!{ |_, fragment|
      Severity: Minor
      Found in lib/prismic/json_parsers.rb - About 1 hr to fix

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

              def document_link_parser(json)
                doc = json['value']['document']
                type = doc['type']
                fragments = {}
                if doc['data'] and doc['data'][type]
        Severity: Minor
        Found in lib/prismic/json_parsers.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 structured_text_parser has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def structured_text_parser(json)
                def self.span_parser(span)
                  case span['type']
                  when 'em'
                    Prismic::Fragments::StructuredText::Span::Em.new(span['start'], span['end'])
        Severity: Minor
        Found in lib/prismic/json_parsers.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

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

                  when 'preformatted'
                    spans = block['spans'].map {|span| span_parser(span) }
                    Prismic::Fragments::StructuredText::Block::Preformatted.new(block['text'], spans, block['label'])
        Severity: Minor
        Found in lib/prismic/json_parsers.rb and 1 other location - About 15 mins to fix
        lib/prismic/json_parsers.rb on lines 153..155

        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

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

                  when 'paragraph'
                    spans = block['spans'].map {|span| span_parser(span) }
                    Prismic::Fragments::StructuredText::Block::Paragraph.new(block['text'], spans, block['label'])
        Severity: Minor
        Found in lib/prismic/json_parsers.rb and 1 other location - About 15 mins to fix
        lib/prismic/json_parsers.rb on lines 156..158

        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