railsgarden-has_draft 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+* [0.1.0] Initial Version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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,18 @@
+CHANGELOG
+has_draft_plugin.sqlite3
+init.rb
+install.rb
+lib/has_draft.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+tasks/has_draft_tasks.rake
+test/config/database.yml
+test/fixtures/article_drafts.yml
+test/fixtures/articles.yml
+test/has_draft_test.rb
+test/models/article.rb
+test/schema.rb
+test/test_helper.rb
+uninstall.rb

data/README.rdoc

@@ -0,0 +1,158 @@
+== Has Draft
+
+Allows for multiple "drafts" of a model which can be useful when developing:
+* Draft/Live Version of Pages, for examples
+* A workflow system whereby a live copy may need to be active while a draft copy is 
+  awaiting approval.
+
+The semantics of this as well as most of the inspiration comes from version_fu, 
+an excellent plugin for a similar purpose of maintaining several "versions" of a model.
+
+This was built to be able to be tacked on to existing models, so the data schema doesn't need to change 
+at all for the model this is applied to.  As such, drafts are actually stored in a nearly-identical table 
+and there is a has_one relationship to this.  This separation allows the base model to really be treated 
+just as before without having to apply conditions in queries to make sure you are really getting the 
+"live" (non-draft) copy: Page.all will still only return the non-draft pages.  This separate table is backed by 
+a model created on the fly as a constant on the original model class.  For example if a Page has_draft, 
+a Page::Draft class will exist as the model for the page_drafts table.
+
+== Installation
+  
+  # In environment.rb
+  config.gem 'railsgarden-has_draft', :lib => 'has_draft', :source => 'http://gems.github.com'
+
+== Basic Example
+  
+  ## First Migration (If Creating base model and drafts at the same time):
+  class InitialSchema < ActiveRecord::Migration
+  
+    [:articles, :article_drafts].each do |table_name|
+      create_table table_name, :force => true do |t|
+        t.references :article if table_name == :article_drafts
+      
+        t.string :title
+        t.text :summary
+        t.text :body
+        t.date :post_date
+      end
+    end
+    
+  end
+  
+  
+  ## Model Class
+  class Article < ActiveRecord::Base
+    has_draft
+  end
+  
+  ## Exposed Class Methods & Scopes:
+  Article.draft_class
+  => Article::Draft
+  Article.with_draft.all
+  => (Articles that have an associated draft)
+  Article.without_draft.all
+  => (Articles with no associated draft)
+  
+  
+  
+  ## Usage Examples:
+  
+  article = Article.create(
+    :title => "My Title", 
+    :summary => "Information here.",
+    :body => "Full body",
+    :post_date => Date.today
+  )
+  
+  article.has_draft?
+  => false
+  
+  article.instantiate_draft!
+  
+  article.has_draft?
+  => true
+  
+  article.draft
+  => Article::Draft Instance
+  
+  article.draft.update_attributes(
+    :title => "New Title"
+  )
+  
+  article.replace_with_draft!
+  
+  article.title
+  => "New Title"
+  
+  article.destroy_draft!
+  
+  article.has_draft?
+  => false
+  
+== Custom Options
+  
+  ## First Migration (If Creating base model and drafts at the same time):
+  class InitialSchema < ActiveRecord::Migration
+  
+    [:articles, :article_copies].each do |table_name|
+      create_table table_name, :force => true do |t|
+        t.integer :news_article_id if table_name == :article_copies
+      
+        t.string :title
+        t.text :summary
+        t.text :body
+        t.date :post_date
+      end
+    end
+    
+  end
+  
+  ## Model Class
+  class Article < ActiveRecord::Base
+    has_draft :class_name => 'Copy', :foreign_key => :news_article_id, :table_name => 'article_copies'
+  end
+
+== Method Callbacks
+
+There are three callbacks you can specify directly as methods:
+
+  class Article < ActiveRecord::Base
+    has_draft
+    
+    def before_instantiate_draft
+      # Do Something
+    end
+    
+    def before_replace_with_draft
+      # Do Something
+    end
+    
+    def before_destroy_draft
+      # Do Something
+    end
+  end
+
+
+
+== Extending the Draft Class
+
+Because you don't directly define the draft class, you can specify a block of code to be run in its
+context by passing a block to has_draft:
+  
+  class Article < ActiveRecord::Base
+    belongs_to :user
+    
+    has_draft do
+      belongs_to :last_updated_user
+      
+      def approve!
+        self.approved_at = Time.now
+        self.save
+      end
+    end
+    
+  end
+
+
+
+Copyright (c) 2008 Ben Hughes, released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'echoe'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_draft plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_draft plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasDraft'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Echoe.new('has_draft', '0.1.0') do |p|
+  p.description    = "Allows for your ActiveRecord models to have drafts which are stored in a separate duplicate table."
+  p.url            = "http://github.com/railsgarden/has_draft"
+  p.author         = "Ben Hughes"
+  p.email          = "ben@railsgarden.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/has_draft.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_draft}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Hughes"]
+  s.date = %q{2009-01-16}
+  s.description = %q{Allows for your ActiveRecord models to have drafts which are stored in a separate duplicate table.}
+  s.email = %q{ben@railsgarden.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/has_draft.rb", "README.rdoc", "tasks/has_draft_tasks.rake"]
+  s.files = ["CHANGELOG", "has_draft_plugin.sqlite3", "init.rb", "install.rb", "lib/has_draft.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/has_draft_tasks.rake", "test/config/database.yml", "test/fixtures/article_drafts.yml", "test/fixtures/articles.yml", "test/has_draft_test.rb", "test/models/article.rb", "test/schema.rb", "test/test_helper.rb", "uninstall.rb", "has_draft.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/railsgarden/has_draft}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Has_draft", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{has_draft}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Allows for your ActiveRecord models to have drafts which are stored in a separate duplicate table.}
+  s.test_files = ["test/has_draft_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+require 'has_draft'
+
+ActiveRecord::Base.send(:include, Rubiety::HasDraft)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/has_draft.rb

@@ -0,0 +1,120 @@
+module Rubiety
+  module HasDraft
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def has_draft(options = {}, &block)
+        return if self.included_modules.include?(HasDraft::InstanceMethods)
+        include HasDraft::InstanceMethods
+        
+        cattr_accessor :draft_class_name, :draft_foreign_key, :draft_table_name, :draft_columns
+        
+        self.draft_class_name = options[:class_name]  || 'Draft'
+        self.draft_foreign_key = options[:foreign_key] || self.to_s.foreign_key
+        self.draft_table_name = options[:table_name]  || "#{table_name_prefix}#{base_class.name.demodulize.underscore}_drafts#{table_name_suffix}"
+        
+        # Create Relationship to Draft Copy
+        class_eval do
+          has_one :draft, :class_name => "#{self.to_s}::#{draft_class_name}",
+                          :foreign_key => draft_foreign_key,
+                          :dependent => :destroy
+          
+          named_scope :with_draft, :include => [:draft], :conditions => "#{draft_table_name}.id IS NOT NULL"
+          named_scope :without_draft, :include => [:draft], :conditions => "#{draft_table_name}.id IS NULL"
+        end
+        
+        # Dynamically Create Model::Draft Class
+        const_set(draft_class_name, Class.new(ActiveRecord::Base))
+        
+        draft_class.cattr_accessor :original_class
+        draft_class.original_class = self
+        draft_class.set_table_name(draft_table_name)
+        
+        # Draft Parent Association
+        draft_class.belongs_to self.to_s.demodulize.underscore.to_sym, :class_name  => "::#{self.to_s}", :foreign_key => draft_foreign_key
+        
+        # Block extension
+        draft_class.class_eval(&block) if block_given?
+        
+        # Finally setup which columns to draft
+        self.draft_columns = draft_class.new.attributes.keys - [draft_class.primary_key, draft_foreign_key, 'created_at', 'updated_at', inheritance_column]
+      end
+      
+      def draft_class
+        const_get(draft_class_name)
+      end
+    end
+    
+    module InstanceMethods
+      def has_draft?
+        !self.draft.nil?
+      end
+      
+      def save_to_draft(perform_validation = true)
+        return false if perform_validation and !self.valid?
+        
+        instantiate_draft! unless has_draft?
+        copy_attributes_to_draft
+        
+        self.draft.save(perform_validation)
+        self.reload
+      end
+      
+      def instantiate_draft
+        self.draft = self.build_draft
+        
+        copy_attributes_to_draft
+        before_instantiate_draft
+        
+        self.draft
+      end
+      
+      def instantiate_draft!
+        returning instantiate_draft do |draft|
+          draft.save unless self.new_record?
+        end
+      end
+      
+      def copy_attributes_to_draft
+        self.class.draft_columns.each do |attribute|
+          self.draft.send("#{attribute}=", send(attribute))
+        end
+        self
+      end
+      
+      def copy_attributes_from_draft
+        self.class.draft_columns.each do |attribute|
+          self.send("#{attribute}=", self.draft.send(attribute))
+        end
+        self
+      end
+      
+      def before_instantiate_draft
+      end
+      
+      def replace_with_draft!
+        copy_attributes_from_draft
+        
+        before_replace_with_draft
+        
+        self.save unless self.new_record?
+        self
+      end
+      
+      def before_replace_with_draft
+      end
+      
+      def destroy_draft!
+        before_destroy_draft
+        
+        self.draft.destroy if self.draft
+        self.draft(true)
+      end
+      
+      def before_destroy_draft
+      end
+    end
+  end
+end

data/tasks/has_draft_tasks.rake

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

data/test/config/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: has_draft_plugin.sqlite
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: has_draft_plugin.sqlite3
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: has_draft_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: has_draft_plugin_test

data/test/fixtures/article_drafts.yml

@@ -0,0 +1,12 @@
+article_with_draft:
+  article_id: <%= Fixtures.identify('article_with_draft') %>
+  title: Article With Draft Changed
+  summary: >
+    Changed: Sed cursus cursus velit. Sed cursus cursus velit.
+  body: >
+    Changed: Nunc auctor bibendum eros. Maecenas porta accumsan mauris. Etiam enim enim, elementum sed, bibendum quis, rhoncus non, 
+    metus. Fusce neque dolor, adipiscing sed, consectetuer et, lacinia sit amet, quam. Suspendisse wisi quam, 
+    consectetuer in, blandit sed, suscipit eu, eros. Etiam ligula enim, tempor ut, blandit nec, mollis eu, lectus. 
+    Nam cursus. Vivamus iaculis. Aenean risus purus, pharetra in, blandit quis, gravida a, turpis. Donec nisl. 
+    Aenean eget mi. Fusce mattis est id diam. Phasellus faucibus interdum sapien. Duis quis nunc. Sed enim.
+  post_date: <%= Date.today.to_s(:db) %>

data/test/fixtures/articles.yml

@@ -0,0 +1,23 @@
+article_without_draft:
+  title: Article Without Draft
+  summary: >
+    Sed cursus cursus velit. Sed cursus cursus velit.
+  body: >
+    Nunc auctor bibendum eros. Maecenas porta accumsan mauris. Etiam enim enim, elementum sed, bibendum quis, rhoncus non, 
+    metus. Fusce neque dolor, adipiscing sed, consectetuer et, lacinia sit amet, quam. Suspendisse wisi quam, 
+    consectetuer in, blandit sed, suscipit eu, eros. Etiam ligula enim, tempor ut, blandit nec, mollis eu, lectus. 
+    Nam cursus. Vivamus iaculis. Aenean risus purus, pharetra in, blandit quis, gravida a, turpis. Donec nisl. 
+    Aenean eget mi. Fusce mattis est id diam. Phasellus faucibus interdum sapien. Duis quis nunc. Sed enim.
+  post_date: <%= Date.today.to_s(:db) %>
+  
+article_with_draft:
+  title: Article With Draft
+  summary: >
+    Sed cursus cursus velit. Sed cursus cursus velit.
+  body: >
+    Nunc auctor bibendum eros. Maecenas porta accumsan mauris. Etiam enim enim, elementum sed, bibendum quis, rhoncus non, 
+    metus. Fusce neque dolor, adipiscing sed, consectetuer et, lacinia sit amet, quam. Suspendisse wisi quam, 
+    consectetuer in, blandit sed, suscipit eu, eros. Etiam ligula enim, tempor ut, blandit nec, mollis eu, lectus. 
+    Nam cursus. Vivamus iaculis. Aenean risus purus, pharetra in, blandit quis, gravida a, turpis. Donec nisl. 
+    Aenean eget mi. Fusce mattis est id diam. Phasellus faucibus interdum sapien. Duis quis nunc. Sed enim.
+  post_date: <%= Date.today.to_s(:db) %>

data/test/has_draft_test.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), 'models/article')
+
+class ArticleTest < Test::Unit::TestCase
+  fixtures :articles, :article_drafts
+  set_fixture_class :article_drafts => Article::Draft
+  
+  context "Article model" do
+    should_have_one :draft
+    should_have_named_scope :with_draft
+    should_have_named_scope :without_draft
+    
+    should_have_class_methods :draft_class_name, :draft_foreign_key, :draft_table_name
+    
+    should "default class name to Draft" do
+      assert_equal "Draft", Article.draft_class_name
+    end
+    
+    should "expose draft class constant" do
+      assert_equal Article::Draft, Article.draft_class
+    end
+    
+    should "default foreign key to article_id" do
+      assert_equal "article_id", Article.draft_foreign_key
+    end
+    
+    should "default table name to article_drafts" do
+      assert_equal "article_drafts", Article.draft_table_name
+    end
+    
+    context "Draft model" do
+      should "have a be defined under Article" do
+        assert Article.constants.include?('Draft')
+      end
+
+      should "load" do
+        assert_nothing_raised do
+          Article::Draft
+        end
+      end
+      
+      should "expose original class name of Article" do
+        assert_equal Article, Article::Draft.original_class
+      end
+    end
+  end
+  
+  context "an article" do
+    setup { @article = articles(:article_without_draft) }
+    
+    context "when instantiating a new draft" do
+      setup { @article.instantiate_draft! }
+      
+      should "create draft" do
+        assert_not_nil @article.draft
+        assert !@article.draft.new_record?
+      end
+      
+      should "copy draft fields" do
+        Article.draft_columns.each do |column|
+          assert_equal @article.send(column), @article.draft.send(column)
+        end
+      end
+    end
+    
+    context "when destroying an existing draft" do
+      setup do
+        @article = articles(:article_with_draft)
+        @article.destroy_draft!
+      end
+      
+      should "destroy associated draft" do
+        assert_nil @article.draft
+      end
+    end
+    
+    context "when replacing with draft" do
+      setup do
+        @article = articles(:article_with_draft)
+        @article.replace_with_draft!
+      end
+      
+      should "still have draft" do
+        assert_not_nil @article.draft
+      end
+      
+      should "now have the same field values as draft" do
+        Article.draft_columns.each do |column|
+          assert_equal @article.send(column), @article.draft.send(column)
+        end
+      end
+    end
+    
+  end
+  
+end

data/test/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  has_draft
+end

data/test/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 0) do
+  
+  [:articles, :article_drafts].each do |table_name|
+    create_table table_name, :force => true do |t|
+      t.references :article if table_name == :article_drafts
+      
+      t.string :title
+      t.text :summary
+      t.text :body
+      t.date :post_date
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda/rails'
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/has_draft'))
+
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'config', '/database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$:.unshift(Test::Unit::TestCase.fixture_path)
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+class Test::Unit::TestCase
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+end
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../init'))

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: railsgarden-has_draft
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Allows for your ActiveRecord models to have drafts which are stored in a separate duplicate table.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/has_draft.rb
+- README.rdoc
+- tasks/has_draft_tasks.rake
+files: 
+- CHANGELOG
+- has_draft_plugin.sqlite3
+- init.rb
+- install.rb
+- lib/has_draft.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- tasks/has_draft_tasks.rake
+- test/config/database.yml
+- test/fixtures/article_drafts.yml
+- test/fixtures/articles.yml
+- test/has_draft_test.rb
+- test/models/article.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+- has_draft.gemspec
+has_rdoc: true
+homepage: http://github.com/railsgarden/has_draft
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Has_draft
+- --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: has_draft
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Allows for your ActiveRecord models to have drafts which are stored in a separate duplicate table.
+test_files: 
+- test/has_draft_test.rb
+- test/test_helper.rb