Module: Cistern::Client::ClassMethods

Defined in:
lib/cistern/client.rb

Instance Method Summary collapse

Instance Method Details

#collectionsObject



170
171
172
# File 'lib/cistern/client.rb', line 170

def collections
  @collections ||= []
end

#mock!Object



158
159
160
# File 'lib/cistern/client.rb', line 158

def mock!
  @mocking = true
end

#mocking?Boolean

Returns:

  • (Boolean)


162
163
164
# File 'lib/cistern/client.rb', line 162

def mocking?
  @mocking
end

#modelsObject



174
175
176
# File 'lib/cistern/client.rb', line 174

def models
  @_models ||= []
end

#new(options = {}) ⇒ Object



252
253
254
255
256
257
# File 'lib/cistern/client.rb', line 252

def new(options = {})
  setup
  validate_options(options)

  const_get(self.mocking? ? :Mock : :Real).new(options)
end

#recognized_argumentsObject



182
183
184
# File 'lib/cistern/client.rb', line 182

def recognized_arguments
  @_recognized_arguments ||= []
end

#recognizes(*args) ⇒ Object



198
199
200
# File 'lib/cistern/client.rb', line 198

def recognizes(*args)
  recognized_arguments.concat(args)
end

#requestsObject



190
191
192
# File 'lib/cistern/client.rb', line 190

def requests
  @_requests ||= []
end

#required_argumentsObject



186
187
188
# File 'lib/cistern/client.rb', line 186

def required_arguments
  @_required_arguments ||= []
end

#requires(*args) ⇒ Object



194
195
196
# File 'lib/cistern/client.rb', line 194

def requires(*args)
  required_arguments.concat(args)
end

#reset!Object



259
260
261
# File 'lib/cistern/client.rb', line 259

def reset!
  const_get(:Mock).reset!
end

#setupObject



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/cistern/client.rb', line 218

def setup
  return true if @_setup

  requests.each do |klass|
    name = klass.service_method ||
           Cistern::String.camelize(Cistern::String.demodulize(klass.name))

    Cistern::Request.service_request(self, klass, name)
  end

  collections.each do |klass|
    name = klass.service_method ||
           Cistern::String.underscore(klass.name.gsub("#{self.name}::", '').gsub('::', ''))

    Cistern::Collection.service_collection(self, klass, name)
  end

  models.each do |klass|
    name = klass.service_method ||
           Cistern::String.underscore(klass.name.gsub("#{self.name}::", '').gsub('::', ''))

    Cistern::Model.service_model(self, klass, name)
  end

  singularities.each do |klass|
    name = klass.service_method ||
           Cistern::String.underscore(klass.name.gsub("#{self.name}::", '').gsub('::', ''))

    Cistern::Singular.service_singular(self, klass, name)
  end

  @_setup = true
end

#singularitiesObject



178
179
180
# File 'lib/cistern/client.rb', line 178

def singularities
  @_singularities ||= []
end

#unmock!Object



166
167
168
# File 'lib/cistern/client.rb', line 166

def unmock!
  @mocking = false
end

#validate_options(options = {}) ⇒ Object



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/cistern/client.rb', line 202

def validate_options(options = {})
  required_options = Cistern::Hash.slice(options, *required_arguments)

  missing_required_options = required_arguments - required_options.keys

  unless missing_required_options.empty?
    fail "Missing required options: #{missing_required_options.inspect}"
  end

  unrecognized_options = options.keys - (required_arguments + recognized_arguments)

  unless unrecognized_options.empty?
    fail "Unrecognized options: #{unrecognized_options.inspect}"
  end
end