revisions 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rajkumar
+
+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,103 @@
+= revisions
+
+Revisions provides a simple, wordpress-like, interface for tracking revisions to a model within a single table. It's a bit rudimentary now, but I hope to add to it as necessary.
+
+The basics:
+* Stores drafts, published items, and revisions
+* 
+
+== INSTALLATION
+
+	sudo gem install revisions --source http://gemcutter.org
+
+then add to environment.rb
+	
+	config.gem 'revisions', :source => 'http://gemcutter.org'
+
+
+== USAGE
+
+The gem is a bit rigid at the moment, so you'll need to setup two columns for it to use:
+
+	t.string 	:status			# draft, published, revision	
+	t.integer 	:revision_of	# Foreign Key that tracks what a model is revising.
+
+You may also want to index these fields.
+
+Once your models are setup, need to declare revisions within any model you intend to track. ie.
+
+	class Response < ActiveRecord::Base
+		has_revisions
+	end
+
+You can also declare variables that you DON'T want to track (like a slug that has to be unique on the table, publication date, etc.)
+
+	class Response < ActiveRecord::Base
+		has_revisions :ignore => ['published_at', 'slug']
+	end
+
+In addition to the variables you declare, revisions will ignore the status, id, revision_of, and created_at fields.
+
+Now you're all set to save and apply revisions. Revisions exposes three methods: latest_revision, pending_revisions?, save_revision and apply_revision.
+
+latest_revision:
+* returns the latest revision
+
+pending_revisions:
+* returns true if there are revisions with a more recent updated_at than the model.
+
+save_revision:
+* If your model is a draft, it simply saves the model.
+* If your model is published, it saves a revision (does not modify the core model)
+* OG model doesn't change, so all associations are intact
+* Behaves like standard ActiveRecord save (ie. returns true/false if it saves succesfully and creates an errors array if not)
+* can be called with bang (save_revision!) to throw an exception if it doesn't save.
+
+apply_revision
+* If called without params, maps the latest revision onto the model, but DOES NOT SAVE.
+* If called with a revision, maps that revision, but doesn't save
+* if called with bang (apply_revision!), maps a revision AND saves
+
+How about some examples.
+
+Saving a Revision:
+
+	response = Response.create({:title => 'donkey', :status => 'published'})
+	response.title = 'monkey'
+	response.save_revision						# => true
+	response.revisions.size						# => 1
+	response.pending_revision?					# => true
+
+save_revision doesn't affect the original response
+
+	response.reload
+	revision = response.latest_revision		# => new response object.
+	response.title									# => 'donkey'
+	revision.title									# => 'monkey'
+
+apply_revision will affect the original response
+
+	response.apply_revision						# => true
+	response.title									# => 'monkey'
+
+
+
+==Final Suggestion
+
+Since revisions all live within the same table, you probably want to setup a default scope on your model so you don't access revisions directly.
+
+	default_scope :conditions => "status <> 'revision'"
+
+
+== LIMITATIONS
+
+There are a few things on the to-do list, among them:
+
+* There's no way to prune revisions yet. But that's coming ASAP.
+* Revisions assumes your model uses a standard rails Table Name (ie Response => Responses)
+* Revisions requires the status and revision_of columns (for now) 
+
+
+==Author
+	
+Brian Hamman, hamman+github [ @ ] gmail.com

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "revisions"
+    gem.summary = %Q{A lightweight way to handle Wordpress-like revisions}
+    gem.description = %Q{Save and apply revisions to a model, while keeping track of old revisiions}
+    gem.email = "hamman@gmail.com"
+    gem.homepage = "http://github.com/hamman/revisions"
+    gem.authors = ["Brian Hamman"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "revisions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/revisions.rb

@@ -0,0 +1,96 @@
+module Revisions
+  module ClassMethods
+  
+    STATUSES = ['draft', 'published', 'revision']
+      
+    def has_revisions opts={}
+      class_inheritable_accessor :unrevised_attributes
+      
+      has_many :revisions,  
+        :class_name => self.name, 
+        :conditions => "status='revision'",
+        :foreign_key => 'revision_of'
+      
+      include InstanceMethods
+      
+      self.unrevised_attributes = opts[:ignore] || []
+      self.unrevised_attributes.concat ['revision_of', 'status', 'created_at']
+    end
+  
+  end
+  module InstanceMethods
+    
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    def published?
+      status == 'published'
+    end
+
+    def revision?
+      status == 'revision'
+    end
+    
+    def draft?
+      status == 'draft'
+    end
+
+    def save_revision
+      if self.published?
+        new_copy = self.clone
+        attributes_to_nil = {}
+        self.unrevised_attributes.each {|a| attributes_to_nil[a] = nil }
+        new_copy.attributes=attributes_to_nil
+        new_copy.created_at = new_copy.updated_at = Time.zone.now
+        new_copy.status = 'revision'
+        new_copy.revision_of = self.id
+        if new_copy.save
+          true
+        else
+          new_copy.errors.each {|attribute,message| self.errors.add(attribute,message)} 
+          false
+        end
+      else
+        save
+      end     
+    end
+
+    def save_revision!
+      save_revision || raise(ActiveRecord::RecordNotSaved)
+    end
+
+    def latest_revision
+      revisions.last
+    end
+
+    def pending_revisions?
+      !latest_revision.nil? && latest_revision.updated_at > self.updated_at
+    end
+
+    # maps a revision's changes onto the main object
+    def apply_revision(revision=nil)
+      revision = latest_revision if revision.nil?
+      unless revision.nil?
+        revised_attributes = revision.attributes.reject {|k,v| self.unrevised_attributes.include?(k) || k == 'id'}
+        self.attributes=revised_attributes
+        return true
+      end
+      false
+    end
+
+    def apply_revision!(revision=nil)
+      if apply_revision(revision)
+        save!
+      else
+        raise RuntimeError.new("No revision to apply!")
+      end
+    end    
+      
+  end
+end
+
+
+if defined?(ActiveRecord)
+  ActiveRecord::Base.instance_eval { extend Revisions::ClassMethods }
+end

data/revisions.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{revisions}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Hamman"]
+  s.date = %q{2010-04-29}
+  s.description = %q{Save and apply revisions to a model, while keeping track of old revisiions}
+  s.email = %q{hamman@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/revisions.rb",
+     "revisions.gemspec",
+     "test/helper.rb",
+     "test/models.rb",
+     "test/schema.rb",
+     "test/test_revisions.rb"
+  ]
+  s.homepage = %q{http://github.com/hamman/revisions}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A lightweight way to handle Wordpress-like revisions}
+  s.test_files = [
+    "test/helper.rb",
+     "test/models.rb",
+     "test/schema.rb",
+     "test/test_revisions.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
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+class Test::Unit::TestCase
+end
+
+
+# You can use "rake test AR_VERSION=2.0.5" to test against 2.0.5, for example.
+# The default is to use the latest installed ActiveRecord.
+if ENV["AR_VERSION"]
+  gem 'activerecord', "#{ENV["AR_VERSION"]}"
+  gem 'activesupport', "#{ENV["AR_VERSION"]}"
+  gem 'iridesco-time-warp', :lib => 'time_warp', :source => "http://gems.github.com"
+end
+
+require 'active_record'
+require 'active_support'
+require 'time_warp'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'revisions'
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+silence_stream(STDOUT) do
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+
+require 'models'

data/test/models.rb

@@ -0,0 +1,4 @@
+class Response < ActiveRecord::Base
+  validates_presence_of :title
+  has_revisions :ignore => ['slug']
+end

data/test/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 1) do 
+  create_table "responses", :force => true do |t|
+    t.text     "body"
+    t.string   "title"
+    t.string   "slug"
+    t.string   "intro"
+    t.datetime "published_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "status"
+    t.integer  "revision_of"
+  end
+end

data/test/test_revisions.rb

@@ -0,0 +1,203 @@
+require 'helper'
+
+class TestRevisions < Test::Unit::TestCase 
+  
+  Time.zone = 'Eastern Time (US & Canada)'
+  
+  
+  context "a response" do
+  
+    setup do
+      @response = Response.create({
+        :title  => "This is a post about Donkey",
+        :slug   => "this-is-a-post-about-donkey",
+        :body   => "This is the body of Donkey",
+      })
+    end
+        
+    context "When saving with revisions" do
+      
+      setup do
+        @response.status = 'published'
+        @response.intro = "donkey intro"
+        pretend_now_is(5.minutes.from_now) do
+          assert @response.save_revision
+          @revision = @response.latest_revision
+        end
+      end
+      
+      should "just save to the same record when in draft mode" do
+        @response.revisions.delete_all
+        @response.status = 'draft'
+        assert @response.save_revision
+        assert_equal 0, @response.revisions.size
+      end
+    
+      should "save a revision that copies all fields" do
+        assert_equal @revision.title, @response.title
+        assert_equal @revision.body, @response.body
+      end
+      
+      should "set more updated timestamps" do
+        assert @revision.created_at > @response.created_at
+        assert @revision.updated_at > @response.updated_at
+      end
+      
+      should "say it's a revision of the first guy" do
+        assert @revision.revision_of = @response.id
+      end
+      
+      should "set the status to revision" do
+        assert_equal 'revision', @revision.status
+      end
+
+      should "copy attributes not yet saved to the DB" do
+        @response.reload
+        assert_equal "donkey intro", @revision.intro
+        assert_not_equal @revision.intro, @response.intro
+      end
+      
+      should "not copy ignored attributes" do
+        assert_not_equal @revision.slug, @response.slug
+      end
+      
+      should "return true when it saves" do
+        assert @response.save_revision
+      end
+      
+      should "return false when it doesn't save" do
+        @response.title = nil
+        assert_equal false, @response.save_revision
+      end
+      
+      should "attach errors to the base object if a revision save fails" do
+        @response.title = nil
+        @response.save_revision
+        assert_equal "can't be blank", @response.errors.on(:title)
+      end
+      
+      should "return true when it saves!" do
+        assert @response.save_revision!
+      end
+      
+      should "raise an exception when it saves! and has bad data" do
+        assert_raises ActiveRecord::RecordNotSaved do
+          @response.title = nil
+          @response.save_revision!          
+        end
+      end
+                 
+    end
+    
+    context "when accessing revisions" do
+      
+      should "return null if there aren't revisions" do
+        assert_equal nil, @response.latest_revision
+      end
+      
+      should "show if there are no pending revisions if none exist" do
+        assert_equal false, @response.pending_revisions?
+      end
+      
+      context "with a revision" do
+        setup do
+          @response.status = 'published'
+          pretend_now_is(5.minutes.from_now) do
+            @response.save_revision!
+            @response.save_revision!
+          end
+        end
+        
+        should "return the revision if there is one" do
+          latest = Response.find(:first, :conditions => 'status=\'revision\'', :order => 'id DESC')
+          assert_equal latest.id, @response.latest_revision.id
+        end
+        
+        should "say there are pending revisions if there are some" do
+          assert @response.pending_revisions?
+        end
+        
+        should "say there aren't pending revisions if they are old" do
+          @response.updated_at = 2.days.from_now
+          assert_equal false, @response.pending_revisions?
+        end
+        
+        
+      end
+      
+
+      
+    end
+
+    context "when applying a revision" do
+            
+      setup do
+        @response.update_attribute(:status, 'published')
+        assert @response.save_revision
+        @revision = @response.latest_revision
+        @revision.title = "new revision title"
+        @revision.body = "new revision body"
+        @revision.slug = "new-donkey-slug"
+        @revision.save
+      end
+      
+      should "copy over parameters we want (title, body, etc.)" do
+        assert @response.apply_revision
+        assert_equal @revision.title, @response.title
+        assert_equal @revision.body, @response.body
+      end
+      
+      should "do nothing (ie not raise an exception)" do
+        @response.revisions.delete_all
+        assert_equal false, @response.apply_revision
+      end
+      
+      should "not copy over parameters we want to keep (slug, status, revision_of, etc.)" do
+        @response.apply_revision
+        assert_equal 'published', @response.status
+        assert_equal nil, @response.revision_of
+        assert_not_equal @response.slug, @revision.slug
+      end
+      
+      should "not save the response" do
+        @response.apply_revision
+        @response.reload
+        assert_not_equal @revision.title, @response.title
+      end
+      
+      should "save the response when using bang" do
+        @response.apply_revision!
+        @response.reload
+        assert_equal @revision.title, @response.title
+        assert_equal 'published', @response.status
+        assert_equal "this-is-a-post-about-donkey", @response.slug #still keep og slug
+      end
+      
+      should "throw an exception on bang when no response" do
+        @response.revisions.delete_all
+        assert_raises RuntimeError do
+          @response.apply_revision!
+        end
+      end
+      
+      context "with multiple revisions" do
+        setup do
+          @response.save_revision
+          @newer_revision = @response.latest_revision
+          @newer_revision.update_attribute(:title, 'even newer title')
+        end
+
+        should "copy over the latest revision if nothing passed" do
+          @response.apply_revision
+          assert_equal @newer_revision.title, @response.title
+        end
+
+        should "use a selected revision if passed" do
+          @response.apply_revision(@revision)
+          assert_equal @revision.title, @response.title
+        end      
+      end
+    
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: revisions
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Brian Hamman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Save and apply revisions to a model, while keeping track of old revisiions
+email: hamman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/revisions.rb
+- revisions.gemspec
+- test/helper.rb
+- test/models.rb
+- test/schema.rb
+- test/test_revisions.rb
+has_rdoc: true
+homepage: http://github.com/hamman/revisions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A lightweight way to handle Wordpress-like revisions
+test_files: 
+- test/helper.rb
+- test/models.rb
+- test/schema.rb
+- test/test_revisions.rb