unread 0.0.5 → 0.0.6

data/.travis.yml

@@ -1,6 +1,6 @@
 rvm:
   - 1.8.7
-  - 1.9.2
+  - 1.9.3
 gemfile:
   - ci/Gemfile.rails-2.3.x
   - ci/Gemfile.rails-3.0.x

data/README.md

@@ -1,24 +1,25 @@
 Unread
 ======
 
-Gem to manage read/unread status of ActiveRecord objects - and it's fast.
+Ruby gem to manage read/unread status of ActiveRecord objects - and it's fast.
 
 [![Build Status](https://secure.travis-ci.org/ledermann/unread.png)](http://travis-ci.org/ledermann/unread)
 
+
 ## Features
 
-* Manages unread records for anything you want your users to read (like messages, documents, comments etc.)
-* Supports "mark as read" to mark a **single** record as read
-* Supports "mark all as read" to mark **all** records as read in a single step
-* Gives you a named_scope to get the unread records for a given user
+* Manages unread records for anything you want users to read (like messages, documents, comments etc.)
+* Supports _mark as read_ to mark a **single** record as read
+* Supports _mark all as read__ to mark **all** records as read in a single step
+* Gives you a scope to get the unread records for a given user
 * Needs only one additional database table
 * Most important: Great performance
 
 
 ## Requirements
 
-* Ruby 1.8.7 or 1.9.2
-* ActiveRecord 2.3.x, 3.0.x, 3.1.x (tested with SQLite and MySQL)
+* Ruby 1.8.7 or 1.9.x
+* Rails 2.3.x, 3.0.x, 3.1.x (tested with SQLite and MySQL)
 * Needs a timestamp field in your models (e.g. created_at) with a database index on it
 
 
@@ -28,7 +29,7 @@ Step 1: Add this to your Gemfile:
   
     gem 'unread'
     
-  and run
+and run
   
     bundle
   
@@ -87,16 +88,16 @@ Step 2: Add this migration:
 
 ## How does it work?
 
-The main idea of this gem is to manage a list of read items for every user **after** a certain timestamp.
+The main idea of this gem is to manage a list of read items for every reader **after** a certain timestamp.
 
-The gem defines a named_scope doing a LEFT JOIN to this list, so your app can get the unread items in a performant manner. Of course, other scopes can be combined.
+The gem defines a scope doing a LEFT JOIN to this list, so your app can get the unread items in a performant manner. Of course, other scopes can be combined.
 
 It will be ensured that the list of read items will not grow up too much:
 
-* If a user uses "mark all as read", his list is deleted and the timestamp is set to the current time.
+* If a user uses "mark all as read", his list gets deleted and the timestamp is set to the current time.
 * If a user never uses "mark all as read", the list will grow and grow with each item he reads. But there is help: Your app can use a cleanup method which removes unnecessary list items.
 
-Overall, this gem can be used for large tables, too. If you are in doubt, look at the generated SQL queries, here is an example:
+Overall, this gem can be used for large data. Please have a look at the generated SQL queries, here is an example:
 
     # Assuming we have a user who has marked all messages as read on 2010-10-20 08:50
     current_user = User.find(42) 
@@ -114,22 +115,17 @@ Overall, this gem can be used for large tables, too. If you are in doubt, look a
     #     WHERE read_marks.id IS NULL 
     #     AND messages.created_at > '2010-10-20 08:50:00'
 
-    Hint: You should add a database index on messages.created_at.
+Hint: You should add a database index on `messages.created_at`.
 
 
 ## Similar tools
 
-There a two other gems/plugins doing a similar job:
+There are two other gems/plugins doing a similar job:
 
 * http://github.com/jhnvz/mark_as_read
 * http://github.com/mbleigh/acts-as-readable
 
-Unfortunately, both of them have a lack of performance, because they calculate the unread records doing a _find(:all)_, which should be avoided for a large amount of records. This gem is based on a timestamp algorithm and therefore it's very fast.
-
-
-## TODO
-
-* Add more documentation
+Unfortunately, both of them have a lack of performance, because they calculate the unread records doing a `find(:all)`, which should be avoided for a large amount of records. This gem is based on a timestamp algorithm and therefore it's very fast.
 
 
 Copyright (c) 2010,2011 Georg Ledermann, released under the MIT license

data/ci/Gemfile.rails-3.1.x

@@ -1,6 +1,6 @@
 source :rubygems
 
-gem 'activerecord', '~> 3.1.0'
+gem 'activerecord', '~> 3.1.1'
 gem 'sqlite3'
 gem 'mysql2', '>= 0.3.6'
 gem 'mocha'

data/lib/app/models/read_mark.rb

@@ -1,5 +1,4 @@
 class ReadMark < ActiveRecord::Base
-  belongs_to :user
   belongs_to :readable, :polymorphic => true
   
   validates_presence_of :user_id, :readable_type
@@ -11,10 +10,16 @@ class ReadMark < ActiveRecord::Base
   send scope_method, :readable_type, lambda { |readable_type | { :conditions => { :readable_type => readable_type }}}
   send scope_method, :user,          lambda { |user|           { :conditions => { :user_id => user.id }}}
   send scope_method, :older_than,    lambda { |timestamp|      { :conditions => [ 'timestamp < ?', timestamp] }}
+
+  # Returns the class defined by ActsAsReadable::acts_as_reader
+  def self.reader_class
+    user_association = reflect_on_all_associations(:belongs_to).find { |assoc| assoc.name == :user }
+    user_association.try(:klass)
+  end
   
   if respond_to?(:class_attribute)
-    class_attribute :reader_class, :readable_classes
+    class_attribute :readable_classes
   else
-    class_inheritable_accessor :reader_class, :readable_classes
+    class_inheritable_accessor :readable_classes
   end
 end

data/lib/unread/acts_as_readable.rb

@@ -5,9 +5,9 @@ module Unread
   
   module ActsAsReadable
     def acts_as_reader
-      ReadMark.reader_class = self
+      ReadMark.belongs_to :user, :class_name => self.to_s
       
-      has_many :read_marks, :dependent => :delete_all
+      has_many :read_marks, :dependent => :delete_all, :foreign_key => 'user_id'
       
       after_create do |user|
         (ReadMark.readable_classes || []).each do |klass|

data/lib/unread/version.rb

@@ -1,3 +1,3 @@
 module Unread
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/test/schema.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Schema.define(:version => 0) do
-  create_table :users, :force => true do |t|
+  create_table :readers, :force => true do |t|
     t.string :name
   end
   

data/test/test_helper.rb

@@ -15,7 +15,7 @@ ActiveRecord::Base.establish_connection(db_name)
 ActiveRecord::Migration.verbose = false
 load(File.dirname(__FILE__) + "/schema.rb")
 
-class User < ActiveRecord::Base
+class Reader < ActiveRecord::Base
   acts_as_reader
 end
 

data/test/unread_test.rb

@@ -2,8 +2,8 @@ require 'test_helper'
 
 class UnreadTest < ActiveSupport::TestCase
   def setup
-    @user = User.create! :name => 'David'
-    @other_user = User.create :name => 'Matz'
+    @reader = Reader.create! :name => 'David'
+    @other_reader = Reader.create :name => 'Matz'
     wait
     @email1 = Email.create!
     wait
@@ -11,7 +11,7 @@ class UnreadTest < ActiveSupport::TestCase
   end
   
   def teardown
-    User.delete_all
+    Reader.delete_all
     Email.delete_all
     ReadMark.delete_all
   end
@@ -25,15 +25,15 @@ class UnreadTest < ActiveSupport::TestCase
   end
   
   def test_reader_class
-    assert_equal User, ReadMark.reader_class
+    assert_equal Reader, ReadMark.reader_class
   end
 
   def test_scope
-    assert_equal [@email1, @email2], Email.unread_by(@user)
-    assert_equal [@email1, @email2], Email.unread_by(@other_user)
+    assert_equal [@email1, @email2], Email.unread_by(@reader)
+    assert_equal [@email1, @email2], Email.unread_by(@other_reader)
     
-    assert_equal 2, Email.unread_by(@user).count
-    assert_equal 2, Email.unread_by(@other_user).count
+    assert_equal 2, Email.unread_by(@reader).count
+    assert_equal 2, Email.unread_by(@other_reader).count
     
     assert_raise(ArgumentError) {
       Email.unread_by(42)
@@ -41,15 +41,15 @@ class UnreadTest < ActiveSupport::TestCase
   end
   
   def test_scope_after_reset
-    @email1.mark_as_read! :for => @user
+    @email1.mark_as_read! :for => @reader
     
-    assert_equal [@email2], Email.unread_by(@user)
-    assert_equal 1, Email.unread_by(@user).count
+    assert_equal [@email2], Email.unread_by(@reader)
+    assert_equal 1, Email.unread_by(@reader).count
   end
 
   def test_unread_after_create
-    assert_equal true, @email1.unread?(@user)
-    assert_equal true, @email1.unread?(@other_user)
+    assert_equal true, @email1.unread?(@reader)
+    assert_equal true, @email1.unread?(@other_reader)
     
     assert_raise(ArgumentError) {
       @email1.unread?(42)
@@ -57,77 +57,77 @@ class UnreadTest < ActiveSupport::TestCase
   end
   
   def test_unread_after_update
-    @email1.mark_as_read! :for => @user
+    @email1.mark_as_read! :for => @reader
     wait
     @email1.update_attributes! :subject => 'changed'
 
-    assert_equal true, @email1.unread?(@user)
+    assert_equal true, @email1.unread?(@reader)
   end
   
   def test_mark_as_read
-    @email1.mark_as_read! :for => @user
+    @email1.mark_as_read! :for => @reader
     
-    assert_equal false, @email1.unread?(@user)
-    assert_equal [@email2], Email.unread_by(@user)
+    assert_equal false, @email1.unread?(@reader)
+    assert_equal [@email2], Email.unread_by(@reader)
     
-    assert_equal true, @email1.unread?(@other_user)
-    assert_equal [@email1, @email2], Email.unread_by(@other_user)
+    assert_equal true, @email1.unread?(@other_reader)
+    assert_equal [@email1, @email2], Email.unread_by(@other_reader)
     
-    assert_equal 1, @user.read_marks.single.count
-    assert_equal @email1, @user.read_marks.single.first.readable
+    assert_equal 1, @reader.read_marks.single.count
+    assert_equal @email1, @reader.read_marks.single.first.readable
   end
   
   def test_mark_as_read_multiple
-    assert_equal true, @email1.unread?(@user)
-    assert_equal true, @email2.unread?(@user)
+    assert_equal true, @email1.unread?(@reader)
+    assert_equal true, @email2.unread?(@reader)
     
-    Email.mark_as_read! [ @email1, @email2 ], :for => @user
+    Email.mark_as_read! [ @email1, @email2 ], :for => @reader
     
-    assert_equal false, @email1.unread?(@user)
-    assert_equal false, @email2.unread?(@user)
+    assert_equal false, @email1.unread?(@reader)
+    assert_equal false, @email2.unread?(@reader)
   end
   
   def test_mark_as_read_with_marked_all
     wait
     
-    Email.mark_as_read! :all, :for => @user
-    @email1.mark_as_read! :for => @user
+    Email.mark_as_read! :all, :for => @reader
+    @email1.mark_as_read! :for => @reader
     
-    assert_equal [], @user.read_marks.single
+    assert_equal [], @reader.read_marks.single
   end
   
   def test_mark_as_read_twice
-    @email1.mark_as_read! :for => @user
-    @email1.mark_as_read! :for => @user
+    @email1.mark_as_read! :for => @reader
+    @email1.mark_as_read! :for => @reader
     
-    assert_equal 1, @user.read_marks.single.count
+    assert_equal 1, @reader.read_marks.single.count
   end
   
   def test_mark_all_as_read
-    Email.mark_as_read! :all, :for => @user
-    assert_equal Time.now.to_s, Email.read_mark(@user).timestamp.to_s
+    Email.mark_as_read! :all, :for => @reader
+    assert_equal Time.now.to_s, Email.read_mark(@reader).timestamp.to_s
     
-    assert_equal [], @user.read_marks.single
+    assert_equal [], @reader.read_marks.single
     assert_equal 0, ReadMark.single.count
     assert_equal 2, ReadMark.global.count
   end
   
   def test_cleanup_read_marks
-    assert_equal 0, @user.read_marks.single.count
+    assert_equal 0, @reader.read_marks.single.count
     
-    @email1.mark_as_read! :for => @user
+    @email1.mark_as_read! :for => @reader
     
-    assert_equal [@email2], Email.unread_by(@user)
-    assert_equal 1, @user.read_marks.single.count
+    assert_equal [@email2], Email.unread_by(@reader)
+    assert_equal 1, @reader.read_marks.single.count
     
     Email.cleanup_read_marks!    
     
-    @user.reload
-    assert_equal 0, @user.read_marks.single.count
+    @reader.reload
+    assert_equal 0, @reader.read_marks.single.count
   end
   
   def test_cleanup_read_marks_not_delete_from_other_readables
-    other_read_mark = @user.read_marks.create! :readable_type => 'Foo', :readable_id => 42, :timestamp => 5.years.ago
+    other_read_mark = @reader.read_marks.create! :readable_type => 'Foo', :readable_id => 42, :timestamp => 5.years.ago
     Email.cleanup_read_marks!
     assert_equal true, ReadMark.exists?(other_read_mark.id)
   end

data/unread.gemspec

@@ -1,7 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "unread/version"
-require 'active_record/version'
 
 Gem::Specification.new do |s|
   s.name        = "unread"
@@ -24,10 +23,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'sqlite3'
-  
-  if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 1
-    s.add_development_dependency 'mysql2', '>= 0.3.6'
-  else
-    s.add_development_dependency 'mysql2', '~> 0.2.11'
-  end
+  s.add_development_dependency 'mysql2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: unread
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Georg Ledermann
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-09 00:00:00 Z
+date: 2011-11-11 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -82,12 +83,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 3
         segments: 
         - 0
-        - 3
-        - 6
-        version: 0.3.6
+        version: "0"
   type: :development
   version_requirements: *id005
 description: "This gem creates a scope for unread objects and adds methods to mark objects as read "
@@ -121,6 +120,7 @@ files:
 - test/unread_test.rb
 - uninstall.rb
 - unread.gemspec
+has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: unread
-rubygems_version: 1.8.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Manages read/unread status of ActiveRecord objects