unread 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62f6d5dbe191941fe9f5b358318fefbf93ad0c20
-  data.tar.gz: 80e1d361fc919f39f33142283b2dfe8d1d9376a1
+  metadata.gz: 641b3b24fbf159c92f7b4a29485b987454cd382f
+  data.tar.gz: 2aa121f6822aad813d903014bf3284b7323a8cbb
 SHA512:
-  metadata.gz: 8808316873efd20db90cb45b9bbf14e4bc6fb3336f69d3f2480bfe8feaee04a21c39a44672d28c892e6365ceb26440525c36283e27d6508baec32f8e2aa72246
-  data.tar.gz: a55db92bee6d0b5969cb244655137e08afc7438a8abedbcb65f92a44d05c77ce60dad18d677e64c745b3b831063e08a5076773d717773d30a1685f74d2735f1e
+  metadata.gz: fd852349b8f7365896c4b2d35e88f18dd7cf3ce3275f52dc0b8c55a24334306d4a6cb22ac98d356d80b92588ebbe9b78d0cd9924785f7524a32055aec0d0c598
+  data.tar.gz: 80038ecb572e07cc0ca3e1e21ae4e2879f21d80d13d03c6d6c524a7000f0098bac258d5b3f142a71cbf20b384c80c3e579ea4e6e08c1228eba351aa6e7251a8c

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.0
+  - 2.1
+  - 2.2
 gemfile:
   - ci/Gemfile-rails-3-0
   - ci/Gemfile-rails-3-1
   - ci/Gemfile-rails-3-2
   - ci/Gemfile-rails-4-0
   - ci/Gemfile-rails-4-1
+  - ci/Gemfile-rails-4-2
 before_install: gem update bundler
+sudo: false

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2014 Georg Ledermann
+Copyright (c) 2010-2015 Georg Ledermann
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -140,4 +140,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-2014 [Georg Ledermann](http://www.georg-ledermann.de), released under the MIT license
+Copyright (c) 2010-2015 [Georg Ledermann](http://www.georg-ledermann.de), released under the MIT license

data/ci/Gemfile-rails-4-2

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.2.0'
+gem 'sqlite3'
+gem 'timecop'
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'
+gem 'coveralls'

data/lib/generators/unread/migration/templates/migration.rb

@@ -1,9 +1,8 @@
 class UnreadMigration < 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
+    create_table :read_marks, force: true do |t|
+      t.references :readable, polymorphic: { null: false }
+      t.references :user,     null: false
       t.datetime :timestamp
     end
 

data/lib/unread/base.rb

@@ -4,7 +4,7 @@ module Unread
   end
 
   module Base
-    def acts_as_reader
+    def acts_as_reader(options={})
       ReadMark.belongs_to :user, :class_name => self.to_s
 
       has_many :read_marks, :dependent => :delete_all, :foreign_key => 'user_id', :inverse_of => :user
@@ -18,6 +18,9 @@ module Unread
         end
       end
 
+      ReadMark.reader_class = self
+      ReadMark.reader_options = options
+
       include Reader::InstanceMethods
     end
 

data/lib/unread/read_mark.rb

@@ -11,9 +11,18 @@ class ReadMark < ActiveRecord::Base
   scope :older_than, lambda { |timestamp| where([ 'timestamp < ?', timestamp ]) }
 
   # Returns the class defined by acts_as_reader
-  def self.reader_class
-    reflect_on_all_associations(:belongs_to).find { |assoc| assoc.name == :user }.try(:klass)
-  end
+  class_attribute :reader_class
+  class_attribute :reader_options
 
+  # Returns the classes defined by acts_as_readable
   class_attribute :readable_classes
+
+  def self.reader_scope
+    result = reader_class
+
+    Array(reader_options[:scopes]).each do |scope|
+      result = result.send(scope)
+    end
+    result
+  end
 end

data/lib/unread/readable.rb

@@ -18,12 +18,19 @@ module Unread
 
       def mark_array_as_read(array, user)
         ReadMark.transaction do
+          global_timestamp = user.read_mark_global(self).try(:timestamp)
+
           array.each do |obj|
             raise ArgumentError unless obj.is_a?(self)
+            timestamp = obj.send(readable_options[:on])
 
-            rm = obj.read_marks.where(:user_id => user.id).first || obj.read_marks.build(:user_id => user.id)
-            rm.timestamp = obj.send(readable_options[:on])
-            rm.save!
+            if global_timestamp && global_timestamp >= timestamp
+              # The object is implicitly marked as read, so there is nothing to do
+            else
+              rm = obj.read_marks.where(:user_id => user.id).first || obj.read_marks.build(:user_id => user.id)
+              rm.timestamp = timestamp
+              rm.save!
+            end
           end
         end
       end
@@ -44,7 +51,7 @@ module Unread
       def cleanup_read_marks!
         assert_reader_class
 
-        ReadMark.reader_class.find_each do |user|
+        ReadMark.reader_scope.find_each do |user|
           ReadMark.transaction do
             if oldest_timestamp = read_scope(user).unread_by(user).minimum(readable_options[:on])
               # There are unread items, so update the global read_mark for this user to the oldest
@@ -91,12 +98,12 @@ module Unread
       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
+        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
-        raise RuntimeError, 'There is no class using acts_as_reader!' unless ReadMark.reader_class
+        raise RuntimeError, 'There is no class using acts_as_reader.' unless ReadMark.reader_class
       end
     end
 
@@ -112,7 +119,7 @@ module Unread
             true
           end
         else
-          !!self.class.unread_by(user).exists?(self) # Rails4 does not return true/false, but nil/count instead.
+          self.class.unread_by(user).exists?(self.id)
         end
       end
 

data/lib/unread/version.rb

@@ -1,3 +1,3 @@
 module Unread
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/model/reader.rb

@@ -1,4 +1,8 @@
 class Reader < ActiveRecord::Base
   self.primary_key = 'number'
-  acts_as_reader
+
+  scope :not_foo, -> { where('name <> "foo"') }
+  scope :not_bar, -> { where('name <> "bar"') }
+
+  acts_as_reader :scopes => [:not_foo, :not_bar]
 end

data/spec/read_mark_spec.rb

@@ -4,4 +4,8 @@ describe ReadMark do
   it "should have reader_class" do
     expect(ReadMark.reader_class).to eq Reader
   end
+
+  it "should have reader_scope" do
+    expect(ReadMark.reader_scope).to eq Reader.not_foo.not_bar
+  end
 end

data/spec/readable_spec.rb

@@ -132,6 +132,14 @@ describe Unread::Readable do
       expect(@email2.unread?(@reader)).to be_falsey
     end
 
+    it "should perform less queries if the objects are already read" do
+      Email.mark_as_read! :all, :for => @reader
+
+      expect {
+        Email.mark_as_read! [ @email1, @email2 ], :for => @reader
+      }.to perform_queries(1)
+    end
+
     it "should mark all objects as read" do
       Email.mark_as_read! :all, :for => @reader
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unread
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -127,6 +127,7 @@ files:
 - ci/Gemfile-rails-3-2
 - ci/Gemfile-rails-4-0
 - ci/Gemfile-rails-4-1
+- ci/Gemfile-rails-4-2
 - lib/generators/unread/migration/migration_generator.rb
 - lib/generators/unread/migration/templates/migration.rb
 - lib/unread.rb
@@ -165,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: unread
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Manages read/unread status of ActiveRecord objects