activerecord-draft_records 0.1.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 Rodrigo Kochenburger
+
+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,17 @@
+= activerecord-draft_records
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rodrigo Kochenburger. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "activerecord-draft_records"
+    gem.summary     = "Add support for draft models (incomplete models) to ActiveRecord"
+    gem.email       = "divoxx@gmail.com"
+    gem.homepage    = "http://github.com/divoxx/activerecord-draft_records"
+    gem.authors     = ["Rodrigo Kochenburger"]
+    gem.description = <<-DESC
+Sometimes it's necessary to store incomplete records, without fullfilling all validations, to complete
+and then validate the record. ActiveRecord::DraftRecords allows you to persist an record even if it's
+invalid by tagging it as a draft.
+    DESC
+
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "database_cleaner", ">= 0.5.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord-draft_records #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/active_record/draft_records.rb

@@ -0,0 +1,53 @@
+module ActiveRecord
+  module DraftRecords
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      # Define default_scope to not include drafts
+      klass.send(:default_scope, :conditions => {:draft => false})
+    end
+    
+    module ClassMethods
+      # Same as ActiveRecord::Base#create, but sets the record as a draft and save
+      # ignoring validations.
+      def create_as_draft(attributes = {}, &block)
+        if attributes.is_a?(Array)
+           attributes.collect { |attr| create_as_draft(attr, &block) }
+         else
+           object = new(attributes)
+           yield(object) if block_given?
+           object.save_as_draft
+           object
+         end
+      end
+      
+      # Attempt to create the record, if it fails, save it as a draft
+      def create_or_draft(attributes = {}, &block)
+        if attributes.is_a?(Array)
+           attributes.collect { |attr| create_as_draft(attr, &block) }
+         else
+           object = new(attributes)
+           yield(object) if block_given?
+           object.save_or_draft
+           object
+         end        
+      end
+      
+      # Returns a ActiveRecord::Scope that fetchs all the drafts
+      def find_drafts(*args)
+        with_exclusive_scope { self.scoped(:conditions => {:draft => true}).find(*args) }
+      end
+    end
+    
+    # Save the record as a draft, setting the record attribute 'draft' to true
+    # and saving the record ignoring the validations.
+    def save_as_draft
+      self.draft = true
+      save(false)
+    end
+    
+    # Attempt to save the record, if any validation fails, save it as a draft.
+    def save_or_draft
+      save || save_as_draft
+    end
+  end
+end

data/spec/features_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Integration features" do
+  it "should save the record as draft and skip validation" do
+    user = User.new :email => 'joe@example.com'
+    user.should_not be_valid
+    user.save_as_draft
+    user.should be_a_draft
+  end
+  
+  it "should allow trying to save the object and saving as a draft if it fails" do
+    user = User.new :email => 'joe@example.com'
+    user.should_not be_valid
+    user.save_or_draft
+    user.should be_a_draft
+  end
+  
+  it "should not save the record as draft if validations pass when calling save_or_draft" do
+    user = User.new :email => 'joe@example.com', :username => 'joe'
+    user.should be_valid
+    user.save_or_draft
+    user.should_not be_a_draft
+  end
+  
+  it "should create a record as draft and skip validations" do
+    user = User.create_as_draft :email => 'joe@example.com'
+    user.should be_instance_of(User)
+    user.should_not be_a_new_record
+    user.should be_a_draft
+  end
+
+  it "should allow trying to create a record and saving as a draft if it fails" do
+    user = User.create_or_draft :email => 'joe@example.com'
+    user.should be_instance_of(User)
+    user.should_not be_a_new_record
+    user.should be_a_draft
+  end
+
+  it "should not return draft records on queries" do
+    user = User.create_as_draft :email => 'joe@example.com'
+    User.all.should_not include(user)
+  end
+  
+  it "should provide a version of ActiveRecord::Base#find that will look for drafts" do
+    user = User.create_as_draft :email => 'joe@example.com'
+    User.find_drafts(:all).should include(user)
+  end  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'active_record/draft_records'
+require 'spec'
+require 'spec/autorun'
+require 'database_cleaner'
+require 'logger'
+
+# Initiate the connection
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+DatabaseCleaner.strategy = :transaction
+  
+# Define the database schema
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :username, :email
+    t.boolean :draft
+  end
+end
+
+class User < ActiveRecord::Base
+  include ActiveRecord::DraftRecords
+  validates_presence_of :username, :email
+end
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-draft_records
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rodrigo Kochenburger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-17 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :development
+  version_requirements: *id002
+description: |
+  Sometimes it's necessary to store incomplete records, without fullfilling all validations, to complete
+  and then validate the record. ActiveRecord::DraftRecords allows you to persist an record even if it's
+  invalid by tagging it as a draft.
+
+email: divoxx@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_record/draft_records.rb
+- spec/features_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/divoxx/activerecord-draft_records
+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: Add support for draft models (incomplete models) to ActiveRecord
+test_files: 
+- spec/features_spec.rb
+- spec/spec_helper.rb