vestal_versions 1.0.2 → 2.0.0

data/.gitignore

@@ -1,22 +1,21 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
 coverage
-rdoc
+doc/
+Gemfile.lock
+gemfiles/*.lock
+InstalledFiles
+lib/bundler/man
 pkg
-
-## PROJECT::SPECIFIC
-*.db
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+_yardoc
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -0,0 +1,22 @@
+branches:
+  only:
+    - master
+gemfile:
+  - gemfiles/activerecord_3_0.gemfile
+  - gemfiles/activerecord_3_1.gemfile
+  - gemfiles/activerecord_3_2.gemfile
+  - gemfiles/activerecord_4_0.gemfile
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  include:
+    - env: COVERAGE=1
+      gemfile: Gemfile
+      rvm: 2.1.0
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+script: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 2.0.0 / 2014-01-20
+
+ * [ENHANCEMENT] Ruby 2.1.0 compatibility
+ * [ENHANCEMENT] Ruby 2.0.0 compatibility
+ * [ENHANCEMENT] Ruby 1.9.3 compatibility
+ * [ENHANCEMENT] Initial Rails 4 compatibility
+ * [ENHANCEMENT] Initial Rails 3 compatibility

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'coveralls', '~> 0.7', :require => false
+  gem 'rspec', '~> 2.0'
+  gem 'sqlite3', '~> 1.0'
+end
+

data/README.rdoc

@@ -1,4 +1,10 @@
-= vestal_versions
+= Vestal Versions
+
+{<img src="https://badge.fury.io/rb/vestal_versions.png" alt="Gem Version" />}[http://badge.fury.io/rb/vestal_versions]
+{<img src="https://travis-ci.org/laserlemon/vestal_versions.png?branch=master" alt="Build Status" />}[https://travis-ci.org/laserlemon/vestal_versions]
+{<img src="https://codeclimate.com/github/laserlemon/vestal_versions.png" alt="Code Climate" />}[https://codeclimate.com/github/laserlemon/vestal_versions]
+{<img src="https://coveralls.io/repos/laserlemon/vestal_versions/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/laserlemon/vestal_versions]
+{<img src="https://gemnasium.com/laserlemon/vestal_versions.png" alt="Dependency Status" />}[https://gemnasium.com/laserlemon/vestal_versions]
 
 Finally, DRY ActiveRecord versioning!
 
@@ -8,23 +14,23 @@ Finally, DRY ActiveRecord versioning!
 
 And that's just what <tt>vestal_versions</tt> does. Not only can a model be reverted to a previous version number but also to a date or time!
 
-== Installation
+== Compatibility
 
-In <tt>environment.rb</tt>:
+Tested with Active Record 3.2.16 with Ruby 1.9.3 and 1.9.2.
 
-  Rails::Initializer.run do |config|
-    ...
-    config.gem 'vestal_versions'
-    ...
-  end
+== Installation
 
-At your application root, run:
+In the Gemfile:
 
-  $ sudo rake gems:install
+** Note: I am giving this project some much needed love to keep her relevant in a post Rails 3 world. I will be finalizing a version to support 1.9.2+ and Rails 3.2+ soon and pushing the gem, till then, use the git repo:
+~dreamr
+  
+  gem 'vestal_versions', :git => 'git://github.com/laserlemon/vestal_versions'
+  
 
 Next, generate and run the first and last versioning migration you'll ever need:
 
-  $ script/generate vestal_versions
+  $ rails generate vestal_versions:migration
   $ rake db:migrate
 
 == Example
@@ -33,9 +39,9 @@ To version an ActiveRecord model, simply add <tt>versioned</tt> to your class li
 
   class User < ActiveRecord::Base
     versioned
-  
+
     validates_presence_of :first_name, :last_name
-  
+
     def name
       "#{first_name} #{last_name}"
     end
@@ -81,25 +87,25 @@ It's that easy! Now watch it in action...
 For the most part, version 1.0 of <tt>vestal_versions</tt> is backwards compatible, with just a few notable changes:
 
 * The versions table has been beefed up. You'll need to add the following columns (and indexes, if you feel so inclined):
-  
+
     change_table :versions do |t|
       t.belongs_to :user, :polymorphic => true
       t.string :user_name
       t.string :tag
     end
-    
+
     change_table :versions do |t|
       t.index [:user_id, :user_type]
       t.index :user_name
       t.index :tag
     end
-  
+
 * When a model is created (or updated the first time after being versioned), an initial version record with a number of 1 is no longer created. These aren't used during reversion and so they end up just being dead weight. Feel free to scrap all your versions where <tt>number == 1</tt> after the upgrade if you'd like to free up some room in your database (but you don't have to).
-  
+
 * Models that have no version records in the database will return a <tt>@user.version</tt> of 1. In the past, this would have returned <tt>nil</tt> instead.
-  
+
 * <tt>Version</tt> has moved to <tt>VestalVersions::Version</tt> to make way for custom version classes.
-  
+
 * <tt>Version#version</tt> did not survive the move to <tt>VestalVersions::Version#version</tt>. That alias was dropped (too confusing). Use <tt>VestalVersions::Version#number</tt>.
 
 == New to 1.0
@@ -107,7 +113,7 @@ For the most part, version 1.0 of <tt>vestal_versions</tt> is backwards compatib
 There are a handful of exciting new additions in version 1.0 of <tt>vestal_versions</tt>. A lot has changed in the code: much better documentation, more modular organization of features, and a more exhaustive test suite. But there are also a number of new features that are available in this release of <tt>vestal_versions</tt>:
 
 * The ability to completely skip versioning within a new <tt>skip_version</tt> block:
-  
+
     @user.version # => 1
     @user.skip_version do
       @user.update_attribute(:first_name, "Stephen")
@@ -116,11 +122,11 @@ There are a handful of exciting new additions in version 1.0 of <tt>vestal_versi
       @user.update_attributes(:last_name => "Jobs")
     end
     @user.version # => 1
-  
+
   Also available, are <tt>merge_version</tt> and <tt>append_version</tt> blocks. The <tt>merge_version</tt> block will compile the possibly multiple versions that would result from the updates inside the block into one summary version. The single resulting version is then tacked onto the version history as usual. The <tt>append_version</tt> block works similarly except that the resulting single version is combined with the most recent version in the history and saved.
-  
+
 * Version tagging. Any version can have a tag attached to it (must be unique within the scope of the versioned parent) and that tag can be used for reversion.
-  
+
     @user.name # => "Steve Richert"
     @user.update_attribute(:last_name, "Jobs")
     @user.name # => "Steve Jobs"
@@ -129,11 +135,11 @@ There are a handful of exciting new additions in version 1.0 of <tt>vestal_versi
     @user.name # => "Steve Richert"
     @user.revert_to("apple")
     @user.name # => "Steve Jobs"
-  
+
   So if you're not big on version numbers, you could just tag your versions and avoid the numbers altogether.
-  
+
 * Resetting. This is basically a hard revert. The new <tt>reset_to!</tt> instance method behaves just like the <tt>revert_to!</tt> method except that after the reversion, it will also scrap all the versions that came after that target version.
-  
+
     @user.name # => "Steve Richert"
     @user.version # => 1
     @user.versions.count # => 0
@@ -145,29 +151,50 @@ There are a handful of exciting new additions in version 1.0 of <tt>vestal_versi
     @user.name # => "Steve Richert"
     @user.version # => 1
     @user.versions.count # => 0
-  
+
 * Storing which user is responsible for a revision. Rather than introduce a lot of controller magic to guess what to store, you can simply update an additional attribute on your versioned model: <tt>updated_by</tt>.
-  
+
     @user.update_attributes(:last_name => "Jobs", :updated_by => "Tyler")
     @user.versions.last.user # => "Tyler"
-  
+
   Instead of passing a simple string to the <tt>updated_by</tt> setter, you can pass a model instance, such as an ActiveRecord user or administrator. The association will be saved polymorphically alongside the version.
-  
+
     @user.update_attributes(:last_name => "Jobs", :updated_by => current_user)
     @user.versions.last.user # => #<User first_name: "Steven", last_name: "Tyler">
-  
+
 * Global configuration. The new <tt>vestal_versions</tt> Rails generator also writes an initializer with instructions on how to set application-wide options for the <tt>versioned</tt> method.
-  
+
 * Conditional version creation. The <tt>versioned</tt> method now accepts <tt>:if</tt> and <tt>:unless</tt> options. Each expects a symbol representing an instance method or a proc that will be evaluated to determine whether or not to create a new version after an update. An array containing any combination of symbols and procs can also be given.
-  
+
     class User < ActiveRecord::Base
       versioned :if => :really_create_a_version?
     end
-  
+
 * Custom version classes. By passing a <tt>:class_name</tt> option to the <tt>versioned</tt> method, you can specify your own ActiveRecord version model. <tt>VestalVersions::Version</tt> is the default, but feel free to stray from that. I recommend that your custom model inherit from <tt>VestalVersions::Version</tt>, but that's up to you!
-  
+
 * A <tt>versioned?</tt> convenience class method. If your user model is versioned, <tt>User.versioned?</tt> will let you know.
-  
+
+* Soft Deletes & Restoration.  By setting <tt>:dependent</tt> to <tt>:tracking</tt> destroys will be tracked.  On destroy a new version will be created storing the complete details of the object with a tag of 'deleted'.  The object can later be restored using the <tt>restore!</tt> method on the VestalVersions::Version record.  The attributes of the restored object will be set using the attribute writer methods.  After a restore! is performed the version record with the 'deleted' tag is removed from the history.
+
+    class User < ActiveRecord::Base
+      versioned :dependent => :tracking
+    end
+
+    >> @user.version
+    => 2
+    >> @user.destroy
+    => <User id: 2, first_name: "Steve", last_name: "Jobs", ... >
+    >> User.find(2)
+    => ActiveRecord::RecordNotFound: Couldn't find User with ID=2
+    >> VestalVersions::Version.last
+    => <VestalVersions::Version id: 4, versioned_id: 2, versioned_type: "User", user_id: nil, user_type: nil, user_name: nil, modifications: {"created_at"=>Sun Aug 01 18:39:57 UTC 2010, "updated_at"=>Sun Aug 01 18:42:28 UTC 2010, "id"=>2, "last_name"=>"Jobs", "first_name"=>"Stephen"}, number: 3, tag: "deleted", created_at: "2010-08-01 18:42:43", updated_at: "2010-08-01 18:42:43">
+    >> VestalVersions::Version.last.restore!
+    => <User id: 2, first_name => "Steven", last_name: "Jobs", ... >
+    >> @user = User.find(2)
+    => <User id: 2, first_name => "Steven", last_name: "Jobs", ... >
+    >> @user.version
+    => 2
+
 == Thanks!
 
 Thank you to all those who post {issues and suggestions}[http://github.com/laserlemon/vestal_versions/issues]. And special thanks to:

data/Rakefile

@@ -1,45 +1,6 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rcov/rcovtask'
-require 'rake/rdoctask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |g|
-    g.name = 'vestal_versions'
-    g.summary = %(Keep a DRY history of your ActiveRecord models' changes)
-    g.description = %(Keep a DRY history of your ActiveRecord models' changes)
-    g.email = 'steve@laserlemon.com'
-    g.homepage = 'http://github.com/laserlemon/vestal_versions'
-    g.authors = %w(laserlemon)
-    g.add_dependency 'activerecord', '>= 2.1.0'
-    g.add_development_dependency 'shoulda'
-    g.add_development_dependency 'mocha'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
-end
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new do |t|
-  t.libs = %w(test)
-  t.pattern = 'test/**/*_test.rb'
-end
-
-Rcov::RcovTask.new do |t|
-  t.libs = %w(test)
-  t.pattern = 'test/**/*_test.rb'
-end
-
-task :test => :check_dependencies
-task :default => :test
-
-Rake::RDocTask.new do |r|
-  version = File.exist?('VERSION') ? File.read('VERSION') : nil
-  r.rdoc_dir = 'rdoc'
-  r.title = ['vestal_versions', version].compact.join(' ')
-  r.options << '--line-numbers' << '--inline-source'
-  r.rdoc_files.include('README*')
-  r.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :spec

data/gemfiles/activerecord_3_0.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.0.0'
+
+gemspec :path => '..'
+
+group :test do
+  gem 'rspec', '~> 2.0'
+  gem 'sqlite3', '~> 1.0'
+end

data/gemfiles/activerecord_3_1.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.1.0'
+
+gemspec :path => '..'
+
+group :test do
+  gem 'rspec', '~> 2.0'
+  gem 'sqlite3', '~> 1.0'
+end

data/gemfiles/activerecord_3_2.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2.0'
+
+gemspec :path => '..'
+
+group :test do
+  gem 'rspec', '~> 2.0'
+  gem 'sqlite3', '~> 1.0'
+end

data/gemfiles/activerecord_4_0.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.0.0'
+
+gemspec :path => '..'
+
+group :test do
+  gem 'rspec', '~> 2.0'
+  gem 'sqlite3', '~> 1.0'
+end

data/lib/generators/vestal_versions.rb

@@ -0,0 +1,11 @@
+require 'rails/generators/named_base'
+
+module VestalVersions
+  module Generators
+    module Base
+      def source_root
+        @_vestal_versions_source_root ||= File.expand_path(File.join('../vestal_versions', generator_name, 'templates'), __FILE__)
+      end
+    end
+  end
+end

data/lib/generators/vestal_versions/migration/migration_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/vestal_versions'
+require 'rails/generators/active_record'
+
+module VestalVersions
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'create_vestal_versions'
+
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}"
+        template 'initializer.rb', 'config/initializers/vestal_versions.rb'
+      end
+    end
+  end
+end

data/{generators/vestal_versions → lib/generators/vestal_versions/migration}/templates/migration.rb

@@ -3,10 +3,11 @@ class CreateVestalVersions < ActiveRecord::Migration
     create_table :versions do |t|
       t.belongs_to :versioned, :polymorphic => true
       t.belongs_to :user, :polymorphic => true
-      t.string :user_name
-      t.text :changes
+      t.string  :user_name
+      t.text    :modifications
       t.integer :number
-      t.string :tag
+      t.integer :reverted_from
+      t.string  :tag
 
       t.timestamps
     end

data/lib/vestal_versions.rb

@@ -1,3 +1,8 @@
+require 'active_support/concern'
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext/module/delegation'
+require 'active_record'
+
 # +vestal_versions+ keeps track of updates to ActiveRecord models, leveraging the introduction of
 # dirty attributes in Rails 2.1. By storing only the updated attributes in a serialized column of a
 # single version model, the history is kept DRY and no additional schema changes are necessary.
@@ -21,16 +26,34 @@
 #
 # See the +versioned+ documentation for more details.
 
-Dir[File.join(File.dirname(__FILE__), 'vestal_versions', '*.rb')].each{|f| require f }
-
 # The base module that gets included in ActiveRecord::Base. See the documentation for
 # VestalVersions::ClassMethods for more useful information.
 module VestalVersions
-  def self.included(base) # :nodoc:
-    base.class_eval do
-      extend ClassMethods
-      extend Versioned
-    end
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+
+  autoload :Changes
+  autoload :Conditions
+  autoload :Control
+  autoload :Creation
+  autoload :Deletion
+  autoload :Options
+  autoload :Reload
+  autoload :Reset
+  autoload :Reversion
+  autoload :Users
+  autoload :Version
+  autoload :VERSION, 'vestal_versions/version_num'
+  autoload :VersionTagging
+  autoload :Versioned
+  autoload :Versions
+
+  class << self
+    delegate :config, :configure, :to => Version
+  end
+
+  included do
+    include Versioned
   end
 
   module ClassMethods
@@ -46,7 +69,9 @@ module VestalVersions
     #   will permanently remove all associated versions *without* triggering any destroy callbacks.
     #   Other options are :destroy which removes the associated versions *with* callbacks, or
     #   :nullify which leaves the version records in the database, but dissociates them from the
-    #   parent object by setting the foreign key columns to +nil+ values.
+    #   parent object by setting the foreign key columns to +nil+ values.  Setting this option to 
+    #   :tracking will perform a soft delete on destroy and create a new version record preserving
+    #   details of this record for later restoration.
     # * <tt>:except</tt>: An update will trigger version creation as long as at least one column
     #   outside those specified here was updated. Also, upon version creation, the columns
     #   specified here will be excluded from the change history. This is useful when dealing with
@@ -63,6 +88,9 @@ module VestalVersions
     #   object is updated to determine whether a new version should be created. +to_proc+ is called
     #   on any symbols given and the resulting procs are called, passing in the object itself. If
     #   an array is given, all must be evaluate to +true+ in order for a version to be created.
+    # * <tt>:initial_version</tt>: When set to true, an initial version is always created when the
+    #   parent object is created. This initial version will have nil changes however it can be
+    #   used to store who created the original version.
     # * <tt>:only</tt>: An update will trigger version creation as long as at least one updated
     #   column falls within those specified here. Also, upon version creation, only the columns
     #   specified here will be included in the change history. This option accepts a symbol, string
@@ -85,15 +113,14 @@ module VestalVersions
       include Reset
       include Conditions
       include Control
-      include Tagging
+      include VersionTagging
       include Reload
+      include Deletion
 
       prepare_versioned_options(options)
       has_many :versions, options, &block
     end
   end
-
-  extend Configuration
 end
 
-ActiveRecord::Base.send(:include, VestalVersions)
+ActiveRecord::Base.class_eval{ include VestalVersions }