Class: Inquery::Query

Inherits:

Object

• Object
• Inquery::Query

show all

Includes:

Mixins::SchemaValidation

Defined in:

lib/inquery/query.rb

Defined Under Namespace

Classes: Chainable

Instance Attribute Summary (collapse)

• - (Object) params readonly

  Returns the value of attribute params.

Class Method Summary (collapse)

• + (Object) call(*args)

  Instantiates the query class using the given arguments and runs call on it.

• + (Object) run(*args)

  Instantiates the query class using the given arguments and runs call and process on it.

Instance Method Summary (collapse)

• - (Object) call

  Override this method to perform the actual query.

• - (Query) initialize(params = {}) constructor

  Instantiates the query class and validates the given params hash (if there was a validation schema specified).

• - (Object) osparams

  Returns a copy of the query's params, wrapped in an OpenStruct object for easyer access.

• - (Object) process(results)

  Override this method to perform an optional result postprocessing.

• - (Object) run

  Runs both call and process.

21
22
23
24
25
26
27

# File 'lib/inquery/query.rb', line 21

def initialize(params = {})
  @params = params

  if self.class._schema
    Schemacop.validate!(self.class._schema, @params)
  end
end

5
6
7

# File 'lib/inquery/query.rb', line 5

def params
  @params
end

15
16
17

# File 'lib/inquery/query.rb', line 15

def self.call(*args)
  new(*args).call
end

9
10
11

# File 'lib/inquery/query.rb', line 9

def self.run(*args)
  new(*args).run
end

35
36
37

# File 'lib/inquery/query.rb', line 35

def call
  fail NotImplementedError
end

46
47
48

# File 'lib/inquery/query.rb', line 46

def osparams
  @osparams ||= OpenStruct.new(params)
end

40
41
42

# File 'lib/inquery/query.rb', line 40

def process(results)
  results
end

30
31
32

# File 'lib/inquery/query.rb', line 30

def run
  process(call)
end