laserlemon-vestal_versions 0.1.0

data/MIT-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/Manifest

@@ -0,0 +1,13 @@
+generators/vestal_versions_migration/templates/migration.rb
+generators/vestal_versions_migration/vestal_versions_migration_generator.rb
+init.rb
+lib/version.rb
+lib/vestal_versions.rb
+MIT-LICENSE
+Rakefile
+README.rdoc
+tasks/vestal_versions_tasks.rake
+test/test_helper.rb
+test/vestal_versions_test.rb
+VERSION.yml
+Manifest

data/README.rdoc

@@ -0,0 +1,13 @@
+= vestal_versions
+
+== Installation
+
+  script/plugin install git://github.com/laserlemon/vestal_versions.git
+
+== Example
+
+Coming soon...
+
+== Tips
+
+Coming soon...

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('vestal_versions', '0.1.0') do |g|
+  g.description = %(Keep a DRY history of your ActiveRecord models' changes)
+  g.url = 'http://github.com/laserlemon/vestal_versions'
+  g.author = 'Steve Richert'
+  g.email = 'steve@laserlemon.com'
+  g.ignore_pattern = %w(tmp/* script/*)
+  g.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|t| load t }

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 0

data/generators/vestal_versions_migration/templates/migration.rb

@@ -0,0 +1,20 @@
+class CreateVestalVersions < ActiveRecord::Migration
+  def self.up
+    create_table :versions do |t|
+      t.belongs_to :versioned, :polymorphic => true
+      t.text :changes
+      t.integer :number
+      t.datetime :created_at
+    end
+    
+    change_table :versions do |t|
+      t.index [:versioned_type, :versioned_id]
+      t.index :number
+      t.index :created_at
+    end
+  end
+
+  def self.down
+    drop_table :versions
+  end
+end

data/generators/vestal_versions_migration/vestal_versions_migration_generator.rb

@@ -0,0 +1,11 @@
+class VestalVersionsMigrationGenerator < Rails::Generator::Base 
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+  
+  def file_name
+    'create_vestal_versions'
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'vestal_versions'
+require 'version'

data/lib/version.rb

@@ -0,0 +1,30 @@
+class Version < ActiveRecord::Base
+  
+  belongs_to :versioned, :polymorphic => true
+  
+  validates_presence_of :versioned, :changes, :number
+  validates_numericality_of :number, :greater_than => 0, :only_integer => true
+  validates_uniqueness_of :number, :scope => ['versioned_type', 'versioned_id']
+  
+  serialize :changes, Hash
+  
+  before_create :set_number
+  
+  def <=>(other)
+    number <=> other.number
+  end
+  
+  def <(other)
+    number < other.number
+  end
+  
+  def >(other)
+    number > other.number
+  end
+  
+  private
+  
+  def set_number
+    write_attribute(:number, versioned.versions.maximum(:number).to_i + 1)
+  end
+end

data/lib/vestal_versions.rb

@@ -0,0 +1,84 @@
+module LaserLemon
+  module VestalVersions
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def versioned
+        has_many :versions, :as => :versioned, :order => 'versions.number', :dependent => :destroy, :autosave => true do
+          def current
+            first(:conditions => {:number => versioned.version})
+          end
+          
+          def at(value)
+            case value
+            when Version: value
+            when Numeric: first(:conditions => {:number => value.floor})
+            when Date, Time: last(:conditions => ['versions.created_at <= ?', value.to_time])
+            end
+          end
+          
+          def between(from_value, to_value)
+            from, to = at(from_value), at(to_value)
+            return [] unless [from, to].all?{|v| v.is_a?(Version) }
+            all(
+              :conditions => {:number => ([from, to].min.number..[from, to].max.number)},
+              :order => "versions.number #{(from > to) ? 'DESC' : 'ASC'}"
+            )
+          end
+        end
+        
+        before_save :build_version
+        
+        include InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      def build_version
+        @version = nil
+        unless changes.blank?
+          if versions.empty?
+            content_columns = self.class.column_names.delete_if{|c| c == self.class.primary_key }.delete_if{|c| c =~ /^(cre|upd)ated_(at|on)$/ }
+            content_attributes = attributes.slice(*content_columns)
+            if new_record?
+              versions.build(:changes => content_attributes)
+            else
+              reverted_attributes = content_attributes.inject({}){|h,(k,v)| h.update(k => (changed.include?(k) ? changes[k].first : v)) }
+              version_timestamp = (try(:updated_at) || try(:created_at))
+              versions.build(:changes => reverted_attributes, :created_at => version_timestamp)
+            end
+          end
+          versions.build(:changes => changes) unless new_record?
+        end
+      end
+      
+      def version
+        @version ||= begin
+          last_version = versions.last
+          last_version.nil? ? 1 : last_version.number
+        end
+      end
+      
+      def revert_to(value)
+        chain = versions.between(version, value)
+        return version unless chain.size > 1
+        new_version, backward = chain.last.number, (chain.first > chain.last)
+        backward ? chain.pop : chain.shift
+        chain.each do |version|
+          version.changes.each do |attribute, change|
+            write_attribute(attribute, backward ? change.first : change.last)
+          end
+        end
+        @version = new_version
+      end
+      
+      def revert_to!(value)
+        revert_to(value) && save
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, LaserLemon::VestalVersions)

data/tasks/vestal_versions_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :vestal_versions do
+#   # Task goes here
+# end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/test/vestal_versions_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class VestalVersionsTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/vestal_versions.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vestal_versions}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Richert"]
+  s.date = %q{2009-06-02}
+  s.description = %q{Keep a DRY history of your ActiveRecord models' changes}
+  s.email = %q{steve@laserlemon.com}
+  s.extra_rdoc_files = ["lib/version.rb", "lib/vestal_versions.rb", "README.rdoc", "tasks/vestal_versions_tasks.rake"]
+  s.files = ["generators/vestal_versions_migration/templates/migration.rb", "generators/vestal_versions_migration/vestal_versions_migration_generator.rb", "init.rb", "lib/version.rb", "lib/vestal_versions.rb", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/vestal_versions_tasks.rake", "test/test_helper.rb", "test/vestal_versions_test.rb", "VERSION.yml", "Manifest", "vestal_versions.gemspec"]
+  s.homepage = %q{http://github.com/laserlemon/vestal_versions}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Vestal_versions", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{vestal_versions}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Keep a DRY history of your ActiveRecord models' changes}
+  s.test_files = ["test/test_helper.rb", "test/vestal_versions_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: laserlemon-vestal_versions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Steve Richert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Keep a DRY history of your ActiveRecord models' changes
+email: steve@laserlemon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/version.rb
+- lib/vestal_versions.rb
+- README.rdoc
+- tasks/vestal_versions_tasks.rake
+files: 
+- generators/vestal_versions_migration/templates/migration.rb
+- generators/vestal_versions_migration/vestal_versions_migration_generator.rb
+- init.rb
+- lib/version.rb
+- lib/vestal_versions.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- tasks/vestal_versions_tasks.rake
+- test/test_helper.rb
+- test/vestal_versions_test.rb
+- VERSION.yml
+- Manifest
+- vestal_versions.gemspec
+has_rdoc: false
+homepage: http://github.com/laserlemon/vestal_versions
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Vestal_versions
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: vestal_versions
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Keep a DRY history of your ActiveRecord models' changes
+test_files: 
+- test/test_helper.rb
+- test/vestal_versions_test.rb