destroy_backgrounded 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+#test resources
+test/*.log
+test/*.sqlite3

data/CONTRIBUTORS.txt

@@ -0,0 +1,6 @@
+Sean Walbran - Original Author
+
+
+Complete list of contributors:
+https://github.com/socialcast/destroy_backgrounded/contributors
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in destroy_backgrounded.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2011 Socialcast, Inc
+
+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.md

@@ -0,0 +1,38 @@
+# destroy_backgrounded
+
+Backgrounded Destroy ActiveRecord instances.
+
+## Usage
+
+```ruby
+class Blog < ActiveRecord::Base
+  acts_as_destroy_backgrounded
+end
+blog = Blog.create! :name => 'foo'
+
+# backgrounded destroy the instance
+blog.destroy
+
+# immediately destroy the instance
+blog.destroy_immediate
+
+```
+
+## Features
+* simple configuration
+* support for immediately destroying
+
+## Contributing
+
+* Fork the project
+* Add tests
+* Fix the issue
+* Submit a pull request on github
+
+see CONTRIBUTORS.txt for complete list of contributors
+
+## Copyright
+
+Copyright (c) 2011 Socialcast Inc. 
+See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+task :default => :test
+

data/destroy_backgrounded.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "destroy_backgrounded/version"
+
+Gem::Specification.new do |s|
+  s.name        = "destroy_backgrounded"
+  s.version     = DestroyBackgrounded::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sean Walbran"]
+  s.email       = ["seanwalbran@gmail.com"]
+  s.homepage    = "http://github.com/seanwalbran/destroy_backgrounded"
+  s.summary     = %q{background destroy Rails ActiveRecord objects}
+  s.description = %q{destroy database records in the background}
+
+  s.rubyforge_project = "destroy_backgrounded"
+
+  s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<mocha>, [">= 0"])
+  s.add_development_dependency(%q<bundler>, [">= 0"])
+  s.add_development_dependency(%q<sqlite3-ruby>, ["~> 1.3.2"])
+  s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+  s.add_development_dependency(%q<timecop>, [">= 0"])
+  s.add_development_dependency(%q<backgrounded>, [">= 0"])
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/destroy_backgrounded.rb

@@ -0,0 +1,44 @@
+require 'active_support/all'
+require 'active_record'
+require 'backgrounded'
+
+module DestroyBackgrounded
+  module ActiveRecordExtensions
+    def destroy_backgrounded?
+      false
+    end
+
+    def acts_as_destroy_backgrounded(*args)
+      extend DestroyBackgrounded::ClassMethods
+      include DestroyBackgrounded::AliasMethods
+      include DestroyBackgrounded::InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def destroy_backgrounded?
+      true
+    end
+  end
+
+  module AliasMethods
+    def self.included(base)
+      base.send(:alias_method, :destroy_immediate, :destroy)
+      base.send(:backgrounded, :destroy_immediate)
+    end
+  end
+
+  module InstanceMethods
+    
+    def destroy
+      if self.class.destroy_backgrounded?
+        destroy_immediate_backgrounded
+      else
+        destroy_immediate
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:extend, DestroyBackgrounded::ActiveRecordExtensions)

data/lib/destroy_backgrounded/version.rb

@@ -0,0 +1,3 @@
+module DestroyBackgrounded
+  VERSION = "0.0.1"
+end

data/test/database.yml

@@ -0,0 +1,4 @@
+sqlite:
+  adapter: sqlite3
+  database: test/destroy_backgrounded.sqlite3
+

data/test/database_setup.rb

@@ -0,0 +1,41 @@
+require 'logger'
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
+
+ActiveRecord::Schema.define(:version => 2) do
+  create_table :blogs, :force => true do |t|
+    t.column :title, :string
+    t.column :body, :string
+  end
+  create_table :comments, :force => true do |t|
+    t.column :blog_id, :integer
+    t.column :text, :string
+  end
+  create_table :links, :force => true do |t|
+    t.column :blog_id, :integer
+    t.column :name, :string
+  end
+end
+
+class Blog < ActiveRecord::Base
+  has_many :comments, :dependent => :destroy
+  has_many :links, :dependent => :destroy
+  acts_as_destroy_backgrounded
+  attr_accessible :title
+  include CallbackMatcher::ActiveRecordHooks
+end
+
+class Comment < ActiveRecord::Base
+  acts_as_destroy_backgrounded
+  attr_accessible :text
+  belongs_to :blog
+  include CallbackMatcher::ActiveRecordHooks
+end
+
+class Link < ActiveRecord::Base
+  belongs_to :blog
+  attr_accessible :name
+  include CallbackMatcher::ActiveRecordHooks
+end
+

data/test/helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require "ruby-debug"
+require 'timecop'
+require 'backgrounded'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'destroy_backgrounded'
+require 'matchers/destroy_matcher'
+require 'matchers/callback_matcher'
+require 'database_setup'
+
+class Test::Unit::TestCase
+  extend DestroyMatcher::MatcherMethods
+  extend CallbackMatcher::MatcherMethods
+end
+
+module Backgrounded
+  module Handler
+    class NoOpHandler
+      def request(object, method, *args)
+      end
+    end
+  end
+end
+Backgrounded.handler = Backgrounded::Handler::NoOpHandler.new
+
+# configure default logger to standard out with info log level
+Backgrounded.logger = Logger.new STDOUT
+Backgrounded.logger.level = Logger::DEBUG
+ActiveRecord::Base.logger=Logger.new(STDOUT)
+ActiveRecord::Base.logger.level=0

data/test/matchers/backgrounded_matchers.rb

@@ -0,0 +1,52 @@
+module DestroyBackgrounded
+  class BackgroundedMatcher
+    def softly
+      @softly = true
+      self
+    end
+    def description
+      "destroy the subject"
+    end
+    def matches?(subject)
+      @subject = subject
+      errors.empty?
+    end
+    def failure_message
+      "Expected #{@subject.inspect} to be destroyed: #{errors.join("\n")}"
+    end
+    def errors
+      return @errors if @errors
+      @errors = []
+      @errors << "was found in database" if subject_found?
+      @errors << "did not destroy instance" if destroyed? && !@subject.destroyed?
+      @errors
+    end
+    def softly?
+      !!@softly
+    end
+    def destroyed?
+      !!@destroyed
+    end
+    def subject_found?
+      !!@subject.class.find(@subject.id)
+    rescue ActiveRecord::RecordNotFound
+      false
+    end
+
+  end
+end
+
+class DestroyMatcher
+  module MatcherMethods
+    def soft_destroy
+      DestroyMatcher.new :soft
+    end
+    def hard_destroy
+      DestroyMatcher.new :hard
+    end
+    def destroy_subject
+      DestroyBackgrounded::DestroyMatcher.new
+    end
+  end
+end
+

data/test/matchers/callback_matcher.rb

@@ -0,0 +1,90 @@
+
+class CallbackMatcher
+  CALLBACK_EVENTS = [:before, :after, :after_commit_on]
+  CALLBACK_TYPES = [:create, :update, :destroy, :save]
+  
+  module MatcherMethods
+    
+    def trigger_callbacks_for(callback_types)
+      CallbackMatcher.new Array.wrap(callback_types)
+    end
+    
+  end
+  
+  module ActiveRecordHooks
+    
+    def self.included(base)
+      base.class_eval do
+        class << self
+          attr_accessor :callback_tester_attrs
+        end
+        @callback_tester_attrs = []
+        CALLBACK_EVENTS.each do |ce|
+          CALLBACK_TYPES.each do |ct|
+            callback_name = :"#{ce}_#{ct}"
+            callback_attr = :"called_#{callback_name}"
+            callback_method, has_on_option = (ce.to_s =~ /_on/ ? [ce.to_s.gsub('_on',''), true] : [callback_name, false]) 
+            @callback_tester_attrs << callback_attr
+            attr_accessor callback_attr
+            send( callback_method, (has_on_option ? {:on => ct} : {})) {
+              instance_variable_set(:"@#{callback_attr}", true)
+            }
+          
+            define_method :"#{callback_attr}?" do
+              instance_variable_get(:"@#{callback_attr}")
+            end
+          end
+        end
+        alias_method_chain :initialize, :callback_init
+      end
+    end
+
+    def initialize_with_callback_init(*args)
+      reset_callback_flags!
+      initialize_without_callback_init(*args)
+    end
+
+    def reset_callback_flags!
+      self.class.callback_tester_attrs.each do |attr|
+        send("#{attr}=", false)
+      end
+    end
+
+  end
+  
+  def initialize(callback_types)
+    @callback_types = callback_types
+  end
+  
+  def failure_message
+    "Expected #{@subject} #{expectation}:"
+  end
+  
+  def negative_failure_message
+    "Did not expect #{@subject} #{expectation}:"
+  end
+  
+  def description
+    "check that #{@callback_types.join(', ')} callbacks were called"
+  end
+  
+  def expectation
+    @expectations.join("\n")
+  end
+  
+  def matches?(subject)
+    @subject = subject
+    @expectations = []
+    result = true
+    @callback_types.each do |ct|
+      CALLBACK_EVENTS.each do |ce|
+        called = @subject.send(:"called_#{ce}_#{ct}?")
+        result &&= called
+        @expectations << "#{ce}_#{ct} callbacks to be triggered"
+      end
+    end
+    result
+  end
+  
+end
+

data/test/matchers/destroy_matcher.rb

@@ -0,0 +1,52 @@
+module DestroyBackgrounded
+  class DestroyMatcher
+    def softly
+      @softly = true
+      self
+    end
+    def description
+      "destroy the subject"
+    end
+    def matches?(subject)
+      @subject = subject
+      errors.empty?
+    end
+    def failure_message
+      "Expected #{@subject.inspect} to be destroyed: #{errors.join("\n")}"
+    end
+    def errors
+      return @errors if @errors
+      @errors = []
+      @errors << "was found in database" if subject_found?
+      @errors << "did not destroy instance" if destroyed? && !@subject.destroyed?
+      @errors
+    end
+    def softly?
+      !!@softly
+    end
+    def destroyed?
+      !!@destroyed
+    end
+    def subject_found?
+      !!@subject.class.find(@subject.id)
+    rescue ActiveRecord::RecordNotFound
+      false
+    end
+
+  end
+end
+
+class DestroyMatcher
+  module MatcherMethods
+    def soft_destroy
+      DestroyMatcher.new :soft
+    end
+    def hard_destroy
+      DestroyMatcher.new :hard
+    end
+    def destroy_subject
+      DestroyBackgrounded::DestroyMatcher.new
+    end
+  end
+end
+

data/test/test_destroy_backgrounded.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestDestroyBackgrounded < Test::Unit::TestCase
+  context 'with non-backgrounded activerecord class' do
+    should 'not be backgrounded' do
+      assert !Link.destroy_backgrounded?
+    end
+  end
+
+  context 'with backgrounded activerecord class' do
+    should 'be backgrounded' do
+      assert Blog.destroy_backgrounded?
+    end
+  end
+
+  context 'with instance of backgrounded class' do
+    setup do
+      @blog = Blog.create! :title => 'foo'
+    end
+    context 'when destroying instance with instance.destroy' do
+      subject do
+        @blog.destroy
+        @blog
+      end
+      should_not destroy_subject
+      should_not trigger_callbacks_for :destroy
+      #should schedule_destroy_subject
+    end
+    context 'when destroying instance with Class.destroy_all' do
+      subject do
+        Blog.destroy_all :id => @blog.id
+        @blog
+      end
+      should_not destroy_subject
+      should_not trigger_callbacks_for :destroy
+      #should schedule_destroy_subject
+    end
+    context 'when destroying instance with instance.destroy_immediate' do
+      subject do
+        @blog.destroy_immediate
+        @blog
+      end
+      should destroy_subject
+    end
+  end
+
+  context 'with instance of non backgrounded class' do
+    setup do
+      @link = Link.create! :name => 'foo'
+    end
+    context 'when destroying instance with instance.destroy' do
+      subject do
+        @link.destroy
+        @link
+      end
+      should destroy_subject
+    end
+    context 'when destroying instance with Class.destroy_all' do
+      subject do
+        Link.destroy_all :id => @link.id
+        @link
+      end
+      should destroy_subject
+      # should_not schedule_destroy_subject
+    end
+  end
+
+  context 'with nonbackgrounded instance that belongs to backgrounded instance' do
+    setup do
+      @blog = Blog.create!(:title => 'foo')
+      @link = @blog.links.create! :text => 'bar'
+    end
+    context 'when destroying parent backgrounded instance with destroy' do
+      subject do
+        @blog.destroy
+        @link
+      end
+      should_not destroy_subject
+      should_not trigger_callbacks_for :destroy
+      #should_not schedule_destroy_subject
+    end
+    context 'when destroying parent backgrounded instance with destroy_immediate' do
+       subject do
+         @blog.destroy_immediate
+         @link
+       end
+       should destroy_subject
+     end
+  end
+
+end
+

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification 
+name: destroy_backgrounded
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sean Walbran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  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: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: backgrounded
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: destroy database records in the background
+email: 
+- seanwalbran@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CONTRIBUTORS.txt
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- destroy_backgrounded.gemspec
+- lib/destroy_backgrounded.rb
+- lib/destroy_backgrounded/version.rb
+- test/database.yml
+- test/database_setup.rb
+- test/helper.rb
+- test/matchers/backgrounded_matchers.rb
+- test/matchers/callback_matcher.rb
+- test/matchers/destroy_matcher.rb
+- test/test_destroy_backgrounded.rb
+homepage: http://github.com/seanwalbran/destroy_backgrounded
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: destroy_backgrounded
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: background destroy Rails ActiveRecord objects
+test_files: 
+- test/database.yml
+- test/database_setup.rb
+- test/helper.rb
+- test/matchers/backgrounded_matchers.rb
+- test/matchers/callback_matcher.rb
+- test/matchers/destroy_matcher.rb
+- test/test_destroy_backgrounded.rb