kb-acts_as_revisable 1.0.3

data/lib/acts_as_revisable/gem_spec_options.rb

@@ -0,0 +1,18 @@
+module WithoutScope #:nodoc:
+  module ActsAsRevisable
+    class GemSpecOptions
+      HASH = {
+        :name => "rich-acts_as_revisable",
+        :version => WithoutScope::ActsAsRevisable::VERSION::STRING,
+        :summary => "acts_as_revisable enables revision tracking, querying, reverting and branching of ActiveRecord models. Inspired by acts_as_versioned.",
+        :email => "rich@withoutscope.com",
+        :homepage => "http://github.com/rich/acts_as_revisable",
+        :has_rdoc => true,
+        :authors => ["Rich Cavanaugh", "Stephen Caudill"],
+        :files => %w( LICENSE README.rdoc Rakefile ) + Dir["{spec,lib,generators,rails}/**/*"],
+        :rdoc_options => ["--main", "README.rdoc"],
+        :extra_rdoc_files => ["README.rdoc", "LICENSE"]
+      }
+    end
+  end
+end

data/lib/acts_as_revisable/options.rb

@@ -0,0 +1,22 @@
+module WithoutScope
+  module ActsAsRevisable
+    # This class provides for a flexible method of setting
+    # options and querying them. This is especially useful
+    # for giving users flexibility when using your plugin.
+    class Options
+      def initialize(*options, &block)
+        @options = options.extract_options!
+        instance_eval(&block) if block_given?
+      end
+
+      def method_missing(key, *args)
+        return (@options[key.to_s.gsub(/\?$/, '').to_sym].eql?(true)) if key.to_s.match(/\?$/)
+        if args.blank?
+          @options[key.to_sym]
+        else
+          @options[key.to_sym] = args.size == 1 ? args.first : args
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_revisable/quoted_columns.rb

@@ -0,0 +1,31 @@
+# This module is more about the pretty than anything else. This allows
+# you to use symbols for column names in a conditions hash.
+#
+#   User.find(:all, :conditions => ["? = ?", :name, "sam"])
+# 
+# Would generate:
+# 
+#   select * from users where "users"."name" = 'sam'
+# 
+# This is consistent with Rails and Ruby where symbols are used to
+# represent methods. Only a symbol matching a column name will 
+# trigger this beavior.
+module WithoutScope::QuotedColumnConditions
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+  
+  module ClassMethods
+    def quote_bound_value(value)
+      if value.is_a?(Symbol) && column_names.member?(value.to_s)
+        # code borrowed from sanitize_sql_hash_for_conditions
+        attr = value.to_s
+        table_name = quoted_table_name
+        
+        return "#{table_name}.#{connection.quote_column_name(attr)}"
+      end
+      
+      super(value)
+    end
+  end
+end

data/lib/acts_as_revisable/version.rb

@@ -0,0 +1,11 @@
+module WithoutScope #:nodoc:
+  module ActsAsRevisable
+    module VERSION #:nodoc:
+      MAJOR = 1
+      MINOR = 0
+      TINY  = 3
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/lib/acts_as_revisable.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'activesupport' unless defined? ActiveSupport
+require 'activerecord' unless defined? ActiveRecord
+
+require 'acts_as_revisable/version.rb'
+require 'acts_as_revisable/base'
+
+ActiveRecord::Base.send(:include, WithoutScope::ActsAsRevisable)

data/rails/init.rb

@@ -0,0 +1 @@
+require 'acts_as_revisable'

data/spec/associations_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WithoutScope::ActsAsRevisable do  
+  after(:each) do
+    cleanup_db
+  end
+    
+  before(:each) do
+    @project = Project.create(:name => "Rich", :notes => "this plugin's author")
+    @project.update_attribute(:name, "one")
+    @project.update_attribute(:name, "two")
+    @project.update_attribute(:name, "three")
+  end
+  
+  it "should have a pretty named association" do
+    lambda { @project.sessions }.should_not raise_error
+  end
+  
+  it "should return all the revisions" do
+    @project.revisions.size.should == 3
+  end
+end

data/spec/branch_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class Project
+  validates_presence_of :name
+end
+
+describe WithoutScope::ActsAsRevisable, "with branching" do    
+  after(:each) do
+    cleanup_db
+  end
+  
+  before(:each) do
+    @project = Project.create(:name => "Rich", :notes => "a note")
+    @project.update_attribute(:name, "Sam")
+  end
+  
+  it "should allow for branch creation" do
+    @project.should == @project.branch.branch_source
+  end
+  
+  it "should branch without saving" do
+    @project.branch.should be_new_record
+  end
+  
+  it "should branch and save" do
+    @project.branch!.should_not be_new_record
+  end
+  
+  it "should not raise an error for a valid branch" do
+    lambda { @project.branch!(:name => "A New User") }.should_not raise_error
+  end
+  
+  it "should raise an error for invalid records" do
+    lambda { @project.branch!(:name => nil) }.should raise_error
+  end
+  
+  it "should not save an invalid record" do
+    @branch = @project.branch(:name => nil)
+    @branch.save.should be_false
+    @branch.should be_new_record
+  end
+end

data/spec/deletable_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WithoutScope::ActsAsRevisable::Deletable do    
+  after(:each) do
+    cleanup_db
+  end
+  
+  before(:each) do
+    @person = Person.create(:name => "Rich", :notes => "a note")
+    @person.update_attribute(:name, "Sam")
+  end
+  
+  it "should store a revision on destroy" do
+    lambda{ @person.destroy }.should change(OldPerson, :count).from(1).to(2)
+  end
+end

data/spec/find_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WithoutScope::ActsAsRevisable do    
+  after(:each) do
+    cleanup_db
+  end
+  
+  describe "with a single revision" do
+    before(:each) do
+      @project1 = Project.create(:name => "Rich", :notes => "a note")
+      @project1.update_attribute(:name, "Sam")
+    end
+  
+    it "should just find the current revision by default" do
+      Project.find(:first).name.should == "Sam"
+    end
+    
+    it "should accept the :with_revisions options" do
+      lambda { Project.find(:all, :with_revisions => true) }.should_not raise_error
+    end
+        
+    it "should find current and revisions with the :with_revisions option" do      
+      Project.find(:all, :with_revisions => true).size.should == 2
+    end
+        
+    it "should find revisions with conditions" do
+      Project.find(:all, :conditions => {:name => "Rich"}, :with_revisions => true).should == [@project1.find_revision(:previous)]
+    end
+  end
+end

data/spec/general_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WithoutScope::ActsAsRevisable do  
+  after(:each) do
+    cleanup_db
+  end
+    
+  before(:each) do
+    @project = Project.create(:name => "Rich", :notes => "this plugin's author")
+  end
+  
+  describe "with auto-generated revision class" do
+    it "should have a revision class" do
+      Foo.revision_class.should == FooRevision
+    end
+  end
+  
+  describe "without revisions" do
+    it "should have a revision_number of zero" do
+      @project.revision_number.should be_zero
+    end
+
+    it "should be the current revision" do
+      @project.revisable_is_current.should be_true
+    end
+    
+    it "should respond to current_revision? positively" do
+      @project.current_revision?.should be_true
+    end
+    
+    it "should not have any revisions in the generic association" do
+      @project.revisions.should be_empty
+    end
+    
+    it "should not have any revisions in the pretty named association" do
+      @project.sessions.should be_empty
+    end
+  end
+  
+  describe "with revisions" do
+    before(:each) do
+      @project.update_attribute(:name, "Stephen")
+    end
+    
+    it "should have a revision_number of one" do
+      @project.revision_number.should == 1
+    end
+    
+    it "should have a single revision in the generic association" do
+      @project.revisions.size.should == 1
+    end
+    
+    it "should have a single revision in the pretty named association" do
+      @project.sessions.size.should == 1
+    end
+    
+    it "should return an instance of the revision class" do
+      @project.revisions.first.should be_an_instance_of(Session)
+    end
+    
+    it "should have the original revision's data" do
+      @project.revisions.first.name.should == "Rich"
+    end    
+  end
+  
+  describe "with excluded columns modified" do
+    before(:each) do
+      @project.update_attribute(:unimportant, "a new value")
+    end
+    
+    it "should maintain the revision_number at zero" do
+      @project.revision_number.should be_zero
+    end
+    
+    it "should not have any revisions" do
+      @project.revisions.should be_empty
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+shared_examples_for "common Options usage" do
+  it "should return a set value" do
+    @options.one.should == 1
+  end
+  
+  it "should return nil for an unset value" do
+    @options.two.should be_nil
+  end
+  
+  it "should return false for unset query option" do
+    @options.should_not be_unset_value
+  end
+  
+  it "should return true for a query option set to true" do
+    @options.should be_yes
+  end
+  
+  it "should return false for a query option set to false" do
+    @options.should_not be_no
+  end
+  
+  it "should return false for a query on a non-boolean value" do
+    @options.should_not be_one
+  end
+  
+  it "should return an array when passed one" do
+    @options.arr.should be_a_kind_of(Array)
+  end
+  
+  it "should not return an array when not passed one" do
+    @options.one.should_not be_a_kind_of(Array)
+  end
+  
+  it "should have the right number of elements in an array" do
+    @options.arr.size.should == 3
+  end
+end
+
+describe WithoutScope::ActsAsRevisable::Options do
+  describe "with hash options" do
+    before(:each) do
+      @options = WithoutScope::ActsAsRevisable::Options.new :one => 1, :yes => true, :no => false, :arr => [1,2,3]
+    end
+    
+    it_should_behave_like "common Options usage"
+  end
+  
+  describe "with block options" do
+    before(:each) do
+      @options = WithoutScope::ActsAsRevisable::Options.new do
+        one 1
+        yes true
+        arr [1,2,3]
+      end
+    end
+    
+    it_should_behave_like "common Options usage"
+  end
+  
+  describe "with both block and hash options" do
+    before(:each) do
+      @options = WithoutScope::ActsAsRevisable::Options.new(:yes => true, :arr => [1,2,3]) do
+        one 1
+      end
+    end
+    
+    it_should_behave_like "common Options usage"
+    
+    describe "the block should override the hash" do
+      before(:each) do
+        @options = WithoutScope::ActsAsRevisable::Options.new(:yes => false, :one => 10, :arr => [1,2,3,4,5]) do
+          one 1
+          yes true
+          arr [1,2,3]
+        end
+      end
+      
+      it_should_behave_like "common Options usage"      
+    end
+  end
+end

data/spec/quoted_columns_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "the quoted_columns extension" do      
+  after(:each) do
+    cleanup_db
+  end
+  
+  it "should quote symbols matching column names as columns" do
+    Project.send(:quote_bound_value, :name).should == %q{"projects"."name"}
+  end
+  
+  it "should not quote symbols that don't match column names" do
+    Project.send(:quote_bound_value, :whatever).should == "'#{:whatever.to_yaml}'"
+  end
+  
+  it "should not quote strings any differently" do
+    Project.send(:quote_bound_value, "what").should == ActiveRecord::Base.send(:quote_bound_value, "what")
+  end  
+end

data/spec/revert_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe WithoutScope::ActsAsRevisable, "with reverting" do  
+  after(:each) do
+    cleanup_db
+  end
+  
+  before(:each) do
+    @project = Project.create(:name => "Rich", :notes => "a note")
+    @project.update_attribute(:name, "Sam")
+  end
+  
+  it "should let you revert to previous versions" do
+    @project.revert_to!(:first)
+    @project.name.should == "Rich"
+  end
+  
+  it "should accept the :without_revision hash option" do
+    lambda { @project.revert_to!(:first, :without_revision => true) }.should_not raise_error
+    @project.name.should == "Rich"
+  end
+  
+  it "should support the revert_to_without_revision method" do
+    lambda { @project.revert_to_without_revision(:first).save }.should_not raise_error
+    @project.name.should == "Rich"
+  end
+  
+  it "should support the revert_to_without_revision! method" do
+    lambda { @project.revert_to_without_revision!(:first) }.should_not raise_error
+    @project.name.should == "Rich"
+  end
+  
+  it "should let you revert to previous versions without a new revision" do
+    @project.revert_to!(:first, :without_revision => true)
+    @project.revisions.size.should == 1
+  end
+  
+  it "should support the revert_to method" do
+    lambda{ @project.revert_to(:first) }.should_not raise_error
+    @project.should be_changed
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+if ENV['EDGE_RAILS_PATH']
+  edge_path = File.expand_path(ENV['EDGE_RAILS_PATH'])
+  require File.join(edge_path, 'activesupport', 'lib', 'active_support')
+  require File.join(edge_path, 'activerecord', 'lib', 'active_record')
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'acts_as_revisable'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :people do |t|
+      t.string :name, :revisable_name, :revisable_type
+      t.text :notes
+      t.boolean :revisable_is_current
+      t.integer :revisable_original_id, :revisable_branched_from_id, :revisable_number, :project_id
+      t.datetime :revisable_current_at, :revisable_revised_at, :revisable_deleted_at
+      t.timestamps
+    end
+    
+    create_table :projects do |t|
+      t.string :name, :unimportant, :revisable_name, :revisable_type
+      t.text :notes
+      t.boolean :revisable_is_current
+      t.integer :revisable_original_id, :revisable_branched_from_id, :revisable_number
+      t.datetime :revisable_current_at, :revisable_revised_at, :revisable_deleted_at
+      t.timestamps
+    end
+    
+    create_table :foos do |t|
+      t.string :name, :revisable_name, :revisable_type
+      t.text :notes
+      t.boolean :revisable_is_current
+      t.integer :revisable_original_id, :revisable_branched_from_id, :revisable_number, :project_id
+      t.datetime :revisable_current_at, :revisable_revised_at, :revisable_deleted_at
+      t.timestamps
+    end
+  end
+end
+
+setup_db
+
+def cleanup_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.execute("delete from #{table}")
+  end
+end
+
+class Person < ActiveRecord::Base
+  belongs_to :project
+  
+  acts_as_revisable do
+    revision_class_name "OldPerson"
+    on_delete :revise
+  end
+end
+
+class OldPerson < ActiveRecord::Base
+  acts_as_revision do
+    revisable_class_name "Person"
+    clone_associations :all
+  end
+end
+
+class Project < ActiveRecord::Base
+  has_many :people
+  
+  acts_as_revisable do
+    revision_class_name "Session"
+    except :unimportant
+  end
+end
+
+class Session < ActiveRecord::Base
+  acts_as_revision do
+    revisable_class_name "Project"
+    clone_associations :all
+  end
+end
+
+class Foo < ActiveRecord::Base
+  acts_as_revisable :generate_revision_class => true
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: kb-acts_as_revisable
+version: !ruby/object:Gem::Version 
+  version: 1.0.3
+platform: ruby
+authors: 
+- Rich Cavanaugh
+- Stephen Caudill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rich@withoutscope.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- spec/associations_spec.rb
+- spec/branch_spec.rb
+- spec/deletable_spec.rb
+- spec/find_spec.rb
+- spec/general_spec.rb
+- spec/options_spec.rb
+- spec/quoted_columns_spec.rb
+- spec/revert_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/acts_as_revisable
+- lib/acts_as_revisable/acts
+- lib/acts_as_revisable/acts/common.rb
+- lib/acts_as_revisable/acts/deletable.rb
+- lib/acts_as_revisable/acts/revisable.rb
+- lib/acts_as_revisable/acts/revision.rb
+- lib/acts_as_revisable/base.rb
+- lib/acts_as_revisable/gem_spec_options.rb
+- lib/acts_as_revisable/options.rb
+- lib/acts_as_revisable/quoted_columns.rb
+- lib/acts_as_revisable/version.rb
+- lib/acts_as_revisable.rb
+- generators/revisable_migration
+- generators/revisable_migration/revisable_migration_generator.rb
+- generators/revisable_migration/templates
+- generators/revisable_migration/templates/migration.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/rich/acts_as_revisable
+post_install_message: 
+rdoc_options: 
+- --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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: acts_as_revisable enables revision tracking, querying, reverting and branching of ActiveRecord models. Inspired by acts_as_versioned.
+test_files: []
+