bitfluent-vestal_versions 1.1.0

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.db
+.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Richert
+
+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.

data/README.rdoc

@@ -0,0 +1,175 @@
+= vestal_versions for Rails 3
+
+Finally, DRY ActiveRecord versioning!
+
+<tt>acts_as_versioned</tt>[http://github.com/technoweenie/acts_as_versioned] by technoweenie[http://github.com/technoweenie] was a great start, but it failed to keep up with ActiveRecord's introduction of dirty objects in version 2.1. Additionally, each versioned model needs its own versions table that duplicates most of the original table's columns. The versions table is then populated with records that often duplicate most of the original record's attributes. All in all, not very DRY.
+
+<tt>vestal_versions</tt>[http://github.com/laserlemon/vestal_versions] requires only one versions table (polymorphically associated with its parent models) and no changes whatsoever to existing tables. But it goes one step DRYer by storing a serialized hash of _only_ the models' changes. Think modern version control systems. By traversing the record of changes, the models can be reverted to any point in time.
+
+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!
+
+== Compatibility
+  
+Tested with Active Record 3.0.0.beta4 with Ruby 1.8.7 and 1.9.2-preview3.
+
+== Installation
+
+In the Gemfile:
+
+  gem 'vestal_versions', :git => 'git://github.com/lailsonbm/vestal_versions', :branch => 'rails3'
+
+Next, generate and run the first and last versioning migration you'll ever need:
+
+  $ rails generate vestal_versions
+  $ rake db:migrate
+
+== Example
+
+To version an ActiveRecord model, simply add <tt>versioned</tt> to your class like so:
+
+  class User < ActiveRecord::Base
+    versioned
+  
+    validates_presence_of :first_name, :last_name
+  
+    def name
+      "#{first_name} #{last_name}"
+    end
+  end
+
+It's that easy! Now watch it in action...
+
+  >> u = User.create(:first_name => "Steve", :last_name => "Richert")
+  => #<User first_name: "Steve", last_name: "Richert">
+  >> u.version
+  => 1
+  >> u.update_attribute(:first_name, "Stephen")
+  => true
+  >> u.name
+  => "Stephen Richert"
+  >> u.version
+  => 2
+  >> u.revert_to(10.seconds.ago)
+  => 1
+  >> u.name
+  => "Steve Richert"
+  >> u.version
+  => 1
+  >> u.save
+  => true
+  >> u.version
+  => 3
+  >> u.update_attribute(:last_name, "Jobs")
+  => true
+  >> u.name
+  => "Steve Jobs"
+  >> u.version
+  => 4
+  >> u.revert_to!(2)
+  => true
+  >> u.name
+  => "Stephen Richert"
+  >> u.version
+  => 5
+
+== Upgrading to 1.0
+
+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
+
+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")
+      @user.first_name = "Steve"
+      @user.save
+      @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"
+    @user.tag_version("apple")
+    @user.update_attribute(:last_name, "Richert")
+    @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
+    @user.update_attribute(:last_name, "Jobs")
+    @user.name # => "Steve Jobs"
+    @user.version # => 2
+    @user.versions.count # => 1
+    @user.reset_to!(1)
+    @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.
+  
+== Thanks!
+
+Thank you to all those who post {issues and suggestions}[http://github.com/laserlemon/vestal_versions/issues]. And special thanks to:
+
+* splattael[http://github.com/splattael], who first bugged (and helped) me to write some tests for this thing
+* snaury[http://github.com/snaury], who helped out early on with the <tt>between</tt> association method, the <tt>:dependent</tt> option and a conflict from using a method called <tt>changes</tt>
+* sthapit[http://github.com/sthapit], who was responsible for the <tt>:only</tt> and <tt>:except</tt> options as well as showing me that I'm a dummy for storing a useless first version
+
+To contribute to <tt>vestal_versions</tt>, please fork, hack away in the integration[http://github.com/laserlemon/vestal_versions/tree/integration] branch and send me a pull request. Remember your tests!

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rcov/rcovtask'
+require 'rake/rdoctask'
+
+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', '>= 3.0.0.beta4'
+    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
+
+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

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/generators/vestal_versions/templates/initializer.rb

@@ -0,0 +1,9 @@
+VestalVersions.configure do |config|
+  # Place any global options here. For example, in order to specify your own version model to use
+  # throughout the application, simply specify:
+  #
+  # config.class_name = "MyCustomVersion"
+  #
+  # Any options passed to the "versioned" method in the model itself will override this global
+  # configuration.
+end

data/generators/vestal_versions/templates/migration.rb

@@ -0,0 +1,27 @@
+class CreateVestalVersions < ActiveRecord::Migration
+  def self.up
+    create_table :versions do |t|
+      t.belongs_to :versioned, :polymorphic => true
+      t.belongs_to :user, :polymorphic => true
+      t.string :user_name
+      t.text :modifications
+      t.integer :number
+      t.string :tag
+
+      t.timestamps
+    end
+
+    change_table :versions do |t|
+      t.index [:versioned_id, :versioned_type]
+      t.index [:user_id, :user_type]
+      t.index :user_name
+      t.index :number
+      t.index :tag
+      t.index :created_at
+    end
+  end
+
+  def self.down
+    drop_table :versions
+  end
+end

data/generators/vestal_versions/vestal_versions_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+class VestalVersionsGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+  
+  argument :name, :type => :string, :default => "create_vestal_versions"
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def generate_files
+    migration_template 'migration.rb', File.join('db', 'migrate', 'create_vestal_versions')
+    template 'initializer.rb', File.join('config', 'initializers', 'vestal_versions.rb')
+  end
+  
+protected
+  # Lets make this hacky thing while ticket #3820 isn't applied again...
+  # https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/3820
+  def self.next_migration_number(dirname) #:nodoc:
+    orm = Rails.configuration.generators.options[:rails][:orm]
+    require "rails/generators/#{orm}"
+    "#{orm.to_s.camelize}::Generators::Base".constantize.next_migration_number(dirname)
+  rescue
+    raise NotImplementedError
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'vestal_versions')

data/lib/vestal_versions.rb

@@ -0,0 +1,103 @@
+# +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.
+#
+# Author:: Steve Richert
+# Copyright:: Copyright (c) 2009 Steve Richert
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+#
+# To enable versioning on a model, simply use the +versioned+ method:
+#
+#   class User < ActiveRecord::Base
+#     versioned
+#   end
+#
+#   user = User.create(:name => "Steve Richert")
+#   user.version # => 1
+#   user.update_attribute(:name, "Steve Jobs")
+#   user.version # => 2
+#   user.revert_to(1)
+#   user.name # => "Steve Richert"
+#
+# See the +versioned+ documentation for more details.
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'generators', 'vestal_versions', 'vestal_versions_generator'))
+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
+  end
+
+  module ClassMethods
+    # +versioned+ associates an ActiveRecord model with many versions. When the object is updated,
+    # a new version containing the changes is created. There are several options available to the
+    # +versioned+ method, most of which are passed to the +has_many+ association itself:
+    # * <tt>:class_name</tt>: The class name of the version model to use for the association. By
+    #   default, this is set to "VestalVersions::Version", representing the built-in version class.
+    #   By specifying this option, you can override the version class, to include custom version
+    #   behavior. It's recommended that a custom version inherit from VestalVersions::Version.
+    # * <tt>:dependent</tt>: Also common to +has_many+ associations, this describes the behavior of
+    #   version records when the parent object is destroyed. This defaults to :delete_all, which
+    #   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.
+    # * <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
+    #   unimportant, constantly changing, or sensitive information. This option accepts a symbol,
+    #   string or an array of either, representing column names to exclude. It is completely
+    #   optional and defaults to +nil+, allowing all columns to be versioned. This option is also
+    #   ignored if the +only+ option is used.
+    # * <tt>:extend</tt>: This option allows you to extend the +has_many+ association proxy with a
+    #   module or an array of modules. Any methods defined in those modules become available on the
+    #   +versions+ association. The VestalVersions::Versions module is essential to the
+    #   functionality of +vestal_versions+ and so is prepended to any additional modules that you
+    #   might specify here.
+    # * <tt>:if</tt>: Accepts a symbol, a proc or an array of either to be evaluated when the parent
+    #   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
+    #   or an array of either, representing column names to include. It is completely optional and
+    #   defaults to +nil+, allowing all columns to be versioned. This option takes precedence over
+    #   the +except+ option if both are specified.
+    # * <tt>:unless</tt>: Accepts a symbol, a proc or an array of either to be evaluated when the
+    #   parent object is updated to determine whether version creation should be skipped. +to_proc+
+    #   is called on any symbols given and the resulting procs are called, passing in the object
+    #   itself. If an array is given and any element evaluates as +true+, the version creation will
+    #   be skipped.
+    def versioned(options = {}, &block)
+      return if versioned?
+
+      include Options
+      include Changes
+      include Creation
+      include Users
+      include Reversion
+      include Reset
+      include Conditions
+      include Control
+      include Tagging
+      include Reload
+
+      prepare_versioned_options(options)
+      has_many :versions, options, &block
+    end
+  end
+
+  extend Configuration
+end
+
+ActiveRecord::Base.send(:include, VestalVersions)

data/lib/vestal_versions/changes.rb

@@ -0,0 +1,125 @@
+module VestalVersions
+  # Provides the ability to manipulate hashes in the specific format that ActiveRecord gives to
+  # dirty attribute changes: string keys and unique, two-element array values.
+  module Changes
+    def self.included(base) # :nodoc:
+      Hash.send(:include, HashMethods)
+
+      base.class_eval do
+        include InstanceMethods
+
+        after_update :merge_version_changes
+      end
+    end
+
+    # Methods available to versioned ActiveRecord::Base instances in order to manage changes used
+    # for version creation.
+    module InstanceMethods
+      # Collects an array of changes from a record's versions between the given range and compiles
+      # them into one summary hash of changes. The +from+ and +to+ arguments can each be either a
+      # version number, a symbol representing an association proxy method, a string representing a
+      # version tag or a version object itself.
+      def changes_between(from, to)
+        from_number, to_number = versions.number_at(from), versions.number_at(to)
+        return {} if from_number == to_number
+        chain = versions.between(from_number, to_number).reject(&:initial?)
+        return {} if chain.empty?
+
+        backward = from_number > to_number
+        backward ? chain.pop : chain.shift unless from_number == 1 || to_number == 1
+
+        chain.inject({}) do |changes, version|
+          changes.append_changes!(backward ? version.changes.reverse_changes : version.changes)
+        end
+      end
+
+      private
+        # Before a new version is created, the newly-changed attributes are appended onto a hash
+        # of previously-changed attributes. Typically the previous changes will be empty, except in
+        # the case that a control block is used where versions are to be merged. See
+        # VestalVersions::Control for more information.
+        def merge_version_changes
+          version_changes.append_changes!(incremental_version_changes)
+        end
+
+        # Stores the cumulative changes that are eventually used for version creation.
+        def version_changes
+          @version_changes ||= {}
+        end
+
+        # Stores the incremental changes that are appended to the cumulative changes before version
+        # creation. Incremental changes are reset when the record is saved because they represent
+        # a subset of the dirty attribute changes, which are reset upon save.
+        def incremental_version_changes
+          changes.slice(*versioned_columns)
+        end
+
+        # Simply resets the cumulative changes after version creation.
+        def reset_version_changes
+          @version_changes = nil
+        end
+    end
+
+    # Instance methods included into Hash for dealing with manipulation of hashes in the specific
+    # format of ActiveRecord::Base#changes.
+    module HashMethods
+      # When called on a hash of changes and given a second hash of changes as an argument,
+      # +append_changes+ will run the second hash on top of the first, updating the last element
+      # of each array value with its own, or creating its own key/value pair for missing keys.
+      # Resulting non-unique array values are removed.
+      #
+      # == Example
+      #
+      # first = {
+      #   "first_name" => ["Steve", "Stephen"],
+      #   "age" => [25, 26]
+      # }
+      # second = {
+      #   "first_name" => ["Stephen", "Steve"],
+      #   "last_name" => ["Richert", "Jobs"],
+      #   "age" => [26, 54]
+      # }
+      # first.append_changes(second)
+      # # => {
+      #   "last_name" => ["Richert", "Jobs"],
+      #   "age" => [25, 54]
+      # }
+      def append_changes(changes)
+        changes.inject(self) do |new_changes, (attribute, change)|
+          new_change = [new_changes.fetch(attribute, change).first, change.last]
+          new_changes.merge(attribute => new_change)
+        end.reject do |attribute, change|
+          change.first == change.last
+        end
+      end
+
+      # Destructively appends a given hash of changes onto an existing hash of changes.
+      def append_changes!(changes)
+        replace(append_changes(changes))
+      end
+
+      # Appends the existing hash of changes onto a given hash of changes. Relates to the
+      # +append_changes+ method in the same way that Hash#reverse_merge relates to
+      # Hash#merge.
+      def prepend_changes(changes)
+        changes.append_changes(self)
+      end
+
+      # Destructively prepends a given hash of changes onto an existing hash of changes.
+      def prepend_changes!(changes)
+        replace(prepend_changes(changes))
+      end
+
+      # Reverses the array values of a hash of changes. Useful for reversion both backward and
+      # forward through a record's history of changes.
+      def reverse_changes
+        inject({}){|nc,(a,c)| nc.merge!(a => c.reverse) }
+      end
+
+      # Destructively reverses the array values of a hash of changes.
+      def reverse_changes!
+        replace(reverse_changes)
+      end
+    end
+  end
+end