geekq/workflow

View on GitHub
lib/workflow.rb

Summary

Maintainability
B
4 hrs
Test Coverage
A
93%

Method assign_workflow has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Invalid

    def assign_workflow(specification_object)

      # Merging two workflow specifications can **not** be done automically, so
      # just make the latest specification win. Same for inheritance -
      # definition in the subclass wins.
Severity: Minor
Found in lib/workflow.rb - About 1 hr to fix

    Method run_on_error has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Invalid

        def run_on_error(error, from, to, event, *args, **kwargs)
    Severity: Minor
    Found in lib/workflow.rb - About 45 mins to fix

      Method run_on_transition has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def run_on_transition(from, to, event, *args, **kwargs)
      Severity: Minor
      Found in lib/workflow.rb - About 35 mins to fix

        Method run_before_transition has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def run_before_transition(from, to, event, *args, **kwargs)
        Severity: Minor
        Found in lib/workflow.rb - About 35 mins to fix

          Method run_on_exit has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              def run_on_exit(state, new_state, triggering_event, *args, **kwargs)
          Severity: Minor
          Found in lib/workflow.rb - About 35 mins to fix

            Method run_after_transition has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                def run_after_transition(from, to, event, *args, **kwargs)
            Severity: Minor
            Found in lib/workflow.rb - About 35 mins to fix

              Method run_on_entry has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                  def run_on_entry(state, prior_state, triggering_event, *args, **kwargs)
              Severity: Minor
              Found in lib/workflow.rb - About 35 mins to fix

                Method run_on_exit has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Invalid

                    def run_on_exit(state, new_state, triggering_event, *args, **kwargs)
                      if state
                        if state.on_exit
                          instance_exec(new_state.name, triggering_event, *args, **kwargs, &state.on_exit)
                        else
                Severity: Minor
                Found in lib/workflow.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 process_event! has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Invalid

                    def process_event!(name, *args, **kwargs)
                      event = current_state.events.first_applicable(name, self)
                      raise NoTransitionAllowed.new(
                        "There is no event #{name.to_sym} defined for the #{current_state} state") \
                        if event.nil?
                Severity: Minor
                Found in lib/workflow.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

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

                        if state.on_exit
                          instance_exec(new_state.name, triggering_event, *args, **kwargs, &state.on_exit)
                        else
                          hook_name = "on_#{state}_exit"
                          self.send hook_name, new_state, triggering_event, *args, **kwargs if has_callback?(hook_name)
                Severity: Minor
                Found in lib/workflow.rb and 1 other location - About 35 mins to fix
                lib/workflow.rb on lines 215..219

                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

                      if state.on_entry
                        instance_exec(prior_state.name, triggering_event, *args, **kwargs, &state.on_entry)
                      else
                        hook_name = "on_#{state}_entry"
                        self.send hook_name, prior_state, triggering_event, *args, **kwargs if has_callback?(hook_name)
                Severity: Minor
                Found in lib/workflow.rb and 1 other location - About 35 mins to fix
                lib/workflow.rb on lines 225..229

                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

                There are no issues that match your filters.

                Category
                Status