Sign upLogin

QNester/methodist

View on GitHub
Star

Showing 8 of 8 total issues

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

class ClientGenerator < MethodistGenerator
  desc 'Create client'
  source_root File.expand_path('templates', __dir__)

  PATTERN_FOLDER     = 'clients'.freeze
Severity: Major
Found in lib/generators/client/client_generator.rb and 2 other locations - About 1 hr to fix
lib/generators/builder/builder_generator.rb on lines 3..26
lib/generators/service/service_generator.rb on lines 3..26

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

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 3 locations. Consider refactoring.
Open

class BuilderGenerator < MethodistGenerator
  desc 'Create a builder'
  source_root File.expand_path('templates', __dir__)

  PATTERN_FOLDER     = 'builders'.freeze
Severity: Major
Found in lib/generators/builder/builder_generator.rb and 2 other locations - About 1 hr to fix
lib/generators/client/client_generator.rb on lines 3..26
lib/generators/service/service_generator.rb on lines 3..26

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

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 3 locations. Consider refactoring.
Open

class ServiceGenerator < MethodistGenerator
  desc 'Create service'
  source_root File.expand_path('templates', __dir__)

  PATTERN_FOLDER     = 'services'.freeze
Severity: Major
Found in lib/generators/service/service_generator.rb and 2 other locations - About 1 hr to fix
lib/generators/builder/builder_generator.rb on lines 3..26
lib/generators/client/client_generator.rb on lines 3..26

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

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

    def observer_proc(klass, method_name, skip_if, instance_method: true, &main_block)
      original_method = instance_method ? klass.instance_method(method_name) : klass.method(method_name)
      me = self

      -> (*args, &block) do
Severity: Minor
Found in lib/methodist/observer.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 stop_observe has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def stop_observe(klass, method_name, instance_method: true)
      method_names = generate_method_names(method_name)

      if instance_method
        unless method_defined?(klass, method_names[:observed]) && method_defined?(klass, method_names[:dump])
Severity: Minor
Found in lib/methodist/observer.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 validate has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

  def validate(input)
    input = {} unless input
    raise InputClassError, 'If you want to use custom #validate, you have to pass a hash to an interactor' unless input.is_a?(Hash)

    validator = contract_class ? contract_class : input_schema
Severity: Minor
Found in lib/methodist/interactor.rb - About 55 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 define_write_method has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def define_write_method(attr_name, proc, options)
      set_proc_to_const(proc, attr_name) if proc

      define_method("#{attr_name}=") do |val|
        val = options[:prepare].call(val) if options[:prepare]
Severity: Minor
Found in lib/methodist/builder.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 contract has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    def contract(contract_class: nil, &block)
      unless new_dry_validation?
        raise DryValidationVersionError,
          "Your depended dry-validation gem version must be gteq #{NEW_DRY_VALIDATION_V}"
      end
Severity: Minor
Found in lib/methodist/interactor.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