unread 0.1.1 → 0.1.2

data/README.md

@@ -18,82 +18,87 @@ Ruby gem to manage read/unread status of ActiveRecord objects - and it's fast.
 
 ## Requirements
 
-* Ruby 1.8.7 or 1.9.x
+* Ruby 1.8.7 or 1.9.3
 * Rails >= 2.3.6 (including 3.0, 3.1, 3.2)
 * Tested with SQLite and MySQL
-* Needs a timestamp field in your models (e.g. created_at) with a database index on it
+* Needs a timestamp field in your models (like created_at or updated_at) with a database index on it
 
 
 ## Installation
 
 Step 1: Add this to your Gemfile:
-  
+
     gem 'unread'
-    
+
 and run
-  
+
     bundle
-  
-    
+
+
 Step 2: Add this migration:
-    
-    class CreateReadMarks < ActiveRecord::Migration
-      def self.up
-        create_table :read_marks, :force => true do |t|
-          t.integer  :readable_id
-          t.integer  :user_id,       :null => false
-          t.string   :readable_type, :null => false, :limit => 20
-          t.datetime :timestamp
-        end
-        add_index :read_marks, [:user_id, :readable_type, :readable_id]
-      end
-
-      def self.down
-        drop_table :read_marks
-      end
+
+```ruby
+class CreateReadMarks < ActiveRecord::Migration
+  def self.up
+    create_table :read_marks, :force => true do |t|
+      t.integer  :readable_id
+      t.integer  :user_id,       :null => false
+      t.string   :readable_type, :null => false, :limit => 20
+      t.datetime :timestamp
     end
 
+    add_index :read_marks, [:user_id, :readable_type, :readable_id]
+  end
+
+  def self.down
+    drop_table :read_marks
+  end
+end
+```
+
   and run the migration:
-    
+
     rake db:migrate
 
 
 ## Usage
 
-    class User < ActiveRecord::Base
-      acts_as_reader
-    end
-    
-    class Message < ActiveRecord::Base
-      acts_as_readable :on => :created_at
-    end
+```ruby
+class User < ActiveRecord::Base
+  acts_as_reader
+end
+
+class Message < ActiveRecord::Base
+  acts_as_readable :on => :created_at
+end
+
+message1 = Message.create!
+message2 = Message.create!
+
+## Get unread messages for a given user
+Message.unread_by(current_user)
+# => [ message1, message2 ]
+
+message1.mark_as_read! :for => current_user
+Message.unread_by(current_user)
+# => [ message2 ]
 
-    message1 = Message.create!
-    message2 = Message.create!
-    
-    ## Get unread messages for a given user
-    Message.unread_by(current_user)
-    # => [ message1, message2 ]
-    
-    message1.mark_as_read! :for => current_user
-    Message.unread_by(current_user)
-    # => [ message2 ]
-    
-    ## Get all messages including the read status for a given user
-    messages = Message.with_read_marks_for(current_user)
-    # => [ message1, message2 ]
-    messages[0].unread?(current_user)
-    # => false
-    messages[1].unread?(current_user)
-    # => true
-    
-    Message.mark_as_read! :all, :for => current_user
-    Message.unread_by(current_user)
-    # => [ ]
-    
-    # Optional: Cleaning up unneeded markers
-    # Do this in a cron job once a day.
-    Message.cleanup_read_marks!
+## Get all messages including the read status for a given user
+messages = Message.with_read_marks_for(current_user)
+# => [ message1, message2 ]
+messages[0].unread?(current_user)
+# => false
+messages[1].unread?(current_user)
+# => true
+
+Message.mark_as_read! :all, :for => current_user
+Message.unread_by(current_user)
+# => [ ]
+
+# Optional: Cleaning up unneeded markers.
+# Do this in a cron job once a day.
+Message.cleanup_read_marks!
+```
 
 
 ## How does it work?
@@ -109,21 +114,26 @@ It will be ensured that the list of read items will not grow up too much:
 
 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) 
-    
-    # Get the unread messages for this user
-    Message.unread_by(current_user)
-    
-    # => 
-    #     SELECT messages.* 
-    #     FROM messages
-    #     LEFT JOIN read_marks ON read_marks.readable_type = 'Message'
-    #                         AND read_marks.readable_id = messages.id
-    #                         AND read_marks.user_id = 42
-    #                         AND read_marks.timestamp >= messages.created_at 
-    #     WHERE read_marks.id IS NULL 
-    #     AND messages.created_at > '2010-10-20 08:50:00'
+```ruby
+# Assuming we have a user who has marked all messages as read on 2010-10-20 08:50
+current_user = User.find(42)
+
+# Get the unread messages for this user
+Message.unread_by(current_user)
+```
+
+Generated query: 
+
+```sql
+SELECT messages.*
+FROM messages
+LEFT JOIN read_marks ON read_marks.readable_type = 'Message'
+                    AND read_marks.readable_id = messages.id
+                    AND read_marks.user_id = 42
+                    AND read_marks.timestamp >= messages.created_at
+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`.
 
@@ -138,4 +148,4 @@ There are two other gems/plugins doing a similar job:
 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,2012 [Georg Ledermann](http://www.georg-ledermann.de), released under the MIT license
+Copyright (c) 2010-2013 [Georg Ledermann](http://www.georg-ledermann.de), released under the MIT license

data/changelog.md

@@ -1,3 +1,7 @@
+0.1.2 - 2013/01/27
+
+* Scopes: Improved parameter check
+
 0.1.1 - 2012/05/01
 
 * Fixed handling namespaced classes. Closes #10 (thanks to @stanislaw)

data/ci/Gemfile.rails-2.3.x

@@ -3,5 +3,5 @@ source :rubygems
 gem 'activerecord', '~> 2.3.14'
 gem 'sqlite3'
 gem 'mysql2', '~> 0.2.11'
-gem 'mocha'
+gem 'mocha', "~> 0.12.8"
 gem 'rake'

data/ci/Gemfile.rails-3.0.x

@@ -3,5 +3,5 @@ source :rubygems
 gem 'activerecord', '~> 3.0.10'
 gem 'sqlite3'
 gem 'mysql2', '~> 0.2.11'
-gem 'mocha'
+gem 'mocha', "~> 0.12.8"
 gem 'rake'

data/ci/Gemfile.rails-3.1.x

@@ -3,5 +3,5 @@ source :rubygems
 gem 'activerecord', '~> 3.1.1'
 gem 'sqlite3'
 gem 'mysql2', '>= 0.3.6'
-gem 'mocha'
+gem 'mocha', "~> 0.12.8"
 gem 'rake'

data/ci/Gemfile.rails-3.2.x

@@ -3,5 +3,5 @@ source :rubygems
 gem 'activerecord', '~> 3.2.1'
 gem 'sqlite3'
 gem 'mysql2', '>= 0.3.6'
-gem 'mocha'
+gem 'mocha', "~> 0.12.8"
 gem 'rake'

data/lib/unread/acts_as_readable.rb

@@ -106,7 +106,7 @@ module Unread
     end
 
     def cleanup_read_marks!
-      assert_reader
+      assert_reader_class
       
       ReadMark.reader_class.find_each do |user|
         ReadMark.transaction do
@@ -126,7 +126,7 @@ module Unread
     end
     
     def reset_read_marks!(user = :all)
-      assert_reader
+      assert_reader_class
 
       ReadMark.transaction do
         if user == :all
@@ -145,12 +145,15 @@ module Unread
       true
     end
     
-    def assert_reader(user=nil)
-      if ReadMark.reader_class
-        if user && !user.is_a?(ReadMark.reader_class)
-          raise ArgumentError, "Class #{user.class.name} is not registered by acts_as_reader!"
-        end
-      else
+    def assert_reader(user)
+      assert_reader_class
+      
+      raise ArgumentError, "Class #{user.class.name} is not registered by acts_as_reader!" unless user.is_a?(ReadMark.reader_class)
+      raise ArgumentError, "The given user has no id!" unless user.id
+    end
+    
+    def assert_reader_class
+      unless ReadMark.reader_class
         raise RuntimeError, 'There is no class using acts_as_reader!'
       end
     end

data/lib/unread/version.rb

@@ -1,3 +1,3 @@
 module Unread
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/test_helper.rb

@@ -12,15 +12,12 @@ ActiveRecord::Base.establish_connection(db_name)
 ActiveRecord::Migration.verbose = false
 load(File.dirname(__FILE__) + "/schema.rb")
 
-module App
-  class Reader < ActiveRecord::Base
-    acts_as_reader
-  end
+class Reader < ActiveRecord::Base
+  acts_as_reader
+end
 
-  class Email < ActiveRecord::Base
-    acts_as_readable :on => :updated_at
-  end
+class Email < ActiveRecord::Base
+  acts_as_readable :on => :updated_at
 end
-include App
 
 puts "Testing with ActiveRecord #{ActiveRecord::VERSION::STRING}"

data/test/unread_test.rb

@@ -34,10 +34,6 @@ class UnreadTest < ActiveSupport::TestCase
     
     assert_equal 2, Email.unread_by(@reader).count
     assert_equal 2, Email.unread_by(@other_reader).count
-    
-    assert_raise(ArgumentError) {
-      Email.unread_by(42)
-    }
   end
   
   def test_with_read_marks_for
@@ -52,6 +48,17 @@ class UnreadTest < ActiveSupport::TestCase
     assert_equal true, emails[1].unread?(@reader)
   end
   
+  def test_scope_param_check
+    [ 42, nil, 'foo', :foo, {} ].each do |not_a_reader|
+      assert_raise(ArgumentError) { Email.unread_by(not_a_reader)}
+      assert_raise(ArgumentError) { Email.with_read_marks_for(not_a_reader)}
+    end
+    
+    unsaved_reader = Reader.new
+    assert_raise(ArgumentError) { Email.unread_by(unsaved_reader)}
+    assert_raise(ArgumentError) { Email.with_read_marks_for(unsaved_reader)}
+  end
+  
   def test_scope_after_reset
     @email1.mark_as_read! :for => @reader
     

data/unread.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '>= 2.3.6'
   
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'mocha', "~> 0.12.8"
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'mysql2'
 end

metadata

@@ -1,104 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: unread
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
-authors: 
+authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
+date: 2013-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 3
-        - 6
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.6
+    none: false
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.8
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
   name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.8
+    none: false
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
   name: mysql2
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id005
-description: "This gem creates a scope for unread objects and adds methods to mark objects as read "
-email: 
+description: ! 'This gem creates a scope for unread objects and adds methods to mark
+  objects as read '
+email:
 - mail@georg-ledermann.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -119,40 +119,31 @@ files:
 - test/test_helper.rb
 - test/unread_test.rb
 - unread.gemspec
-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
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
 requirements: []
-
 rubyforge_project: unread
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Manages read/unread status of ActiveRecord objects
-test_files: 
+test_files:
 - test/database.yml
 - test/schema.rb
 - test/test_helper.rb