bhollis/maruku

View on GitHub

Showing 121 of 121 total issues

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

  def to_latex_code
    if get_setting(:latex_use_listings)
      @doc.latex_require_package('listings')

      s = "\\lstset{columns=fixed,frame=shadowbox}"
Severity: Minor
Found in lib/maruku/output/to_latex.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

    Method read_indented_content has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

      def read_indented_content(src, indentation, break_list, item_type, ial_offset=0)
    Severity: Minor
    Found in lib/maruku/input/parse_block.rb - About 35 mins to fix

      Method md_ref_def has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def md_ref_def(ref_id, url, title=nil, meta={}, al=nil)
      Severity: Minor
      Found in lib/maruku/helpers.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 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

        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

        Method span_descendents has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            def span_descendents(e)
              descendents = []
              e.each_element do |c|
                name = c.respond_to?(:name) ? c.name : nil
                if name && HTML_INLINE_ELEMS.include?(c.name)
        Severity: Minor
        Found in lib/maruku/html.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

        Method close_script_style has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            def close_script_style
              tag = @tag_stack.last
        
              # See http://www.w3.org/TR/xhtml1/#C_4 for character sequences not allowed within an element body.
              if @already =~ /<|&|\]\]>|--/
        Severity: Minor
        Found in lib/maruku/input/html_helper.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

        Method to_html_equation has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def to_html_equation
                mathml = get_setting(:html_math_output_mathml) && render_mathml(:equation, self.math)
                png    = get_setting(:html_math_output_png)    && render_png(:equation, self.math)
        
                div = xelem('div')
        Severity: Minor
        Found in lib/maruku/ext/math/to_html.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

        Method convert_to_mathml_blahtex has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

          def convert_to_mathml_blahtex(kind, tex)
            result = run_blahtex(tex, %w[--mathml])
        
            doc = REXML::Document.new(result)
            mathml = doc.get_elements('//markup').to_a.first
        Severity: Minor
        Found in lib/maruku/ext/math/mathml_engines/blahtex.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

        Method extract_chunks has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        def extract_chunks(is, start_reg, end_reg)
            all = []
            current = nil; current_start = nil
            line = 1
            is.each_line do |l|
        Severity: Minor
        Found in docs/exd/exd.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

        Avoid too many return statements within this method.
        Open

              return :olist          if self =~ /\A[ ]{0,3}\d+\.\s+.*/
        Severity: Major
        Found in lib/maruku/input/mdline.rb - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                return :raw_html       if self =~ %r{\A[ ]{0,3}</?\s*\w+}
          Severity: Major
          Found in lib/maruku/input/mdline.rb - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                  return :code           if number_of_leading_spaces >= 4
            Severity: Major
            Found in lib/maruku/input/mdline.rb - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                    return :quote          if self =~ /\A>/
              Severity: Major
              Found in lib/maruku/input/mdline.rb - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                      return :text           if self =~ /\A[ ]{0,3}#{EMailAddress}/
                Severity: Major
                Found in lib/maruku/input/mdline.rb - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                        return :ulist          if self =~ /\A[ ]{0,3}([\*\-\+])\s+.*/
                  Severity: Major
                  Found in lib/maruku/input/mdline.rb - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                          return :hrule          if self =~ /\A(\s*[\*\-_]\s*){3,}\z/
                    Severity: Major
                    Found in lib/maruku/input/mdline.rb - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                            return :raw_html       if self =~ /\A[ ]{0,3}<\!\-\-/
                      Severity: Major
                      Found in lib/maruku/input/mdline.rb - About 30 mins to fix
                        Severity
                        Category
                        Status
                        Source
                        Language