digestifier 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6571f35b67e51f1547d094219716e4545cf9a635
-  data.tar.gz: 0768e76da9516ffca6a432db97a5ff484df60444
+  metadata.gz: d3a5586226e9c9c2d3873fa148109906568a72bd
+  data.tar.gz: f0028131bb564be48fb02c89914559727834f6fd
 SHA512:
-  metadata.gz: 6c54ef82d778a0e4dfda4b7608f1ac382c1dfaa8b00c9c47382433a6fd185e272a989f58a49fd368f8c32ae9d9904f56a73a7a9d86d5fb79f56e4468516404cf
-  data.tar.gz: c474429545bc4fc5600df7c69ebb346fb4443da12cf52cdfd4b2c91aaeff4650aa2706b07ea6076a8a617255d4009886efc29065c6a25879a5cf6e379a0495d0
+  metadata.gz: ae5bb559b00b5e577bf18a91f16398abe0dca5a330806cf553764c44fbc79af499aa54cc72c1e45e7e10e82ccb7ad2707c565aae63da26bb955f34dca7412fa7
+  data.tar.gz: cd7b5a66c3e5592c834ce79380d28ded690e079a36e80814af27a77d1b78f1f3243c14211980a94fa5708398f70b6fb1984a5f46afddef32dca271df9b6f57e0

data/README.md

@@ -1,29 +1,105 @@
 # Digestifier
 
-TODO: Write a gem description
+A simple Rails engine for sending out email digests of activity.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'digestifier'
+    gem 'digestifier', '0.0.2'
 
-And then execute:
+Don't forget to bundle:
 
     $ bundle
 
-Or install it yourself as:
+Then, add the migrations to your app and update your database accordingly:
 
-    $ gem install digestifier
+    $ rake digestifier:install:migrations db:migrate
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+Create an initializer that sets up both a digest and the sender address:
 
-## Contributing
+```ruby
+# config/initializers/digestifier.rb
+
+# Set the sender of your digest emails
+Digestifier.sender = 'Hello <hello@inspire9.com>'
+
+# Set the digest object to a constant so it can be referred to elsewhere.
+DIGEST = Digestifier::Digest.new
+# Set the lambda that returns objects for the digest. This takes a single
+# argument - the time range - and should return a collection of objects. How
+# you get this collection is up to you, but the example below is a decent
+# starting point.
+DIGEST.contents = lambda { |range|
+  Article.where(created_at: range).order(:created_at)
+}
+# The digest recipients defaults to all User objects in your system. If you
+# want to use a different class, or filter those objects, you can customise it:
+DIGEST.recipients = lambda { User }
+# The default frequency is once a day.
+DIGEST.default_frequency = 24.hours
+```
+
+### Sending emails
+
+This will likely go in a rake task - but it's up to you.
+
+```ruby
+Digestifier::Delivery.deliver DIGEST
+```
+
+If it does go in a rake task, ensure the task loads your Rails environment as well:
+
+```ruby
+task :send_digest => :environment do
+  Digestifier::Delivery.deliver DIGEST
+end
+```
+
+### Customising partial templates
+
+This step is almost certainly essential: you'll want to customise how each item in your digest is presented. The partials for this should be located in `app/views/digestifier/mailer`, and use the item's class name, downcased and underscored (for example: `_article.html.erb` or `_comment.html.haml`).
+
+What goes in these templates is completely up to you - the default is super-simple and almost certainly not enough for a decent digest:
+
+```erb
+<%= digest_item.name %>
+```
+
+`digest_item` will be available in your partial, but you can also refer to it using a downcased and underscored interpretation of the class (so, `article` and `comment` respectively in the example file names above).
+
+### Customising the main email
+
+The main email template should probably be overwritten as well - just put your preferred view code in `app/views/digestifier/mailer/digest.[html.erb|html.haml|etc]`.
+
+The two instance variables you have access to are `@recipient` and `@content_items`. If you wish to use the Digestifier partial matching, something like this should do the trick:
+
+```erb
+<% @content_items.each do |item| %>
+  <%= render_digest_partial item %>
+<% end %>
+```
+
+### Customising the mailer
+
+If you want to put your own Mailer, then this is certainly possible:
+
+```ruby
+Digestifier.mailer = CustomMailer
+```
+
+Your new mailer class should respond to `digest` and accept the following arguments: recipient and content_items.
+
+### Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Licence
+
+Copyright (c) 2013, Digestifier is developed and maintained by [Inspire9](http://inspire9.com), and is released under the open MIT Licence.

data/digestifier.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'digestifier'
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = 'Digests as a Rails Engine'

data/lib/digestifier/delivery.rb

@@ -21,9 +21,7 @@ class Digestifier::Delivery
   delegate :default_frequency, to: :digest
 
   def contents
-    digest.contents.call.where(
-      created_at: last_sent..Time.zone.now
-    )
+    digest.contents.call(last_sent..Time.zone.now)
   end
 
   def frequency

data/lib/digestifier/digest.rb

@@ -3,6 +3,6 @@ class Digestifier::Digest
 
   def initialize
     @default_frequency = 24.hours
-    @recipients        = Proc.new { User.order(:id) }
+    @recipients        = lambda { User.order(:id) }
   end
 end

data/spec/acceptance/custom_views_spec.rb

@@ -7,7 +7,9 @@ describe 'Custom digest partials' do
   before :each do
     ActionMailer::Base.deliveries.clear
 
-    digest.contents = lambda { Book }
+    digest.contents = lambda { |range|
+      Book.where(created_at: range).order(:created_at)
+    }
 
     user
   end

data/spec/acceptance/delivering_digests_spec.rb

@@ -7,7 +7,9 @@ describe 'Delivering digests' do
   before :each do
     ActionMailer::Base.deliveries.clear
 
-    digest.contents = lambda { Article }
+    digest.contents = lambda { |range|
+      Article.where(created_at: range).order(:created_at)
+    }
 
     user
   end

data/spec/acceptance/recipient_preferences_spec.rb

@@ -7,7 +7,9 @@ describe 'Custom digest frequency' do
   before :each do
     ActionMailer::Base.deliveries.clear
 
-    digest.contents = lambda { Article }
+    digest.contents = lambda { |range|
+      Article.where(created_at: range).order(:created_at)
+    }
   end
 
   it 'respects receipient frequency preferences' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: digestifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pat Allan