activeasync 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+
+before_script: "sh -c 'cd spec/dummy && bundle exec rake db:migrate'"

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.2 (2012-01-26)
+* railtie for initializing activeasync in rails
+* rspec module for use in testing
+
 ## 0.0.1 (2012-01-26)
 
 * async method: interface for sending methods with arguments to Resque

data/Gemfile

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

data/README.md

@@ -0,0 +1,110 @@
+# ActiveAsync
+
+ActiveAsync aims to provide an interface for easily setting up ActiveRecord objects
+and ruby classes to run methods asynchronously.
+
+ActiveAsync currently depends on Resque and ActiveSupport.
+
+[![Build Status](https://secure.travis-ci.org/challengepost/activeasync.png)](http://travis-ci.org/challengepost/activeasync)
+
+## Install
+
+In your Gemfile
+
+    gem "activeasync"
+
+Or via command line
+
+    gem install activeasync
+
+
+## Usage
+
+Background class methods
+
+``` ruby
+require 'active_async'
+
+class HeavyLifter
+  include ActiveAsync::Async
+
+  def lift(*stuff)
+    # heavy lifting
+  end
+
+end
+
+HeavyLifter.async(:lift, 1, 2, 3)
+```
+
+With ActiveRecord and Rails
+
+``` ruby
+# config/application.rb
+require 'active_async/railtie'
+
+# app/models/risky_business.rb
+class RiskyBusiness < ActiveRecord::Base
+
+  def party_time
+    # all night long
+  end
+
+end
+
+business = RiskyBusiness.last
+business.async(:party_time)     # runs business#party_time asynchronously
+```
+
+Run callbacks asynchronously
+
+``` ruby
+class LateNite < ActiveRecord::Base
+  after_save :drive_home, :async => true
+
+  def drive_home
+    # traffic jam
+  end
+
+end
+
+late_nite = LateNite.last
+late_nite.save                # runs late_night#drive_home asynchronously after save
+```
+
+## RSpec
+
+ActiveAsync comes with some helpers support for RSpec.
+
+To remove Resque dependency from some of your specs, use the :stub_resque option in
+selectd spec blocks. Async methods will run in the foreground.
+
+``` ruby
+# spec/spec_helper.rb
+
+require 'active_async/rspec'
+
+# spec/models/late_nite_spec.rb
+
+it "drive home after late nite save", :stub_resque do
+  # all methods run in foreground
+end
+```
+
+You can also manually set the Async background adapter to `ActiveAsync::FakeResque` or 
+any similar module/class that responds to `#enqueue(*args)`:
+
+``` ruby
+before do
+  ActiveAsync.background = ActiveAsync::FakeResque
+end
+```
+
+## Contributing
+
+To contribute to activeasync, clone the project and submit pull requests in a branch with tests.
+
+To run tests, install the bundle and migrate the test database:
+
+    $ bundle
+    $ cd spec/dummy && bundle exec rake db:migrate db:test:prepare

data/activeasync.gemspec

@@ -26,6 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rails", "~> 3.0"
   s.add_development_dependency "rspec", "~> 2.8.0"
   s.add_development_dependency "database_cleaner", "~> 0.7.0"
-  s.add_development_dependency "ruby-debug"
   s.add_development_dependency "sqlite3"
 end

data/lib/active_async.rb

@@ -3,7 +3,6 @@ require "active_support/concern"
 require "active_async/version"
 require "active_async/async"
 require "active_async/callbacks"
-require "active_async/active_record"
 
 module ActiveAsync
   extend self

data/lib/active_async/railtie.rb

@@ -0,0 +1,12 @@
+require "rails"
+require "active_record"
+require "active_async"
+require "active_async/active_record"
+
+module ActiveAsync
+  class Railtie < Rails::Railtie
+    initializer "active_async.configure_rails_initialization" do
+      ::ActiveRecord::Base.send :include, ActiveAsync::ActiveRecord
+    end
+  end
+end

data/lib/active_async/rspec.rb

@@ -0,0 +1,13 @@
+require 'active_async'
+require 'active_async/fake_resque'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.before(:each, :stub_resque) do |example|
+    ActiveAsync.background = ActiveAsync::FakeResque
+  end
+
+  config.after(:each, :stub_resque) do |example|
+    ActiveAsync.background = Resque
+  end
+end

data/lib/active_async/version.rb

@@ -1,3 +1,3 @@
 module ActiveAsync
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/active_async/callbacks_spec.rb

@@ -5,8 +5,11 @@ describe ActiveAsync::Callbacks do
   describe "active model example", :stub_resque do
     class DummyBase
       extend ActiveModel::Callbacks
+      include ActiveAsync::Async
+      include ActiveAsync::Callbacks
 
       define_model_callbacks :save, :update, :create
+      define_async_callbacks :after_save, :after_update, :after_create
 
       def id; object_id; end
       def find(id); end
@@ -14,11 +17,6 @@ describe ActiveAsync::Callbacks do
       def save;   run_callbacks :save; end
       def update; run_callbacks :update; end
       def create; run_callbacks :create; end
-
-      include ActiveAsync::Async
-      include ActiveAsync::Callbacks
-
-      define_async_callbacks :after_save, :after_update, :after_create
     end
 
     class DummyUser < DummyBase
@@ -106,7 +104,7 @@ describe ActiveAsync::Callbacks do
         it "should update method name and define async method when async is true" do
           extracted_args = DummyUser.send(:extract_async_methods, [:method_name, {:async => true}])
           extracted_args.should == ["async_method_name", {}]
-          DummyUser.instance_methods.should include("async_method_name")
+          DummyUser.instance_methods.map(&:to_sym).should include(:async_method_name)
         end
       end
 

data/spec/dummy/config/application.rb

@@ -4,10 +4,12 @@ require File.expand_path('../boot', __FILE__)
 require "active_record/railtie"
 require "action_controller/railtie"
 require "action_mailer/railtie"
-require "active_resource/railtie"
+# require "active_resource/railtie"
 # require "sprockets/railtie"
 # require "rails/test_unit/railtie"
 
+require 'active_async/railtie'
+
 if defined?(Bundler)
   # If you precompile assets before deploying to production, use this line
   Bundler.require(*Rails.groups(:assets => %w(development test)))

data/spec/dummy/db/schema.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ ENV["RAILS_ENV"] ||= 'test'
 
 require 'rspec/autorun'
 require 'database_cleaner'
-require 'active_async'
+require 'active_async/rspec'
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 

metadata

@@ -1,141 +1,96 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: activeasync
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 10
-        version: "1.10"
-  requirement: *id001
-  prerelease: false
+date: 2012-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: resque
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70145636764700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  requirement: *id002
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
   prerelease: false
+  version_requirements: *70145636764700
+- !ruby/object:Gem::Dependency
   name: activesupport
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70145636764160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  requirement: *id003
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
   prerelease: false
+  version_requirements: *70145636764160
+- !ruby/object:Gem::Dependency
   name: rails
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70145636763680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 2
-        - 8
-        - 0
-        version: 2.8.0
-  requirement: *id004
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
   prerelease: false
+  version_requirements: *70145636763680
+- !ruby/object:Gem::Dependency
   name: rspec
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70145636763200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 7
-        - 0
-        version: 0.7.0
-  requirement: *id005
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
   prerelease: false
+  version_requirements: *70145636763200
+- !ruby/object:Gem::Dependency
   name: database_cleaner
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70145636762700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id006
-  prerelease: false
-  name: ruby-debug
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id007
   prerelease: false
+  version_requirements: *70145636762700
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: &70145636762300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-description: "Provides async methods ruby objects for queuing background jobs. Currently supports Resque. Bonus: callback hooks for ActiveRecord objects"
-email: 
+  prerelease: false
+  version_requirements: *70145636762300
+description: ! 'Provides async methods ruby objects for queuing background jobs. Currently
+  supports Resque. Bonus: callback hooks for ActiveRecord objects'
+email:
 - rosskaff@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
+- README.md
 - Rakefile
 - activeasync.gemspec
 - lib/active_async.rb
@@ -143,6 +98,8 @@ files:
 - lib/active_async/async.rb
 - lib/active_async/callbacks.rb
 - lib/active_async/fake_resque.rb
+- lib/active_async/railtie.rb
+- lib/active_async/rspec.rb
 - lib/active_async/version.rb
 - spec/active_async/active_record_spec.rb
 - spec/active_async/async_spec.rb
@@ -151,12 +108,8 @@ files:
 - spec/active_async_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/Rakefile
-- spec/dummy/app/assets/images/rails.png
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
 - spec/dummy/app/models/blog.rb
 - spec/dummy/app/models/post.rb
@@ -169,7 +122,6 @@ files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/async.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
@@ -182,51 +134,31 @@ files:
 - spec/dummy/db/migrate/20120127010859_create_blogs.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
-- spec/dummy/lib/assets/.gitkeep
-- spec/dummy/lib/tasks/.gitkeep
 - spec/dummy/log/.gitkeep
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
-- spec/dummy/vendor/assets/javascripts/.gitkeep
-- spec/dummy/vendor/assets/stylesheets/.gitkeep
-- spec/dummy/vendor/plugins/.gitkeep
 - spec/spec_helper.rb
-- spec/support/stub_resque.rb
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: activeasync
-rubygems_version: 1.8.10
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Add async support to ruby objects
 test_files: []
-

data/spec/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
-//
-// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
-// GO AFTER THE REQUIRES BELOW.
-//
-//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -1,13 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the top of the
- * compiled file, but it's generally better to create a new file per style scope.
- *
- *= require_self
- *= require_tree .
-*/

data/spec/dummy/config/initializers/async.rb

@@ -1,2 +0,0 @@
-require 'active_async'
-ActiveRecord::Base.send :include, ActiveAsync::ActiveRecord

data/spec/dummy/public/404.html

@@ -1,26 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>The page you were looking for doesn't exist (404)</title>
-  <style type="text/css">
-    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
-    div.dialog {
-      width: 25em;
-      padding: 0 4em;
-      margin: 4em auto 0 auto;
-      border: 1px solid #ccc;
-      border-right-color: #999;
-      border-bottom-color: #999;
-    }
-    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
-  </style>
-</head>
-
-<body>
-  <!-- This file lives in public/404.html -->
-  <div class="dialog">
-    <h1>The page you were looking for doesn't exist.</h1>
-    <p>You may have mistyped the address or the page may have moved.</p>
-  </div>
-</body>
-</html>

data/spec/dummy/public/422.html

@@ -1,26 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>The change you wanted was rejected (422)</title>
-  <style type="text/css">
-    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
-    div.dialog {
-      width: 25em;
-      padding: 0 4em;
-      margin: 4em auto 0 auto;
-      border: 1px solid #ccc;
-      border-right-color: #999;
-      border-bottom-color: #999;
-    }
-    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
-  </style>
-</head>
-
-<body>
-  <!-- This file lives in public/422.html -->
-  <div class="dialog">
-    <h1>The change you wanted was rejected.</h1>
-    <p>Maybe you tried to change something you didn't have access to.</p>
-  </div>
-</body>
-</html>

data/spec/dummy/public/500.html

@@ -1,25 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>We're sorry, but something went wrong (500)</title>
-  <style type="text/css">
-    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
-    div.dialog {
-      width: 25em;
-      padding: 0 4em;
-      margin: 4em auto 0 auto;
-      border: 1px solid #ccc;
-      border-right-color: #999;
-      border-bottom-color: #999;
-    }
-    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
-  </style>
-</head>
-
-<body>
-  <!-- This file lives in public/500.html -->
-  <div class="dialog">
-    <h1>We're sorry, but something went wrong.</h1>
-  </div>
-</body>
-</html>

data/spec/support/stub_resque.rb

@@ -1,12 +0,0 @@
-require 'active_async/fake_resque'
-
-RSpec.configure do |c|
-  c.treat_symbols_as_metadata_keys_with_true_values = true
-  c.before(:each, :stub_resque) do |example|
-    ActiveAsync.background = ActiveAsync::FakeResque
-  end
-
-  c.after(:each, :stub_resque) do |example|
-    ActiveAsync.background = Resque
-  end
-end