tablexi / flow_machine Goto Github PK

Currently, if we call an event on the workflow object that doesn't exists in the current state, we get a no-op false return value rather than a NotMethodError or something similar. Could it be more handy for the development environment to raise an exception here to help track down bad code paths (a caller that is trying to do a wrong transition on a specific scenario) instead? Even if the client code checks for falsy return values there is no way to know that an invalid transition/event was called.

Here is a piece of code to illustrate the scenario:

class PublishingWorkflow
  include FlowMachine::Workflow

  state DraftState
  state PublishedState
end

class DraftState < FlowMachine::WorkflowState
  event :publish do
    transition to: :published
  end
end

class PublishedState < FlowMachine::WorkflowState
  event :retract do
    transition to: :retracted
  end
end

workflow = PublishingWorkflow.new(BlogPost.new(state: :draft))
# drafts can't be retracted.
workflow.retract! #=> false

It's sometimes handy to add the scopes as: FlowMachine::Workflow.class_for(self).create_scopes_on(self), but that is very verbose.

Proposal: FlowMachine::Workflow.create_scopes_on(self) which calls class_for

Add RDoc documentation

When config.warnings = true in spec_helper is enabled, there are several warnings about uninialized instance variables.

flow_machine/lib/flow_machine/workflow.rb:67: warning: instance variable @state_attribute not initialized
flow_machine/lib/flow_machine/workflow.rb:162: warning: instance variable @previous_state not initialized

Deprecate the methods in FlowMachine::Factory in favor of having them straight on FlowMachine

Example:
Previous: FlowMachine::Factory.workflow_for(...)
New: FlowMachine.workflow_for(...)

And add notes about these methods to the README.

Currently, there are a few places where we are using ActiveSupport: try, delegate, Inflectors, and extract_options!. Ideally these would not be used.