unread 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: de3df2e59a6b6f3a9526ff9e5fa922c110ef8be3
-  data.tar.gz: d5978503df223116016aeb6295d75c9ff3cf5183
+SHA256:
+  metadata.gz: 783e65e652089e8325398c9f593d126f4332d83041cd2fd88cc86266105a1809
+  data.tar.gz: 24f73b4d3038e0d81acff4ca44c7fead8f628a2eea5e7479420b47952d8215fe
 SHA512:
-  metadata.gz: 52db71810adf1939ebf35bd0aedf2ce6f9f546190ec35719dc3dfc6a190132585b49dbd5fa0e44ef47ebb2b0bb5a06832bde7c9073c8b80066a0de3ff9b98dee
-  data.tar.gz: 6178164de3a46bb4c40a1a0e7ab5c0d9eef3a3dd71a8ee642701a19555f38f026ca6f28018967b96b982e1281d225f3a8aeed81d2343567d8c0ca4955aa1e165
+  metadata.gz: ba242fd2a04f70545c5313bc73d5aff1a5bbee97b29a52625df620a3290800a90267693e8d3d5d488b00d4dd72e6dfe0a8eb1eae12428cb56ccd6cbff4dd04fe
+  data.tar.gz: 849a46af19decb7627d0359b46bfd79f269751603144e59c621d27c56caac81943b8b2ae9b85e03a0326ac84f28d4fca59288d627d4d8eacca61fe05decb1ae7

data/.travis.yml

@@ -1,44 +1,25 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.7
-  - 2.3.3
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 gemfile:
+  - gemfiles/rails_5_2.gemfile
   - gemfiles/rails_5_1.gemfile
   - gemfiles/rails_5_0.gemfile
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_4_1.gemfile
   - gemfiles/rails_4_0.gemfile
-  - gemfiles/rails_3_2.gemfile
-  - gemfiles/rails_3_1.gemfile
-  - gemfiles/rails_3_0.gemfile
 matrix:
   exclude:
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails_3_0.gemfile
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails_3_1.gemfile
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails_3_2.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails_3_0.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails_3_1.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails_3_2.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.4.3
       gemfile: gemfiles/rails_4_0.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.4.3
+      gemfile: gemfiles/rails_4_1.gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/rails_4_0.gemfile
+    - rvm: 2.5.0
       gemfile: gemfiles/rails_4_1.gemfile
 before_install: gem update bundler
 sudo: false
@@ -47,5 +28,6 @@ env:
   - DB=mysql
   - DB=postgres
 before_script:
+  - gem update --system # https://github.com/travis-ci/travis-ci/issues/8978
   - sh -c "if [ '$DB' = 'mysql' ]; then mysql -e 'create database IF NOT EXISTS unread_test;'; fi"
   - sh -c "if [ '$DB' = 'postgres' ]; then psql -c 'create database unread_test;' -U postgres; fi"

data/Appraisals

@@ -1,3 +1,8 @@
+appraise "rails-5-2" do
+  gem "activerecord", "~> 5.2.0.beta2"
+  gem "mysql2", ">= 0.3.18", "< 0.5", "!= 0.4.3"
+end
+
 appraise "rails-5-1" do
   gem "activerecord", "~> 5.1.0"
   gem 'mysql2', '>= 0.3.18', '< 0.5'
@@ -22,18 +27,3 @@ appraise "rails-4-0" do
   gem "activerecord", "~> 4.0.13"
   gem "mysql2", '~> 0.3.10'
 end
-
-appraise "rails-3-2" do
-  gem "activerecord", "~> 3.2.22"
-  gem 'mysql2', '~> 0.3.10'
-end
-
-appraise "rails-3-1" do
-  gem "activerecord", "~> 3.1.12"
-  gem 'mysql2', '~> 0.3.10'
-end
-
-appraise "rails-3-0" do
-  gem "activerecord", "~> 3.0.20"
-  gem "activerecord-mysql2-adapter"
-end

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2017 Georg Ledermann
+Copyright (c) 2010-2018 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

@@ -4,7 +4,7 @@ Unread
 Ruby gem to manage read/unread status of ActiveRecord objects - and it's fast.
 
 [![Build Status](https://travis-ci.org/ledermann/unread.svg?branch=master)](https://travis-ci.org/ledermann/unread)
-[![Code Climate](https://codeclimate.com/github/ledermann/unread.svg)](https://codeclimate.com/github/ledermann/unread)
+[![Maintainability](https://api.codeclimate.com/v1/badges/930c8df0f99b20324444/maintainability)](https://codeclimate.com/github/ledermann/unread/maintainability)
 [![Coverage Status](https://coveralls.io/repos/ledermann/unread/badge.svg?branch=master)](https://coveralls.io/r/ledermann/unread?branch=master)
 
 ## Features
@@ -19,8 +19,8 @@ Ruby gem to manage read/unread status of ActiveRecord objects - and it's fast.
 
 ## Requirements
 
-* Ruby 2.0.0 or newer
-* Rails 3.0 or newer (including Rails 4.x and Rails 5.x)
+* Ruby 2.2 or newer
+* Rails 4.0 or newer (including Rails 5.1 and 5.2)
 * MySQL, PostgreSQL or SQLite
 * Needs a timestamp field in your models (like created_at or updated_at) with a database index on it
 
@@ -65,12 +65,22 @@ class User < ActiveRecord::Base
 
   # Optional: Allow a subset of users as readers only
   def self.reader_scope
-    where(:is_admin => true)
+    where(is_admin: true)
   end
 end
 
 class Message < ActiveRecord::Base
-  acts_as_readable :on => :created_at
+  acts_as_readable on: :created_at
+
+  # The `on:` option sets the relevant attribute for comparing timestamps.
+  #
+  # The default is :updated_at, so updating a record, which was read by a
+  # reader makes it unread again.
+  #
+  # Using :created_at, only new records will show up as unread. Updating a
+  # record which was read by a reader, will NOT mark it as unread.
+  #
+  # Any other existing timestamp field can be used as `on:` option.
 end
 
 message1 = Message.create!
@@ -80,7 +90,7 @@ message2 = Message.create!
 Message.unread_by(current_user)
 # => [ message1, message2 ]
 
-message1.mark_as_read! :for => current_user
+message1.mark_as_read! for: current_user
 Message.unread_by(current_user)
 # => [ message2 ]
 
@@ -88,7 +98,7 @@ Message.unread_by(current_user)
 Message.read_by(current_user)
 # => [ ]
 
-message1.mark_as_read! :for => current_user
+message1.mark_as_read! for: current_user
 Message.read_by(current_user)
 # => [ message1 ]
 
@@ -100,7 +110,7 @@ messages[0].unread?(current_user)
 messages[1].unread?(current_user)
 # => true
 
-Message.mark_as_read! :all, :for => current_user
+Message.mark_as_read! :all, for: current_user
 Message.unread_by(current_user)
 # => [ ]
 
@@ -114,7 +124,7 @@ user2 = User.create!
 User.have_not_read(message1)
 # => [ user1, user2 ]
 
-message1.mark_as_read! :for => user1
+message1.mark_as_read! for: user1
 User.have_not_read(message1)
 # => [ user2 ]
 
@@ -122,11 +132,11 @@ User.have_not_read(message1)
 User.have_read(message1)
 # => [ user1 ]
 
-message1.mark_as_read! :for => user2
+message1.mark_as_read! for: user2
 User.have_read(message1)
 # => [ user1, user2 ]
 
-Message.mark_as_read! :all, :for => user1
+Message.mark_as_read! :all, for: user1
 User.have_not_read(message1)
 # => [ ]
 User.have_not_read(message2)
@@ -189,4 +199,4 @@ AND messages.created_at > '2010-10-20 08:50:00'
 Hint: You should add a database index on `messages.created_at`.
 
 
-Copyright (c) 2010-2017 [Georg Ledermann](http://www.georg-ledermann.de) and [contributors](https://github.com/ledermann/unread/graphs/contributors), released under the MIT license
+Copyright (c) 2010-2018 [Georg Ledermann](http://www.georg-ledermann.de) and [contributors](https://github.com/ledermann/unread/graphs/contributors), released under the MIT license

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/UPGRADE.md

@@ -11,7 +11,7 @@ The gem accepts any type of classes as reader and it's not limited to `User` cla
 
 ```ruby
 Customer.have_not_read(message1)
-message1.mark_as_read! :for => Customer.find(1)
+message1.mark_as_read! for: Customer.find(1)
 ```
 
 If you are upgrading from v0.6.3 or older, you need to do the following after upgrading:
@@ -32,7 +32,7 @@ The class method `acts_as_reader` doesn't take the option `:scope` anymore. If y
 
 ```ruby
 class User < ActiveRecord::Base
-  acts_as_reader :scope => -> { where(:is_admin => true) }
+  acts_as_reader scope: -> { where(is_admin: true) }
 end
 ```
 
@@ -43,7 +43,7 @@ class User < ActiveRecord::Base
   acts_as_reader
 
   def self.reader_scope
-    where(:is_admin => true)
+    where(is_admin: true)
   end
 end
 ```

data/gemfiles/{rails_3_0.gemfile → rails_5_2.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 3.0.20"
-gem "activerecord-mysql2-adapter"
+gem "activerecord", "~> 5.2.0.beta2"
+gem "mysql2", ">= 0.3.18", "< 0.5", "!= 0.4.3"
 
 gemspec path: "../"

data/lib/unread/base.rb

@@ -8,9 +8,9 @@ module Unread
       ReadMark.reader_classes ||= []
 
       unless ReadMark.reader_classes.include?(self)
-        ReadMark.belongs_to :reader, :polymorphic => true, inverse_of: :read_marks
+        ReadMark.belongs_to :reader, polymorphic: true, inverse_of: :read_marks
 
-        has_many :read_marks, :dependent => :delete_all, as: :reader, :inverse_of => :reader
+        has_many :read_marks, dependent: :delete_all, as: :reader, inverse_of: :reader
 
         after_create :setup_new_reader
 
@@ -28,10 +28,10 @@ module Unread
       unless ReadMark.readable_classes.include?(self)
         class_attribute :readable_options
 
-        options.reverse_merge!(:on => :updated_at)
+        options.reverse_merge!(on: :updated_at)
         self.readable_options = options
 
-        has_many :read_marks, :as => :readable, :dependent => :delete_all, inverse_of: :readable
+        has_many :read_marks, as: :readable, dependent: :delete_all, inverse_of: :readable
 
         ReadMark.readable_classes << self
 

data/lib/unread/garbage_collector.rb

@@ -7,7 +7,7 @@ module Unread
 
     def run!
       ReadMark.reader_classes.each do |reader_class|
-        readers_to_cleanup(reader_class).each do |reader|
+        readers_to_cleanup(reader_class).find_each do |reader|
           if oldest_timestamp = readable_class.read_scope(reader).
                                   unread_by(reader).
                                   minimum(readable_class.readable_options[:on])
@@ -29,16 +29,17 @@ module Unread
       reader_class.
         reader_scope.
         joins(:read_marks).
-        where(ReadMark.table_name => { :readable_type => readable_class.name }).
+        where(ReadMark.table_name => { readable_type: readable_class.name }).
         group("#{ReadMark.quoted_table_name}.reader_type, #{ReadMark.quoted_table_name}.reader_id, #{reader_class.quoted_table_name}.#{reader_class.quoted_primary_key}").
-        having("COUNT(#{ReadMark.quoted_table_name}.id) > 1")
+        having("COUNT(#{ReadMark.quoted_table_name}.id) > 1").
+        select("#{reader_class.quoted_table_name}.#{reader_class.quoted_primary_key}")
     end
 
     def update_read_marks_for_user(reader, timestamp)
       ReadMark.transaction do
         # Delete markers OLDER than the given timestamp
         reader.read_marks.
-          where(:readable_type => readable_class.name).
+          where(readable_type: readable_class.name).
           single.
           older_than(timestamp).
           delete_all

data/lib/unread/read_mark.rb

@@ -1,9 +1,9 @@
 class ReadMark < ActiveRecord::Base
-  belongs_to :readable, :polymorphic => true
+  belongs_to :readable, polymorphic: true, inverse_of: :read_marks
 
   validates_presence_of :reader_id, :reader_type, :readable_type
 
-  scope :global, lambda { where(:readable_id => nil) }
+  scope :global, lambda { where(readable_id: nil) }
   scope :single, lambda { where('readable_id IS NOT NULL') }
   scope :older_than, lambda { |timestamp| where([ 'timestamp < ?', timestamp ]) }
 

data/lib/unread/readable.rb

@@ -9,41 +9,58 @@ module Unread
 
         if target == :all
           reset_read_marks_for_user(reader)
-        elsif target.is_a?(Array)
-          mark_array_as_read(target, reader)
+        elsif target.respond_to?(:each)
+          mark_collection_as_read(target, reader)
         else
           raise ArgumentError
         end
       end
 
-      def mark_array_as_read(array, reader)
+      def mark_collection_as_read(collection, reader)
         ReadMark.transaction do
           global_timestamp = reader.read_mark_global(self).try(:timestamp)
 
-          array.each do |obj|
+          collection.each do |obj|
             raise ArgumentError unless obj.is_a?(self)
             timestamp = obj.send(readable_options[:on])
 
             if global_timestamp && global_timestamp >= timestamp
               # The object is implicitly marked as read, so there is nothing to do
             else
-              # This transaction is needed, so that parent transaction won't rollback even there's an error.
-              ReadMark.transaction(requires_new: true) do
-                begin
-                  rm = obj.read_marks.where(reader_id: reader.id, reader_type: reader.class.base_class.name).first || obj.read_marks.build
-                  rm.reader_id   = reader.id
-                  rm.reader_type = reader.class.base_class.name
-                  rm.timestamp   = timestamp
-                  rm.save!
-                rescue ActiveRecord::RecordNotUnique
-                  raise ActiveRecord::Rollback
-                end
-              end
+              mark_collection_item_as_read(obj, reader, timestamp)
             end
           end
         end
       end
 
+      def mark_collection_item_as_read(obj, reader, timestamp)
+        marking_proc = proc {
+          rm = obj.read_marks.find_or_initialize_by(reader: reader)
+          rm.timestamp = timestamp
+          rm.save!
+        }
+
+        if using_postgresql?
+          # With PostgreSQL, a transaction is unusable after a unique constraint vialoation.
+          # To avoid this, nested transactions are required.
+          # http://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html#module-ActiveRecord::Transactions::ClassMethods-label-Exception+handling+and+rolling+back
+          ReadMark.transaction(requires_new: true) do
+            begin
+              marking_proc.call
+            rescue ActiveRecord::RecordNotUnique
+              # The object is explicitly marked as read, so rollback the inner transaction
+              raise ActiveRecord::Rollback
+            end
+          end
+        else
+          begin
+            marking_proc.call
+          rescue ActiveRecord::RecordNotUnique
+            # The object is explicitly marked as read, so there is nothing to do
+          end
+        end
+      end
+
       # A scope with all items accessable for the given reader
       # It's used in cleanup_read_marks! to support a filtered cleanup
       # Should be overriden if a reader doesn't have access to all items
@@ -70,7 +87,7 @@ module Unread
         assert_reader(reader)
 
         ReadMark.transaction do
-          reader.read_marks.where(:readable_type => self.readable_parent.name).delete_all
+          reader.read_marks.where(readable_type: self.readable_parent.name).delete_all
           rm = reader.read_marks.new
           rm.readable_type = self.readable_parent.name
           rm.timestamp = Time.current
@@ -123,12 +140,12 @@ module Unread
         end
       end
 
+      private
+
       def read_mark(reader)
-        read_marks.where(:reader_id => reader.id, reader_type: reader.class.base_class.name).first
+        read_marks.where(reader_id: reader.id, reader_type: reader.class.base_class.name).first
       end
 
-      private
-
       def read_mark_id_belongs_to?(reader)
         self.read_mark_reader_id.to_i == reader.id &&
           self.read_mark_reader_type == reader.class.base_class.name

data/lib/unread/reader.rb

@@ -16,7 +16,7 @@ module Unread
       def read_mark_global(klass)
         @read_mark_global ||= {}
         readable_klass = klass.readable_parent
-        @read_mark_global[readable_klass] ||= read_marks.where(:readable_type => readable_klass.name).global.first
+        @read_mark_global[readable_klass] ||= read_marks.where(readable_type: readable_klass.name).global.first
       end
 
       def forget_memoized_read_mark_global
@@ -44,7 +44,7 @@ module Unread
       # If you don't want this, you can override this method in your reader class
       def setup_new_reader
         (ReadMark.readable_classes || []).each do |klass|
-          klass.mark_as_read! :all, :for => self
+          klass.mark_as_read! :all, for: self
         end
       end
     end

data/lib/unread/version.rb

@@ -1,3 +1,3 @@
 module Unread
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

data/spec/app/models/document.rb

@@ -1,4 +1,4 @@
 class Document < ActiveRecord::Base
   self.primary_key = 'uid'
-  acts_as_readable :on => :updated_at
+  acts_as_readable on: :updated_at
 end

data/spec/support/spec_migration.rb

@@ -1,18 +1,18 @@
 class SpecMigration < Unread::MIGRATION_BASE_CLASS
   def self.up
-    create_table Reader, :primary_key => 'number', :force => true do |t|
+    create_table Reader, primary_key: 'number', force: true do |t|
       t.string :name
     end
 
-    create_table DifferentReader, :primary_key => 'number', :force => true do |t|
+    create_table DifferentReader, primary_key: 'number', force: true do |t|
       t.string :name
     end
 
-    create_table Customer, :force => true do |t|
+    create_table Customer, force: true do |t|
       t.string :type
     end
 
-    create_table Document, :primary_key => 'uid', :force => true do |t|
+    create_table Document, primary_key: 'uid', force: true do |t|
       t.string :type
       t.string :subject
       t.text :content

data/spec/support/timecop.rb

@@ -1,3 +1,3 @@
 def wait
-  Timecop.freeze(1.minute.from_now.change(:usec => 0))
+  Timecop.freeze(1.minute.from_now.change(usec: 0))
 end

data/spec/unread/base_spec.rb

@@ -4,7 +4,7 @@ describe Unread::Base do
   before :each do
     @email = Email.create!
     wait
-    @reader = Reader.create! :name => 'John'
+    @reader = Reader.create! name: 'John'
   end
 
   describe :acts_as_reader do
@@ -47,7 +47,7 @@ describe Unread::Base do
     end
 
     it "should use default options" do
-      expect(Email.readable_options).to eq({ :on => :updated_at })
+      expect(Email.readable_options).to eq({ on: :updated_at })
     end
 
     it "should be idempotent" do

data/spec/unread/garbage_collector_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe Unread::GarbageCollector do
   before :each do
-    @reader = Reader.create! :name => 'David'
-    @other_reader = Reader.create :name => 'Matz'
+    @reader = Reader.create! name: 'David'
+    @other_reader = Reader.create name: 'Matz'
     @sti_reader = StiReader.create!
     wait
     @email1 = Email.create!
@@ -15,7 +15,7 @@ describe Unread::GarbageCollector do
     it "should delete all single read marks" do
       expect(@reader.read_marks.single.count).to eq 0
 
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(Email.unread_by(@reader)).to eq [@email2]
       expect(@reader.read_marks.single.count).to eq 1
@@ -27,8 +27,8 @@ describe Unread::GarbageCollector do
     end
 
     it "should reset if all objects are read" do
-      @email1.mark_as_read! :for => @reader
-      @email2.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
+      @email2.mark_as_read! for: @reader
 
       expect(@reader.read_marks.single.count).to eq 2
 

data/spec/unread/readable_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe Unread::Readable do
   before :each do
-    @reader = Reader.create! :name => 'David'
-    @other_reader = Reader.create :name => 'Matz'
+    @reader = Reader.create! name: 'David'
+    @other_reader = Reader.create name: 'Matz'
     @sti_reader = StiReader.create!
     wait
     @email1 = Email.create!
@@ -18,7 +18,7 @@ describe Unread::Readable do
     end
 
     it "should return unread records" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(Email.unread_by(@reader)).to eq [@email2]
       expect(Email.unread_by(@reader).count).to eq 1
@@ -27,7 +27,7 @@ describe Unread::Readable do
     end
 
     it "should return empty array directly after marking all as read" do
-      Email.mark_as_read! :all, :for => @reader
+      Email.mark_as_read! :all, for: @reader
       expect(Email.unread_by(@reader)).to eq([])
     end
 
@@ -58,7 +58,7 @@ describe Unread::Readable do
       end
 
       it "should return unread records" do
-        @email1.mark_as_read! :for => @reader
+        @email1.mark_as_read! for: @reader
 
         expect(Email.unread_by(@reader)).to eq [@email2]
         expect(Email.unread_by(@reader).count).to eq 1
@@ -89,14 +89,14 @@ describe Unread::Readable do
     end
 
     it "should return read records" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(Email.read_by(@reader)).to eq [@email1]
       expect(Email.read_by(@reader).count).to eq 1
     end
 
     it "should return all records when all read" do
-      Email.mark_as_read! :all, :for => @reader
+      Email.mark_as_read! :all, for: @reader
 
       expect(Email.read_by(@reader)).to eq [@email1, @email2]
     end
@@ -128,14 +128,14 @@ describe Unread::Readable do
       end
 
       it "should return read records" do
-        @email1.mark_as_read! :for => @reader
+        @email1.mark_as_read! for: @reader
 
         expect(Email.read_by(@reader)).to eq [@email1]
         expect(Email.read_by(@reader).count).to eq 1
       end
 
       it "should return all records when all read" do
-        Email.mark_as_read! :all, :for => @reader
+        Email.mark_as_read! :all, for: @reader
 
         expect(Email.read_by(@reader)).to eq [@email1, @email2]
       end
@@ -191,11 +191,11 @@ describe Unread::Readable do
     end
 
     it "should handle updating object" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
       wait
       expect(@email1.unread?(@reader)).to be_falsey
 
-      @email1.update_attributes! :subject => 'changed'
+      @email1.update_attributes! subject: 'changed'
       expect(@email1.unread?(@reader)).to be_truthy
     end
 
@@ -206,7 +206,7 @@ describe Unread::Readable do
     end
 
     it "should work with eager-loaded read marks" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect {
         emails = Email.with_read_marks_for(@reader).to_a
@@ -225,7 +225,7 @@ describe Unread::Readable do
     end
 
     it "should work with eager-loaded read marks for the correct reader" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       emails = Email.with_read_marks_for(@reader).to_a
       expect(emails[0].unread?(@reader)).to be_falsey
@@ -235,7 +235,7 @@ describe Unread::Readable do
 
   describe '#mark_as_read!' do
     it "should mark a single object as read" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(@email1.unread?(@reader)).to be_falsey
       expect(Email.unread_by(@reader)).to eq [@email2]
@@ -248,8 +248,8 @@ describe Unread::Readable do
     end
 
     it "should be idempotent" do
-      @email1.mark_as_read! :for => @reader
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
+      @email1.mark_as_read! for: @reader
 
       expect(@reader.read_marks.single.count).to eq 1
     end
@@ -260,7 +260,7 @@ describe Unread::Readable do
       expect(@email1.unread?(@reader)).to be_truthy
       expect(@email2.unread?(@reader)).to be_truthy
 
-      Email.mark_as_read! [ @email1, @email2 ], :for => @reader
+      Email.mark_as_read! [ @email1, @email2 ], for: @reader
 
       expect(@email1.unread?(@reader)).to be_falsey
       expect(@email2.unread?(@reader)).to be_falsey
@@ -269,8 +269,8 @@ describe Unread::Readable do
     it "should mark the rest as read when the first record is not unique" do
       Email.mark_as_read! [ @email1 ], for: @reader
 
-      allow(@email1).to receive_message_chain("read_marks.build").and_return(@email1.read_marks.build)
-      allow(@email1).to receive_message_chain("read_marks.where").and_return([])
+      allow(@email1).to receive_message_chain("read_marks.find_or_initialize_by")
+        .and_return(@email1.read_marks.build(reader: @reader))
 
       expect do
         Email.mark_as_read! [ @email1, @email2 ], for: @reader
@@ -281,15 +281,22 @@ describe Unread::Readable do
     end
 
     it "should perform less queries if the objects are already read" do
-      Email.mark_as_read! :all, :for => @reader
+      Email.mark_as_read! :all, for: @reader
 
       expect {
-        Email.mark_as_read! [ @email1, @email2 ], :for => @reader
+        Email.mark_as_read! [ @email1, @email2 ], for: @reader
       }.to perform_queries(1)
     end
 
+    it "should allow a collection of records to be marked as read" do
+      Email.mark_as_read! Email.all, for: @reader
+
+      expect(@email1.unread?(@reader)).to be_falsey
+      expect(@email2.unread?(@reader)).to be_falsey
+    end
+
     it "should mark all objects as read" do
-      Email.mark_as_read! :all, :for => @reader
+      Email.mark_as_read! :all, for: @reader
 
       expect(@reader.read_mark_global(Email).timestamp).to eq Time.current
       expect(@reader.read_marks.single).to eq []
@@ -300,8 +307,8 @@ describe Unread::Readable do
     it "should mark all objects as read with existing read objects" do
       wait
 
-      Email.mark_as_read! :all, :for => @reader
-      @email1.mark_as_read! :for => @reader
+      Email.mark_as_read! :all, for: @reader
+      @email1.mark_as_read! for: @reader
 
       expect(@reader.read_marks.single).to eq []
     end
@@ -309,19 +316,24 @@ describe Unread::Readable do
     it "should reset memoized global read mark" do
       rm_global = @reader.read_mark_global(Email)
 
-      Email.mark_as_read! :all, :for => @reader
+      Email.mark_as_read! :all, for: @reader
       expect(@reader.read_mark_global(Email)).not_to eq(rm_global)
     end
 
     it "should not allow invalid arguments" do
       expect {
-        Email.mark_as_read! :foo, :for => @reader
+        Email.mark_as_read! :foo, for: @reader
       }.to raise_error(ArgumentError)
 
       expect {
         Email.mark_as_read! :foo, :bar
       }.to raise_error(ArgumentError)
     end
+
+    it "should work with STI readers" do
+      Email.mark_as_read! [ @email1 ], for: Customer.find(@sti_reader.id)
+      expect(@email1.unread?(@sti_reader)).to be_falsey
+    end
   end
 
   describe :cleanup_read_marks! do

data/spec/unread/reader_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe Unread::Reader do
   before :each do
-    @reader = Reader.create! :name => 'David'
-    @other_reader = Reader.create :name => 'Matz'
-    @different_reader = DifferentReader.create! :name => 'Behrooz', :number => @reader.number
+    @reader = Reader.create! name: 'David'
+    @other_reader = Reader.create name: 'Matz'
+    @different_reader = DifferentReader.create! name: 'Behrooz', number: @reader.number
     wait
     @email1 = Email.create!
     wait
@@ -18,7 +18,7 @@ describe Unread::Reader do
     end
 
     it "should return *only* the readers that have not read a given object" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(Reader.have_not_read(@email1)).to eq [@other_reader]
       expect(Reader.have_not_read(@email1).count).to eq 1
@@ -30,7 +30,7 @@ describe Unread::Reader do
       # even though the id of @reader and @different_reader is the same because
       # they are different object types, the @email1 should only be marked as
       # read for @reader.
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(Reader.have_not_read(@email1)).to eq [@other_reader]
       expect(Reader.have_not_read(@email1).count).to eq 1
@@ -38,7 +38,7 @@ describe Unread::Reader do
       expect(DifferentReader.have_not_read(@email1)).to eq [@different_reader]
       expect(DifferentReader.have_not_read(@email1).count).to eq 1
 
-      @email1.mark_as_read! :for => @different_reader
+      @email1.mark_as_read! for: @different_reader
 
       expect(DifferentReader.have_not_read(@email1).count).to eq 0
 
@@ -69,7 +69,7 @@ describe Unread::Reader do
     end
 
     it "should return *only* the readers that have read the given object" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect(Reader.have_read(@email1)).to eq [@reader]
       expect(Reader.have_read(@email1).count).to eq 1
@@ -78,7 +78,7 @@ describe Unread::Reader do
     end
 
     it "should return the reader for all the object when all read" do
-      Email.mark_as_read! :all, :for => @reader
+      Email.mark_as_read! :all, for: @reader
 
       expect(Reader.have_read(@email1)).to eq [@reader]
       expect(Reader.have_read(@email1).count).to eq 1
@@ -145,11 +145,11 @@ describe Unread::Reader do
     end
 
     it "should handle updating object" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
       wait
       expect(@reader.have_read?(@email1)).to be_truthy
 
-      @email1.update_attributes! :subject => 'changed'
+      @email1.update_attributes! subject: 'changed'
       expect(@reader.have_read?(@email1)).to be_falsey
     end
 
@@ -160,7 +160,7 @@ describe Unread::Reader do
     end
 
     it "should work with eager-loaded read marks" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       expect {
         readers = Reader.with_read_marks_for(@email1).to_a
@@ -171,7 +171,7 @@ describe Unread::Reader do
     end
 
     it "should work with eager-loaded read marks for the correct readable" do
-      @email1.mark_as_read! :for => @reader
+      @email1.mark_as_read! for: @reader
 
       readers = Reader.with_read_marks_for(@email1).to_a
       expect(readers[0].have_read?(@email1)).to be_truthy

data/unread.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/ledermann/unread"
   s.summary     = %q{Manages read/unread status of ActiveRecord objects}
   s.description = %q{This gem creates a scope for unread objects and adds methods to mark objects as read }
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.2'
 
   s.rubyforge_project = "unread"
 
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'mysql2'
-  s.add_development_dependency 'pg'
+  s.add_development_dependency 'pg', '< 1'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'term-ansicolor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unread
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,16 +84,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -182,14 +182,12 @@ files:
 - Rakefile
 - UPGRADE.md
 - bin/console
-- gemfiles/rails_3_0.gemfile
-- gemfiles/rails_3_1.gemfile
-- gemfiles/rails_3_2.gemfile
 - gemfiles/rails_4_0.gemfile
 - gemfiles/rails_4_1.gemfile
 - gemfiles/rails_4_2.gemfile
 - gemfiles/rails_5_0.gemfile
 - gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_2.gemfile
 - lib/generators/unread/migration/migration_generator.rb
 - lib/generators/unread/migration/templates/migration.rb
 - lib/generators/unread/polymorphic_reader_migration/polymorphic_reader_migration_generator.rb
@@ -235,7 +233,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -243,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: unread
-rubygems_version: 2.6.11
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Manages read/unread status of ActiveRecord objects

data/gemfiles/rails_3_1.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 3.1.12"
-gem "mysql2", "~> 0.3.10"
-
-gemspec path: "../"

data/gemfiles/rails_3_2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 3.2.22"
-gem "mysql2", "~> 0.3.10"
-
-gemspec path: "../"