acts_as_versionable 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_versionable.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_versionable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/acts_as_versionable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_versionable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_versionable"
+  s.version     = ActsAsVersionable::VERSION
+  s.authors     = ["Carlos Segura"]
+  s.email       = ["csegura@ideseg.com"]
+  s.homepage    = ""
+  s.summary     = "Minimalist engine for versions"
+  s.description = ""
+
+  s.rubyforge_project = "acts_as_versionable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'lib', 'acts_as_versionable')
+ActiveRecord::Base.class_eval { include ActsAsVersionable }

data/lib/acts_as_versionable.rb

@@ -0,0 +1,81 @@
+require 'acts_as_versionable/version'
+
+# ActsAsVersionable
+module ActsAsVersionable
+
+  class NoSuchVersionError < Exception; end
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+  
+    def create_class(name, superclass, &block)
+      klass = Class.new superclass, &block
+      Object.const_set name, klass
+    end
+
+    def acts_as_versionable(opts = {})
+      has_many :versions, :class_name => "#{self}Version", :dependent => :destroy
+      after_save :apply_versioning 
+
+      attr_accessor :local_changes
+
+      class << create_class("#{self}Version", ActiveRecord::Base)
+        def actual_columns
+          content_columns.reject { |c| c.type == :datetime || c.name == 'versioned_as' }
+        end
+      end
+
+      include InstanceMethods
+    end
+
+  end
+
+  module InstanceMethods
+
+    def version
+      current_version || 0
+    end
+
+    def revert_to(version)
+      revision = versions.find_by_versioned_as(version) 
+      
+      raise NoSuchVersionError, "Couldn't find #{version} version" if revision.blank?
+
+      versions.actual_columns.each do |column|
+        self[column.name] = revision[column.name]  
+      end
+
+      self.current_version = version
+      self.local_changes = true
+      self.save
+    end
+
+    private
+      
+    def apply_versioning
+      unless self.local_changes
+        version_content = {}
+        last_version = version + 1
+
+        versions.actual_columns.each do |column|
+          version_content[column.name] = self[column.name]
+        end
+
+        version_content.merge!(:versioned_as => last_version)
+
+        if versions.create(version_content)
+          self.local_changes = true
+          self.update_attribute(:current_version, last_version)
+        end
+      end
+
+      self.local_changes = false 
+    end
+
+  end
+
+end
+

data/lib/acts_as_versionable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsVersionable
+  VERSION = "0.0.1"
+end

data/lib/generators/versionize/templates/migration.rb

@@ -0,0 +1,27 @@
+<% 
+  model = model_name.constantize
+  model_name = model_name.downcase # model_name.downcase! - can't modify frozen string
+  versions_table = model_name + '_versions'
+  columns = model.content_columns.reject { |c| c.type == :datetime }
+%>
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= versions_table %> do |t| 
+      <% columns.each do |column| %>
+        t.column :<%= column.name %>, :<%= column.type %>
+      <% end %>
+
+      t.integer :<%= model_name + '_id' %>
+      t.integer :versioned_as
+      t.timestamps
+    end
+
+    add_index :<%= versions_table %>, :versioned_as
+    add_column :<%= model_name.pluralize %>, :current_version, :integer
+  end
+
+  def self.down
+    drop_table :<%= versions_table %>
+    remove_column :<%= model_name.pluralize %>, :current_version
+  end
+end

data/lib/generators/versionize/versionize_generator.rb

@@ -0,0 +1,28 @@
+class VersionizeGenerator < Rails::Generator::NamedBase
+  attr_accessor :model_name
+
+  def initialize(args, opts = {})
+    super
+    @model_name = args.first
+  end
+
+  def manifest
+    model_name_for_migration = @model_name.downcase.pluralize
+    
+    record do |m|
+      m.migration_template('migration.rb', 'db/migrate', 
+        :assigns => {
+          :model_name => @model_name,
+          :migration_name => "CreateVersionsFor#{@model_name.pluralize}"
+        }, 
+        :migration_file_name => "create_versions_for_#{model_name_for_migration}")
+    end
+  end
+
+protected
+
+  def banner
+    "Usage: #{$0} versionize ModelName"
+  end
+
+end

data/test/acts_as_versionable_test.rb

@@ -0,0 +1,109 @@
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+require 'test/unit'
+require "#{File.dirname(__FILE__)}/../init"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :articles do |t|
+      t.string :title
+      t.text   :body
+
+      t.integer :user_id
+      t.integer :current_version
+      t.timestamps
+    end
+
+    create_table :article_versions do |t|
+      t.string  :title
+      t.text    :body
+      t.integer :article_id
+      t.integer :versioned_as
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Article < ActiveRecord::Base
+  acts_as_versionable
+end
+
+class VersionableTest < Test::Unit::TestCase
+  def setup
+    setup_db
+
+    (1..3).each { |c| 
+      Article.create!(:title => c.to_s, :body => c.to_s)
+    }
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_if_mixed_methods_present
+    article = Article.first
+    [:versions, :version, :revert_to].each do |method|
+      assert_equal true, article.respond_to?(method) 
+    end
+  end
+
+  def test_initial_versions_of_the_articles
+    Article.all.each do |a|
+      assert_equal 1, a.versions.size
+      assert_equal 1, a.version
+    end
+  end
+
+  def test_version_change_to_2
+    article = Article.first
+
+    assert_not_nil article
+    assert_equal '1', article.title
+    assert_equal 1, article.version
+
+    article.update_attributes(:title => '4', :body => '4')
+    
+    assert_equal 2, article.version
+    assert_equal 2, article.versions.size
+    assert_equal '4', article.title
+    assert_equal '4', article.body
+  end
+
+  def test_revert_to
+    article = Article.first
+    assert_not_nil article
+
+    article.update_attributes(:title => '4', :body => '4')
+    assert_equal 2, article.versions.size
+    
+    article.revert_to(1)
+    assert_equal 1, article.version
+    assert_equal '1', article.title
+    assert_equal '1', article.body
+
+    article.revert_to(2)
+    assert_equal 2, article.version
+    assert_equal '4', article.title 
+    assert_equal '4', article.body
+  
+    assert_raise ActsAsVersionable::NoSuchVersionError do
+      article.revert_to(3)
+    end
+  end
+
+  def test_dependent_destroy
+    Article.destroy_all
+    assert_equal [], ArticleVersion.all
+  end
+end
+

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_versionable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Carlos Segura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-18 00:00:00.000000000Z
+dependencies: []
+description: ''
+email:
+- csegura@ideseg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- acts_as_versionable.gemspec
+- init.rb
+- lib/acts_as_versionable.rb
+- lib/acts_as_versionable/version.rb
+- lib/generators/versionize/templates/migration.rb
+- lib/generators/versionize/versionize_generator.rb
+- test/acts_as_versionable_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: acts_as_versionable
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Minimalist engine for versions
+test_files:
+- test/acts_as_versionable_test.rb