Class: Cistern::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/cistern/service.rb

Defined Under Namespace

Modules: Collections

Class Method Summary collapse

Class Method Details

.collections ⇒ Object 



106
107
108
 
# File 'lib/cistern/service.rb', line 106

def collections
  @collections ||= []
end

.inherited(klass) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cistern/service.rb', line 18

def inherited(klass)
  klass.class_eval <<-EOS, __FILE__, __LINE__
    module Collections
      include Cistern::Service::Collections

      def service
        #{klass.name}
      end
    end

    def self.service
      #{klass.name}
    end

    class Real
      def initialize(options={})
      end
    end

    class Mock
      def initialize(options={})
      end
    end

    class Model
      include Cistern::Model

      def self.inherited(klass)
        service.models << klass
      end

      def self.service
        #{klass.name}
      end
    end

    class Collection
      include Cistern::Collection

      def self.inherited(klass)
        klass.send(:extend, Cistern::Attributes::ClassMethods)
        klass.send(:extend, Cistern::Collection::ClassMethods)
        klass.send(:include, Cistern::Attributes::InstanceMethods)

        service.collections << klass
      end

      def self.service
        #{klass.name}
      end
    end

    class Request
      include Cistern::Request

      def self.inherited(klass)
        klass.extend(Cistern::Request::ClassMethods)

        service.requests << klass
      end

      def self.service
        #{klass.name}
      end

      def _mock(*args)
        mock(*args)
      end

      def _real(*args)
        real(*args)
      end
    end
  EOS

  klass.send(:const_set, :Timeout, Class.new(Cistern::Error))

  klass::Mock.send(:include, klass::Collections)
  klass::Mock.send(:extend, Cistern::WaitFor)
  klass::Mock.timeout_error = klass::Timeout

  klass::Mock.send(:extend, Cistern::Data)

  klass::Real.send(:include, klass::Collections)
  klass::Real.send(:extend, Cistern::WaitFor)
  klass::Real.timeout_error = klass::Timeout
end

.mock! ⇒ Object 



3
 
# File 'lib/cistern/service.rb', line 3

def self.mock!;    @mocking = true; end

.mocking? ⇒ Boolean

Returns:

  • (Boolean) 


4
 
# File 'lib/cistern/service.rb', line 4

def self.mocking?; @mocking; end

.models ⇒ Object 



110
111
112
 
# File 'lib/cistern/service.rb', line 110

def models
  @_models ||= []
end

.new(options = {}) ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/cistern/service.rb', line 177

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

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

.recognized_arguments ⇒ Object 



114
115
116
 
# File 'lib/cistern/service.rb', line 114

def recognized_arguments
  @_recognized_arguments ||= []
end

.recognizes(*args) ⇒ Object 



130
131
132
 
# File 'lib/cistern/service.rb', line 130

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

.requests ⇒ Object 



122
123
124
 
# File 'lib/cistern/service.rb', line 122

def requests
  @_requests ||= []
end

.required_arguments ⇒ Object 



118
119
120
 
# File 'lib/cistern/service.rb', line 118

def required_arguments
  @_required_arguments ||= []
end

.requires(*args) ⇒ Object 



126
127
128
 
# File 'lib/cistern/service.rb', line 126

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

.reset! ⇒ Object 



184
185
186
 
# File 'lib/cistern/service.rb', line 184

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

.setup ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/cistern/service.rb', line 150

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

  @_setup = true
end

.unmock! ⇒ Object 



5
 
# File 'lib/cistern/service.rb', line 5

def self.unmock!;  @mocking = false; end

.validate_options(options = {}) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cistern/service.rb', line 134

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?
    raise "Missing required options: #{missing_required_options.inspect}"
  end

  unrecognized_options = options.keys - (required_arguments + recognized_arguments)

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