expirable 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 916910e100aa840628c2a8290a7e2c5125355746
-  data.tar.gz: c6075ee52e81f11758d7a8e155dd5870b14cd90f
+  metadata.gz: b8956d367c94c4aa41af394e953d3ed1373c9fab
+  data.tar.gz: 73a7a94a0ca5c1ce64280751eb783b68e5aa2231
 SHA512:
-  metadata.gz: 040aabdfa25d7f376d04275b3c2b72f9906957782655130639404d1c50b6d3a1a5da452481f6bac5e89177abb7a059cee7515e1e8d76a514309b402ae3a77377
-  data.tar.gz: bc2eac48b6fdcfba757bfa170ae8977d40245367cd28b59d42bf5c7dfbb4e26e3e0218548dc03154f8f1f09a10c78dce8530c7b8e4e3f4343972fd979c784f93
+  metadata.gz: d4bd2017ed7aef995fca1ab9a0a44ca6db3a2cc834eb6432f336853be2fda9c95e392de844975e643d0d09f1296eb5b912198cd09f5fa66e79cee23ec3b162ad
+  data.tar.gz: 487c0bb9cd88a3943943d4d5349d3966ea3e51b5ab6d41d6a32b5839ee23c472dc50d6006ffa25ddb4b240d48305cf730dd77d87aa2f9f6120967caaa63bfbce

data/README.md

@@ -0,0 +1,76 @@
+Expirable
+=========
+
+Expirable is a simple Rails mixin to handle deadlines in workflows.
+It builds on [Delayed::Job](https://github.com/collectiveidea/delayed_job)
+and [Clockwork](https://github.com/tomykaira/clockwork) to provide a painless approach
+to handling time-based events.
+
+
+Installation
+------------
+
+To install the Expirable and its dependencies, add `expirable` and an
+appropriate Delayed::Jobs backend to your Gemfile:
+```rb
+gem 'delayed_job_active_record'
+gem 'expirable'
+```
+
+Next, set up Delayed::Job if you are not already using it in your project:
+```bash
+rails generate delayed_job:active_record
+rake db:migrate
+```
+
+Finally, set up Expirable itself by running `rails g expirable:setup`.
+This will create a Clockwork configuration file called _lib/clock.rb_.
+By default, it is configured to check deadlines at one minute past every hour.
+See the [Clockwork manual](https://github.com/tomykaira/clockwork#clockwork---a-clock-process-to-replace-cron--)
+for more information if you need to change this configuration.
+
+
+Running Expirable
+-----------------
+
+To run Expirable, you will need to run a Clockwork worker and a Delayed::Job worker.
+You can run the Clockwork worker by executing `bundle exec clockwork lib/clock.rb`
+from the root of the Rails project, and Delayed::Job worker with `./bin/delayed_job run`.
+
+You can also use [Foreman](http://blog.daviddollar.org/2011/05/06/introducing-foreman.html)
+to manage these processes. For example, if you run your Rails application on Unicorn, then
+you can create a `Procfile` with the following content and run your application with `foreman start`:
+```conf
+cron: bundle exec clockwork lib/clock.rb
+web: bundle exec unicorn_rails
+worker: ./bin/delayed_job run
+```
+
+
+Handling Deadlines
+------------------
+
+To be expirable, a class must do the following three things:
+
+1. include `Expirable`;
+2. define a `deadline_expired` instance method that will be invoked when the model's deadline expires; and
+3. define a class method named `newly_expired` that returns a collection of model instances that have expired, but haven't yet received a `deadline_expired` message.
+
+As an example, the following model uses [AASM](https://github.com/aasm/aasm) and Expirable to transition tasks to a failed state when their deadline is passed:
+```rb
+class ExampleTask < ActiveRecord::Base
+  include AASM
+  include Expirable
+  
+  scope :newly_expired,
+        -> { in_progress.where('deadline < ?', DateTime.now) }
+
+  aasm do
+    # ... state and event definitions skipped ...
+
+    event :deadline_expired do
+      transitions from: :in_progress, to: :missed
+    end
+  end
+end
+```

data/lib/generators/expirable/setup/setup_generator.rb

@@ -0,0 +1,13 @@
+module Expirable
+  module Generators
+    class SetupGenerator < Rails::Generators::Base
+      desc "Creates a basic clock.rb file to perform expiration hourly"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_clock_config
+        copy_file "clock.rb", "lib/clock.rb"
+      end
+    end
+  end
+end

data/lib/generators/expirable/setup/templates/clock.rb

@@ -0,0 +1,14 @@
+require 'clockwork'
+require './config/boot'
+require './config/environment'
+
+# Ensure all of the models are loaded. Expirable models are automatically
+#  registered when their class definitions are evaluated, so we need to
+#  load all of them when clockwork starts up.
+Rails.application.eager_load!
+
+module Clockwork
+  every 1.hour, 'Expirable.send_expired_events', at: '**:01' do
+    Expirable.send_expired_events
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expirable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brendan MacDonell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,7 +58,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/expirable.rb
+- lib/generators/expirable/setup/setup_generator.rb
+- lib/generators/expirable/setup/templates/clock.rb
 homepage: http://rubygems.org/gems/expirable
 licenses:
 - MIT