Merge the master-journalized branch from https://github.com/finnlabs/redmine/
Felix Schäfer
14 years ago
commit
70e10ab4bd
@ -0,0 +1,3 @@ |
||||
[submodule "vendor/plugins/acts_as_journalized"] |
||||
path = vendor/plugins/acts_as_journalized |
||||
url = git://github.com/finnlabs/acts_as_journalized |
||||
@ -1,42 +0,0 @@ |
||||
# redMine - project management software |
||||
# Copyright (C) 2006-2008 Jean-Philippe Lang |
||||
# |
||||
# This program is free software; you can redistribute it and/or |
||||
# modify it under the terms of the GNU General Public License |
||||
# as published by the Free Software Foundation; either version 2 |
||||
# of the License, or (at your option) any later version. |
||||
# |
||||
# This program is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with this program; if not, write to the Free Software |
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
||||
|
||||
module JournalsHelper |
||||
def render_notes(issue, journal, options={}) |
||||
content = '' |
||||
editable = User.current.logged? && (User.current.allowed_to?(:edit_issue_notes, issue.project) || (journal.user == User.current && User.current.allowed_to?(:edit_own_issue_notes, issue.project))) |
||||
links = [] |
||||
if !journal.notes.blank? |
||||
links << link_to_remote(image_tag('comment.png'), |
||||
{ :url => {:controller => 'journals', :action => 'new', :id => issue, :journal_id => journal} }, |
||||
:title => l(:button_quote)) if options[:reply_links] |
||||
links << link_to_in_place_notes_editor(image_tag('edit.png'), "journal-#{journal.id}-notes", |
||||
{ :controller => 'journals', :action => 'edit', :id => journal }, |
||||
:title => l(:button_edit)) if editable |
||||
end |
||||
content << content_tag('div', links.join(' '), :class => 'contextual') unless links.empty? |
||||
content << textilizable(journal, :notes) |
||||
css_classes = "wiki" |
||||
css_classes << " editable" if editable |
||||
content_tag('div', content, :id => "journal-#{journal.id}-notes", :class => css_classes) |
||||
end |
||||
|
||||
def link_to_in_place_notes_editor(text, field_id, url, options={}) |
||||
onclick = "new Ajax.Request('#{url_for(url)}', {asynchronous:true, evalScripts:true, method:'get'}); return false;" |
||||
link_to text, '#', options.merge(:onclick => onclick) |
||||
end |
||||
end |
||||
@ -1,76 +0,0 @@ |
||||
# redMine - project management software |
||||
# Copyright (C) 2006 Jean-Philippe Lang |
||||
# |
||||
# This program is free software; you can redistribute it and/or |
||||
# modify it under the terms of the GNU General Public License |
||||
# as published by the Free Software Foundation; either version 2 |
||||
# of the License, or (at your option) any later version. |
||||
# |
||||
# This program is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with this program; if not, write to the Free Software |
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
||||
|
||||
class Journal < ActiveRecord::Base |
||||
belongs_to :journalized, :polymorphic => true |
||||
# added as a quick fix to allow eager loading of the polymorphic association |
||||
# since always associated to an issue, for now |
||||
belongs_to :issue, :foreign_key => :journalized_id |
||||
|
||||
belongs_to :user |
||||
has_many :details, :class_name => "JournalDetail", :dependent => :delete_all |
||||
attr_accessor :indice |
||||
|
||||
acts_as_event :title => Proc.new {|o| status = ((s = o.new_status) ? " (#{s})" : nil); "#{o.issue.tracker} ##{o.issue.id}#{status}: #{o.issue.subject}" }, |
||||
:description => :notes, |
||||
:author => :user, |
||||
:type => Proc.new {|o| (s = o.new_status) ? (s.is_closed? ? 'issue-closed' : 'issue-edit') : 'issue-note' }, |
||||
:url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.issue.id, :anchor => "change-#{o.id}"}} |
||||
|
||||
acts_as_activity_provider :type => 'issues', |
||||
:permission => :view_issues, |
||||
:author_key => :user_id, |
||||
:find_options => {:include => [{:issue => :project}, :details, :user], |
||||
:conditions => "#{Journal.table_name}.journalized_type = 'Issue' AND" + |
||||
" (#{JournalDetail.table_name}.prop_key = 'status_id' OR #{Journal.table_name}.notes <> '')"} |
||||
|
||||
def save(*args) |
||||
# Do not save an empty journal |
||||
(details.empty? && notes.blank?) ? false : super |
||||
end |
||||
|
||||
# Returns the new status if the journal contains a status change, otherwise nil |
||||
def new_status |
||||
c = details.detect {|detail| detail.prop_key == 'status_id'} |
||||
(c && c.value) ? IssueStatus.find_by_id(c.value.to_i) : nil |
||||
end |
||||
|
||||
def new_value_for(prop) |
||||
c = details.detect {|detail| detail.prop_key == prop} |
||||
c ? c.value : nil |
||||
end |
||||
|
||||
def editable_by?(usr) |
||||
usr && usr.logged? && (usr.allowed_to?(:edit_issue_notes, project) || (self.user == usr && usr.allowed_to?(:edit_own_issue_notes, project))) |
||||
end |
||||
|
||||
def project |
||||
journalized.respond_to?(:project) ? journalized.project : nil |
||||
end |
||||
|
||||
def attachments |
||||
journalized.respond_to?(:attachments) ? journalized.attachments : nil |
||||
end |
||||
|
||||
# Returns a string of css classes |
||||
def css_classes |
||||
s = 'journal' |
||||
s << ' has-notes' unless notes.blank? |
||||
s << ' has-details' unless details.blank? |
||||
s |
||||
end |
||||
end |
||||
@ -1,25 +0,0 @@ |
||||
# redMine - project management software |
||||
# Copyright (C) 2006 Jean-Philippe Lang |
||||
# |
||||
# This program is free software; you can redistribute it and/or |
||||
# modify it under the terms of the GNU General Public License |
||||
# as published by the Free Software Foundation; either version 2 |
||||
# of the License, or (at your option) any later version. |
||||
# |
||||
# This program is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with this program; if not, write to the Free Software |
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
||||
|
||||
class JournalDetail < ActiveRecord::Base |
||||
belongs_to :journal |
||||
|
||||
def before_save |
||||
self.value = value[0..254] if value && value.is_a?(String) |
||||
self.old_value = old_value[0..254] if old_value && old_value.is_a?(String) |
||||
end |
||||
end |
||||
@ -1,27 +0,0 @@ |
||||
# redMine - project management software |
||||
# Copyright (C) 2006-2007 Jean-Philippe Lang |
||||
# |
||||
# This program is free software; you can redistribute it and/or |
||||
# modify it under the terms of the GNU General Public License |
||||
# as published by the Free Software Foundation; either version 2 |
||||
# of the License, or (at your option) any later version. |
||||
# |
||||
# This program is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with this program; if not, write to the Free Software |
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
||||
|
||||
class JournalObserver < ActiveRecord::Observer |
||||
def after_create(journal) |
||||
if Setting.notified_events.include?('issue_updated') || |
||||
(Setting.notified_events.include?('issue_note_added') && journal.notes.present?) || |
||||
(Setting.notified_events.include?('issue_status_updated') && journal.new_status.present?) || |
||||
(Setting.notified_events.include?('issue_priority_updated') && journal.new_value_for('priority_id').present?) |
||||
Mailer.deliver_issue_edit(journal) |
||||
end |
||||
end |
||||
end |
||||
@ -1,19 +1,5 @@ |
||||
<% reply_links = authorize_for('issues', 'edit') -%> |
||||
<% for journal in journals %> |
||||
<div id="change-<%= journal.id %>" class="<%= journal.css_classes %>"> |
||||
<h4><div class="journal-link"><%= link_to "##{journal.indice}", :anchor => "note-#{journal.indice}" %></div> |
||||
<%= avatar(journal.user, :size => "24") %> |
||||
<%= content_tag('a', '', :name => "note-#{journal.indice}")%> |
||||
<%= authoring journal.created_on, journal.user, :label => :label_updated_time_by %></h4> |
||||
|
||||
<% if journal.details.any? %> |
||||
<ul class="details"> |
||||
<% for detail in journal.details %> |
||||
<li><%= show_detail(detail) %></li> |
||||
<% end %> |
||||
</ul> |
||||
<% end %> |
||||
<%= render_notes(issue, journal, :reply_links => reply_links) unless journal.notes.blank? %> |
||||
</div> |
||||
<%= render_journal issue, journal, :edit_permission => :edit_issue_notes, |
||||
:edit_own_permission => :edit_own_issue_notes %> |
||||
<%= call_hook(:view_issues_history_journal_bottom, { :journal => journal }) %> |
||||
<% end %> |
||||
|
||||
@ -1,8 +0,0 @@ |
||||
<% form_remote_tag(:url => {}, :html => { :id => "journal-#{@journal.id}-form" }) do %> |
||||
<%= text_area_tag :notes, @journal.notes, :class => 'wiki-edit', |
||||
:rows => (@journal.notes.blank? ? 10 : [[10, @journal.notes.length / 50].max, 100].min) %> |
||||
<%= call_hook(:view_journals_notes_form_after_notes, { :journal => @journal}) %> |
||||
<p><%= submit_tag l(:button_save) %> |
||||
<%= link_to l(:button_cancel), '#', :onclick => "Element.remove('journal-#{@journal.id}-form'); " + |
||||
"Element.show('journal-#{@journal.id}-notes'); return false;" %></p> |
||||
<% end %> |
||||
@ -1,3 +0,0 @@ |
||||
page.hide "journal-#{@journal.id}-notes" |
||||
page.insert_html :after, "journal-#{@journal.id}-notes", |
||||
:partial => 'notes_form' |
||||
@ -1,10 +0,0 @@ |
||||
if @journal.frozen? |
||||
# journal was destroyed |
||||
page.remove "change-#{@journal.id}" |
||||
else |
||||
page.replace "journal-#{@journal.id}-notes", render_notes(@journal.issue, @journal, :reply_links => authorize_for('issues', 'edit')) |
||||
page.show "journal-#{@journal.id}-notes" |
||||
page.remove "journal-#{@journal.id}-form" |
||||
end |
||||
|
||||
call_hook(:view_journals_update_rjs_bottom, { :page => page, :journal => @journal }) |
||||
@ -1,11 +1,9 @@ |
||||
class Meeting < ActiveRecord::Base |
||||
belongs_to :project |
||||
|
||||
acts_as_event :title => Proc.new {|o| "#{o.scheduled_on} Meeting"}, |
||||
:datetime => :scheduled_on, |
||||
:author => nil, |
||||
:url => Proc.new {|o| {:controller => 'meetings', :action => 'show', :id => o.id}} |
||||
|
||||
acts_as_activity_provider :timestamp => 'scheduled_on', |
||||
:find_options => { :include => :project } |
||||
acts_as_journalized :event_title => Proc.new {|o| "#{o.scheduled_on} Meeting"}, |
||||
:event_datetime => :scheduled_on, |
||||
:event_author => nil, |
||||
:event_url => Proc.new {|o| {:controller => 'meetings', :action => 'show', :id => o.id}} |
||||
:activity_timestamp => 'scheduled_on' |
||||
end |
||||
|
||||
@ -1,22 +0,0 @@ |
||||
--- |
||||
journal_details_001: |
||||
old_value: "1" |
||||
property: attr |
||||
id: 1 |
||||
value: "2" |
||||
prop_key: status_id |
||||
journal_id: 1 |
||||
journal_details_002: |
||||
old_value: "40" |
||||
property: attr |
||||
id: 2 |
||||
value: "30" |
||||
prop_key: done_ratio |
||||
journal_id: 1 |
||||
journal_details_003: |
||||
old_value: nil |
||||
property: attr |
||||
id: 3 |
||||
value: "6" |
||||
prop_key: fixed_version_id |
||||
journal_id: 4 |
||||
@ -1,29 +1,217 @@ |
||||
--- |
||||
journals_001: |
||||
created_on: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
notes: "Journal notes" |
||||
--- |
||||
journals_001: |
||||
id: 1 |
||||
journalized_type: Issue |
||||
type: "IssueJournal" |
||||
activity_type: "issues" |
||||
created_at: <%= 3.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 1 |
||||
journalized_id: 1 |
||||
journals_002: |
||||
created_on: <%= 1.days.ago.to_date.to_s(:db) %> |
||||
notes: "Some notes with Redmine links: #2, r2." |
||||
notes: "Journal notes" |
||||
journaled_id: 1 |
||||
changes: | |
||||
--- |
||||
status_id: |
||||
- 1 |
||||
- 2 |
||||
done_ratio: |
||||
- 40 |
||||
- 30 |
||||
journals_002: |
||||
id: 2 |
||||
journalized_type: Issue |
||||
type: "IssueJournal" |
||||
activity_type: "issues" |
||||
created_at: <%= 1.days.ago.to_date.to_s(:db) %> |
||||
version: 2 |
||||
user_id: 2 |
||||
journalized_id: 1 |
||||
journals_003: |
||||
created_on: <%= 1.days.ago.to_date.to_s(:db) %> |
||||
notes: "A comment with inline image: !picture.jpg!" |
||||
notes: "Some notes with Redmine links: #2, r2." |
||||
journaled_id: 1 |
||||
changes: "--- {}" |
||||
journals_003: |
||||
id: 3 |
||||
journalized_type: Issue |
||||
type: "IssueJournal" |
||||
activity_type: "issues" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
journalized_id: 2 |
||||
journals_004: |
||||
created_on: <%= 1.days.ago.to_date.to_s(:db) %> |
||||
notes: "A comment with a private version." |
||||
notes: "A comment with inline image: !picture.jpg!" |
||||
journaled_id: 2 |
||||
changes: "--- {}" |
||||
journals_004: |
||||
id: 4 |
||||
journalized_type: Issue |
||||
type: "IssueJournal" |
||||
activity_type: "issues" |
||||
created_at: <%= 1.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "A comment with a private version." |
||||
journaled_id: 6 |
||||
changes: | |
||||
--- |
||||
fixed_version_id: |
||||
- |
||||
- 6 |
||||
journals_005: |
||||
id: 5 |
||||
type: "IssueJournal" |
||||
activity_type: "issues" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 0 |
||||
user_id: 1 |
||||
notes: |
||||
journaled_id: 5 |
||||
changes: "--- {}" |
||||
journals_006: |
||||
id: 6 |
||||
type: "WikiContentJournal" |
||||
activity_type: "wiki_edits" |
||||
created_at: 2007-03-07 00:08:07 +01:00 |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: Page creation |
||||
journaled_id: 1 |
||||
changes: | |
||||
--- |
||||
compression: "" |
||||
data: |- |
||||
h1. CookBook documentation |
||||
|
||||
|
||||
|
||||
Some [[documentation]] here... |
||||
journals_007: |
||||
id: 7 |
||||
type: "WikiContentJournal" |
||||
activity_type: "wiki_edits" |
||||
created_at: 2007-03-07 00:08:34 +01:00 |
||||
version: 2 |
||||
user_id: 1 |
||||
journalized_id: 6 |
||||
notes: Small update |
||||
journaled_id: 1 |
||||
changes: | |
||||
--- |
||||
compression: "" |
||||
data: |- |
||||
h1. CookBook documentation |
||||
|
||||
|
||||
|
||||
Some updated [[documentation]] here... |
||||
journals_008: |
||||
id: 8 |
||||
type: "WikiContentJournal" |
||||
activity_type: "wiki_edits" |
||||
created_at: 2007-03-07 00:10:51 +01:00 |
||||
version: 3 |
||||
user_id: 1 |
||||
notes: "" |
||||
journaled_id: 1 |
||||
changes: | |
||||
--- |
||||
compression: "" |
||||
data: |- |
||||
h1. CookBook documentation |
||||
Some updated [[documentation]] here... |
||||
journals_009: |
||||
id: 9 |
||||
type: "WikiContentJournal" |
||||
activity_type: "wiki_edits" |
||||
created_at: 2007-03-08 00:18:07 +01:00 |
||||
version: 1 |
||||
user_id: 1 |
||||
notes: |
||||
journaled_id: 2 |
||||
changes: | |
||||
--- |
||||
data: |- |
||||
h1. Another page |
||||
|
||||
This is a link to a ticket: #2 |
||||
|
||||
|
||||
journals_010: |
||||
id: 10 |
||||
type: "MessageJournal" |
||||
activity_type: "messages" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 1 |
||||
notes: |
||||
journaled_id: 5 |
||||
changes: --- {} |
||||
journals_011: |
||||
id: 11 |
||||
type: "AttachmentJournal" |
||||
activity_type: "files" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "An attachment on a version" |
||||
journaled_id: 9 |
||||
changes: --- {} |
||||
journals_012: |
||||
id: 12 |
||||
type: "AttachmentJournal" |
||||
activity_type: "files" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "An attachment on a project" |
||||
journaled_id: 8 |
||||
changes: --- {} |
||||
journals_013: |
||||
id: 13 |
||||
type: "AttachmentJournal" |
||||
activity_type: "files" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "An attachment on an issue" |
||||
journaled_id: 7 |
||||
changes: --- {} |
||||
journals_014: |
||||
id: 14 |
||||
type: "AttachmentJournal" |
||||
activity_type: "documents" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "An attachment on a document" |
||||
journaled_id: 2 |
||||
changes: --- {} |
||||
journals_015: |
||||
id: 15 |
||||
type: "MessageJournal" |
||||
activity_type: "messages" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "A message journal" |
||||
journaled_id: 1 |
||||
journals_016: |
||||
id: 16 |
||||
type: "MessageJournal" |
||||
activity_type: "messages" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "A message journal" |
||||
journaled_id: 2 |
||||
journals_017: |
||||
id: 17 |
||||
type: "MessageJournal" |
||||
activity_type: "messages" |
||||
created_at: <%= 2.days.ago.to_date.to_s(:db) %> |
||||
version: 1 |
||||
user_id: 2 |
||||
notes: "A message journal" |
||||
journaled_id: 3 |
||||
journals_005: |
||||
id: 18 |
||||
type: "IssueJournal" |
||||
activity_type: "issues" |
||||
created_at: <%= 3.days.ago.to_date.to_s(:db) %> |
||||
version: 0 |
||||
user_id: 2 |
||||
notes: |
||||
journaled_id: 11 |
||||
changes: "--- {}" |
||||
@ -1,56 +0,0 @@ |
||||
--- |
||||
wiki_content_versions_001: |
||||
updated_on: 2007-03-07 00:08:07 +01:00 |
||||
page_id: 1 |
||||
id: 1 |
||||
version: 1 |
||||
author_id: 2 |
||||
comments: Page creation |
||||
wiki_content_id: 1 |
||||
compression: "" |
||||
data: |- |
||||
h1. CookBook documentation |
||||
|
||||
|
||||
|
||||
Some [[documentation]] here... |
||||
wiki_content_versions_002: |
||||
updated_on: 2007-03-07 00:08:34 +01:00 |
||||
page_id: 1 |
||||
id: 2 |
||||
version: 2 |
||||
author_id: 1 |
||||
comments: Small update |
||||
wiki_content_id: 1 |
||||
compression: "" |
||||
data: |- |
||||
h1. CookBook documentation |
||||
|
||||
|
||||
|
||||
Some updated [[documentation]] here... |
||||
wiki_content_versions_003: |
||||
updated_on: 2007-03-07 00:10:51 +01:00 |
||||
page_id: 1 |
||||
id: 3 |
||||
version: 3 |
||||
author_id: 1 |
||||
comments: "" |
||||
wiki_content_id: 1 |
||||
compression: "" |
||||
data: |- |
||||
h1. CookBook documentation |
||||
Some updated [[documentation]] here... |
||||
wiki_content_versions_004: |
||||
data: |- |
||||
h1. Another page |
||||
|
||||
This is a link to a ticket: #2 |
||||
updated_on: 2007-03-08 00:18:07 +01:00 |
||||
page_id: 2 |
||||
wiki_content_id: 2 |
||||
id: 4 |
||||
version: 1 |
||||
author_id: 1 |
||||
comments: |
||||
|
||||
@ -0,0 +1 @@ |
||||
Subproject commit 6683304d3cca187795b344f0b831edbc7cf709c0 |
||||
@ -1,74 +0,0 @@ |
||||
*SVN* (version numbers are overrated) |
||||
|
||||
* (5 Oct 2006) Allow customization of #versions association options [Dan Peterson] |
||||
|
||||
*0.5.1* |
||||
|
||||
* (8 Aug 2006) Versioned models now belong to the unversioned model. @article_version.article.class => Article [Aslak Hellesoy] |
||||
|
||||
*0.5* # do versions even matter for plugins? |
||||
|
||||
* (21 Apr 2006) Added without_locking and without_revision methods. |
||||
|
||||
Foo.without_revision do |
||||
@foo.update_attributes ... |
||||
end |
||||
|
||||
*0.4* |
||||
|
||||
* (28 March 2006) Rename non_versioned_fields to non_versioned_columns (old one is kept for compatibility). |
||||
* (28 March 2006) Made explicit documentation note that string column names are required for non_versioned_columns. |
||||
|
||||
*0.3.1* |
||||
|
||||
* (7 Jan 2006) explicitly set :foreign_key option for the versioned model's belongs_to assocation for STI [Caged] |
||||
* (7 Jan 2006) added tests to prove has_many :through joins work |
||||
|
||||
*0.3* |
||||
|
||||
* (2 Jan 2006) added ability to share a mixin with versioned class |
||||
* (2 Jan 2006) changed the dynamic version model to MyModel::Version |
||||
|
||||
*0.2.4* |
||||
|
||||
* (27 Nov 2005) added note about possible destructive behavior of if_changed? [Michael Schuerig] |
||||
|
||||
*0.2.3* |
||||
|
||||
* (12 Nov 2005) fixed bug with old behavior of #blank? [Michael Schuerig] |
||||
* (12 Nov 2005) updated tests to use ActiveRecord Schema |
||||
|
||||
*0.2.2* |
||||
|
||||
* (3 Nov 2005) added documentation note to #acts_as_versioned [Martin Jul] |
||||
|
||||
*0.2.1* |
||||
|
||||
* (6 Oct 2005) renamed dirty? to changed? to keep it uniform. it was aliased to keep it backwards compatible. |
||||
|
||||
*0.2* |
||||
|
||||
* (6 Oct 2005) added find_versions and find_version class methods. |
||||
|
||||
* (6 Oct 2005) removed transaction from create_versioned_table(). |
||||
this way you can specify your own transaction around a group of operations. |
||||
|
||||
* (30 Sep 2005) fixed bug where find_versions() would order by 'version' twice. (found by Joe Clark) |
||||
|
||||
* (26 Sep 2005) added :sequence_name option to acts_as_versioned to set the sequence name on the versioned model |
||||
|
||||
*0.1.3* (18 Sep 2005) |
||||
|
||||
* First RubyForge release |
||||
|
||||
*0.1.2* |
||||
|
||||
* check if module is already included when acts_as_versioned is called |
||||
|
||||
*0.1.1* |
||||
|
||||
* Adding tests and rdocs |
||||
|
||||
*0.1* |
||||
|
||||
* Initial transfer from Rails ticket: http://dev.rubyonrails.com/ticket/1974 |
||||
@ -1,20 +0,0 @@ |
||||
Copyright (c) 2005 Rick Olson |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
"Software"), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
@ -1,28 +0,0 @@ |
||||
= acts_as_versioned |
||||
|
||||
This library adds simple versioning to an ActiveRecord module. ActiveRecord is required. |
||||
|
||||
== Resources |
||||
|
||||
Install |
||||
|
||||
* gem install acts_as_versioned |
||||
|
||||
Rubyforge project |
||||
|
||||
* http://rubyforge.org/projects/ar-versioned |
||||
|
||||
RDocs |
||||
|
||||
* http://ar-versioned.rubyforge.org |
||||
|
||||
Subversion |
||||
|
||||
* http://techno-weenie.net/svn/projects/acts_as_versioned |
||||
|
||||
Collaboa |
||||
|
||||
* http://collaboa.techno-weenie.net/repository/browse/acts_as_versioned |
||||
|
||||
Special thanks to Dreamer on ##rubyonrails for help in early testing. His ServerSideWiki (http://serversidewiki.com) |
||||
was the first project to use acts_as_versioned <em>in the wild</em>. |
||||
@ -1,41 +0,0 @@ |
||||
== Creating the test database |
||||
|
||||
The default name for the test databases is "activerecord_versioned". If you |
||||
want to use another database name then be sure to update the connection |
||||
adapter setups you want to test with in test/connections/<your database>/connection.rb. |
||||
When you have the database online, you can import the fixture tables with |
||||
the test/fixtures/db_definitions/*.sql files. |
||||
|
||||
Make sure that you create database objects with the same user that you specified in i |
||||
connection.rb otherwise (on Postgres, at least) tests for default values will fail. |
||||
|
||||
== Running with Rake |
||||
|
||||
The easiest way to run the unit tests is through Rake. The default task runs |
||||
the entire test suite for all the adapters. You can also run the suite on just |
||||
one adapter by using the tasks test_mysql_ruby, test_ruby_mysql, test_sqlite, |
||||
or test_postresql. For more information, checkout the full array of rake tasks with "rake -T" |
||||
|
||||
Rake can be found at http://rake.rubyforge.org |
||||
|
||||
== Running by hand |
||||
|
||||
Unit tests are located in test directory. If you only want to run a single test suite, |
||||
or don't want to bother with Rake, you can do so with something like: |
||||
|
||||
cd test; ruby -I "connections/native_mysql" base_test.rb |
||||
|
||||
That'll run the base suite using the MySQL-Ruby adapter. Change the adapter |
||||
and test suite name as needed. |
||||
|
||||
== Faster tests |
||||
|
||||
If you are using a database that supports transactions, you can set the |
||||
"AR_TX_FIXTURES" environment variable to "yes" to use transactional fixtures. |
||||
This gives a very large speed boost. With rake: |
||||
|
||||
rake AR_TX_FIXTURES=yes |
||||
|
||||
Or, by hand: |
||||
|
||||
AR_TX_FIXTURES=yes ruby -I connections/native_sqlite3 base_test.rb |
||||
@ -1,182 +0,0 @@ |
||||
require 'rubygems' |
||||
|
||||
Gem::manage_gems |
||||
|
||||
require 'rake/rdoctask' |
||||
require 'rake/packagetask' |
||||
require 'rake/gempackagetask' |
||||
require 'rake/testtask' |
||||
require 'rake/contrib/rubyforgepublisher' |
||||
|
||||
PKG_NAME = 'acts_as_versioned' |
||||
PKG_VERSION = '0.3.1' |
||||
PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}" |
||||
PROD_HOST = "technoweenie@bidwell.textdrive.com" |
||||
RUBY_FORGE_PROJECT = 'ar-versioned' |
||||
RUBY_FORGE_USER = 'technoweenie' |
||||
|
||||
desc 'Default: run unit tests.' |
||||
task :default => :test |
||||
|
||||
desc 'Test the calculations plugin.' |
||||
Rake::TestTask.new(:test) do |t| |
||||
t.libs << 'lib' |
||||
t.pattern = 'test/**/*_test.rb' |
||||
t.verbose = true |
||||
end |
||||
|
||||
desc 'Generate documentation for the calculations plugin.' |
||||
Rake::RDocTask.new(:rdoc) do |rdoc| |
||||
rdoc.rdoc_dir = 'rdoc' |
||||
rdoc.title = "#{PKG_NAME} -- Simple versioning with active record models" |
||||
rdoc.options << '--line-numbers --inline-source' |
||||
rdoc.rdoc_files.include('README', 'CHANGELOG', 'RUNNING_UNIT_TESTS') |
||||
rdoc.rdoc_files.include('lib/**/*.rb') |
||||
end |
||||
|
||||
spec = Gem::Specification.new do |s| |
||||
s.name = PKG_NAME |
||||
s.version = PKG_VERSION |
||||
s.platform = Gem::Platform::RUBY |
||||
s.summary = "Simple versioning with active record models" |
||||
s.files = FileList["{lib,test}/**/*"].to_a + %w(README MIT-LICENSE CHANGELOG RUNNING_UNIT_TESTS) |
||||
s.files.delete "acts_as_versioned_plugin.sqlite.db" |
||||
s.files.delete "acts_as_versioned_plugin.sqlite3.db" |
||||
s.files.delete "test/debug.log" |
||||
s.require_path = 'lib' |
||||
s.autorequire = 'acts_as_versioned' |
||||
s.has_rdoc = true |
||||
s.test_files = Dir['test/**/*_test.rb'] |
||||
s.add_dependency 'activerecord', '>= 1.10.1' |
||||
s.add_dependency 'activesupport', '>= 1.1.1' |
||||
s.author = "Rick Olson" |
||||
s.email = "technoweenie@gmail.com" |
||||
s.homepage = "http://techno-weenie.net" |
||||
end |
||||
|
||||
Rake::GemPackageTask.new(spec) do |pkg| |
||||
pkg.need_tar = true |
||||
end |
||||
|
||||
desc "Publish the API documentation" |
||||
task :pdoc => [:rdoc] do |
||||
Rake::RubyForgePublisher.new(RUBY_FORGE_PROJECT, RUBY_FORGE_USER).upload |
||||
end |
||||
|
||||
desc 'Publish the gem and API docs' |
||||
task :publish => [:pdoc, :rubyforge_upload] |
||||
|
||||
desc "Publish the release files to RubyForge." |
||||
task :rubyforge_upload => :package do |
||||
files = %w(gem tgz).map { |ext| "pkg/#{PKG_FILE_NAME}.#{ext}" } |
||||
|
||||
if RUBY_FORGE_PROJECT then |
||||
require 'net/http' |
||||
require 'open-uri' |
||||
|
||||
project_uri = "http://rubyforge.org/projects/#{RUBY_FORGE_PROJECT}/" |
||||
project_data = open(project_uri) { |data| data.read } |
||||
group_id = project_data[/[?&]group_id=(\d+)/, 1] |
||||
raise "Couldn't get group id" unless group_id |
||||
|
||||
# This echos password to shell which is a bit sucky |
||||
if ENV["RUBY_FORGE_PASSWORD"] |
||||
password = ENV["RUBY_FORGE_PASSWORD"] |
||||
else |
||||
print "#{RUBY_FORGE_USER}@rubyforge.org's password: " |
||||
password = STDIN.gets.chomp |
||||
end |
||||
|
||||
login_response = Net::HTTP.start("rubyforge.org", 80) do |http| |
||||
data = [ |
||||
"login=1", |
||||
"form_loginname=#{RUBY_FORGE_USER}", |
||||
"form_pw=#{password}" |
||||
].join("&") |
||||
http.post("/account/login.php", data) |
||||
end |
||||
|
||||
cookie = login_response["set-cookie"] |
||||
raise "Login failed" unless cookie |
||||
headers = { "Cookie" => cookie } |
||||
|
||||
release_uri = "http://rubyforge.org/frs/admin/?group_id=#{group_id}" |
||||
release_data = open(release_uri, headers) { |data| data.read } |
||||
package_id = release_data[/[?&]package_id=(\d+)/, 1] |
||||
raise "Couldn't get package id" unless package_id |
||||
|
||||
first_file = true |
||||
release_id = "" |
||||
|
||||
files.each do |filename| |
||||
basename = File.basename(filename) |
||||
file_ext = File.extname(filename) |
||||
file_data = File.open(filename, "rb") { |file| file.read } |
||||
|
||||
puts "Releasing #{basename}..." |
||||
|
||||
release_response = Net::HTTP.start("rubyforge.org", 80) do |http| |
||||
release_date = Time.now.strftime("%Y-%m-%d %H:%M") |
||||
type_map = { |
||||
".zip" => "3000", |
||||
".tgz" => "3110", |
||||
".gz" => "3110", |
||||
".gem" => "1400" |
||||
}; type_map.default = "9999" |
||||
type = type_map[file_ext] |
||||
boundary = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor" |
||||
|
||||
query_hash = if first_file then |
||||
{ |
||||
"group_id" => group_id, |
||||
"package_id" => package_id, |
||||
"release_name" => PKG_FILE_NAME, |
||||
"release_date" => release_date, |
||||
"type_id" => type, |
||||
"processor_id" => "8000", # Any |
||||
"release_notes" => "", |
||||
"release_changes" => "", |
||||
"preformatted" => "1", |
||||
"submit" => "1" |
||||
} |
||||
else |
||||
{ |
||||
"group_id" => group_id, |
||||
"release_id" => release_id, |
||||
"package_id" => package_id, |
||||
"step2" => "1", |
||||
"type_id" => type, |
||||
"processor_id" => "8000", # Any |
||||
"submit" => "Add This File" |
||||
} |
||||
end |
||||
|
||||
query = "?" + query_hash.map do |(name, value)| |
||||
[name, URI.encode(value)].join("=") |
||||
end.join("&") |
||||
|
||||
data = [ |
||||
"--" + boundary, |
||||
"Content-Disposition: form-data; name=\"userfile\"; filename=\"#{basename}\"", |
||||
"Content-Type: application/octet-stream", |
||||
"Content-Transfer-Encoding: binary", |
||||
"", file_data, "" |
||||
].join("\x0D\x0A") |
||||
|
||||
release_headers = headers.merge( |
||||
"Content-Type" => "multipart/form-data; boundary=#{boundary}" |
||||
) |
||||
|
||||
target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php" |
||||
http.post(target + query, data, release_headers) |
||||
end |
||||
|
||||
if first_file then |
||||
release_id = release_response.body[/release_id=(\d+)/, 1] |
||||
raise("Couldn't get release id") unless release_id |
||||
end |
||||
|
||||
first_file = false |
||||
end |
||||
end |
||||
end |
||||
@ -1 +0,0 @@ |
||||
require 'acts_as_versioned' |
||||
@ -1,564 +0,0 @@ |
||||
# Copyright (c) 2005 Rick Olson |
||||
# |
||||
# Permission is hereby granted, free of charge, to any person obtaining |
||||
# a copy of this software and associated documentation files (the |
||||
# "Software"), to deal in the Software without restriction, including |
||||
# without limitation the rights to use, copy, modify, merge, publish, |
||||
# distribute, sublicense, and/or sell copies of the Software, and to |
||||
# permit persons to whom the Software is furnished to do so, subject to |
||||
# the following conditions: |
||||
# |
||||
# The above copyright notice and this permission notice shall be |
||||
# included in all copies or substantial portions of the Software. |
||||
# |
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
||||
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
||||
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
||||
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
|
||||
module ActiveRecord #:nodoc: |
||||
module Acts #:nodoc: |
||||
# Specify this act if you want to save a copy of the row in a versioned table. This assumes there is a |
||||
# versioned table ready and that your model has a version field. This works with optimistic locking if the lock_version |
||||
# column is present as well. |
||||
# |
||||
# The class for the versioned model is derived the first time it is seen. Therefore, if you change your database schema you have to restart |
||||
# your container for the changes to be reflected. In development mode this usually means restarting WEBrick. |
||||
# |
||||
# class Page < ActiveRecord::Base |
||||
# # assumes pages_versions table |
||||
# acts_as_versioned |
||||
# end |
||||
# |
||||
# Example: |
||||
# |
||||
# page = Page.create(:title => 'hello world!') |
||||
# page.version # => 1 |
||||
# |
||||
# page.title = 'hello world' |
||||
# page.save |
||||
# page.version # => 2 |
||||
# page.versions.size # => 2 |
||||
# |
||||
# page.revert_to(1) # using version number |
||||
# page.title # => 'hello world!' |
||||
# |
||||
# page.revert_to(page.versions.last) # using versioned instance |
||||
# page.title # => 'hello world' |
||||
# |
||||
# page.versions.earliest # efficient query to find the first version |
||||
# page.versions.latest # efficient query to find the most recently created version |
||||
# |
||||
# |
||||
# Simple Queries to page between versions |
||||
# |
||||
# page.versions.before(version) |
||||
# page.versions.after(version) |
||||
# |
||||
# Access the previous/next versions from the versioned model itself |
||||
# |
||||
# version = page.versions.latest |
||||
# version.previous # go back one version |
||||
# version.next # go forward one version |
||||
# |
||||
# See ActiveRecord::Acts::Versioned::ClassMethods#acts_as_versioned for configuration options |
||||
module Versioned |
||||
CALLBACKS = [:set_new_version, :save_version_on_create, :save_version?, :clear_altered_attributes] |
||||
def self.included(base) # :nodoc: |
||||
base.extend ClassMethods |
||||
end |
||||
|
||||
module ClassMethods |
||||
# == Configuration options |
||||
# |
||||
# * <tt>class_name</tt> - versioned model class name (default: PageVersion in the above example) |
||||
# * <tt>table_name</tt> - versioned model table name (default: page_versions in the above example) |
||||
# * <tt>foreign_key</tt> - foreign key used to relate the versioned model to the original model (default: page_id in the above example) |
||||
# * <tt>inheritance_column</tt> - name of the column to save the model's inheritance_column value for STI. (default: versioned_type) |
||||
# * <tt>version_column</tt> - name of the column in the model that keeps the version number (default: version) |
||||
# * <tt>sequence_name</tt> - name of the custom sequence to be used by the versioned model. |
||||
# * <tt>limit</tt> - number of revisions to keep, defaults to unlimited |
||||
# * <tt>if</tt> - symbol of method to check before saving a new version. If this method returns false, a new version is not saved. |
||||
# For finer control, pass either a Proc or modify Model#version_condition_met? |
||||
# |
||||
# acts_as_versioned :if => Proc.new { |auction| !auction.expired? } |
||||
# |
||||
# or... |
||||
# |
||||
# class Auction |
||||
# def version_condition_met? # totally bypasses the <tt>:if</tt> option |
||||
# !expired? |
||||
# end |
||||
# end |
||||
# |
||||
# * <tt>if_changed</tt> - Simple way of specifying attributes that are required to be changed before saving a model. This takes |
||||
# either a symbol or array of symbols. WARNING - This will attempt to overwrite any attribute setters you may have. |
||||
# Use this instead if you want to write your own attribute setters (and ignore if_changed): |
||||
# |
||||
# def name=(new_name) |
||||
# write_changed_attribute :name, new_name |
||||
# end |
||||
# |
||||
# * <tt>extend</tt> - Lets you specify a module to be mixed in both the original and versioned models. You can also just pass a block |
||||
# to create an anonymous mixin: |
||||
# |
||||
# class Auction |
||||
# acts_as_versioned do |
||||
# def started? |
||||
# !started_at.nil? |
||||
# end |
||||
# end |
||||
# end |
||||
# |
||||
# or... |
||||
# |
||||
# module AuctionExtension |
||||
# def started? |
||||
# !started_at.nil? |
||||
# end |
||||
# end |
||||
# class Auction |
||||
# acts_as_versioned :extend => AuctionExtension |
||||
# end |
||||
# |
||||
# Example code: |
||||
# |
||||
# @auction = Auction.find(1) |
||||
# @auction.started? |
||||
# @auction.versions.first.started? |
||||
# |
||||
# == Database Schema |
||||
# |
||||
# The model that you're versioning needs to have a 'version' attribute. The model is versioned |
||||
# into a table called #{model}_versions where the model name is singlular. The _versions table should |
||||
# contain all the fields you want versioned, the same version column, and a #{model}_id foreign key field. |
||||
# |
||||
# A lock_version field is also accepted if your model uses Optimistic Locking. If your table uses Single Table inheritance, |
||||
# then that field is reflected in the versioned model as 'versioned_type' by default. |
||||
# |
||||
# Acts_as_versioned comes prepared with the ActiveRecord::Acts::Versioned::ActMethods::ClassMethods#create_versioned_table |
||||
# method, perfect for a migration. It will also create the version column if the main model does not already have it. |
||||
# |
||||
# class AddVersions < ActiveRecord::Migration |
||||
# def self.up |
||||
# # create_versioned_table takes the same options hash |
||||
# # that create_table does |
||||
# Post.create_versioned_table |
||||
# end |
||||
# |
||||
# def self.down |
||||
# Post.drop_versioned_table |
||||
# end |
||||
# end |
||||
# |
||||
# == Changing What Fields Are Versioned |
||||
# |
||||
# By default, acts_as_versioned will version all but these fields: |
||||
# |
||||
# [self.primary_key, inheritance_column, 'version', 'lock_version', versioned_inheritance_column] |
||||
# |
||||
# You can add or change those by modifying #non_versioned_columns. Note that this takes strings and not symbols. |
||||
# |
||||
# class Post < ActiveRecord::Base |
||||
# acts_as_versioned |
||||
# self.non_versioned_columns << 'comments_count' |
||||
# end |
||||
# |
||||
def acts_as_versioned(options = {}, &extension) |
||||
# don't allow multiple calls |
||||
return if self.included_modules.include?(ActiveRecord::Acts::Versioned::ActMethods) |
||||
|
||||
send :include, ActiveRecord::Acts::Versioned::ActMethods |
||||
|
||||
cattr_accessor :versioned_class_name, :versioned_foreign_key, :versioned_table_name, :versioned_inheritance_column, |
||||
:version_column, :max_version_limit, :track_altered_attributes, :version_condition, :version_sequence_name, :non_versioned_columns, |
||||
:version_association_options |
||||
|
||||
# legacy |
||||
alias_method :non_versioned_fields, :non_versioned_columns |
||||
alias_method :non_versioned_fields=, :non_versioned_columns= |
||||
|
||||
class << self |
||||
alias_method :non_versioned_fields, :non_versioned_columns |
||||
alias_method :non_versioned_fields=, :non_versioned_columns= |
||||
end |
||||
|
||||
send :attr_accessor, :altered_attributes |
||||
|
||||
self.versioned_class_name = options[:class_name] || "Version" |
||||
self.versioned_foreign_key = options[:foreign_key] || self.to_s.foreign_key |
||||
self.versioned_table_name = options[:table_name] || "#{table_name_prefix}#{base_class.name.demodulize.underscore}_versions#{table_name_suffix}" |
||||
self.versioned_inheritance_column = options[:inheritance_column] || "versioned_#{inheritance_column}" |
||||
self.version_column = options[:version_column] || 'version' |
||||
self.version_sequence_name = options[:sequence_name] |
||||
self.max_version_limit = options[:limit].to_i |
||||
self.version_condition = options[:if] || true |
||||
self.non_versioned_columns = [self.primary_key, inheritance_column, 'version', 'lock_version', versioned_inheritance_column] |
||||
self.version_association_options = { |
||||
:class_name => "#{self.to_s}::#{versioned_class_name}", |
||||
:foreign_key => versioned_foreign_key, |
||||
:dependent => :delete_all |
||||
}.merge(options[:association_options] || {}) |
||||
|
||||
if block_given? |
||||
extension_module_name = "#{versioned_class_name}Extension" |
||||
silence_warnings do |
||||
self.const_set(extension_module_name, Module.new(&extension)) |
||||
end |
||||
|
||||
options[:extend] = self.const_get(extension_module_name) |
||||
end |
||||
|
||||
class_eval do |
||||
has_many :versions, version_association_options do |
||||
# finds earliest version of this record |
||||
def earliest |
||||
@earliest ||= find(:first, :order => 'version') |
||||
end |
||||
|
||||
# find latest version of this record |
||||
def latest |
||||
@latest ||= find(:first, :order => 'version desc') |
||||
end |
||||
end |
||||
before_save :set_new_version |
||||
after_create :save_version_on_create |
||||
after_update :save_version |
||||
after_save :clear_old_versions |
||||
after_save :clear_altered_attributes |
||||
|
||||
unless options[:if_changed].nil? |
||||
self.track_altered_attributes = true |
||||
options[:if_changed] = [options[:if_changed]] unless options[:if_changed].is_a?(Array) |
||||
options[:if_changed].each do |attr_name| |
||||
define_method("#{attr_name}=") do |value| |
||||
write_changed_attribute attr_name, value |
||||
end |
||||
end |
||||
end |
||||
|
||||
include options[:extend] if options[:extend].is_a?(Module) |
||||
end |
||||
|
||||
# create the dynamic versioned model |
||||
const_set(versioned_class_name, Class.new(ActiveRecord::Base)).class_eval do |
||||
def self.reloadable? ; false ; end |
||||
# find first version before the given version |
||||
def self.before(version) |
||||
find :first, :order => 'version desc', |
||||
:conditions => ["#{original_class.versioned_foreign_key} = ? and version < ?", version.send(original_class.versioned_foreign_key), version.version] |
||||
end |
||||
|
||||
# find first version after the given version. |
||||
def self.after(version) |
||||
find :first, :order => 'version', |
||||
:conditions => ["#{original_class.versioned_foreign_key} = ? and version > ?", version.send(original_class.versioned_foreign_key), version.version] |
||||
end |
||||
|
||||
def previous |
||||
self.class.before(self) |
||||
end |
||||
|
||||
def next |
||||
self.class.after(self) |
||||
end |
||||
|
||||
def versions_count |
||||
page.version |
||||
end |
||||
end |
||||
|
||||
versioned_class.cattr_accessor :original_class |
||||
versioned_class.original_class = self |
||||
versioned_class.set_table_name versioned_table_name |
||||
versioned_class.belongs_to self.to_s.demodulize.underscore.to_sym, |
||||
:class_name => "::#{self.to_s}", |
||||
:foreign_key => versioned_foreign_key |
||||
versioned_class.send :include, options[:extend] if options[:extend].is_a?(Module) |
||||
versioned_class.set_sequence_name version_sequence_name if version_sequence_name |
||||
end |
||||
end |
||||
|
||||
module ActMethods |
||||
def self.included(base) # :nodoc: |
||||
base.extend ClassMethods |
||||
end |
||||
|
||||
# Finds a specific version of this record |
||||
def find_version(version = nil) |
||||
self.class.find_version(id, version) |
||||
end |
||||
|
||||
# Saves a version of the model if applicable |
||||
def save_version |
||||
save_version_on_create if save_version? |
||||
end |
||||
|
||||
# Saves a version of the model in the versioned table. This is called in the after_save callback by default |
||||
def save_version_on_create |
||||
rev = self.class.versioned_class.new |
||||
self.clone_versioned_model(self, rev) |
||||
rev.version = send(self.class.version_column) |
||||
rev.send("#{self.class.versioned_foreign_key}=", self.id) |
||||
rev.save |
||||
end |
||||
|
||||
# Clears old revisions if a limit is set with the :limit option in <tt>acts_as_versioned</tt>. |
||||
# Override this method to set your own criteria for clearing old versions. |
||||
def clear_old_versions |
||||
return if self.class.max_version_limit == 0 |
||||
excess_baggage = send(self.class.version_column).to_i - self.class.max_version_limit |
||||
if excess_baggage > 0 |
||||
sql = "DELETE FROM #{self.class.versioned_table_name} WHERE version <= #{excess_baggage} AND #{self.class.versioned_foreign_key} = #{self.id}" |
||||
self.class.versioned_class.connection.execute sql |
||||
end |
||||
end |
||||
|
||||
def versions_count |
||||
version |
||||
end |
||||
|
||||
# Reverts a model to a given version. Takes either a version number or an instance of the versioned model |
||||
def revert_to(version) |
||||
if version.is_a?(self.class.versioned_class) |
||||
return false unless version.send(self.class.versioned_foreign_key) == self.id and !version.new_record? |
||||
else |
||||
return false unless version = versions.find_by_version(version) |
||||
end |
||||
self.clone_versioned_model(version, self) |
||||
self.send("#{self.class.version_column}=", version.version) |
||||
true |
||||
end |
||||
|
||||
# Reverts a model to a given version and saves the model. |
||||
# Takes either a version number or an instance of the versioned model |
||||
def revert_to!(version) |
||||
revert_to(version) ? save_without_revision : false |
||||
end |
||||
|
||||
# Temporarily turns off Optimistic Locking while saving. Used when reverting so that a new version is not created. |
||||
def save_without_revision |
||||
save_without_revision! |
||||
true |
||||
rescue |
||||
false |
||||
end |
||||
|
||||
def save_without_revision! |
||||
without_locking do |
||||
without_revision do |
||||
save! |
||||
end |
||||
end |
||||
end |
||||
|
||||
# Returns an array of attribute keys that are versioned. See non_versioned_columns |
||||
def versioned_attributes |
||||
self.attributes.keys.select { |k| !self.class.non_versioned_columns.include?(k) } |
||||
end |
||||
|
||||
# If called with no parameters, gets whether the current model has changed and needs to be versioned. |
||||
# If called with a single parameter, gets whether the parameter has changed. |
||||
def changed?(attr_name = nil) |
||||
attr_name.nil? ? |
||||
(!self.class.track_altered_attributes || (altered_attributes && altered_attributes.length > 0)) : |
||||
(altered_attributes && altered_attributes.include?(attr_name.to_s)) |
||||
end |
||||
|
||||
# keep old dirty? method |
||||
alias_method :dirty?, :changed? |
||||
|
||||
# Clones a model. Used when saving a new version or reverting a model's version. |
||||
def clone_versioned_model(orig_model, new_model) |
||||
self.versioned_attributes.each do |key| |
||||
new_model.send("#{key}=", orig_model.send(key)) if orig_model.has_attribute?(key) |
||||
end |
||||
|
||||
if orig_model.is_a?(self.class.versioned_class) |
||||
new_model[new_model.class.inheritance_column] = orig_model[self.class.versioned_inheritance_column] |
||||
elsif new_model.is_a?(self.class.versioned_class) |
||||
new_model[self.class.versioned_inheritance_column] = orig_model[orig_model.class.inheritance_column] |
||||
end |
||||
end |
||||
|
||||
# Checks whether a new version shall be saved or not. Calls <tt>version_condition_met?</tt> and <tt>changed?</tt>. |
||||
def save_version? |
||||
version_condition_met? && changed? |
||||
end |
||||
|
||||
# Checks condition set in the :if option to check whether a revision should be created or not. Override this for |
||||
# custom version condition checking. |
||||
def version_condition_met? |
||||
case |
||||
when version_condition.is_a?(Symbol) |
||||
send(version_condition) |
||||
when version_condition.respond_to?(:call) && (version_condition.arity == 1 || version_condition.arity == -1) |
||||
version_condition.call(self) |
||||
else |
||||
version_condition |
||||
end |
||||
end |
||||
|
||||
# Executes the block with the versioning callbacks disabled. |
||||
# |
||||
# @foo.without_revision do |
||||
# @foo.save |
||||
# end |
||||
# |
||||
def without_revision(&block) |
||||
self.class.without_revision(&block) |
||||
end |
||||
|
||||
# Turns off optimistic locking for the duration of the block |
||||
# |
||||
# @foo.without_locking do |
||||
# @foo.save |
||||
# end |
||||
# |
||||
def without_locking(&block) |
||||
self.class.without_locking(&block) |
||||
end |
||||
|
||||
def empty_callback() end #:nodoc: |
||||
|
||||
protected |
||||
# sets the new version before saving, unless you're using optimistic locking. In that case, let it take care of the version. |
||||
def set_new_version |
||||
self.send("#{self.class.version_column}=", self.next_version) if new_record? || (!locking_enabled? && save_version?) |
||||
end |
||||
|
||||
# Gets the next available version for the current record, or 1 for a new record |
||||
def next_version |
||||
return 1 if new_record? |
||||
(versions.calculate(:max, :version) || 0) + 1 |
||||
end |
||||
|
||||
# clears current changed attributes. Called after save. |
||||
def clear_altered_attributes |
||||
self.altered_attributes = [] |
||||
end |
||||
|
||||
def write_changed_attribute(attr_name, attr_value) |
||||
# Convert to db type for comparison. Avoids failing Float<=>String comparisons. |
||||
attr_value_for_db = self.class.columns_hash[attr_name.to_s].type_cast(attr_value) |
||||
(self.altered_attributes ||= []) << attr_name.to_s unless self.changed?(attr_name) || self.send(attr_name) == attr_value_for_db |
||||
write_attribute(attr_name, attr_value_for_db) |
||||
end |
||||
|
||||
module ClassMethods |
||||
# Finds a specific version of a specific row of this model |
||||
def find_version(id, version = nil) |
||||
return find(id) unless version |
||||
|
||||
conditions = ["#{versioned_foreign_key} = ? AND version = ?", id, version] |
||||
options = { :conditions => conditions, :limit => 1 } |
||||
|
||||
if result = find_versions(id, options).first |
||||
result |
||||
else |
||||
raise RecordNotFound, "Couldn't find #{name} with ID=#{id} and VERSION=#{version}" |
||||
end |
||||
end |
||||
|
||||
# Finds versions of a specific model. Takes an options hash like <tt>find</tt> |
||||
def find_versions(id, options = {}) |
||||
versioned_class.find :all, { |
||||
:conditions => ["#{versioned_foreign_key} = ?", id], |
||||
:order => 'version' }.merge(options) |
||||
end |
||||
|
||||
# Returns an array of columns that are versioned. See non_versioned_columns |
||||
def versioned_columns |
||||
self.columns.select { |c| !non_versioned_columns.include?(c.name) } |
||||
end |
||||
|
||||
# Returns an instance of the dynamic versioned model |
||||
def versioned_class |
||||
const_get versioned_class_name |
||||
end |
||||
|
||||
# Rake migration task to create the versioned table using options passed to acts_as_versioned |
||||
def create_versioned_table(create_table_options = {}) |
||||
# create version column in main table if it does not exist |
||||
if !self.content_columns.find { |c| %w(version lock_version).include? c.name } |
||||
self.connection.add_column table_name, :version, :integer |
||||
end |
||||
|
||||
self.connection.create_table(versioned_table_name, create_table_options) do |t| |
||||
t.column versioned_foreign_key, :integer |
||||
t.column :version, :integer |
||||
end |
||||
|
||||
updated_col = nil |
||||
self.versioned_columns.each do |col| |
||||
updated_col = col if !updated_col && %(updated_at updated_on).include?(col.name) |
||||
self.connection.add_column versioned_table_name, col.name, col.type, |
||||
:limit => col.limit, |
||||
:default => col.default, |
||||
:scale => col.scale, |
||||
:precision => col.precision |
||||
end |
||||
|
||||
if type_col = self.columns_hash[inheritance_column] |
||||
self.connection.add_column versioned_table_name, versioned_inheritance_column, type_col.type, |
||||
:limit => type_col.limit, |
||||
:default => type_col.default, |
||||
:scale => type_col.scale, |
||||
:precision => type_col.precision |
||||
end |
||||
|
||||
if updated_col.nil? |
||||
self.connection.add_column versioned_table_name, :updated_at, :timestamp |
||||
end |
||||
end |
||||
|
||||
# Rake migration task to drop the versioned table |
||||
def drop_versioned_table |
||||
self.connection.drop_table versioned_table_name |
||||
end |
||||
|
||||
# Executes the block with the versioning callbacks disabled. |
||||
# |
||||
# Foo.without_revision do |
||||
# @foo.save |
||||
# end |
||||
# |
||||
def without_revision(&block) |
||||
class_eval do |
||||
CALLBACKS.each do |attr_name| |
||||
alias_method "orig_#{attr_name}".to_sym, attr_name |
||||
alias_method attr_name, :empty_callback |
||||
end |
||||
end |
||||
block.call |
||||
ensure |
||||
class_eval do |
||||
CALLBACKS.each do |attr_name| |
||||
alias_method attr_name, "orig_#{attr_name}".to_sym |
||||
end |
||||
end |
||||
end |
||||
|
||||
# Turns off optimistic locking for the duration of the block |
||||
# |
||||
# Foo.without_locking do |
||||
# @foo.save |
||||
# end |
||||
# |
||||
def without_locking(&block) |
||||
current = ActiveRecord::Base.lock_optimistically |
||||
ActiveRecord::Base.lock_optimistically = false if current |
||||
result = block.call |
||||
ActiveRecord::Base.lock_optimistically = true if current |
||||
result |
||||
end |
||||
end |
||||
end |
||||
end |
||||
end |
||||
end |
||||
|
||||
ActiveRecord::Base.send :include, ActiveRecord::Acts::Versioned |
||||
@ -1,41 +0,0 @@ |
||||
$:.unshift(File.dirname(__FILE__) + '/../../../rails/activesupport/lib') |
||||
$:.unshift(File.dirname(__FILE__) + '/../../../rails/activerecord/lib') |
||||
$:.unshift(File.dirname(__FILE__) + '/../lib') |
||||
require 'test/unit' |
||||
begin |
||||
require 'active_support' |
||||
require 'active_record' |
||||
require 'active_record/fixtures' |
||||
rescue LoadError |
||||
require 'rubygems' |
||||
retry |
||||
end |
||||
require 'acts_as_versioned' |
||||
|
||||
config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml')) |
||||
ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log") |
||||
ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']} |
||||
ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test']) |
||||
|
||||
load(File.dirname(__FILE__) + "/schema.rb") |
||||
|
||||
# set up custom sequence on widget_versions for DBs that support sequences |
||||
if ENV['DB'] == 'postgresql' |
||||
ActiveRecord::Base.connection.execute "DROP SEQUENCE widgets_seq;" rescue nil |
||||
ActiveRecord::Base.connection.remove_column :widget_versions, :id |
||||
ActiveRecord::Base.connection.execute "CREATE SEQUENCE widgets_seq START 101;" |
||||
ActiveRecord::Base.connection.execute "ALTER TABLE widget_versions ADD COLUMN id INTEGER PRIMARY KEY DEFAULT nextval('widgets_seq');" |
||||
end |
||||
|
||||
Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/" |
||||
$:.unshift(Test::Unit::TestCase.fixture_path) |
||||
|
||||
class Test::Unit::TestCase #:nodoc: |
||||
# Turn off transactional fixtures if you're working with MyISAM tables in MySQL |
||||
self.use_transactional_fixtures = true |
||||
|
||||
# Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david) |
||||
self.use_instantiated_fixtures = false |
||||
|
||||
# Add more helper methods to be used by all tests here... |
||||
end |
||||
@ -1,18 +0,0 @@ |
||||
sqlite: |
||||
:adapter: sqlite |
||||
:dbfile: acts_as_versioned_plugin.sqlite.db |
||||
sqlite3: |
||||
:adapter: sqlite3 |
||||
:dbfile: acts_as_versioned_plugin.sqlite3.db |
||||
postgresql: |
||||
:adapter: postgresql |
||||
:username: postgres |
||||
:password: postgres |
||||
:database: acts_as_versioned_plugin_test |
||||
:min_messages: ERROR |
||||
mysql: |
||||
:adapter: mysql |
||||
:host: localhost |
||||
:username: rails |
||||
:password: |
||||
:database: acts_as_versioned_plugin_test |
||||
@ -1,6 +0,0 @@ |
||||
caged: |
||||
id: 1 |
||||
name: caged |
||||
mly: |
||||
id: 2 |
||||
name: mly |
||||
@ -1,3 +0,0 @@ |
||||
class Landmark < ActiveRecord::Base |
||||
acts_as_versioned :if_changed => [ :name, :longitude, :latitude ] |
||||
end |
||||
@ -1,7 +0,0 @@ |
||||
washington: |
||||
id: 1 |
||||
landmark_id: 1 |
||||
version: 1 |
||||
name: Washington, D.C. |
||||
latitude: 38.895 |
||||
longitude: -77.036667 |
||||
@ -1,6 +0,0 @@ |
||||
washington: |
||||
id: 1 |
||||
name: Washington, D.C. |
||||
latitude: 38.895 |
||||
longitude: -77.036667 |
||||
version: 1 |
||||
@ -1,10 +0,0 @@ |
||||
welcome: |
||||
id: 1 |
||||
title: Welcome to the weblog |
||||
lock_version: 24 |
||||
type: LockedPage |
||||
thinking: |
||||
id: 2 |
||||
title: So I was thinking |
||||
lock_version: 24 |
||||
type: SpecialLockedPage |
||||
@ -1,27 +0,0 @@ |
||||
welcome_1: |
||||
id: 1 |
||||
page_id: 1 |
||||
title: Welcome to the weblg |
||||
version: 23 |
||||
version_type: LockedPage |
||||
|
||||
welcome_2: |
||||
id: 2 |
||||
page_id: 1 |
||||
title: Welcome to the weblog |
||||
version: 24 |
||||
version_type: LockedPage |
||||
|
||||
thinking_1: |
||||
id: 3 |
||||
page_id: 2 |
||||
title: So I was thinking!!! |
||||
version: 23 |
||||
version_type: SpecialLockedPage |
||||
|
||||
thinking_2: |
||||
id: 4 |
||||
page_id: 2 |
||||
title: So I was thinking |
||||
version: 24 |
||||
version_type: SpecialLockedPage |
||||
@ -1,13 +0,0 @@ |
||||
class AddVersionedTables < ActiveRecord::Migration |
||||
def self.up |
||||
create_table("things") do |t| |
||||
t.column :title, :text |
||||
end |
||||
Thing.create_versioned_table |
||||
end |
||||
|
||||
def self.down |
||||
Thing.drop_versioned_table |
||||
drop_table "things" rescue nil |
||||
end |
||||
end |
||||
@ -1,43 +0,0 @@ |
||||
class Page < ActiveRecord::Base |
||||
belongs_to :author |
||||
has_many :authors, :through => :versions, :order => 'name' |
||||
belongs_to :revisor, :class_name => 'Author' |
||||
has_many :revisors, :class_name => 'Author', :through => :versions, :order => 'name' |
||||
acts_as_versioned :if => :feeling_good? do |
||||
def self.included(base) |
||||
base.cattr_accessor :feeling_good |
||||
base.feeling_good = true |
||||
base.belongs_to :author |
||||
base.belongs_to :revisor, :class_name => 'Author' |
||||
end |
||||
|
||||
def feeling_good? |
||||
@@feeling_good == true |
||||
end |
||||
end |
||||
end |
||||
|
||||
module LockedPageExtension |
||||
def hello_world |
||||
'hello_world' |
||||
end |
||||
end |
||||
|
||||
class LockedPage < ActiveRecord::Base |
||||
acts_as_versioned \ |
||||
:inheritance_column => :version_type, |
||||
:foreign_key => :page_id, |
||||
:table_name => :locked_pages_revisions, |
||||
:class_name => 'LockedPageRevision', |
||||
:version_column => :lock_version, |
||||
:limit => 2, |
||||
:if_changed => :title, |
||||
:extend => LockedPageExtension |
||||
end |
||||
|
||||
class SpecialLockedPage < LockedPage |
||||
end |
||||
|
||||
class Author < ActiveRecord::Base |
||||
has_many :pages |
||||
end |
||||
@ -1,16 +0,0 @@ |
||||
welcome_2: |
||||
id: 1 |
||||
page_id: 1 |
||||
title: Welcome to the weblog |
||||
body: Such a lovely day |
||||
version: 24 |
||||
author_id: 1 |
||||
revisor_id: 1 |
||||
welcome_1: |
||||
id: 2 |
||||
page_id: 1 |
||||
title: Welcome to the weblg |
||||
body: Such a lovely day |
||||
version: 23 |
||||
author_id: 2 |
||||
revisor_id: 2 |
||||
@ -1,7 +0,0 @@ |
||||
welcome: |
||||
id: 1 |
||||
title: Welcome to the weblog |
||||
body: Such a lovely day |
||||
version: 24 |
||||
author_id: 1 |
||||
revisor_id: 1 |
||||
@ -1,6 +0,0 @@ |
||||
class Widget < ActiveRecord::Base |
||||
acts_as_versioned :sequence_name => 'widgets_seq', :association_options => { |
||||
:dependent => :nullify, :order => 'version desc' |
||||
} |
||||
non_versioned_columns << 'foo' |
||||
end |
||||
@ -1,46 +0,0 @@ |
||||
require File.join(File.dirname(__FILE__), 'abstract_unit') |
||||
|
||||
if ActiveRecord::Base.connection.supports_migrations? |
||||
class Thing < ActiveRecord::Base |
||||
attr_accessor :version |
||||
acts_as_versioned |
||||
end |
||||
|
||||
class MigrationTest < Test::Unit::TestCase |
||||
self.use_transactional_fixtures = false |
||||
def teardown |
||||
if ActiveRecord::Base.connection.respond_to?(:initialize_schema_information) |
||||
ActiveRecord::Base.connection.initialize_schema_information |
||||
ActiveRecord::Base.connection.update "UPDATE schema_info SET version = 0" |
||||
else |
||||
ActiveRecord::Base.connection.initialize_schema_migrations_table |
||||
ActiveRecord::Base.connection.assume_migrated_upto_version(0) |
||||
end |
||||
|
||||
Thing.connection.drop_table "things" rescue nil |
||||
Thing.connection.drop_table "thing_versions" rescue nil |
||||
Thing.reset_column_information |
||||
end |
||||
|
||||
def test_versioned_migration |
||||
assert_raises(ActiveRecord::StatementInvalid) { Thing.create :title => 'blah blah' } |
||||
# take 'er up |
||||
ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/fixtures/migrations/') |
||||
t = Thing.create :title => 'blah blah', :price => 123.45, :type => 'Thing' |
||||
assert_equal 1, t.versions.size |
||||
|
||||
# check that the price column has remembered its value correctly |
||||
assert_equal t.price, t.versions.first.price |
||||
assert_equal t.title, t.versions.first.title |
||||
assert_equal t[:type], t.versions.first[:type] |
||||
|
||||
# make sure that the precision of the price column has been preserved |
||||
assert_equal 7, Thing::Version.columns.find{|c| c.name == "price"}.precision |
||||
assert_equal 2, Thing::Version.columns.find{|c| c.name == "price"}.scale |
||||
|
||||
# now lets take 'er back down |
||||
ActiveRecord::Migrator.down(File.dirname(__FILE__) + '/fixtures/migrations/') |
||||
assert_raises(ActiveRecord::StatementInvalid) { Thing.create :title => 'blah blah' } |
||||
end |
||||
end |
||||
end |
||||
@ -1,68 +0,0 @@ |
||||
ActiveRecord::Schema.define(:version => 0) do |
||||
create_table :pages, :force => true do |t| |
||||
t.column :version, :integer |
||||
t.column :title, :string, :limit => 255 |
||||
t.column :body, :text |
||||
t.column :updated_on, :datetime |
||||
t.column :author_id, :integer |
||||
t.column :revisor_id, :integer |
||||
end |
||||
|
||||
create_table :page_versions, :force => true do |t| |
||||
t.column :page_id, :integer |
||||
t.column :version, :integer |
||||
t.column :title, :string, :limit => 255 |
||||
t.column :body, :text |
||||
t.column :updated_on, :datetime |
||||
t.column :author_id, :integer |
||||
t.column :revisor_id, :integer |
||||
end |
||||
|
||||
create_table :authors, :force => true do |t| |
||||
t.column :page_id, :integer |
||||
t.column :name, :string |
||||
end |
||||
|
||||
create_table :locked_pages, :force => true do |t| |
||||
t.column :lock_version, :integer |
||||
t.column :title, :string, :limit => 255 |
||||
t.column :type, :string, :limit => 255 |
||||
end |
||||
|
||||
create_table :locked_pages_revisions, :force => true do |t| |
||||
t.column :page_id, :integer |
||||
t.column :version, :integer |
||||
t.column :title, :string, :limit => 255 |
||||
t.column :version_type, :string, :limit => 255 |
||||
t.column :updated_at, :datetime |
||||
end |
||||
|
||||
create_table :widgets, :force => true do |t| |
||||
t.column :name, :string, :limit => 50 |
||||
t.column :foo, :string |
||||
t.column :version, :integer |
||||
t.column :updated_at, :datetime |
||||
end |
||||
|
||||
create_table :widget_versions, :force => true do |t| |
||||
t.column :widget_id, :integer |
||||
t.column :name, :string, :limit => 50 |
||||
t.column :version, :integer |
||||
t.column :updated_at, :datetime |
||||
end |
||||
|
||||
create_table :landmarks, :force => true do |t| |
||||
t.column :name, :string |
||||
t.column :latitude, :float |
||||
t.column :longitude, :float |
||||
t.column :version, :integer |
||||
end |
||||
|
||||
create_table :landmark_versions, :force => true do |t| |
||||
t.column :landmark_id, :integer |
||||
t.column :name, :string |
||||
t.column :latitude, :float |
||||
t.column :longitude, :float |
||||
t.column :version, :integer |
||||
end |
||||
end |
||||
@ -1,347 +0,0 @@ |
||||
require File.join(File.dirname(__FILE__), 'abstract_unit') |
||||
require File.join(File.dirname(__FILE__), 'fixtures/page') |
||||
require File.join(File.dirname(__FILE__), 'fixtures/widget') |
||||
|
||||
class VersionedTest < Test::Unit::TestCase |
||||
fixtures :pages, :page_versions, :locked_pages, :locked_pages_revisions, :authors, :landmarks, :landmark_versions |
||||
set_fixture_class :page_versions => Page::Version |
||||
|
||||
def test_saves_versioned_copy |
||||
p = Page.create! :title => 'first title', :body => 'first body' |
||||
assert !p.new_record? |
||||
assert_equal 1, p.versions.size |
||||
assert_equal 1, p.version |
||||
assert_instance_of Page.versioned_class, p.versions.first |
||||
end |
||||
|
||||
def test_saves_without_revision |
||||
p = pages(:welcome) |
||||
old_versions = p.versions.count |
||||
|
||||
p.save_without_revision |
||||
|
||||
p.without_revision do |
||||
p.update_attributes :title => 'changed' |
||||
end |
||||
|
||||
assert_equal old_versions, p.versions.count |
||||
end |
||||
|
||||
def test_rollback_with_version_number |
||||
p = pages(:welcome) |
||||
assert_equal 24, p.version |
||||
assert_equal 'Welcome to the weblog', p.title |
||||
|
||||
assert p.revert_to!(p.versions.first.version), "Couldn't revert to 23" |
||||
assert_equal 23, p.version |
||||
assert_equal 'Welcome to the weblg', p.title |
||||
end |
||||
|
||||
def test_versioned_class_name |
||||
assert_equal 'Version', Page.versioned_class_name |
||||
assert_equal 'LockedPageRevision', LockedPage.versioned_class_name |
||||
end |
||||
|
||||
def test_versioned_class |
||||
assert_equal Page::Version, Page.versioned_class |
||||
assert_equal LockedPage::LockedPageRevision, LockedPage.versioned_class |
||||
end |
||||
|
||||
def test_special_methods |
||||
assert_nothing_raised { pages(:welcome).feeling_good? } |
||||
assert_nothing_raised { pages(:welcome).versions.first.feeling_good? } |
||||
assert_nothing_raised { locked_pages(:welcome).hello_world } |
||||
assert_nothing_raised { locked_pages(:welcome).versions.first.hello_world } |
||||
end |
||||
|
||||
def test_rollback_with_version_class |
||||
p = pages(:welcome) |
||||
assert_equal 24, p.version |
||||
assert_equal 'Welcome to the weblog', p.title |
||||
|
||||
assert p.revert_to!(p.versions.first), "Couldn't revert to 23" |
||||
assert_equal 23, p.version |
||||
assert_equal 'Welcome to the weblg', p.title |
||||
end |
||||
|
||||
def test_rollback_fails_with_invalid_revision |
||||
p = locked_pages(:welcome) |
||||
assert !p.revert_to!(locked_pages(:thinking)) |
||||
end |
||||
|
||||
def test_saves_versioned_copy_with_options |
||||
p = LockedPage.create! :title => 'first title' |
||||
assert !p.new_record? |
||||
assert_equal 1, p.versions.size |
||||
assert_instance_of LockedPage.versioned_class, p.versions.first |
||||
end |
||||
|
||||
def test_rollback_with_version_number_with_options |
||||
p = locked_pages(:welcome) |
||||
assert_equal 'Welcome to the weblog', p.title |
||||
assert_equal 'LockedPage', p.versions.first.version_type |
||||
|
||||
assert p.revert_to!(p.versions.first.version), "Couldn't revert to 23" |
||||
assert_equal 'Welcome to the weblg', p.title |
||||
assert_equal 'LockedPage', p.versions.first.version_type |
||||
end |
||||
|
||||
def test_rollback_with_version_class_with_options |
||||
p = locked_pages(:welcome) |
||||
assert_equal 'Welcome to the weblog', p.title |
||||
assert_equal 'LockedPage', p.versions.first.version_type |
||||
|
||||
assert p.revert_to!(p.versions.first), "Couldn't revert to 1" |
||||
assert_equal 'Welcome to the weblg', p.title |
||||
assert_equal 'LockedPage', p.versions.first.version_type |
||||
end |
||||
|
||||
def test_saves_versioned_copy_with_sti |
||||
p = SpecialLockedPage.create! :title => 'first title' |
||||
assert !p.new_record? |
||||
assert_equal 1, p.versions.size |
||||
assert_instance_of LockedPage.versioned_class, p.versions.first |
||||
assert_equal 'SpecialLockedPage', p.versions.first.version_type |
||||
end |
||||
|
||||
def test_rollback_with_version_number_with_sti |
||||
p = locked_pages(:thinking) |
||||
assert_equal 'So I was thinking', p.title |
||||
|
||||
assert p.revert_to!(p.versions.first.version), "Couldn't revert to 1" |
||||
assert_equal 'So I was thinking!!!', p.title |
||||
assert_equal 'SpecialLockedPage', p.versions.first.version_type |
||||
end |
||||
|
||||
def test_lock_version_works_with_versioning |
||||
p = locked_pages(:thinking) |
||||
p2 = LockedPage.find(p.id) |
||||
|
||||
p.title = 'fresh title' |
||||
p.save |
||||
assert_equal 2, p.versions.size # limit! |
||||
|
||||
assert_raises(ActiveRecord::StaleObjectError) do |
||||
p2.title = 'stale title' |
||||
p2.save |
||||
end |
||||
end |
||||
|
||||
def test_version_if_condition |
||||
p = Page.create! :title => "title" |
||||
assert_equal 1, p.version |
||||
|
||||
Page.feeling_good = false |
||||
p.save |
||||
assert_equal 1, p.version |
||||
Page.feeling_good = true |
||||
end |
||||
|
||||
def test_version_if_condition2 |
||||
# set new if condition |
||||
Page.class_eval do |
||||
def new_feeling_good() title[0..0] == 'a'; end |
||||
alias_method :old_feeling_good, :feeling_good? |
||||
alias_method :feeling_good?, :new_feeling_good |
||||
end |
||||
|
||||
p = Page.create! :title => "title" |
||||
assert_equal 1, p.version # version does not increment |
||||
assert_equal 1, p.versions(true).size |
||||
|
||||
p.update_attributes(:title => 'new title') |
||||
assert_equal 1, p.version # version does not increment |
||||
assert_equal 1, p.versions(true).size |
||||
|
||||
p.update_attributes(:title => 'a title') |
||||
assert_equal 2, p.version |
||||
assert_equal 2, p.versions(true).size |
||||
|
||||
# reset original if condition |
||||
Page.class_eval { alias_method :feeling_good?, :old_feeling_good } |
||||
end |
||||
|
||||
def test_version_if_condition_with_block |
||||
# set new if condition |
||||
old_condition = Page.version_condition |
||||
Page.version_condition = Proc.new { |page| page.title[0..0] == 'b' } |
||||
|
||||
p = Page.create! :title => "title" |
||||
assert_equal 1, p.version # version does not increment |
||||
assert_equal 1, p.versions(true).size |
||||
|
||||
p.update_attributes(:title => 'a title') |
||||
assert_equal 1, p.version # version does not increment |
||||
assert_equal 1, p.versions(true).size |
||||
|
||||
p.update_attributes(:title => 'b title') |
||||
assert_equal 2, p.version |
||||
assert_equal 2, p.versions(true).size |
||||
|
||||
# reset original if condition |
||||
Page.version_condition = old_condition |
||||
end |
||||
|
||||
def test_version_no_limit |
||||
p = Page.create! :title => "title", :body => 'first body' |
||||
p.save |
||||
p.save |
||||
5.times do |i| |
||||
assert_page_title p, i |
||||
end |
||||
end |
||||
|
||||
def test_version_max_limit |
||||
p = LockedPage.create! :title => "title" |
||||
p.update_attributes(:title => "title1") |
||||
p.update_attributes(:title => "title2") |
||||
5.times do |i| |
||||
assert_page_title p, i, :lock_version |
||||
assert p.versions(true).size <= 2, "locked version can only store 2 versions" |
||||
end |
||||
end |
||||
|
||||
def test_track_altered_attributes_default_value |
||||
assert !Page.track_altered_attributes |
||||
assert LockedPage.track_altered_attributes |
||||
assert SpecialLockedPage.track_altered_attributes |
||||
end |
||||
|
||||
def test_version_order |
||||
assert_equal 23, pages(:welcome).versions.first.version |
||||
assert_equal 24, pages(:welcome).versions.last.version |
||||
end |
||||
|
||||
def test_track_altered_attributes |
||||
p = LockedPage.create! :title => "title" |
||||
assert_equal 1, p.lock_version |
||||
assert_equal 1, p.versions(true).size |
||||
|
||||
p.title = 'title' |
||||
assert !p.save_version? |
||||
p.save |
||||
assert_equal 2, p.lock_version # still increments version because of optimistic locking |
||||
assert_equal 1, p.versions(true).size |
||||
|
||||
p.title = 'updated title' |
||||
assert p.save_version? |
||||
p.save |
||||
assert_equal 3, p.lock_version |
||||
assert_equal 1, p.versions(true).size # version 1 deleted |
||||
|
||||
p.title = 'updated title!' |
||||
assert p.save_version? |
||||
p.save |
||||
assert_equal 4, p.lock_version |
||||
assert_equal 2, p.versions(true).size # version 1 deleted |
||||
end |
||||
|
||||
def assert_page_title(p, i, version_field = :version) |
||||
p.title = "title#{i}" |
||||
p.save |
||||
assert_equal "title#{i}", p.title |
||||
assert_equal (i+4), p.send(version_field) |
||||
end |
||||
|
||||
def test_find_versions |
||||
assert_equal 2, locked_pages(:welcome).versions.size |
||||
assert_equal 1, locked_pages(:welcome).versions.find(:all, :conditions => ['title LIKE ?', '%weblog%']).length |
||||
assert_equal 2, locked_pages(:welcome).versions.find(:all, :conditions => ['title LIKE ?', '%web%']).length |
||||
assert_equal 0, locked_pages(:thinking).versions.find(:all, :conditions => ['title LIKE ?', '%web%']).length |
||||
assert_equal 2, locked_pages(:welcome).versions.length |
||||
end |
||||
|
||||
def test_find_version |
||||
assert_equal page_versions(:welcome_1), Page.find_version(pages(:welcome).id, 23) |
||||
assert_equal page_versions(:welcome_2), Page.find_version(pages(:welcome).id, 24) |
||||
assert_equal pages(:welcome), Page.find_version(pages(:welcome).id) |
||||
|
||||
assert_equal page_versions(:welcome_1), pages(:welcome).find_version(23) |
||||
assert_equal page_versions(:welcome_2), pages(:welcome).find_version(24) |
||||
assert_equal pages(:welcome), pages(:welcome).find_version |
||||
|
||||
assert_raise(ActiveRecord::RecordNotFound) { Page.find_version(pages(:welcome).id, 1) } |
||||
assert_raise(ActiveRecord::RecordNotFound) { Page.find_version(0, 23) } |
||||
end |
||||
|
||||
def test_with_sequence |
||||
assert_equal 'widgets_seq', Widget.versioned_class.sequence_name |
||||
3.times { Widget.create! :name => 'new widget' } |
||||
assert_equal 3, Widget.count |
||||
assert_equal 3, Widget.versioned_class.count |
||||
end |
||||
|
||||
def test_has_many_through |
||||
assert_equal [authors(:caged), authors(:mly)], pages(:welcome).authors |
||||
end |
||||
|
||||
def test_has_many_through_with_custom_association |
||||
assert_equal [authors(:caged), authors(:mly)], pages(:welcome).revisors |
||||
end |
||||
|
||||
def test_referential_integrity |
||||
pages(:welcome).destroy |
||||
assert_equal 0, Page.count |
||||
assert_equal 0, Page::Version.count |
||||
end |
||||
|
||||
def test_association_options |
||||
association = Page.reflect_on_association(:versions) |
||||
options = association.options |
||||
assert_equal :delete_all, options[:dependent] |
||||
assert_equal 'version', options[:order] |
||||
|
||||
association = Widget.reflect_on_association(:versions) |
||||
options = association.options |
||||
assert_equal :nullify, options[:dependent] |
||||
assert_equal 'version desc', options[:order] |
||||
assert_equal 'widget_id', options[:foreign_key] |
||||
|
||||
widget = Widget.create! :name => 'new widget' |
||||
assert_equal 1, Widget.count |
||||
assert_equal 1, Widget.versioned_class.count |
||||
widget.destroy |
||||
assert_equal 0, Widget.count |
||||
assert_equal 1, Widget.versioned_class.count |
||||
end |
||||
|
||||
def test_versioned_records_should_belong_to_parent |
||||
page = pages(:welcome) |
||||
page_version = page.versions.last |
||||
assert_equal page, page_version.page |
||||
end |
||||
|
||||
def test_unaltered_attributes |
||||
landmarks(:washington).attributes = landmarks(:washington).attributes.except("id") |
||||
assert !landmarks(:washington).changed? |
||||
end |
||||
|
||||
def test_unchanged_string_attributes |
||||
landmarks(:washington).attributes = landmarks(:washington).attributes.except("id").inject({}) { |params, (key, value)| params.update(key => value.to_s) } |
||||
assert !landmarks(:washington).changed? |
||||
end |
||||
|
||||
def test_should_find_earliest_version |
||||
assert_equal page_versions(:welcome_1), pages(:welcome).versions.earliest |
||||
end |
||||
|
||||
def test_should_find_latest_version |
||||
assert_equal page_versions(:welcome_2), pages(:welcome).versions.latest |
||||
end |
||||
|
||||
def test_should_find_previous_version |
||||
assert_equal page_versions(:welcome_1), page_versions(:welcome_2).previous |
||||
assert_equal page_versions(:welcome_1), pages(:welcome).versions.before(page_versions(:welcome_2)) |
||||
end |
||||
|
||||
def test_should_find_next_version |
||||
assert_equal page_versions(:welcome_2), page_versions(:welcome_1).next |
||||
assert_equal page_versions(:welcome_2), pages(:welcome).versions.after(page_versions(:welcome_1)) |
||||
end |
||||
|
||||
def test_should_find_version_count |
||||
assert_equal 24, pages(:welcome).versions_count |
||||
assert_equal 24, page_versions(:welcome_1).versions_count |
||||
assert_equal 24, page_versions(:welcome_2).versions_count |
||||
end |
||||
end |
||||
Loading…
Reference in new issue