has_draft 1.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+== [2010-10-15] 1.0.1 Minor fix to homepage URL
+
+== [2010-10-15] 1.0.0 Major Updates
+
+* Finally updated to be a Gem
+* Internal refactoring
+* Converted tests to RSpec
+* Added support for Rails 3.0
+
+== 0.1.0 Initial Version

data/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/README.rdoc

@@ -0,0 +1,154 @@
+== 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.
+
+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.  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
+
+This gem requires ActiveRecord 3.0.
+
+In your Gemfile:
+  
+  gem "has_draft"
+
+== 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

data/Rakefile

@@ -0,0 +1,14 @@
+require "rubygems"
+require "rake"
+require "rake/rdoctask"
+
+desc "Generate documentation for the plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "has_draft"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1,3 @@
+require "has_draft"
+
+HasDraft::Railtie.insert

data/lib/has_draft/railtie.rb

@@ -0,0 +1,19 @@
+module HasDraft
+  if defined?(Rails::Railtie)
+    require "rails"
+    
+    class Railtie < Rails::Railtie
+      initializer "has_draft.extend_active_record" do
+        ActiveSupport.on_load(:active_record) do
+          HasDraft::Railtie.insert
+        end
+      end
+    end
+  end
+  
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, HasDraft)
+    end
+  end
+end

data/lib/has_draft/version.rb

@@ -0,0 +1,3 @@
+module HasDraft
+  VERSION = "1.0.1"
+end

data/lib/has_draft.rb

@@ -0,0 +1,120 @@
+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
+
+require "has_draft/railtie"

data/spec/db/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  adapter: sqlite
+  database: spec/db/test.sqlite
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/db/test.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/spec/db/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/spec/factories/article.rb

@@ -0,0 +1,20 @@
+require "factory_girl"
+
+Factory.define(:article) do |f|
+  f.title { Faker::Lorem.sentence }
+  f.summary { Faker::Lorem.paragraphs.first }
+  f.body { Faker::Lorem.paragraphs.join("\n\n") }
+  f.post_date { 1.day.ago.to_date }
+end
+
+Factory.define(:article_draft, :class => Article::Draft) do |f|
+  f.association(:article)
+  f.title { Faker::Lorem.sentence }
+  f.summary { Faker::Lorem.paragraphs.first }
+  f.body { Faker::Lorem.paragraphs.join("\n\n") }
+  f.post_date { 1.day.ago.to_date }
+end
+
+Factory.define(:article_with_draft, :parent => :article) do |f|
+  f.association(:draft, :factory => :article_draft)
+end

data/spec/has_draft_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe HasDraft do
+  context "Model with has_draft" do
+    it "should expose #draft_class_name as Draft" do
+      Article.draft_class_name.should == "Draft"
+    end
+    
+    it "should expose #draft_class as Article::Draft" do
+      Article.draft_class.should == Article::Draft
+    end
+    
+    it "should default #draft_foreign_key as article_id" do
+      Article.draft_foreign_key.should == "article_id"
+    end
+    
+    it "should default #draft_table_name as article_drafts" do
+      Article.draft_table_name.should == "article_drafts"
+    end
+    
+    describe "Draft Model" do
+      it "should be defined under the Article namespace" do
+        Article.constants.should include('Draft')
+      end
+      
+      it "should expose #original_class as Article" do
+        Article::Draft.original_class.should == Article
+      end
+    end
+  end
+  
+  context "an article" do
+    before { @article = Factory.create(:article) }
+    
+    context "when instantiating a new draft" do
+      before { @article.instantiate_draft! }
+      
+      it "should create draft" do
+        @article.draft.should_not be_nil
+        @article.draft.should_not be_new_record
+      end
+      
+      it "should copy draft fields" do
+        Article.draft_columns.each do |column|
+          @article.send(column).should == @article.draft.send(column)
+        end
+      end
+    end
+    
+    context "when destroying an existing draft" do
+      before do
+        @article = Factory.create(:article_with_draft)
+        @article.destroy_draft!
+      end
+      
+      it "should associated draft" do
+        @article.draft.should be_nil
+      end
+    end
+    
+    context "when replacing with draft" do
+      before do
+        @article = Factory.create(:article_with_draft)
+        @article.replace_with_draft!
+      end
+      
+      it "should still have draft" do
+        @article.draft.should_not be_nil
+      end
+      
+      it "should now have the same field values as draft" do
+        Article.draft_columns.each do |column|
+          @article.send(column).should == @article.draft.send(column)
+        end
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "rspec"
+require "factory_girl"
+require "faker"
+require "rails"
+require "active_record"
+require "active_support"
+
+# Establish DB Connection
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'db', 'database.yml')))
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+require File.dirname(__FILE__) + '/../init'
+
+# Example has_draft Model:
+class Article < ActiveRecord::Base
+  has_draft
+end
+
+# Load Factories:
+Dir[File.join(File.dirname(__FILE__), "factories/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: has_draft
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+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: []
+
+files: 
+- lib/has_draft/railtie.rb
+- lib/has_draft/version.rb
+- lib/has_draft.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/factories/article.rb
+- spec/has_draft_spec.rb
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/rubiety/has_draft
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: has_draft
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Attached draft model to your ActiveRecord models.
+test_files: []
+