Class: PcQueues::QueueRule

Inherits:

ActiveRecord::Base

• Object
• ActiveRecord::Base
• PcQueues::QueueRule

Defined in:

lib/pc_queues/queue_rule.rb

Overview

QueueRule is the base class (STI) for Rules that are evaluated as part of a QueueRuleSet There must be at least one implmentor of the passes? method in the hierachy of QueueRule being stored in a QueueRuleSet.

Direct Known Subclasses

PcQueues::QueueRules::BooleanQueueRule, PcQueues::QueueRules::NumericQueueRule, PcQueues::QueueRules::SampleQueueRule, PcQueues::QueueRules::StringMatchQueueRule

Class Method Summary

• .accessible_attributes ⇒ Object

  attr_accessible :numeric_value, :string_value, :bool_value, :type.

• .options(opts = {}) ⇒ Object

  A convenience method for creating QueueRule instances with more declaritive code.

Instance Method Summary

• #passes?(enqueable, *args) ⇒ Boolean

  All derived classes must implement this method and it must return a Boolean.

Class Method Details

.accessible_attributes ⇒ Object

attr_accessible :numeric_value, :string_value, :bool_value, :type

# File 'lib/pc_queues/queue_rule.rb', line 12

def self.accessible_attributes
  [:numeric_value, :string_value, :bool_value, :type]
end

.options(opts = {}) ⇒ Object

A convenience method for creating QueueRule instances with more declaritive code. Derived classes can implement and super to this.

Eg. rule_set.queue_rules.create(MyNewRule.options special_opt1: value)

# File 'lib/pc_queues/queue_rule.rb', line 22

def self.options(opts = {})
  opts[:type] = self.name
  opts
end

Instance Method Details

#passes?(enqueable, *args) ⇒ Boolean

All derived classes must implement this method and it must return a Boolean

Returns:

• (Boolean)

Raises:

• (NotImplementedError)

# File 'lib/pc_queues/queue_rule.rb', line 28

def passes?(enqueable, *args)
  raise NotImplementedError, "The class: #{self.class.name} requires an implementation of #{__method__}"
end