destroy_soon 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.8.7

data/CHANGELOG.mkd

@@ -0,0 +1,12 @@
+## v0.0.3
+
+* Configuring which delayed job queue to use
+
+## v0.0.2
+
+* Fixing rubygems issue
+
+## v0.0.1
+
+* Initial release.
+

data/Gemfile

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

data/README.mkd

@@ -0,0 +1,80 @@
+## About
+
+DestroySoon encapsulates the common pattern of asynchronously removing ActiveRecord models. In complex systems where there is a [God](http://en.wikipedia.org/wiki/God_object) entity, the God descruction take a long time to run due to all dependent destruction. In this case it's a good ideia to place the heavy weight job to the background.
+
+DestroySoon uses [DelayedJob](https://github.com/collectiveidea/delayed_job) as queue processing system.
+
+[![Build Status](https://secure.travis-ci.org/redu/destroy-soon.png)](http://travis-ci.org/redu/destroy-soon)
+
+## Quickstart
+
+Add DestroySoon to your gemfile:
+
+```ruby
+gem 'destroy_soon', :git => 'git://github.com/redu/destroy-soon.git'
+```
+
+You just need to inject some behaivor to the object you want to destroy asynchronously:
+
+```ruby
+class Course < ActiveRecord::Base
+  include DestroySoon::ModelAdditions
+end
+```
+
+The ActiveRecord model should have a new column called ``destroy_soon``. This column will be setted to true when a destruction task is scheduled. You should generate a migration as follows:
+
+```sh
+$ rails g migration AddDestroySoonToCourse
+```
+
+Edit the migration to add the column:
+
+```ruby
+class AddDestroySoonToCourse < ActiveRecord::Migration
+  def self.up
+    add_column :courses, :destroy_soon, :boolean, :default => false
+    add_index :courses, :destroy_soon
+  end
+
+  def self.down
+    remove_column :courses, :destroy_soon
+  end
+end
+```
+
+And migrate the database using ``rake db:migrate``. In order to destroy Course instance in the backgroud call the ``async_destroy`` method:
+
+```ruby
+class CoursesController < BaseController
+  def destroy
+    @course = Course.find(params[:id])
+    @course.async_destroy
+
+    respond_with(@course)
+  end
+end
+```
+
+## Configuration
+
+You can use DelayedJob's named queues setting the queue name as follows:
+
+```ruby
+# config/initializers/destroy_soon.rb
+DestroySoon::Queue.default_queue = "destruction"
+```
+ 
+<img src="https://github.com/downloads/redu/redupy/redutech-marca.png" alt="Redu Educational Technologies" width="300">
+
+This project is maintained and funded by [Redu Educational Techologies](http://tech.redu.com.br).
+
+# Copyright
+
+Copyright (c) 2012 Redu Educational Technologies
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |r|
+  r.verbose = false
+end
+
+task :default => :spec

data/TODO.mkd

@@ -0,0 +1,3 @@
+* Create migration generator
+* initializer generator
+* write the docs

data/destroy_soon.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "destroy_soon/version"
+
+Gem::Specification.new do |s|
+  s.name        = "destroy_soon"
+  s.version     = DestroySoon::VERSION
+  s.authors     = ["Guilherme Cavalcanti"]
+  s.email       = ["guiocavalcanti@gmail.com"]
+  s.homepage    = "http://github.com/redu/destroy-soon"
+  s.summary     = "Delayed destroy ActiveRecord model using DelayedJob as queue system"
+  s.description = "Delayed destroy ActiveRecord model"
+  s.rubyforge_project = "destroy_soon"
+
+  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.test_files    = Dir.glob('spec/**/*')
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+
+  s.add_runtime_dependency "activerecord", "~> 3.0.10"
+  s.add_runtime_dependency "activesupport", "~> 3.0.10"
+  s.add_runtime_dependency "delayed_job_active_record", "~> 0.3.2"
+  s.add_runtime_dependency "rake"
+end

data/lib/destroy_soon.rb

@@ -0,0 +1,9 @@
+require "destroy_soon/version"
+
+module DestroySoon
+  # Your code goes here...
+end
+
+require "destroy_soon/job"
+require "destroy_soon/queue"
+require "destroy_soon/model_additions"

data/lib/destroy_soon/job.rb

@@ -0,0 +1,17 @@
+module DestroySoon
+  class Job
+    attr_accessor :entity_klass, :entity_id
+    def initialize(opts)
+      @entity_id = opts[:entity].id
+      @entity_klass = opts[:entity].class.to_s
+    end
+
+    def perform
+      entity.try(:destroy)
+    end
+
+    def entity
+      entity_klass.constantize.find_by_id(entity_id)
+    end
+  end
+end

data/lib/destroy_soon/model_additions.rb

@@ -0,0 +1,17 @@
+require "active_record"
+require "delayed_job_active_record"
+
+module DestroySoon::ModelAdditions
+  extend ActiveSupport::Concern
+  included do
+    scope :will_not_be_destroyed, where(:destroy_soon => false)
+  end
+
+  def async_destroy
+    unless self.destroy_soon
+      self.update_attribute(:destroy_soon, true)
+
+      DestroySoon::Queue.new.enqueue DestroySoon::Job.new(:entity => self)
+    end
+  end
+end

data/lib/destroy_soon/queue.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext'
+
+module DestroySoon
+  class Queue
+    DEFAULT_QUEUE = nil
+    cattr_accessor :default_queue
+
+    def initializer
+      @default_queue = default_queue || DEFAULT_QUEUE
+    end
+
+    def enqueue(job)
+      args = [job]
+      args << { :queue => default_queue } if default_queue
+
+      Delayed::Job.enqueue(*args)
+    end
+  end
+end

data/lib/destroy_soon/version.rb

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

data/spec/model_additions_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module DestroySoon
+  describe ModelAdditions do
+    before(:all) do
+      class User < ActiveRecord::Base
+        include DestroySoon::ModelAdditions
+      end
+    end
+    after do
+      Delayed::Job.destroy_all
+    end
+    let(:subject) do
+      User.create(:name => "Call me susy")
+    end
+
+    it "should have a marked_for_destruction attr" do
+      User.new.should respond_to :destroy_soon?
+    end
+    it "should respond to delayed destroy" do
+      subject.should respond_to :async_destroy
+    end
+    it "should set destroy_soon to true when trying to destroy" do
+      expect {
+        subject.async_destroy
+      }.to change(subject, :destroy_soon?)
+    end
+    it "should delay the destruction" do
+      Queue.any_instance.should_receive(:enqueue)
+      subject.async_destroy
+    end
+    it "should not be enqueued again if it's going to be destroyed" do
+      Queue.any_instance.should_receive(:enqueue).once
+      2.times { subject.async_destroy }
+    end
+    it "should scope by visibility" do
+      subject.async_destroy
+      User.will_not_be_destroyed.should_not include subject
+    end
+  end
+end

data/spec/queue_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module DestroySoon
+  describe Queue do
+    after do
+      Delayed::Job.destroy_all
+    end
+    before(:all) do
+      class User < ActiveRecord::Base
+        include DestroySoon::ModelAdditions
+      end
+    end
+    let(:user) do
+      User.create(:name => "call me susy")
+    end
+    let(:job) do
+      Job.new(:entity => user)
+    end
+    let(:subject) do
+      Queue.new
+    end
+
+    it "should enqueue the job" do
+      Delayed::Job.should_receive(:enqueue).with(job)
+      subject.enqueue(job)
+    end
+
+    it "should enqueue the job on the configured queue" do
+      Queue.default_queue = "general"
+      Delayed::Job.should_receive(:enqueue).with(job, :queue => "general")
+      subject.enqueue(job)
+      Queue.default_queue = nil
+    end
+
+    it "should call destroy after all" do
+      User.any_instance.should_receive(:destroy).once
+      subject.enqueue(job)
+    end
+
+    it "should return the job" do
+      subject.enqueue(job).should be_a Delayed::Job
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Schema.define do
+  begin
+    drop_table :users
+    drop_table :delayed_jobs
+  rescue
+  end
+
+  create_table "delayed_jobs" do |t|
+    t.integer  "priority",   :default => 0
+    t.integer  "attempts",   :default => 0
+    t.text     "handler"
+    t.text     "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by"
+    t.string   "queue"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users" do |t|
+    t.string :name
+    t.boolean :destroy_soon, :default => false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require "rubygems"
+require "bundler/setup"
+require "destroy_soon"
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+load("schema.rb")
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  Delayed::Worker.delay_jobs = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: destroy_soon
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Guilherme Cavalcanti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rspec
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: sqlite3
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 0
+        - 10
+        version: 3.0.10
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 0
+        - 10
+        version: 3.0.10
+  prerelease: false
+  type: :runtime
+  name: activesupport
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  prerelease: false
+  type: :runtime
+  name: delayed_job_active_record
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  name: rake
+  requirement: *id006
+description: Delayed destroy ActiveRecord model
+email: 
+- guiocavalcanti@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.mkd
+- Gemfile
+- README.mkd
+- Rakefile
+- TODO.mkd
+- destroy_soon.gemspec
+- lib/destroy_soon.rb
+- lib/destroy_soon/job.rb
+- lib/destroy_soon/model_additions.rb
+- lib/destroy_soon/queue.rb
+- lib/destroy_soon/version.rb
+- spec/model_additions_spec.rb
+- spec/queue_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: http://github.com/redu/destroy-soon
+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_soon
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Delayed destroy ActiveRecord model using DelayedJob as queue system
+test_files: 
+- spec/model_additions_spec.rb
+- spec/queue_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb