Module: MongoidExt::Versioning::ClassMethods

Defined in:
lib/mongoid_ext/versioning.rb

Instance Method Summary collapse

Instance Method Details

#version_klass ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/mongoid_ext/versioning.rb', line 86

def version_klass
  parent_klass = self
  @version_klass ||= Class.new do
    include Mongoid::Document
    include Mongoid::Timestamps

    cattr_accessor :parent_class
    self.parent_class = parent_klass

    self.collection_name = "#{self.parent_class.collection_name}.versions"

    identity :type => String
    field :message, :type => String
    field :data, :type => Hash

    referenced_in :owner, :class_name => parent_klass.versionable_options[:user_class]

    referenced_in :target, :polymorphic => true

    after_create :add_version

    validates_presence_of :target_id

    def content(key)
      cdata = self.data[key]
      if cdata.respond_to?(:join)
        cdata.join(" ")
      else
        cdata || ""
      end
    end

    private
    def add_version
      self.class.parent_class.push({:_id => self.target_id}, {:version_ids => self.id})
      self.class.parent_class.increment({:_id => self.target_id}, {:versions_count => 1})
    end
  end
end

#versionable_keys(*keys) ⇒ Object

example:

class Foo
  include Mongoid::Document
  include MongoidExt::Versioning
  versionable_keys :field1, :field2, :field3, :user_class => "Customer", :owner_field => "updated_by_id"
  ...
end



134
135
136
137
138
139
140
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
177
178
179
180
181
182
183
184
185
 
# File 'lib/mongoid_ext/versioning.rb', line 134

def versionable_keys(*keys)
  self.versionable_options = keys.extract_options!
  self.versionable_options[:owner_field] ||= "user_id"
  self.versionable_options[:owner_field] = self.versionable_options[:owner_field].to_s

  relationship = self.relations[self.versionable_options[:owner_field].sub(/_id$/, "")]
  if !relationship
    raise ArgumentError, "the supplied :owner_field => #{self.versionable_options[:owner_field].inspect} option is invalid"
  end
  self.versionable_options[:user_class] = relationship.class_name

  define_method(:save_version) do
    data = {}
    message = ""
    keys.each do |key|
      if change = changes[key.to_s]
        data[key.to_s] = change.first
      else
        data[key.to_s] = self[key]
      end
    end

    if message_changes = self.changes["version_message"]
      message = message_changes.first
    else
      version_message = ""
    end

    uuser_id = send(self.versionable_options[:owner_field]+"_was")||send(self.versionable_options[:owner_field])
    if !self.new? && !data.empty? && uuser_id
      max_versions = self.versionable_options[:max_versions].to_i
      if self.version_ids.size >= max_versions
        old = self.version_ids.slice!(0, max_versions)
        self.class.skip_callback(:save, :before, :save_version)
        self.version_klass.delete_all(:_ids => old)
        self.save
        self.class.set_callback(:save, :before, :save_version)
      end

      self.version_klass.create({
        'data' => data,
        'owner_id' => uuser_id,
        'target' => self,
        'message' => message
      })
    end
  end

  define_method(:versioned_keys) do
    keys
  end
end