Module: SimplyStored::Couch::ClassMethods

Includes:
SimplyStored::ClassMethods::Base, BelongsTo, HasMany, HasOne, Validations, Storage::ClassMethods
Defined in:
lib/simply_stored/couch.rb

Instance Method Summary collapse

Methods included from Storage::ClassMethods

#define_attachment_accessors, #has_s3_attachment

Methods included from HasOne

#define_has_one_getter, #define_has_one_setter, #has_one

Methods included from HasMany

#define_has_many_count, #define_has_many_getter, #define_has_many_setter_add, #define_has_many_setter_remove, #define_has_many_setter_remove_all, #define_has_many_through_getter, #has_many

Methods included from BelongsTo

#belongs_to

Methods included from Validations

#validates_format_of, #validates_inclusion_of, #validates_uniqueness_of

Methods included from SimplyStored::ClassMethods::Base

#_find_property, #attr_accessible, #attr_protected, #foreign_key, #foreign_property, #get_class_from_name

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/simply_stored/couch.rb', line 250

def method_missing(name, *args)
  if name.to_s =~ /^find_by/
    _define_find_by(name, *args)
  elsif name.to_s =~ /^find_all_by/
    _define_find_all_by(name, *args)
  elsif name.to_s =~ /^count_by/
    _define_count_by(name, *args)
  else
    super
  end
end

Instance Method Details

#_define_count_by(name, *args) ⇒ Object 



214
215
216
217
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
 
# File 'lib/simply_stored/couch.rb', line 214

def _define_count_by(name, *args)
  keys = name.to_s.gsub(/^count_by_/, "").split("_and_")
  view_name = name.to_s.gsub(/^count_/, "").to_sym
  view_keys = keys.length == 1 ? keys.first : keys
  without_deleted_view_name = "#{view_name}_withoutdeleted"
  without_deleted_view_keys = keys + [:deleted_at]
  
  unless respond_to?(view_name)
    puts "Warning: Defining view #{self.name}##{view_name} with keys #{view_keys.inspect} at call time, please add it to the class body. (Called from #{caller[0]})"
    view(view_name, :key => view_keys)
  end
  
  if !respond_to?(without_deleted_view_name) && soft_deleting_enabled?
    puts "Warning: Defining view #{self.name}##{without_deleted_view_name} with keys #{without_deleted_view_keys.inspect} at call time, please add it to the class body. (Called from #{caller[0]})"
    view(without_deleted_view_name, :key => without_deleted_view_keys)
  end
  
  (class << self; self end).instance_eval do
    define_method("#{name}") do |*key_args|
      options = key_args.last.is_a?(Hash) ? key_args.pop : {}
      options.assert_valid_keys(:with_deleted)
      with_deleted = options.delete(:with_deleted)
      
      if soft_deleting_enabled? && !with_deleted
        key_args = key_args + [nil] # deleted_at
        CouchPotato.database.view(send(without_deleted_view_name, :key => (key_args.size == 1 ? key_args.first : key_args), :reduce => true))
      else
        CouchPotato.database.view(send(view_name, :key => (key_args.size == 1 ? key_args.first : key_args), :reduce => true))
      end
      
    end
  end

  send(name, *args)
end

#_define_find_all_by(name, *args) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/simply_stored/couch.rb', line 178

def _define_find_all_by(name, *args)
  keys = name.to_s.gsub(/^find_all_by_/, "").split("_and_")
  view_name = name.to_s.gsub(/^find_all_/, "").to_sym
  view_keys = keys.length == 1 ? keys.first : keys
  without_deleted_view_name = "#{view_name}_withoutdeleted"
  without_deleted_view_keys = keys + [:deleted_at]
  
  unless respond_to?(view_name)
    puts "Warning: Defining view #{self.name}##{view_name} with keys #{view_keys.inspect} at call time, please add it to the class body. (Called from #{caller[0]})"
    view(view_name, :key => view_keys)
  end
  
  if !respond_to?(without_deleted_view_name) && soft_deleting_enabled?
    puts "Warning: Defining view #{self.name}##{without_deleted_view_name} with keys #{without_deleted_view_keys.inspect} at call time, please add it to the class body. (Called from #{caller[0]})"
    view(without_deleted_view_name, :key => without_deleted_view_keys)
  end
  
  (class << self; self end).instance_eval do
    define_method(name) do |*key_args|
      options = key_args.last.is_a?(Hash) ? key_args.pop : {}
      options.assert_valid_keys(:with_deleted)
      with_deleted = options.delete(:with_deleted)
      
      raise ArgumentError, "Too many or too few arguments, require #{keys.inspect}" unless keys.size == key_args.size            
      
      if soft_deleting_enabled? && !with_deleted
        key_args = key_args + [nil] # deleted_at
        CouchPotato.database.view(send(without_deleted_view_name, :key => (key_args.size == 1 ? key_args.first : key_args), :include_docs => true))
      else
        CouchPotato.database.view(send(view_name, :key => (key_args.size == 1 ? key_args.first : key_args), :include_docs => true))
      end
    end
  end
  send(name, *args)
end

#_define_find_by(name, *args) ⇒ Object 



141
142
143
144
145
146
147
148
149
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
176
 
# File 'lib/simply_stored/couch.rb', line 141

def _define_find_by(name, *args)
  keys = name.to_s.gsub(/^find_by_/, "").split("_and_")
  view_name = name.to_s.gsub(/^find_/, "").to_sym
  view_keys = keys.length == 1 ? keys.first : keys
  without_deleted_view_name = "#{view_name}_withoutdeleted"
  without_deleted_view_keys = keys + [:deleted_at]
  
  unless respond_to?(view_name)
    puts "Warning: Defining view #{self.name}##{view_name} with keys #{view_keys.inspect} at call time, please add it to the class body. (Called from #{caller[0]})"
    view(view_name, :key => view_keys)
  end
  
  if !respond_to?(without_deleted_view_name) && soft_deleting_enabled?
    puts "Warning: Defining view #{self.name}##{without_deleted_view_name} with keys #{without_deleted_view_keys.inspect} at call time, please add it to the class body. (Called from #{caller[0]})"
    view(without_deleted_view_name, :key => without_deleted_view_keys)
  end
  
  (class << self; self end).instance_eval do
    define_method(name) do |*key_args|
      options = key_args.last.is_a?(Hash) ? key_args.pop : {}
      options.assert_valid_keys(:with_deleted)
      with_deleted = options.delete(:with_deleted)
      
      raise ArgumentError, "Too many or too few arguments, require #{keys.inspect}" unless keys.size == key_args.size            
      
      if soft_deleting_enabled? && !with_deleted
        key_args = key_args + [nil] # deleted_at
        CouchPotato.database.view(send(without_deleted_view_name, :key => (key_args.size == 1 ? key_args.first : key_args), :limit => 1, :include_docs => true)).first
      else
        CouchPotato.database.view(send(view_name, :key => (key_args.size == 1 ? key_args.first : key_args), :limit => 1, :include_docs => true)).first
      end
    end
  end
  
  send(name, *args)
end

#_define_hard_delete_methods ⇒ Object 



262
263
264
265
266
267
268
269
270
 
# File 'lib/simply_stored/couch.rb', line 262

def _define_hard_delete_methods
  define_method("destroy!") do
    destroy(true)
  end
  
  define_method("delete!") do
    destroy(true)
  end
end

#_define_soft_delete_views ⇒ Object 



272
273
274
 
# File 'lib/simply_stored/couch.rb', line 272

def _define_soft_delete_views 
  view :all_documents_without_deleted, :key => soft_delete_attribute
end

#all(*args) ⇒ Object 



79
80
81
 
# File 'lib/simply_stored/couch.rb', line 79

def all(*args)
  find(:all, *args)
end

#count(options = {}) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/simply_stored/couch.rb', line 87

def count(options = {})
  options.assert_valid_keys(:with_deleted)
  with_deleted = options[:with_deleted]
  
  if with_deleted || !soft_deleting_enabled?
    CouchPotato.database.view(all_documents(:reduce => true))
  else
    CouchPotato.database.view(all_documents_without_deleted(:reduce => true, :key => nil))
  end
end

#create(attributes = {}, &blk) ⇒ Object 



38
39
40
41
42
 
# File 'lib/simply_stored/couch.rb', line 38

def create(attributes = {}, &blk)
  instance = new(attributes, &blk)
  instance.save
  instance
end

#create!(attributes = {}, &blk) ⇒ Object 



44
45
46
47
48
 
# File 'lib/simply_stored/couch.rb', line 44

def create!(attributes = {}, &blk)
  instance = new(attributes, &blk)
  instance.save!
  instance
end

#enable_soft_delete(property_name = :deleted_at) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/simply_stored/couch.rb', line 98

def enable_soft_delete(property_name = :deleted_at)
  @_soft_delete_attribute = property_name.to_sym
  property property_name, :type => Time
  _define_hard_delete_methods
  _define_soft_delete_views
end

#find(*args) ⇒ Object 



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
 
# File 'lib/simply_stored/couch.rb', line 50

def find(*args)
  what = args.shift
  options = args.last.is_a?(Hash) ? args.last : {}
  
  with_deleted = options.delete(:with_deleted)
  
  case what
  when :all
    if with_deleted || !soft_deleting_enabled?
      CouchPotato.database.view(all_documents(*args))
    else
      CouchPotato.database.view(all_documents_without_deleted(options.update(:key => nil)))
    end
  when :first
    if with_deleted || !soft_deleting_enabled?
      CouchPotato.database.view(all_documents(:limit => 1)).first
    else
      CouchPotato.database.view(all_documents_without_deleted(:key => nil, :limit => 1)).first
    end
  else          
    raise SimplyStored::Error, "Can't load record without an id" if what.nil?
    document = CouchPotato.database.load_document(what)
    if document.nil? or !document.is_a?(self) or (document.deleted? && !with_deleted)
      raise(SimplyStored::RecordNotFound, "#{self.name} could not be found with #{what.inspect}")
    end
    document
  end
end

#first(*args) ⇒ Object 



83
84
85
 
# File 'lib/simply_stored/couch.rb', line 83

def first(*args)
  find(:first, *args)
end

#require_attributes(*names) ⇒ Object 



125
126
127
128
129
 
# File 'lib/simply_stored/couch.rb', line 125

def require_attributes(*names)
  names.each do |name|
    validates_presence_of name
  end
end

#require_format_of(attr, valid_regex, options = {}) ⇒ Object 



136
137
138
139
 
# File 'lib/simply_stored/couch.rb', line 136

def require_format_of(attr, valid_regex, options = {})
  options.update(:with => valid_regex)
  validates_format_of(attr, options)
end

#require_inclusion_of(name, valid_set, options = {}) ⇒ Object 



131
132
133
134
 
# File 'lib/simply_stored/couch.rb', line 131

def require_inclusion_of(name, valid_set, options = {})
  options.update(:in => valid_set)
  validates_inclusion_of(name, options)
end

#simpledb_string(*names) ⇒ Object 



113
114
115
116
117
 
# File 'lib/simply_stored/couch.rb', line 113

def simpledb_string(*names)
  names.each do |name|
    property name
  end
end

#simpledb_timestamp(*names) ⇒ Object 



119
120
121
122
123
 
# File 'lib/simply_stored/couch.rb', line 119

def simpledb_timestamp(*names)
  names.each do |name|
    property name, :type => Time
  end
end

#soft_delete_attribute ⇒ Object 



105
106
107
 
# File 'lib/simply_stored/couch.rb', line 105

def soft_delete_attribute
  @_soft_delete_attribute
end

#soft_deleting_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/simply_stored/couch.rb', line 109

def soft_deleting_enabled?
  !soft_delete_attribute.nil?
end