postmodern/wordlist.rb

View on GitHub

Showing 12 of 12 total issues

Method option_parser has 117 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def option_parser
      OptionParser.new do |opts|
        opts.banner = "usage: #{PROGRAM_NAME} { [options] WORDLIST ... | --build WORDLIST [FILE ...] }"

        opts.separator ""
Severity: Major
Found in lib/wordlist/cli.rb - About 4 hrs to fix

    Method parse has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

        def parse(text,&block)
          return enum_for(__method__,text).to_a unless block_given?
    
          scanner = StringScanner.new(text)
    
    
    Severity: Minor
    Found in lib/wordlist/lexer.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

    File cli.rb has 260 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require_relative 'file'
    require_relative 'builder'
    require_relative 'version'
    
    require 'optparse'
    Severity: Minor
    Found in lib/wordlist/cli.rb - About 2 hrs to fix

      Method initialize has 34 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def initialize(lang:          Lang.default,
                         stop_words:    StopWords[lang],
                         ignore_words:  [],
                         digits:   true,
                         special_chars:  SPECIAL_CHARS,
      Severity: Minor
      Found in lib/wordlist/lexer.rb - About 1 hr to fix

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

            def read_mode(argv)
              unless argv.length >= 1
                print_error "too few arguments given, requires at least one WORDLIST argument"
                print_error "usage: #{PROGRAM_NAME} [options] WORDLIST ..."
                return -1
        Severity: Minor
        Found in lib/wordlist/cli.rb - About 1 hr to fix

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

                def self.command(path, format: , append: false)
                  case format
                  when :gzip, :bzip2, :xz
                    command  = format.to_s
                    redirect = if append then '>>'
          Severity: Minor
          Found in lib/wordlist/compression/writer.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

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

          module Wordlist
            module Operators
              #
              # Lazily enumerates over every word that belongs to both wordlists.
              #
          Severity: Minor
          Found in lib/wordlist/operators/intersect.rb and 1 other location - About 25 mins to fix
          lib/wordlist/operators/subtract.rb on lines 5..49

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

          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

          module Wordlist
            module Operators
              #
              # Lazily enumerates over every word in the first wordlist, that is not in
              # the second wordlist.
          Severity: Minor
          Found in lib/wordlist/operators/subtract.rb and 1 other location - About 25 mins to fix
          lib/wordlist/operators/intersect.rb on lines 5..50

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

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

              def initialize(lang:          Lang.default,
                             stop_words:    StopWords[lang],
                             ignore_words:  [],
                             digits:   true,
                             special_chars:  SPECIAL_CHARS,
          Severity: Minor
          Found in lib/wordlist/lexer.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 each has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              def each
                return enum_for(__method__) unless block_given?
          
                each_line do |line|
                  line.chomp!
          Severity: Minor
          Found in lib/wordlist/file.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

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

                def each
                  return enum_for(__method__) unless block_given?
          
                  if @replace
                    @wordlist.each do |word|
          Severity: Minor
          Found in lib/wordlist/modifiers/gsub.rb and 1 other location - About 20 mins to fix
          lib/wordlist/modifiers/sub.rb on lines 82..92

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

          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

                def each
                  return enum_for(__method__) unless block_given?
          
                  if @replace
                    @wordlist.each do |word|
          Severity: Minor
          Found in lib/wordlist/modifiers/sub.rb and 1 other location - About 20 mins to fix
          lib/wordlist/modifiers/gsub.rb on lines 36..46

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

          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

          Severity
          Category
          Status
          Source
          Language