Module: Squirrell

Included in:
ExampleQuery
Defined in:
lib/squirrell.rb,
lib/squirrell/version.rb,
lib/squirrell/class_methods.rb,
lib/squirrell/instance_methods.rb

Overview

Including this module gives a few convenience methods for query objects.

Defined Under Namespace

Modules: ClassMethods, InstanceMethods Classes: ExecutorError, InvalidArelError, MissingParameterError, UnusedParameter

Constant Summary collapse

VERSION = 
'0.2.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.executor ⇒ Object

Returns the value of attribute executor.



10
11
12
 
# File 'lib/squirrell.rb', line 10

def executor
  @executor
end

.permits ⇒ Object

Returns the value of attribute permits.



9
10
11
 
# File 'lib/squirrell.rb', line 9

def permits
  @permits
end

.requires ⇒ Object

Returns the value of attribute requires.



8
9
10
 
# File 'lib/squirrell.rb', line 8

def requires
  @requires
end

Class Method Details

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (Squirrell) —

    the object that the method was called on



20
21
22
 
# File 'lib/squirrell.rb', line 20

def self.configure
  yield self
end

.included(klass) ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/squirrell.rb', line 37

def self.included(klass)
  Squirrell.requires ||= {}
  Squirrell.requires[klass] = []
  Squirrell.permits ||= {}
  Squirrell.permits[klass] = []

  klass.extend ClassMethods
  klass.include InstanceMethods
end