Module: Datamappify::Repository::QueryMethods

Defined in:
lib/datamappify/repository/query_methods.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



8
9
10
11
12
 
# File 'lib/datamappify/repository/query_methods.rb', line 8

def self.included(klass)
  klass.class_eval do
    include QueryMethod::Callbacks
  end
end

Instance Method Details

#all ⇒ Array<Entity>

Returns a collection of all the entities in the repository

Returns:



42
43
44
 
# File 'lib/datamappify/repository/query_methods.rb', line 42

def all
  QueryMethod::FindMultiple.new(query_options, {}).perform
end

#count ⇒ Integer

Returns:

  • (Integer) 


120
121
122
 
# File 'lib/datamappify/repository/query_methods.rb', line 120

def count
  QueryMethod::Count.new(query_options).perform
end

#create(entity) ⇒ Entity, false

Parameters:

  • entity (Entity) —

    an entity or a collection of entities

Returns:



50
51
52
53
54
 
# File 'lib/datamappify/repository/query_methods.rb', line 50

def create(entity)
  run_callbacks entity, :save, :create do
    QueryMethod::Create.new(query_options, entity).perform
  end
end

#create!(entity) ⇒ Entity

Parameters:

  • entity (Entity) —

    an entity or a collection of entities

Returns:

Raises:



61
62
63
 
# File 'lib/datamappify/repository/query_methods.rb', line 61

def create!(entity)
  create(entity) || raise(Data::EntityNotSaved)
end

#destroy(entity) ⇒ void, false

Parameters:

Returns:

  • (void, false) 


104
105
106
107
108
 
# File 'lib/datamappify/repository/query_methods.rb', line 104

def destroy(entity)
  run_callbacks entity, :destroy do
    QueryMethod::Destroy.new(query_options, entity).perform
  end
end

#destroy!(entity) ⇒ void

This method returns an undefined value.

Parameters:

Raises:



115
116
117
 
# File 'lib/datamappify/repository/query_methods.rb', line 115

def destroy!(entity)
  destroy(entity) || raise(Data::EntityNotDestroyed)
end

#exists?(entity) ⇒ Boolean

Does the entity exist already in the repository?

Parameters:

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/datamappify/repository/query_methods.rb', line 19

def exists?(entity)
  QueryMethod::Exists.new(query_options, entity).perform
end

#find(criteria) ⇒ Entity?

Parameters:

  • criteria (Integer, String) —

    an entity id or a hash containing criteria

Returns:



27
28
29
 
# File 'lib/datamappify/repository/query_methods.rb', line 27

def find(criteria)
  QueryMethod::Find.new(query_options, criteria).perform
end

#query_options ⇒ Hash (private)

Some default, required objects passed into each query method

Returns:

  • (Hash) 


129
130
131
132
133
134
135
 
# File 'lib/datamappify/repository/query_methods.rb', line 129

def query_options
  {
    :data_mapper => data_mapper,
    :states      => states,
    :lazy_load?  => lazy_load?
  }
end

#save(entity) ⇒ Entity, false

Parameters:

  • entity (Entity) —

    an entity or a collection of entities

Returns:



88
89
90
 
# File 'lib/datamappify/repository/query_methods.rb', line 88

def save(entity)
  exists?(entity) ? update(entity) : create(entity)
end

#save!(entity) ⇒ Entity

Parameters:

  • entity (Entity) —

    an entity or a collection of entities

Returns:

Raises:



97
98
99
 
# File 'lib/datamappify/repository/query_methods.rb', line 97

def save!(entity)
  exists?(entity) ? update!(entity) : create!(entity)
end

#update(entity) ⇒ Entity, false

Parameters:

  • entity (Entity) —

    an entity or a collection of entities

Returns:



69
70
71
72
73
 
# File 'lib/datamappify/repository/query_methods.rb', line 69

def update(entity)
  run_callbacks entity, :save, :update do
    QueryMethod::Update.new(query_options, entity).perform
  end
end

#update!(entity) ⇒ Entity

Parameters:

  • entity (Entity) —

    an entity or a collection of entities

Returns:

Raises:



80
81
82
 
# File 'lib/datamappify/repository/query_methods.rb', line 80

def update!(entity)
  update(entity) || raise(Data::EntityNotSaved)
end

#where(criteria) ⇒ Entity

Parameters:

  • criteria (Hash) —

    a hash containing criteria

Returns:



35
36
37
 
# File 'lib/datamappify/repository/query_methods.rb', line 35

def where(criteria)
  QueryMethod::FindMultiple.new(query_options, criteria).perform
end