wikify 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfb7da00d14ef7a813e3fbc64869133635a7958c
+  data.tar.gz: f34e12fbf529cf68005815784fb03299fd6b7aad
+SHA512:
+  metadata.gz: 1f3096e30c0f7f77e27b2217b59dad0d96942663967250e8d62a598435de1e9c6c51a478c997c093af8b43a63282b4f61c29c7409c6a4253ba1da6dc779becae
+  data.tar.gz: 0462d4122d9179c6648c161211a75109082dc8f86ca1f142ee3fa7f1cc82e99f3770e16ab73d7942139b2d6aaa99c95a4a9424aac98e083f9b6e4e9a348bf50d

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_STORE
+*~

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - ruby-head
+env:
+ - "rake=0.9"
+script: "bundle exec rspec -c"
+notifications:
+  email: false
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Laycock
+
+MIT License
+
+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.md

@@ -0,0 +1,91 @@
+# Wikify
+
+Active Record model versioning.
+
+[![Build Status](https://travis-ci.org/Arcath/Wikify.png?branch=master)](https://travis-ci.org/Arcath/Wikify) | [![Code Climate](https://codeclimate.com/github/Arcath/Wikify.png)](https://codeclimate.com/github/Arcath/Wikify) | [![Coverage Status](https://coveralls.io/repos/Arcath/Wikify/badge.png)](https://coveralls.io/r/Arcath/Wikify) | [RDoc](http://rubydoc.info/github/Arcath/Wikify/master/frames)
+
+## Installation
+
+### Adding the Gem
+
+Add this line to your application's Gemfile:
+
+    gem 'wikify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wikify
+    
+### Migration
+
+Wikify has a built in generator for creating the migration which can be run using:
+
+    $ rails g wikify:migration
+    $ rake db:migrate
+
+You will now have a table for your versions, wikify contains a model for the versions which is used by default.
+
+## Usage
+
+To enable wikify on your models add `wikify` to your model class:
+
+``` ruby
+class Article < ActiveRecord::Base
+  wikify
+end
+```
+
+Your model now has version tracking!
+
+For an example of how Wikify works see the [Logical Function Spec](https://github.com/Arcath/Wikify/blob/master/spec/logical_function_spec.rb) which is a commented example of all the functionality (that gets tested with every push).
+
+## Restoring a Version
+
+Versions have a handy `restore` method that lets you very quickly and easily restore a version over the current/target model. A version stores the model & id when it gets created when you call `restore` Wikify finds the model with the stored id and then overwrites all its attributes with the ones in the versions cache.
+
+### Restoring a deleted version
+
+You can restore a deleted versions by using the `Wikify.destroyed_versions` method. You must supply a model and optionally an id e.g.
+
+``` ruby
+Wikify.destroyed_versions(Article)
+#> An list of versions where event is "destroy" and model is "Article"
+Wikify.destroyed_versions(Article, 2)
+#> The destory events for the given article only
+```
+
+### Associations
+
+#### Has-Many
+
+Wikify can track the versions of child objects, for example a comments model attached to that articles model:
+
+``` ruby
+class Article < ActiveRecord::Base
+  has_many :comments
+  
+  wikify
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :article
+  
+  wikify_on_parent(:article)
+end
+```
+
+This then stores versions on the parent model so that they can be tracked with it. The child model also has a `versions` method that works the same but it looks for its versions through the parent.
+
+Again see the [Logical Function Spec](https://github.com/Arcath/Wikify/blob/master/spec/logical_function_spec.rb)  for examples of this code in action.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/wikify/migration/USAGE

@@ -0,0 +1,5 @@
+Description
+  Generates the database table required for wikify
+  
+Usage
+  rails g wikify:migration

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

@@ -0,0 +1,11 @@
+module Wikify
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      argument :model_name, :type => :string, :default => "versions"
+      
+      def generate_migration
+        generate "migration", "create_wikify_#{model_name}", "resource_id:integer", "resource_type", "data:text", "event", "linked_child_resource_type", "linked_child_resource_id:integer", "linked_child:boolean", "comitter_id:integer", "created_at:datetime", "updated_at:datetime"
+      end
+    end
+  end
+end

data/lib/wikify.rb

@@ -0,0 +1,58 @@
+# Version Number
+require "wikify/version_number"
+
+# System
+require 'ostruct' #Required for ruby 1.9.3
+
+# Gems
+require 'active_record'
+require 'active_support'
+
+# Internal Requires
+require "wikify/child_methods"
+require "wikify/controller"
+require "wikify/methods"
+require "wikify/model"
+require "wikify/version_concern"
+require "wikify/version"
+
+# Wikify
+#
+# Model Versioning for ActiveRecord
+module Wikify
+  # Searches the version table for destroy events, takes an optional id when you know exactly what you are looking for.
+  #
+  #    Wikify.destroyed_versions(Model, 10)
+  def self.destroyed_versions(model, id = nil)
+    hash =  {"#{model.wikify_options[:assoc_as]}_type".to_sym => model.to_s, event: "destroy"}
+    hash["#{model.wikify_options[:assoc_as]}_id".to_sym] = id if id
+    model.wikify_options[:assoc_model].constantize.where(hash)
+  end
+  
+  # Stores the current users id within the current thread (lets us get it from the controller)
+  def self.set_user_id(id)
+    thread_store.user_id = id
+  end
+  
+  # Returns the stored id
+  def self.user_id
+    thread_store.user_id
+  end
+  
+  private
+  
+  def self.thread_store
+    Thread.current[:wikify_store] ||= OpenStruct.new({user_id: nil})
+  end
+end
+
+
+ActiveSupport.on_load(:active_record) do
+  include Wikify::Model
+end
+
+if defined?(ActionController)
+  ActiveSupport.on_load(:action_controller) do
+    include Wikify::Controller
+  end
+end

data/lib/wikify/child_methods.rb

@@ -0,0 +1,38 @@
+module Wikify
+  # Methods included by child models
+  module ChildMethods
+    # Records an update operation against the parent
+    def wikify_update
+      new_version = new_version_instance
+      new_version.data = @wikify_cached_object
+      new_version.event = "child" + (@wikify_override[:event] || "update")
+      new_version.save
+    end
+    
+    # Records a create operation against the parent
+    def wikify_create
+      new_version = new_version_instance
+      new_version.event = "child create"
+      new_version.save
+      @wikify_cached_object = self.attributes
+    end
+    
+    # Records a destroy operation against the parent
+    def wikify_destroy
+      new_version = new_version_instance
+      new_version.data = @wikify_cached_object
+      new_version.event = "child destroy"
+      new_version.save
+    end
+    
+    private
+    
+    def new_version_instance
+      self.send(wikify_parent).send(wikify_options[:assoc_name]).new({linked_child: true, linked_child_resource_type: self.class.to_s, linked_child_resource_id: self.id})
+    end
+    
+    def wikify_search_hash
+      {"linked_child_#{wikify_options[:assoc_as]}_id".to_sym => self.id, "linked_child_#{wikify_options[:assoc_as]}_type".to_sym => self.class.to_s, "linked_child" => true}
+    end
+  end
+end

data/lib/wikify/controller.rb

@@ -0,0 +1,23 @@
+module Wikify
+  
+  # Used to extend ActionController with the required methods
+  module Controller
+    
+    # Adds the before filter trigger to ActionController (aka your ApplicationController)
+    def self.included(base)
+      if defined?(ActionController) && (base == ActionController::Base || base == ActionController::API)
+        base.before_filter :set_wikify_user
+      end
+    end
+    
+    # Default method for finding the current user
+    def current_user_wikify
+      current_user if defined?(current_user)
+    end
+    
+    # The before filter method that stores the user id in Wikify
+    def set_wikify_user
+      Wikify.set_user_id(current_user_wikify.id) if current_user_wikify != nil
+    end
+  end
+end

data/lib/wikify/methods.rb

@@ -0,0 +1,39 @@
+module Wikify
+  # Methods that get included on models using wikify
+  module Methods
+    # The Wikify update operation
+    #
+    # Creates a new version, records the cached object and saves it as an update
+    def wikify_update
+      new_version = self.send(wikify_options[:assoc_name]).new
+      new_version.data = @wikify_cached_object
+      new_version.event = (@wikify_override[:event] || "update")
+      new_version.save
+    end
+    
+    # The Wikify create operation
+    #
+    # Creates a new version with no data and sets the event to create
+    def wikify_create
+      new_version = self.send(wikify_options[:assoc_name]).new
+      new_version.event = "create"
+      new_version.save
+      @wikify_cached_object = self.attributes
+    end
+    
+    # The Wikify destroy operation
+    #
+    # Creates a new version recods the cached object and saves it as a destroy
+    def wikify_destroy
+      new_version = self.send(wikify_options[:assoc_name]).new
+      new_version.data = @wikify_cached_object
+      new_version.event = "destroy"
+      new_version.save
+    end
+    
+    # The hash used to find versions
+    def wikify_search_hash
+      {"#{wikify_options[:assoc_as]}_id".to_sym => self.id, "#{wikify_options[:assoc_as]}_type".to_sym => self.class.to_s}
+    end
+  end
+end

data/lib/wikify/model.rb

@@ -0,0 +1,74 @@
+module Wikify
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    # Caches the model
+    #
+    # Called using the `after_find` callback in ActiveRecord
+    def wikify_cache
+      @wikify_override = {}
+      @wikify_cached_object = self.attributes
+    end
+    
+    # Allows you override the wikify options for this event
+    def wikify_override(options)
+      @wikify_override = options
+    end
+    
+    def version_at(time)
+      self.versions.where("created_at < ?", time).limit(1).first.next
+    end
+    
+    module ClassMethods
+      # Enables the wikify functionality on the model
+      #
+      # Takes a hash of options:
+      #
+      # :assoc_name => :versions
+      # :assoc_as => :resource
+      # :assoc_model => "Wikify::Version"
+      #
+      def wikify(options = {})
+        # Create a class_attribute to store the wikify options hash in
+        class_attribute :wikify_options
+        
+        # Set some Defaults
+        options[:assoc_name] ||=  :versions
+        options[:assoc_as] ||= :resource
+        options[:assoc_model] ||= "Wikify::Version"
+        options[:no_include] ||= false
+        
+        # Store the Options Hash
+        self.wikify_options = options.dup
+        
+        # Register the Callbacks
+        after_find :wikify_cache
+        after_create :wikify_create
+        after_update :wikify_update
+        after_destroy :wikify_destroy
+
+        # Allow reading of the cached object
+        attr_reader :wikify_cached_object
+        
+        # Define a method to access the versions
+        define_method(wikify_options[:assoc_name]){
+          wikify_options[:assoc_model].constantize.where(wikify_search_hash)
+        }
+                
+        include Wikify::Methods unless options[:no_include]
+      end
+      
+      # Takes the same options as wikify
+      def wikify_on_parent(parent, options = {})
+        wikify(options.merge({no_include: true}))
+        
+        class_attribute :wikify_parent
+        self.wikify_parent = parent
+        
+        include Wikify::ChildMethods
+      end
+    end
+  end
+end

data/lib/wikify/version.rb

@@ -0,0 +1,6 @@
+module Wikify
+  class Version < ActiveRecord::Base
+    self.table_name_prefix = 'wikify_'
+    include Wikify::VersionConcern
+  end
+end

data/lib/wikify/version_concern.rb

@@ -0,0 +1,62 @@
+module Wikify
+  module VersionConcern
+    extend ActiveSupport::Concern
+    
+    included do
+      serialize :data, Hash
+      
+      before_save :record_comitter
+    end
+    
+    def object
+      OpenStruct.new(data)
+    end
+    
+    def previous
+      self.class.where("created_at < ?", self.created_at).limit(1).first
+    end
+    
+    def next
+      results = self.class.where("created_at > ?", self.created_at).limit(1)
+      return results.first if results != []
+      return self.restore_to
+    end
+    
+    # Finds the model/instance to restore to and then over writes all its data.
+    #
+    # Also over rides the version event to restore so you can tell the difference between a restore and an update in your history.
+    def restore
+      unless event == "destroy"
+        target = restore_to
+        target.attributes = self.data
+        target.wikify_override({event: "restore"})
+        target.save
+      else
+        target = resource_type.constantize.new
+        target.attributes = self.data
+        target.wikify_override({event: "restore"})
+        target.save
+      end
+    end
+    
+    # Finds the model to restore type
+    def restore_to
+      restore_type.constantize.find(restore_id)
+    end
+    
+    def restore_type
+      return self.send(self.attributes.keys.select {|i| i =~ /_type/ }.first.to_sym) unless self.linked_child == true
+      return self.send(self.attributes.keys.select {|i| i =~ /linked_child_.*?_type/ }.first.to_sym)
+    end
+    
+    def restore_id
+      return self.send(self.attributes.keys.select {|i| i =~ /_id/ }.first.to_sym) unless self.linked_child == true
+      return self.send(self.attributes.keys.select {|i| i =~ /linked_child_.*?_id/ }.first.to_sym)
+    end
+    
+    # Gets the comitter from the Wikify thread store
+    def record_comitter
+      self.comitter_id = Wikify.user_id if Wikify.user_id != nil
+    end
+  end
+end

data/lib/wikify/version_number.rb

@@ -0,0 +1,4 @@
+module Wikify
+  # Wikify's version number
+  VersionNumber = "0.0.1.pre"
+end

data/spec/children_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Child do
+  it "should have the wikify methods" do
+    Child._create_callbacks.length.should eq 1
+    Child._update_callbacks.length.should eq 1
+    Child._destroy_callbacks.length.should eq 1
+  end
+  
+  it "should have the callback methods" do
+    child = Parent.last.children.new
+    child.methods.include?(:wikify_cache).should be_true
+    child.methods.include?(:wikify_update).should be_true
+    child.methods.include?(:wikify_create).should be_true
+    child.methods.include?(:wikify_destroy).should be_true
+  end
+  
+  it "should write its updates to the parent" do
+    parent = Parent.new({name: "Parent 100"})
+    parent.save
+    
+    parent.versions.count.should eq 1
+    
+    child = parent.children.new({name: "Child 1"})
+    child.save
+    
+    parent.versions.count.should eq 2
+    parent.versions.last.event.should eq "child create"
+  end
+  
+  it "should record updates to the parent" do
+    child = Child.find_by_name("Child 1")
+    
+    child.parent.versions.count.should eq 2
+    
+    child.name = "Child 1 Updated"
+    child.save
+    
+    child.parent.versions.count.should eq 3
+  end
+  
+  it "Should set the restore to values" do
+    child = Child.find_by_name("Child 1 Updated")
+    
+    child.versions.last.restore_type.should eq "Child"
+    child.versions.last.restore_id.should eq child.id
+  end
+  
+  it "should restore a version do" do
+    child = Child.find_by_name("Child 1 Updated")
+    child.versions.last.restore
+    
+    child = Child.find(child.id)
+    
+    child.name.should eq "Child 1"
+  end
+  
+  it "should create an event on destroy" do
+    child = Child.find_by_name("Child 1")
+    parent = child.parent
+    
+    c = parent.versions.count
+    
+    child.destroy
+    
+    parent.versions.count.should eq c + 1
+    parent.versions.last.event.should eq "child destroy"
+  end
+end

data/spec/comitter_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "User id storing" do
+  it "should only be for that thread" do
+    Wikify.user_id.should be_nil
+    Thread.new do
+      Wikify.set_user_id = 1
+      Wikify.user_id.should eq 1
+    end
+    Wikify.user_id.should be_nil
+  end
+  
+  it "should get set by the controller" do
+    parent = Parent.new({name: "Committer 1"})
+    parent.save
+    parent
+    controller = Controller.new
+    controller.request # See this method for what it does
+    parent = Parent.find_by_name("Committer 1 Updated")
+    parent.versions.count.should eq 2
+    parent.versions.last.comitter_id.should eq 1
+  end
+  
+  it "should handle the current_user return being nil" do
+    lambda { controller = NilController.new }.should_not raise_exception
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "With custom config" do
+  it "should set the assosiation name" do
+    doc = Document.new
+    doc.revisions.count.should eq 0
+  end
+  
+  it "should record a version for create/update" do
+    Document.create!({title: "Foo"})
+    doc = Document.find_by_title("Foo")
+    doc.title = "Bar"
+    doc.save
+    
+    doc.revisions.count.should eq 2
+  end
+  
+  it "should let you restore a version" do
+    doc = Document.find_by_title("Bar")
+    doc.revisions.last.restore
+    
+    doc = Document.find_by_title("Foo")
+    doc.title.should eq "Foo"
+  end
+end

data/spec/create_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe "Model create" do
+  it "should record a create event" do
+    parent = Parent.new({name: "First Create Test"})
+    parent.save
+    
+    parent.versions.count.should eq 1
+    parent.versions.last.event.should eq "create"
+  end
+end

data/spec/destroy_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "Model Destroy" do
+  it "should record a destroy" do
+    Wikify.destroyed_versions(Parent).count.should eq 0
+    
+    parent = Parent.new({name: "First Destory Test"})
+    parent.save
+    
+    parent.destroy
+    
+    Wikify.destroyed_versions(Parent).count.should eq 1
+    
+    old_version = Wikify.destroyed_versions(Parent).last
+    old_version.data.should eq parent.attributes
+  end
+end

data/spec/included_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Parent do
+  it "Should have the wikify method" do
+    Parent._create_callbacks.length.should eq 2
+    Parent._update_callbacks.length.should eq 2
+    Parent._destroy_callbacks.length.should eq 1
+  end
+  
+  it "should have the callback methods" do
+    parent = Parent.new
+    parent.methods.include?(:wikify_cache).should be_true
+    parent.methods.include?(:wikify_update).should be_true
+    parent.methods.include?(:wikify_create).should be_true
+    parent.methods.include?(:wikify_destroy).should be_true
+  end
+  
+  it "should have the relationship with versions" do
+    parent = Parent.new
+    parent.versions.count.should eq 0
+  end
+end

data/spec/logical_function_spec.rb

@@ -0,0 +1,77 @@
+# This is a worked example that appears in the readme except with shoulds to make sure that it works as planned
+require 'spec_helper'
+
+describe "Working logically" do
+  it "should behave like we expect" do
+    # First lets create a new object
+    parent = Parent.new
+    parent.name = "david" # Lets set the name
+    parent.save # And save that record
+    
+    parent_id = parent.id # We will need this later
+    
+    parent.versions.count.should eq 1 # We should now have 1 version
+    parent.versions.first.event.should eq "create" # that was created when we created the record
+    parent.versions.first.data.should eq Hash.new # and has an empty hash for its data
+    
+    # Its a new day and we want to change "david" to "David"
+    david = Parent.find(parent_id)
+    david.name = "David"
+    david.save
+    
+    david.versions.count.should eq 2 # We should now have a new version
+    david.versions.last.event.should eq "update" # that was an update
+    david.versions.last.data["name"].should eq "david" # and has the old name in the data hash
+    
+    # Its another day and we make another change
+    david = Parent.find(parent_id)
+    david.name = "Dav1d"
+    david.save
+    
+    david.versions.count.should eq 3 # We should now have a new version
+    david.versions.last.event.should eq "update" # that was an update
+    david.versions.last.data["name"].should eq "David" # and has the old name in the data hash
+    
+    # Its another day and we want to restore the version with David
+    david = Parent.find(parent_id)
+    david.versions.last.restore # Restore the last version
+    
+    david = Parent.find(parent_id)
+    david.versions.count.should eq 4 # We should now have a new version
+    david.versions.last.event.should eq "restore" # that was an update
+    david.versions.last.data["name"].should eq "Dav1d" # and has the old name in the data hash
+    david.name.should eq "David" # The name should have been restored
+    
+    # David has died so its time to delete his record
+    david = Parent.find(parent_id)
+    david.destroy
+    
+    # Whoops he wasn't dead just resting his heart time to restore his record
+    david_version = Wikify.destroyed_versions(Parent, parent_id).last
+    david_version.event.should eq "destroy" # The last thing to happen to david should be destroy
+    david_version.restore
+    
+    david = Parent.find(parent_id)
+    david.name.should eq "David" # And now hes back! and at the same ID as before!
+    
+    # David has now had a child (Like Arnie did in Junior)
+    david = Parent.find(parent_id)
+    
+    david.versions.count.should eq 6 # David should have 6 versions at this point
+    
+    jeff = david.children.new({name: "Jeff"})
+    jeff.save
+    
+    david.versions.count.should eq 7 # Now that Jeff has been saved David should have 7 versions
+    
+    # Turns out Jeff is a girl, name change needed
+    jeff = Child.find_by_name("Jeff")
+    jeff.name = "Jasmine"
+    jeff.save
+    
+    jeff.parent.versions.count.should eq 8 # That change should be recorded in the parent
+    
+    jeff.versions.count.should eq 2 # Children's versions search the parent for versions related to them.
+    
+  end
+end

data/spec/models/child.rb

@@ -0,0 +1,5 @@
+class Child < ActiveRecord::Base
+  belongs_to :parent
+  
+  wikify_on_parent :parent
+end

data/spec/models/document.rb

@@ -0,0 +1,5 @@
+class Document < ActiveRecord::Base
+  wikify({:assoc_name => :revisions,
+      :assoc_as => :thing,
+      assoc_model: "Revision"})
+end

data/spec/models/parent.rb

@@ -0,0 +1,5 @@
+class Parent < ActiveRecord::Base
+  wikify
+  
+  has_many :children
+end

data/spec/models/revision.rb

@@ -0,0 +1,3 @@
+class Revision < ActiveRecord::Base
+  include Wikify::VersionConcern
+end

data/spec/restore_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "Restoring a Model" do
+  it "should have a model to restore to" do
+    parent = Parent.new({name: "First Restore Test"})
+    parent.save
+    
+    parent.versions.last.restore_to.should eq parent
+  end
+  
+  it "should restore a model" do
+    parent = Parent.find_by_name("First Restore Test")
+    parent.name = "Updated Restore Test"
+    
+    parent.versions.last.restore
+    Parent.find(parent.id).name.should eq "First Restore Test"
+  end
+  
+  it "after a restore the last versions action should be restored" do
+    parent = Parent.find_by_name("First Restore Test")
+    parent.name = "Updated Restore Test"
+    
+    parent.versions.last.restore
+    Parent.find(parent.id).versions.last.event.should eq "restore"
+  end
+  
+  it "should restore a deleted version" do
+    parent = Parent.find_by_name("First Restore Test")
+    parent.destroy
+    parent_id = parent.id
+
+    version = Wikify.destroyed_versions(Parent).last
+    version.restore
+    
+    parent = Parent.find_by_name("First Restore Test")
+    parent.name.should eq "First Restore Test"
+    parent.id.should eq parent_id
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter "spec"
+end
+
+# Controller
+require 'support/controller'
+
+# Require Gem
+require 'wikify'
+
+ActionController::Base.load
+
+# Require Models
+require 'models/parent'
+require 'models/document'
+require 'models/revision'
+require 'models/child'
+
+# Configure Active Record
+require 'sqlite3'
+require 'support/database'

data/spec/support/controller.rb

@@ -0,0 +1,45 @@
+module ActionController
+  API = true
+  
+  class Base
+    def self.load
+      ActiveSupport.run_load_hooks(:action_controller, self)
+    end
+    
+    def self.before_filter(sym)
+      true
+    end
+  end
+end
+
+class Controller < ActionController::Base
+  def initialize
+    set_wikify_user
+  end
+  
+  def current_user
+    OpenStruct.new({id: 1})
+  end
+  
+  def request
+    parent = Parent.find_by_name("Committer 1")
+    parent.name = "Committer 1 Updated"
+    parent.save
+  end
+end
+
+class NilController < ActionController::Base
+  def initialize
+    set_wikify_user
+  end
+  
+  def current_user
+    nil
+  end
+  
+  def request
+    parent = Parent.find_by_name("Committer 1")
+    parent.name = "Committer 1 Updated"
+    parent.save
+  end
+end

data/spec/support/database.rb

@@ -0,0 +1,73 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+puts "---------------"
+puts "Database Creation"
+puts "---------------"
+
+ActiveRecord::Schema.define do
+  create_table :parents do |table|
+    table.column :name, :string
+    
+    table.timestamps
+  end
+  
+  create_table :children do |table|
+    table.column :name, :string
+    table.column :parent_id, :integer
+    
+    table.timestamps
+  end
+  
+  create_table :wikify_versions do |table|
+    table.column :resource_id, :integer
+    table.column :resource_type, :string
+    table.column :data, :text
+    table.column :linked_child_resource_type, :string
+    table.column :linked_child_resource_id, :integer
+    table.column :linked_child, :boolean, default: false
+    table.column :event, :string
+    table.column :comitter_id, :integer
+    
+    table.timestamps
+  end
+  
+  create_table :revisions do |table|
+    table.column :thing_id, :integer
+    table.column :thing_type, :string
+    table.column :linked_child_thing_id, :integer
+    table.column :linked_child_thing_type, :string
+    table.column :linked_child, :boolean, default: false
+    table.column :data, :text
+    table.column :event, :string
+    table.column :comitter_id, :integer
+    
+    table.timestamps
+  end
+  
+  create_table :documents do |table|
+    table.column :title, :string
+    
+    table.timestamps
+  end
+end
+
+puts "---------------"
+puts "Begin Tests"
+puts "---------------"
+
+describe "The Database" do
+  it "should be empty" do
+    Parent.all.count.should eq 0
+    Child.all.count.should eq 0
+  end
+  
+  it "should work" do
+    parent = Parent.new
+    parent.name = "Hello World"
+    parent.save
+    Parent.last.name.should eq "Hello World"
+  end
+end

data/spec/update_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "Model Update" do
+  it "should create a version on update and set the event to :update" do
+    parent = Parent.new({name: "First Update Test"})
+    parent.save
+    
+    ffound = Parent.find_by_name("First Update Test")
+    ffound.name = "Updated First Update Test"
+    ffound.save
+    
+    sfound = Parent.find_by_name("Updated First Update Test")
+    sfound.versions.count.should eq 2
+    sfound.versions.last.data["name"].should eq "First Update Test"
+    sfound.versions.last.event.should eq "update"
+  end
+  
+  it "should create a second version after the first" do
+    ffound = Parent.find_by_name("Updated First Update Test")
+    ffound.name = "Second Update Test"
+    ffound.save
+    
+    sfound = Parent.find_by_name("Second Update Test")
+    sfound.versions.count.should eq 3
+    sfound.versions[1].data["name"].should eq "First Update Test"
+    sfound.versions.last.data["name"].should eq "Updated First Update Test"
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Wikify::Version do
+  it "should create a struct for your data" do
+    version = Wikify::Version.last
+    version.object.should be_a OpenStruct
+  end
+  
+  it "should have a link to the previous version" do
+    version = Wikify::Version.last
+    version.previous.should be_a Wikify::Version
+  end
+  
+  it "should have a link to the next version" do
+    version = Wikify::Version.last
+    prev = version.previous
+    prev.next.should be_a Wikify::Version
+  end
+  
+  it "should return the current model for next if it is the latest version" do
+    version = Wikify::Version.last
+    version.next.should be_a version.restore_type.constantize
+  end
+  
+  it "should find the version at a specified time" do
+    parent = Parent.new({name: 'Time Test'})
+    parent.save
+    sleep 3
+    parent = Parent.find(parent.id)
+    parent.name = "Time Test 1"
+    parent.save
+    sleep 1
+    version = parent.version_at(Time.now - 3)
+    version.should be_a Wikify::Version
+    version.object.name.should eq "Time Test"
+  end
+end

data/wikify.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wikify/version_number'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wikify"
+  spec.version       = Wikify::VersionNumber
+  spec.authors       = ["Adam Laycock"]
+  spec.email         = ["adam@arcath.net"]
+  spec.description   = %q{Active Record Model history/versioning with restore functionality.}
+  spec.summary       = %q{Active Record Model history/versioning with restore functionality.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: wikify
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Adam Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Active Record Model history/versioning with restore functionality.
+email:
+- adam@arcath.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/wikify/migration/USAGE
+- lib/generators/wikify/migration/migration_generator.rb
+- lib/wikify.rb
+- lib/wikify/child_methods.rb
+- lib/wikify/controller.rb
+- lib/wikify/methods.rb
+- lib/wikify/model.rb
+- lib/wikify/version.rb
+- lib/wikify/version_concern.rb
+- lib/wikify/version_number.rb
+- spec/children_spec.rb
+- spec/comitter_spec.rb
+- spec/config_spec.rb
+- spec/create_spec.rb
+- spec/destroy_spec.rb
+- spec/included_spec.rb
+- spec/logical_function_spec.rb
+- spec/models/child.rb
+- spec/models/document.rb
+- spec/models/parent.rb
+- spec/models/revision.rb
+- spec/restore_spec.rb
+- spec/spec_helper.rb
+- spec/support/controller.rb
+- spec/support/database.rb
+- spec/update_spec.rb
+- spec/version_spec.rb
+- wikify.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Active Record Model history/versioning with restore functionality.
+test_files:
+- spec/children_spec.rb
+- spec/comitter_spec.rb
+- spec/config_spec.rb
+- spec/create_spec.rb
+- spec/destroy_spec.rb
+- spec/included_spec.rb
+- spec/logical_function_spec.rb
+- spec/models/child.rb
+- spec/models/document.rb
+- spec/models/parent.rb
+- spec/models/revision.rb
+- spec/restore_spec.rb
+- spec/spec_helper.rb
+- spec/support/controller.rb
+- spec/support/database.rb
+- spec/update_spec.rb
+- spec/version_spec.rb
+has_rdoc: