Sign upLogin

ruby/rdoc

View on GitHub
Star

Showing 406 of 406 total issues

Avoid too many return statements within this method.
Open

      return @module if @module
Severity: Major
Found in lib/rdoc/code_object/mixin.rb - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

        return 'about one day'               if seconds < 172800   #  2 days
    Severity: Major
    Found in lib/rdoc/generator/darkfish.rb - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

          return "#{seconds / 604800} weeks"   if seconds < 7257600  #  3 months
      Severity: Major
      Found in lib/rdoc/generator/darkfish.rb - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

            return @block_params = 'str' if value =~ /^\$[&0-9]$/
        Severity: Major
        Found in lib/rdoc/code_object/method_attr.rb - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

              return 'one day'                     if seconds < 86400    #  1 day
          Severity: Major
          Found in lib/rdoc/generator/darkfish.rb - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                return "#{seconds / 86400} days"     if seconds < 604800   #  1 week
            Severity: Major
            Found in lib/rdoc/generator/darkfish.rb - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                  return 'about one week'              if seconds < 1209600  #  2 week
              Severity: Major
              Found in lib/rdoc/generator/darkfish.rb - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                          return unless arg.receiver.is_a?(Prism::SelfNode)
                Severity: Major
                Found in lib/rdoc/parser/prism_ruby.rb - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                            return if arg.receiver
                  Severity: Major
                  Found in lib/rdoc/parser/prism_ruby.rb - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                          return res
                    Severity: Major
                    Found in lib/rdoc/parser/ruby.rb - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                          return "#{seconds / 31536000} years"
                      Severity: Major
                      Found in lib/rdoc/generator/darkfish.rb - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                              return blankline unless RDoc::AnyMethod === code_object
                        Severity: Major
                        Found in lib/rdoc/markup/pre_process.rb - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                return blankline unless code_object
                          Severity: Major
                          Found in lib/rdoc/markup/pre_process.rb - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                  return blankline unless code_object
                            Severity: Major
                            Found in lib/rdoc/markup/pre_process.rb - About 30 mins to fix

                              Avoid too many return statements within this method.
                              Open

                                    return blankline unless code_object
                              Severity: Major
                              Found in lib/rdoc/markup/pre_process.rb - About 30 mins to fix

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

                                      bullet = type == :BULLET ? '*' :  @list_index.last.to_s + '.'
      @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
      width = bullet.length + 1
      @indent += width
    end
                                Severity: Minor
                                Found in lib/rdoc/markup/to_bs.rb and 1 other location - About 30 mins to fix
                                lib/rdoc/markup/to_rdoc.rb on lines 166..170

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

                                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

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

                                      bullet = type == :BULLET ? '*' :  @list_index.last.to_s + '.'
      @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
      width = bullet.length + 1
      @indent += width
    end
                                Severity: Minor
                                Found in lib/rdoc/markup/to_rdoc.rb and 1 other location - About 30 mins to fix
                                lib/rdoc/markup/to_bs.rb on lines 61..65

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

                                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 generate_index has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                Open

                                  def generate_index
    setup

    template_file = @template_dir + 'index.rhtml'
    return unless template_file.exist?
                                Severity: Minor
                                Found in lib/rdoc/generator/darkfish.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 generate_servlet_not_found has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                Open

                                  def generate_servlet_not_found message
    setup

    template_file = @template_dir + 'servlet_not_found.rhtml'
    return unless template_file.exist?
                                Severity: Minor
                                Found in lib/rdoc/generator/darkfish.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 generate_servlet_root has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                Open

                                  def generate_servlet_root installed
    setup

    template_file = @template_dir + 'servlet_root.rhtml'
    return unless template_file.exist?
                                Severity: Minor
                                Found in lib/rdoc/generator/darkfish.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

                                Severity
                                Category
                                Status
                                Source
                                Language