sugarcrm/sugar_utils

View on GitHub

Showing 7 of 7 total issues

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

    def self.append(filename, data, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity
      flush = options[:flush] || false
      owner = options[:owner]
      group = options[:group]
      # NOTE: We are using the variable name 'perm' because that is the name of
Severity: Major
Found in lib/sugar_utils/file.rb and 1 other location - About 3 hrs to fix
lib/sugar_utils/file.rb on lines 149..189

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

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 self.write(filename, data, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity
      flush = options[:flush] || false
      owner = options[:owner]
      group = options[:group]
      # NOTE: We are using the variable name 'perm' because that is the name of
Severity: Major
Found in lib/sugar_utils/file.rb and 1 other location - About 3 hrs to fix
lib/sugar_utils/file.rb on lines 237..277

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

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

    def self.read(filename, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity, PerceivedComplexity
      options[:value_on_missing] ||= ''
      options[:raise_on_missing] = true if options[:raise_on_missing].nil?

      result =
Severity: Minor
Found in lib/sugar_utils/file.rb - About 1 hr 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 has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def self.read(filename, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity, PerceivedComplexity
      options[:value_on_missing] ||= ''
      options[:raise_on_missing] = true if options[:raise_on_missing].nil?

      result =
Severity: Minor
Found in lib/sugar_utils/file.rb - About 1 hr to fix

    Method write has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def self.write(filename, data, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity
          flush = options[:flush] || false
          owner = options[:owner]
          group = options[:group]
          # NOTE: We are using the variable name 'perm' because that is the name of
    Severity: Minor
    Found in lib/sugar_utils/file.rb - About 1 hr 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 append has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def self.append(filename, data, options = {}) # rubocop:disable MethodLength, AbcSize, CyclomaticComplexity
          flush = options[:flush] || false
          owner = options[:owner]
          group = options[:group]
          # NOTE: We are using the variable name 'perm' because that is the name of
    Severity: Minor
    Found in lib/sugar_utils/file.rb - About 1 hr 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 deprecate_option has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def self.deprecate_option(_method, option_name, option_repl, year, month) # rubocop:disable MethodLength
    Severity: Minor
    Found in lib/sugar_utils/file.rb - About 35 mins to fix
      Severity
      Category
      Status
      Source
      Language