Sign upLogin

bhollis/maruku

View on GitHub
Star
lib/maruku/input/parse_span.rb

Summary

Maintainability
F
1 wk
Test Coverage

Method read_span has a Cognitive Complexity of 152 (exceeds 5 allowed). Consider refactoring.
Open

  def read_span(src, escaped, exit_on_chars=nil, exit_on_strings=nil)
    escaped = Array(escaped)
    con = SpanContext.new
    dquote_state = squote_state = :closed
    c = d = prev_char = nil
Severity: Minor
Found in lib/maruku/input/parse_span.rb - About 3 days 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

File parse_span.rb has 596 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module MaRuKu::In::Markdown::SpanLevelParser
  include MaRuKu::Helpers

  EscapedCharInText = '\\`*_{}[]()#.!|:+->'.split(//)
  EscapedCharInQuotes = EscapedCharInText + ["'", '"']
Severity: Major
Found in lib/maruku/input/parse_span.rb - About 1 day to fix

    Method read_span has 244 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def read_span(src, escaped, exit_on_chars=nil, exit_on_strings=nil)
    escaped = Array(escaped)
    con = SpanContext.new
    dquote_state = squote_state = :closed
    c = d = prev_char = nil
    Severity: Major
    Found in lib/maruku/input/parse_span.rb - About 1 day to fix

      Method read_simple has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
      Open

        def read_simple(src, escaped, exit_on_chars=nil, exit_on_strings=nil, warn=true)
    text = ""
    escaped = Array(escaped)
    exit_on_chars = Array(exit_on_chars)
    exit_on_strings = Array(exit_on_strings)
      Severity: Minor
      Found in lib/maruku/input/parse_span.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 read_link has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

        def read_link(src, con)
    # we read the string and see what happens
    src.ignore_char # opening bracket
    children = read_span(src, EscapedCharInText, ']')
    src.ignore_char # closing bracket
      Severity: Minor
      Found in lib/maruku/input/parse_span.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 read_image has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

        def read_image(src, con)
    src.ignore_chars(2) # opening "!["
    alt_text = read_span(src, EscapedCharInText, ']')
    src.ignore_char # closing bracket
    # ignore space
      Severity: Minor
      Found in lib/maruku/input/parse_span.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 read_link has 48 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        def read_link(src, con)
    # we read the string and see what happens
    src.ignore_char # opening bracket
    children = read_span(src, EscapedCharInText, ']')
    src.ignore_char # closing bracket
      Severity: Minor
      Found in lib/maruku/input/parse_span.rb - About 1 hr to fix

        Method read_image has 47 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          def read_image(src, con)
    src.ignore_chars(2) # opening "!["
    alt_text = read_span(src, EscapedCharInText, ']')
    src.ignore_char # closing bracket
    # ignore space
        Severity: Minor
        Found in lib/maruku/input/parse_span.rb - About 1 hr to fix

          Method read_simple has 29 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            def read_simple(src, escaped, exit_on_chars=nil, exit_on_strings=nil, warn=true)
    text = ""
    escaped = Array(escaped)
    exit_on_chars = Array(exit_on_chars)
    exit_on_strings = Array(exit_on_strings)
          Severity: Minor
          Found in lib/maruku/input/parse_span.rb - About 1 hr to fix

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

              def read_inline_code(src, con)
    # Count the number of ticks
    num_ticks = 0
    while src.cur_char == '`'
      num_ticks += 1
            Severity: Minor
            Found in lib/maruku/input/parse_span.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 read_inline_html has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

              def read_inline_html(src, con)
    h = HTMLHelper.new
    begin
      # This is our current buffer in the context
      next_stuff = src.current_remaining_buffer
            Severity: Minor
            Found in lib/maruku/input/parse_span.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 read_simple has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

              def read_simple(src, escaped, exit_on_chars=nil, exit_on_strings=nil, warn=true)
            Severity: Minor
            Found in lib/maruku/input/parse_span.rb - About 35 mins to fix

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

                        follows = src.cur_chars(4)
          if follows =~ /^\*\*\*[^\s\*]/
            con.push_element read_emstrong(src, '***')
          elsif follows  =~ /^\*\*[^\s\*]/
            con.push_element read_strong(src, '**')
              Severity: Minor
              Found in lib/maruku/input/parse_span.rb and 1 other location - About 35 mins to fix
              lib/maruku/input/parse_span.rb on lines 197..206

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

              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

                          follows = src.cur_chars(4)
            if  follows =~ /^\_\_\_[^\s\_]/
              con.push_element read_emstrong(src, '___')
            elsif follows  =~ /^\_\_[^\s\_]/
              con.push_element read_strong(src, '__')
              Severity: Minor
              Found in lib/maruku/input/parse_span.rb and 1 other location - About 35 mins to fix
              lib/maruku/input/parse_span.rb on lines 173..182

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

              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