sucker_punch-persistence 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +17 -0
  3. data/.rspec +2 -0
  4. data/Gemfile +3 -0
  5. data/Gemfile.lock +150 -0
  6. data/LICENSE +21 -0
  7. data/README.md +31 -0
  8. data/Rakefile +5 -0
  9. data/lib/generators/sucker_punch/activerecord/migration_generator.rb +19 -0
  10. data/lib/generators/sucker_punch/activerecord/templates/create_jobs_table.rb +10 -0
  11. data/lib/sucker_punch/persistence.rb +11 -0
  12. data/lib/sucker_punch/persistence/activerecord.rb +18 -0
  13. data/lib/sucker_punch/persistence/activerecord/adapter.rb +13 -0
  14. data/lib/sucker_punch/persistence/activerecord/job.rb +8 -0
  15. data/lib/sucker_punch/persistence/call.rb +13 -0
  16. data/lib/sucker_punch/persistence/mailbox.rb +22 -0
  17. data/lib/sucker_punch/persistence/mailbox_factory.rb +13 -0
  18. data/lib/sucker_punch/persistence/mongoid.rb +18 -0
  19. data/lib/sucker_punch/persistence/mongoid/adapter.rb +13 -0
  20. data/lib/sucker_punch/persistence/mongoid/job.rb +11 -0
  21. data/lib/sucker_punch/persistence/version.rb +5 -0
  22. data/spec/activerecord/Rakefile +2 -0
  23. data/spec/activerecord/activerecord_spec.rb +24 -0
  24. data/spec/activerecord/db/config.yml +3 -0
  25. data/spec/activerecord/db/migrate/20140330202513_create_jobs_table.rb +1 -0
  26. data/spec/activerecord/db/schema.rb +24 -0
  27. data/spec/activerecord/migration_generator_spec.rb +25 -0
  28. data/spec/mongoid/mongoid.yml +10 -0
  29. data/spec/mongoid/mongoid_spec.rb +12 -0
  30. data/spec/persistence_spec.rb +54 -0
  31. data/spec/spec_helper.rb +9 -0
  32. data/spec/support/adapter_examples.rb +53 -0
  33. data/spec/support/database_cleaner_support.rb +14 -0
  34. data/spec/support/persistence_support.rb +21 -0
  35. data/sucker_punch-persistence.gemspec +40 -0
  36. metadata +274 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 49bdc935eb355f7c2ba36bc59952b7bec90fd119
4
+ data.tar.gz: afb191abe9c9e05c9fef46be93bf1ee50f860e0e
5
+ SHA512:
6
+ metadata.gz: c2db82b5ff53d5067e1516693e7b460df4950c20e5fab6ca8e4f6b8dcc8560c7f220740c78a7c2d59d6d15da4f4d19c8307fd8f0f6e8dfce5f091c16d24c562e
7
+ data.tar.gz: 017a4b9f1fd4ee8aaef50d9da41b63e81aa3be51ce00cb9c0ff1e5dcc4ff060380be01e6db034237ad594e5ad25c8a3c65f2cb2daf19fe74b6e1c8e6c14b996a
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ *.sqlite
6
+ .yardoc
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --format progress
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,150 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ sucker_punch-persistence (0.0.1)
5
+ activerecord (>= 3.0.0)
6
+ mongoid (>= 3.0.0)
7
+ sucker_punch (~> 1.0)
8
+
9
+ GEM
10
+ remote: https://rubygems.org/
11
+ specs:
12
+ actionmailer (3.2.17)
13
+ actionpack (= 3.2.17)
14
+ mail (~> 2.5.4)
15
+ actionpack (3.2.17)
16
+ activemodel (= 3.2.17)
17
+ activesupport (= 3.2.17)
18
+ builder (~> 3.0.0)
19
+ erubis (~> 2.7.0)
20
+ journey (~> 1.0.4)
21
+ rack (~> 1.4.5)
22
+ rack-cache (~> 1.2)
23
+ rack-test (~> 0.6.1)
24
+ sprockets (~> 2.2.1)
25
+ activemodel (3.2.17)
26
+ activesupport (= 3.2.17)
27
+ builder (~> 3.0.0)
28
+ activerecord (3.2.17)
29
+ activemodel (= 3.2.17)
30
+ activesupport (= 3.2.17)
31
+ arel (~> 3.0.2)
32
+ tzinfo (~> 0.3.29)
33
+ activeresource (3.2.17)
34
+ activemodel (= 3.2.17)
35
+ activesupport (= 3.2.17)
36
+ activesupport (3.2.17)
37
+ i18n (~> 0.6, >= 0.6.4)
38
+ multi_json (~> 1.0)
39
+ arel (3.0.3)
40
+ builder (3.0.4)
41
+ celluloid (0.15.2)
42
+ timers (~> 1.1.0)
43
+ coderay (1.1.0)
44
+ columnize (0.3.6)
45
+ database_cleaner (1.2.0)
46
+ debugger (1.6.6)
47
+ columnize (>= 0.3.1)
48
+ debugger-linecache (~> 1.2.0)
49
+ debugger-ruby_core_source (~> 1.3.2)
50
+ debugger-linecache (1.2.0)
51
+ debugger-ruby_core_source (1.3.2)
52
+ diff-lcs (1.2.5)
53
+ erubis (2.7.0)
54
+ generator_spec (0.9.2)
55
+ activesupport (>= 3.0.0)
56
+ railties (>= 3.0.0)
57
+ hike (1.2.3)
58
+ i18n (0.6.9)
59
+ journey (1.0.4)
60
+ json (1.8.1)
61
+ mail (2.5.4)
62
+ mime-types (~> 1.16)
63
+ treetop (~> 1.4.8)
64
+ method_source (0.8.2)
65
+ mime-types (1.25.1)
66
+ mongoid (3.1.6)
67
+ activemodel (~> 3.2)
68
+ moped (~> 1.4)
69
+ origin (~> 1.0)
70
+ tzinfo (~> 0.3.29)
71
+ moped (1.5.2)
72
+ multi_json (1.9.2)
73
+ origin (1.1.0)
74
+ polyglot (0.3.4)
75
+ pry (0.9.12.6)
76
+ coderay (~> 1.0)
77
+ method_source (~> 0.8)
78
+ slop (~> 3.4)
79
+ pry-debugger (0.2.2)
80
+ debugger (~> 1.3)
81
+ pry (~> 0.9.10)
82
+ rack (1.4.5)
83
+ rack-cache (1.2)
84
+ rack (>= 0.4)
85
+ rack-ssl (1.3.4)
86
+ rack
87
+ rack-test (0.6.2)
88
+ rack (>= 1.0)
89
+ rails (3.2.17)
90
+ actionmailer (= 3.2.17)
91
+ actionpack (= 3.2.17)
92
+ activerecord (= 3.2.17)
93
+ activeresource (= 3.2.17)
94
+ activesupport (= 3.2.17)
95
+ bundler (~> 1.0)
96
+ railties (= 3.2.17)
97
+ railties (3.2.17)
98
+ actionpack (= 3.2.17)
99
+ activesupport (= 3.2.17)
100
+ rack-ssl (~> 1.3.2)
101
+ rake (>= 0.8.7)
102
+ rdoc (~> 3.4)
103
+ thor (>= 0.14.6, < 2.0)
104
+ rake (10.2.2)
105
+ rdoc (3.12.2)
106
+ json (~> 1.4)
107
+ rspec (2.14.1)
108
+ rspec-core (~> 2.14.0)
109
+ rspec-expectations (~> 2.14.0)
110
+ rspec-mocks (~> 2.14.0)
111
+ rspec-core (2.14.8)
112
+ rspec-expectations (2.14.5)
113
+ diff-lcs (>= 1.1.3, < 2.0)
114
+ rspec-mocks (2.14.6)
115
+ slop (3.5.0)
116
+ sprockets (2.2.2)
117
+ hike (~> 1.2)
118
+ multi_json (~> 1.0)
119
+ rack (~> 1.0)
120
+ tilt (~> 1.1, != 1.3.0)
121
+ sqlite3 (1.3.8)
122
+ standalone_migrations (2.1.1)
123
+ activerecord (~> 3.2.13)
124
+ railties (~> 3.2.13)
125
+ rake
126
+ sucker_punch (1.0.3)
127
+ celluloid (~> 0.15.2)
128
+ thor (0.19.1)
129
+ tilt (1.4.1)
130
+ timers (1.1.0)
131
+ treetop (1.4.15)
132
+ polyglot
133
+ polyglot (>= 0.3.1)
134
+ tzinfo (0.3.39)
135
+
136
+ PLATFORMS
137
+ ruby
138
+
139
+ DEPENDENCIES
140
+ bundler (~> 1.3)
141
+ database_cleaner
142
+ generator_spec
143
+ pry
144
+ pry-debugger
145
+ rails
146
+ rake
147
+ rspec
148
+ sqlite3
149
+ standalone_migrations
150
+ sucker_punch-persistence!
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2014 Josh Jordan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # SuckerPunch::Persistence
2
+
3
+ ActiveRecord and Mongoid persistence for asynchronous jobs created with sucker_punch
4
+
5
+ ## Warning
6
+
7
+ This gem is **not** production-ready. I do not recommend using it yet.
8
+
9
+ See [1.0 issues](https://github.com/joshjordan/sucker_punch-persistence/issues?milestone=1&state=open)
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ gem 'sucker_punch-persistence'
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install sucker_punch-persistence
24
+
25
+ ## Contributing
26
+
27
+ 1. Fork it
28
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
29
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
30
+ 4. Push to the branch (`git push origin my-new-feature`)
31
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,5 @@
1
+ require 'bundler/gem_tasks'
2
+
3
+ task :console do
4
+ exec 'pry -r sucker_punch/persistence -I ./lib'
5
+ end
@@ -0,0 +1,19 @@
1
+ require 'rails/generators'
2
+ require 'rails/generators/active_record'
3
+
4
+ module SuckerPunch::Persistence::ActiveRecord
5
+ class MigrationGenerator < ::Rails::Generators::Base
6
+ include ::Rails::Generators::Migration
7
+
8
+ source_root File.expand_path('../templates', __FILE__)
9
+
10
+ desc 'Generates (but does not run) a migration to add a Jobs table.'
11
+ def create_migration_file
12
+ migration_template 'create_jobs_table.rb', 'db/migrate/create_jobs_table.rb'
13
+ end
14
+
15
+ def self.next_migration_number(dirname)
16
+ ::ActiveRecord::Generators::Base.next_migration_number(dirname)
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,10 @@
1
+ class CreateJobsTable < ActiveRecord::Migration
2
+ def change
3
+ create_table :jobs do |t|
4
+ t.timestamps null: false
5
+ t.string :status, null: false
6
+ t.text :arguments
7
+ t.text :result
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,11 @@
1
+ require 'sucker_punch'
2
+
3
+ require 'sucker_punch/persistence/mailbox_factory'
4
+ require 'sucker_punch/persistence/call'
5
+ require 'sucker_punch/persistence/version'
6
+
7
+ module SuckerPunch::Persistence
8
+ def prepended(klass)
9
+ klass.mailbox_class MailboxFactory.new(persistence_adapter)
10
+ end
11
+ end
@@ -0,0 +1,18 @@
1
+ require 'sucker_punch/persistence/activerecord/adapter'
2
+ require 'sucker_punch/persistence/activerecord/job'
3
+
4
+ module SuckerPunch::Persistence
5
+ module ActiveRecord
6
+ extend SuckerPunch::Persistence
7
+
8
+ def self.persistence_adapter
9
+ Adapter.new
10
+ end
11
+
12
+ def perform(*args, completed_callback)
13
+ super(*args).tap do |return_value|
14
+ completed_callback.call(return_value)
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,13 @@
1
+ module SuckerPunch::Persistence::ActiveRecord
2
+ class Adapter
3
+ def create_record(arguments)
4
+ Job.create!(arguments: arguments, status: 'queued')
5
+ end
6
+
7
+ def update_status(record, status, return_value = nil)
8
+ record.status = status
9
+ record.result = return_value if return_value
10
+ record.save!
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,8 @@
1
+ require 'active_record'
2
+
3
+ module SuckerPunch::Persistence::ActiveRecord
4
+ class Job < ActiveRecord::Base
5
+ serialize :arguments
6
+ serialize :result
7
+ end
8
+ end
@@ -0,0 +1,13 @@
1
+ module SuckerPunch::Persistence
2
+ module Call
3
+ attr_accessor :record, :data_store
4
+
5
+ def dispatch(*args)
6
+ data_store.update_status(record, 'started')
7
+ @arguments.push ->(return_value) do
8
+ data_store.update_status(record, 'complete', return_value)
9
+ end
10
+ super
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,22 @@
1
+ module SuckerPunch::Persistence
2
+ class Mailbox < ::Celluloid::Mailbox
3
+ def initialize(data_store)
4
+ super()
5
+ self.data_store = data_store
6
+ end
7
+
8
+ def <<(message)
9
+ if message.is_a?(::Celluloid::Call) && (arguments = message.arguments.dup).shift == :perform
10
+ record = data_store.create_record(arguments)
11
+ message.extend(SuckerPunch::Persistence::Call)
12
+ message.data_store = data_store
13
+ message.record = record
14
+ end
15
+ super
16
+ end
17
+
18
+ private
19
+
20
+ attr_accessor :data_store
21
+ end
22
+ end
@@ -0,0 +1,13 @@
1
+ require 'sucker_punch/persistence/mailbox'
2
+
3
+ module SuckerPunch::Persistence
4
+ class MailboxFactory
5
+ def initialize(persistence_adapter)
6
+ @persistence_adapter = persistence_adapter
7
+ end
8
+
9
+ def new
10
+ Mailbox.new(@persistence_adapter)
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,18 @@
1
+ require 'sucker_punch/persistence/mongoid/adapter'
2
+ require 'sucker_punch/persistence/mongoid/job'
3
+
4
+ module SuckerPunch::Persistence
5
+ module Mongoid
6
+ extend SuckerPunch::Persistence
7
+
8
+ def self.persistence_adapter
9
+ Adapter.new
10
+ end
11
+
12
+ def perform(*args, completed_callback)
13
+ super(*args).tap do |return_value|
14
+ completed_callback.call(return_value)
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,13 @@
1
+ module SuckerPunch::Persistence::Mongoid
2
+ class Adapter
3
+ def create_record(arguments)
4
+ Job.create!(arguments: arguments, status: 'queued')
5
+ end
6
+
7
+ def update_status(record, status, return_value = nil)
8
+ record.status = status
9
+ record.result = return_value if return_value
10
+ record.save!
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,11 @@
1
+ require 'mongoid'
2
+
3
+ module SuckerPunch::Persistence::Mongoid
4
+ class Job
5
+ include ::Mongoid::Document
6
+
7
+ field :status
8
+ field :arguments, type: Array
9
+ field :result
10
+ end
11
+ end
@@ -0,0 +1,5 @@
1
+ module SuckerPunch
2
+ module Persistence
3
+ VERSION = "0.0.1"
4
+ end
5
+ end
@@ -0,0 +1,2 @@
1
+ require 'standalone_migrations'
2
+ StandaloneMigrations::Tasks.load_tasks
@@ -0,0 +1,24 @@
1
+ require 'spec_helper'
2
+
3
+ require 'sucker_punch/persistence/activerecord'
4
+
5
+ describe SuckerPunch::Persistence::ActiveRecord do
6
+ db_config = YAML.load_file('spec/activerecord/db/config.yml')['development']
7
+ db_config['database'] = "spec/activerecord/#{db_config['database']}"
8
+
9
+ before(:all) do
10
+ ActiveRecord::Base.establish_connection(db_config)
11
+ end
12
+
13
+ before(:each) do
14
+ ActiveRecord::Base.establish_connection(db_config)
15
+ end
16
+
17
+ include_context 'database cleaning', :active_record
18
+
19
+ after(:each) do
20
+ ActiveRecord::Base.connection.close
21
+ end
22
+
23
+ include_examples 'a datastore adapter', 'ActiveRecord'
24
+ end
@@ -0,0 +1,3 @@
1
+ development:
2
+ adapter: sqlite3
3
+ database: db/sucker_punch-persistence.sqlite
@@ -0,0 +1 @@
1
+ require 'generators/sucker_punch/activerecord/templates/create_jobs_table'
@@ -0,0 +1,24 @@
1
+ # encoding: UTF-8
2
+ # This file is auto-generated from the current state of the database. Instead
3
+ # of editing this file, please use the migrations feature of Active Record to
4
+ # incrementally modify your database, and then regenerate this schema definition.
5
+ #
6
+ # Note that this schema.rb definition is the authoritative source for your
7
+ # database schema. If you need to create the application database on another
8
+ # system, you should be using db:schema:load, not running all the migrations
9
+ # from scratch. The latter is a flawed and unsustainable approach (the more migrations
10
+ # you'll amass, the slower it'll run and the greater likelihood for issues).
11
+ #
12
+ # It's strongly recommended to check this file into your version control system.
13
+
14
+ ActiveRecord::Schema.define(:version => 20140330202513) do
15
+
16
+ create_table "jobs", :force => true do |t|
17
+ t.datetime "created_at", :null => false
18
+ t.datetime "updated_at", :null => false
19
+ t.string "status", :null => false
20
+ t.text "arguments"
21
+ t.text "result"
22
+ end
23
+
24
+ end
@@ -0,0 +1,25 @@
1
+ require 'spec_helper'
2
+ require 'generators/sucker_punch/activerecord/migration_generator'
3
+
4
+ describe SuckerPunch::Persistence::ActiveRecord::MigrationGenerator, :type => :generator do
5
+ include GeneratorSpec::TestCase
6
+ destination File.expand_path('../tmp', __FILE__)
7
+
8
+ after(:each) { prepare_destination }
9
+
10
+ it "generates a migration for creating the Jobs table" do
11
+ run_generator
12
+
13
+ destination_root.should have_structure {
14
+ directory 'db' do
15
+ directory 'migrate' do
16
+ migration 'create_jobs_table' do
17
+ contains 'class CreateJobs'
18
+ contains 'def change'
19
+ contains 'create_table :jobs do |t|'
20
+ end
21
+ end
22
+ end
23
+ }
24
+ end
25
+ end
@@ -0,0 +1,10 @@
1
+ development:
2
+ sessions:
3
+ default:
4
+ database: sucker_punch-persistence
5
+ hosts:
6
+ - localhost
7
+ options:
8
+ consistency: :strong
9
+ max_retries: 1
10
+ retry_interval: 0
@@ -0,0 +1,12 @@
1
+ require 'spec_helper'
2
+
3
+ require 'sucker_punch/persistence/mongoid'
4
+
5
+ describe SuckerPunch::Persistence::Mongoid do
6
+ before(:all) do
7
+ Mongoid.load!('spec/mongoid/mongoid.yml')
8
+ end
9
+
10
+ include_context 'database cleaning', :mongoid
11
+ include_examples 'a datastore adapter', 'Mongoid'
12
+ end
@@ -0,0 +1,54 @@
1
+ require 'spec_helper'
2
+
3
+ describe SuckerPunch::Persistence do
4
+ class TestJob
5
+ include SuckerPunch::Job
6
+ prepend ::PersistenceSupport::TestDataStore
7
+
8
+ def perform(*args)
9
+ 'Hamato Yoshi'
10
+ end
11
+ end
12
+
13
+ it 'persists asynchronous jobs as they are queued' do
14
+ PersistenceSupport::TestDataStore
15
+ .should_receive(:create_record)
16
+ .with(['Donatello'])
17
+
18
+ TestJob.new.async.perform('Donatello')
19
+ end
20
+
21
+ it 'persists synchronous jobs when they are queued' do
22
+ PersistenceSupport::TestDataStore
23
+ .should_receive(:create_record)
24
+ .with(['Raphael'])
25
+
26
+ TestJob.new.perform('Raphael')
27
+ end
28
+
29
+ it 'marks job records as started before executing them' do
30
+ PersistenceSupport::TestDataStore
31
+ .should_receive(:update_status)
32
+ .with({ data: ['Raphael']}, 'started')
33
+ .ordered
34
+
35
+ PersistenceSupport::TestDataStore
36
+ .should_receive(:update_status)
37
+ .with(any_args).ordered
38
+
39
+ TestJob.new.perform('Raphael')
40
+ end
41
+
42
+ it 'marks job records as finished after executing them' do
43
+ PersistenceSupport::TestDataStore
44
+ .should_receive(:update_status)
45
+ .with(any_args).once.ordered
46
+
47
+ PersistenceSupport::TestDataStore
48
+ .should_receive(:update_status)
49
+ .with({ data: ['Leonardo']}, 'complete', 'Hamato Yoshi')
50
+ .ordered
51
+
52
+ TestJob.new.perform('Leonardo')
53
+ end
54
+ end
@@ -0,0 +1,9 @@
1
+ Bundler.require(:default, :development)
2
+
3
+ require 'sucker_punch/testing/inline'
4
+
5
+ Dir["#{Dir.pwd}/spec/support/**/*.rb"].each {|f| require f}
6
+
7
+ RSpec.configure do |config|
8
+ config.order = 'random'
9
+ end
@@ -0,0 +1,53 @@
1
+ share_examples_for 'a datastore adapter' do |adapter_name|
2
+ let(:persisted_job_class) do
3
+ adapter_module = namespace
4
+ Class.new do
5
+ include SuckerPunch::Job
6
+ prepend adapter_module
7
+
8
+ def perform(mutant_name)
9
+ 'Hamato Yoshi' if mutant_name == 'Splinter'
10
+ end
11
+ end
12
+ end
13
+
14
+ subject { persisted_job_class.new }
15
+
16
+ it 'persists asynchronous jobs as they are queued' do
17
+ adapter_class.any_instance.stub(:update_status)
18
+
19
+ subject.async.perform('Donatello')
20
+
21
+ job_record.arguments.should eq ['Donatello']
22
+ job_record.status.should eq 'queued'
23
+ end
24
+
25
+ it 'persists synchronous jobs when they are queued' do
26
+ adapter_class.any_instance.stub(:update_status)
27
+
28
+ subject.perform('Raphael')
29
+
30
+ job_record.arguments.should eq ['Raphael']
31
+ job_record.status.should eq 'queued'
32
+ end
33
+
34
+ it 'marks job records as finished after executing them' do
35
+ subject.perform('Leonardo')
36
+
37
+ job_record.status.should eq 'complete'
38
+ end
39
+
40
+ it 'persists the job execution result' do
41
+ subject.perform('Splinter')
42
+
43
+ job_record.result.should eq 'Hamato Yoshi'
44
+ end
45
+
46
+ #Override in spec when data store does not support .first
47
+ let(:job_record) { job_class.first }
48
+
49
+ #Override in spec when data store uses a different naming convention
50
+ let(:adapter_class) { namespace.const_get('Adapter') }
51
+ let(:job_class) { namespace.const_get('Job') }
52
+ let(:namespace) { SuckerPunch::Persistence.const_get(adapter_name) }
53
+ end
@@ -0,0 +1,14 @@
1
+ shared_context 'database cleaning' do |database_type|
2
+ before(:all) do
3
+ DatabaseCleaner[database_type].strategy = :truncation
4
+ DatabaseCleaner[database_type].clean_with :truncation
5
+ end
6
+
7
+ before(:each) do
8
+ DatabaseCleaner[database_type].start
9
+ end
10
+
11
+ after(:each) do
12
+ DatabaseCleaner[database_type].clean
13
+ end
14
+ end
@@ -0,0 +1,21 @@
1
+ module PersistenceSupport
2
+ module TestDataStore
3
+ extend SuckerPunch::Persistence
4
+
5
+ def self.persistence_adapter
6
+ self
7
+ end
8
+
9
+ def self.create_record(args)
10
+ { data: args }
11
+ end
12
+
13
+ def self.update_status(record, status, return_value = nil); end
14
+
15
+ def perform(*args, completed_callback)
16
+ super(*args).tap do |return_value|
17
+ completed_callback.call(return_value)
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,40 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'sucker_punch/persistence/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'sucker_punch-persistence'
8
+ spec.version = SuckerPunch::Persistence::VERSION
9
+ spec.authors = ['Josh Jordan']
10
+ spec.email = ['josh.jordan@gmail.com']
11
+ spec.summary = %q{ActiveRecord and Mongoid persistence for asynchronous jobs created with sucker_punch}
12
+ spec.description = spec.summary
13
+ spec.homepage = 'http://www.github.com/joshjordan/sucker_punch-persistence'
14
+ spec.license = 'MIT'
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ['lib']
20
+
21
+ spec.add_dependency 'sucker_punch', '~> 1.0'
22
+
23
+ #Mongoid: break out to a separate gem
24
+ spec.add_dependency 'mongoid', '>= 3.0.0'
25
+
26
+ #ActiveRecord: break out to a separate gem
27
+ spec.add_dependency 'activerecord', '>= 3.0.0'
28
+ spec.add_development_dependency 'database_cleaner'
29
+ spec.add_development_dependency 'sqlite3'
30
+ spec.add_development_dependency 'rails'
31
+ spec.add_development_dependency 'standalone_migrations'
32
+ spec.add_development_dependency 'generator_spec'
33
+
34
+ spec.add_development_dependency 'bundler', '~> 1.3'
35
+ spec.add_development_dependency 'rake'
36
+
37
+ spec.add_development_dependency 'rspec'
38
+ spec.add_development_dependency 'pry'
39
+ spec.add_development_dependency 'pry-debugger'
40
+ end
metadata ADDED
@@ -0,0 +1,274 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sucker_punch-persistence
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Josh Jordan
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-04-05 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: sucker_punch
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: mongoid
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: 3.0.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: 3.0.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: activerecord
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: 3.0.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: 3.0.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: database_cleaner
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: sqlite3
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - '>='
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - '>='
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rails
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - '>='
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - '>='
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: standalone_migrations
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - '>='
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - '>='
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: generator_spec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - '>='
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - '>='
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: bundler
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ~>
130
+ - !ruby/object:Gem::Version
131
+ version: '1.3'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ~>
137
+ - !ruby/object:Gem::Version
138
+ version: '1.3'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rake
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - '>='
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - '>='
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rspec
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - '>='
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - '>='
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: pry
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - '>='
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - '>='
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: pry-debugger
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - '>='
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - '>='
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ description: ActiveRecord and Mongoid persistence for asynchronous jobs created with
196
+ sucker_punch
197
+ email:
198
+ - josh.jordan@gmail.com
199
+ executables: []
200
+ extensions: []
201
+ extra_rdoc_files: []
202
+ files:
203
+ - .gitignore
204
+ - .rspec
205
+ - Gemfile
206
+ - Gemfile.lock
207
+ - LICENSE
208
+ - README.md
209
+ - Rakefile
210
+ - lib/generators/sucker_punch/activerecord/migration_generator.rb
211
+ - lib/generators/sucker_punch/activerecord/templates/create_jobs_table.rb
212
+ - lib/sucker_punch/persistence.rb
213
+ - lib/sucker_punch/persistence/activerecord.rb
214
+ - lib/sucker_punch/persistence/activerecord/adapter.rb
215
+ - lib/sucker_punch/persistence/activerecord/job.rb
216
+ - lib/sucker_punch/persistence/call.rb
217
+ - lib/sucker_punch/persistence/mailbox.rb
218
+ - lib/sucker_punch/persistence/mailbox_factory.rb
219
+ - lib/sucker_punch/persistence/mongoid.rb
220
+ - lib/sucker_punch/persistence/mongoid/adapter.rb
221
+ - lib/sucker_punch/persistence/mongoid/job.rb
222
+ - lib/sucker_punch/persistence/version.rb
223
+ - spec/activerecord/Rakefile
224
+ - spec/activerecord/activerecord_spec.rb
225
+ - spec/activerecord/db/config.yml
226
+ - spec/activerecord/db/migrate/20140330202513_create_jobs_table.rb
227
+ - spec/activerecord/db/schema.rb
228
+ - spec/activerecord/migration_generator_spec.rb
229
+ - spec/mongoid/mongoid.yml
230
+ - spec/mongoid/mongoid_spec.rb
231
+ - spec/persistence_spec.rb
232
+ - spec/spec_helper.rb
233
+ - spec/support/adapter_examples.rb
234
+ - spec/support/database_cleaner_support.rb
235
+ - spec/support/persistence_support.rb
236
+ - sucker_punch-persistence.gemspec
237
+ homepage: http://www.github.com/joshjordan/sucker_punch-persistence
238
+ licenses:
239
+ - MIT
240
+ metadata: {}
241
+ post_install_message:
242
+ rdoc_options: []
243
+ require_paths:
244
+ - lib
245
+ required_ruby_version: !ruby/object:Gem::Requirement
246
+ requirements:
247
+ - - '>='
248
+ - !ruby/object:Gem::Version
249
+ version: '0'
250
+ required_rubygems_version: !ruby/object:Gem::Requirement
251
+ requirements:
252
+ - - '>='
253
+ - !ruby/object:Gem::Version
254
+ version: '0'
255
+ requirements: []
256
+ rubyforge_project:
257
+ rubygems_version: 2.1.9
258
+ signing_key:
259
+ specification_version: 4
260
+ summary: ActiveRecord and Mongoid persistence for asynchronous jobs created with sucker_punch
261
+ test_files:
262
+ - spec/activerecord/Rakefile
263
+ - spec/activerecord/activerecord_spec.rb
264
+ - spec/activerecord/db/config.yml
265
+ - spec/activerecord/db/migrate/20140330202513_create_jobs_table.rb
266
+ - spec/activerecord/db/schema.rb
267
+ - spec/activerecord/migration_generator_spec.rb
268
+ - spec/mongoid/mongoid.yml
269
+ - spec/mongoid/mongoid_spec.rb
270
+ - spec/persistence_spec.rb
271
+ - spec/spec_helper.rb
272
+ - spec/support/adapter_examples.rb
273
+ - spec/support/database_cleaner_support.rb
274
+ - spec/support/persistence_support.rb