maestrodev/maestro-ruby-plugin

View on GitHub

Showing 8 of 8 total issues

Class MaestroWorker has 33 methods (exceeds 20 allowed). Consider refactoring.
Open

  class MaestroWorker
    # Workitem constants
    CONTEXT_OUTPUTS_META = '__context_outputs__'
    OUTPUT_META = '__output__'
    PREVIOUS_CONTEXT_OUTPUTS_META = '__previous_context_outputs__'
Severity: Minor
Found in lib/maestro_plugin/maestro_worker.rb - About 4 hrs to fix

    Method write_output has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
    Open

        def write_output(output, options = {})
          # First time thru?  We need to do some setup!
          reset_buffered_output if @buffered_output.nil?
    
          @buffered_output += output
    Severity: Minor
    Found in lib/maestro_plugin/maestro_worker.rb - About 3 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 maestro_worker.rb has 288 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require 'json'
    
    module MaestroDev
      module Plugin
        # General plugin problem.  A plugin can raise errors of this type and have the 'message' portion of the error
    Severity: Minor
    Found in lib/maestro_plugin/maestro_worker.rb - About 2 hrs to fix

      Method write_output has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def write_output(output, options = {})
            # First time thru?  We need to do some setup!
            reset_buffered_output if @buffered_output.nil?
      
            @buffered_output += output
      Severity: Minor
      Found in lib/maestro_plugin/maestro_worker.rb - About 1 hr to fix

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

            def cancel
              workitem[CANCEL_META] = true
              send_workitem_message
            rescue Exception => e
              Maestro.log.warn "Failed To Send Cancel Message To Server #{e.class} #{e}: #{e.backtrace.join("\n")}"
        Severity: Minor
        Found in lib/maestro_plugin/maestro_worker.rb and 1 other location - About 35 mins to fix
        lib/maestro_plugin/maestro_worker.rb on lines 282..289

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

        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 not_needed
              workitem[NOT_NEEDED] = true
              send_workitem_message
            rescue Exception => e
              Maestro.log.warn "Failed To Send Not Needed Message To Server #{e.class} #{e}: #{e.backtrace.join("\n")}"
        Severity: Minor
        Found in lib/maestro_plugin/maestro_worker.rb and 1 other location - About 35 mins to fix
        lib/maestro_plugin/maestro_worker.rb on lines 271..278

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

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

            def as_boolean(value)
              res = false
        
              if value
                if value.is_a?(TrueClass) || value.is_a?(FalseClass)
        Severity: Minor
        Found in lib/maestro_plugin/maestro_worker.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 create_record_with_fields has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            def create_record_with_fields(model, record_fields, record_values = nil)
              workitem[PERSIST_META] = true
              workitem[CREATE_META] = true
              workitem[MODEL_META] = model
              unless record_fields.is_a? Hash
        Severity: Minor
        Found in lib/maestro_plugin/maestro_worker.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