acts_as_readable 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2eb3570785a65d3e80567534270dae5825eceb07fdeec498764c2065f129892
-  data.tar.gz: c9bacbe67acb169365404c423640fd4f25d9536315228d014bea8c6e7e100987
+  metadata.gz: 28febc32aaf17802d8db7b624fc3dce68bf6620d438b8a2bab8c7aa2cc8620ca
+  data.tar.gz: 6ad32b0cf210c6806c90611e6cc2575a5d710b87e65bd8d0d08ef35bde28627b
 SHA512:
-  metadata.gz: c7ddc495d6010d7748b134c731908c1a2e71b88b4cc86b8f694729e4bc1c83659e10bf0b0547801012124f1f946d871397ef9ac53c1ff9798a5753bddbf40f5d
-  data.tar.gz: 97cdf31a2684e938da9462d8f6d8f20ca0d6bd7170da449ef7e4eafa7c21633f452bcf6227daacb95541c37747e61aa99bcdb942a3c4e0aaa1f2400c06787d34
+  metadata.gz: 42f65a6d0f3071710fa9cbdb4b65c507f0a753dc299294989d5c908148512e3443514f4f500555be7fa01fcf3ccb618435a9a8a5197398668f3319d8d0b0daaf
+  data.tar.gz: cbd81ccf4ea4d53f58ea46c67cf5d625daa83909476d84597eb4caf6c0ceae4f826579543240cee80bad5d231de4038072a3f59f5809d7c219117355418556a6

data/README.rdoc

@@ -32,4 +32,12 @@ TODO...
 
 	bob.readings                      # => [<Reading 1>]
 
+=== Testing
+
+There are multiple gemfiles available for testing against different Rails versions.  Set `BUNDLE_GEMFILE` to target them, e.g.
+
+  bundle install
+  BUNDLE_GEMFILE=gemfiles/rails7.gemfile bundle exec rspec
+
+
 Copyright (c) 2012 Culture Code Software Consulting. Released under the MIT license

data/lib/acts_as_readable/acts_as_readable.rb

@@ -8,11 +8,13 @@ module ActsAsReadable
 
       User.has_many :readings,  :dependent => :delete_all
 
-      has_many :readings,       :as => :readable, :dependent => :delete_all
-      has_many :readers,        lambda { where :readings => {:state => 'read'} }, :through => :readings, :source => :user
+      has_many :readings, :as => :readable, :dependent => :delete_all
+      has_many :readers, lambda { where :readings => {:state => 'read'} }, :through => :readings, :source => :user
 
-      scope :read_by,           lambda {|user| ActsAsReadable::HelperMethods.outer_join_readings(all, user).where(ActsAsReadable::HelperMethods.read_conditions(self, user))}
-      scope :unread_by,         lambda {|user| ActsAsReadable::HelperMethods.outer_join_readings(all, user).where(ActsAsReadable::HelperMethods.unread_conditions(self, user))}
+      scope :read_by, lambda {|user| ActsAsReadable::HelperMethods.outer_join_readings(all, user).where(ActsAsReadable::HelperMethods.read_conditions(self, user, :created_at))}
+      scope :unread_by, lambda {|user| ActsAsReadable::HelperMethods.outer_join_readings(all, user).where(ActsAsReadable::HelperMethods.unread_conditions(self, user, :created_at))}
+      scope :latest_update_read_by, lambda {|user| ActsAsReadable::HelperMethods.outer_join_readings(all, user).where(ActsAsReadable::HelperMethods.read_conditions(self, user, :updated_at))}
+      scope :latest_update_unread_by, lambda {|user| ActsAsReadable::HelperMethods.outer_join_readings(all, user).where(ActsAsReadable::HelperMethods.unread_conditions(self, user, :updated_at))}
 
       extend ActsAsReadable::ClassMethods
       include ActsAsReadable::InstanceMethods
@@ -24,19 +26,19 @@ module ActsAsReadable
   end
 
   module HelperMethods
-    def self.read_conditions(readable_class, user)
-      ["(readable_type IS NULL     AND COALESCE(#{readable_class.table_name}.updated_at < :all_read_at, :true))
-     OR (readable_type IS NOT NULL AND COALESCE(readings.updated_at < :all_read_at, :true))
-     OR (readings.state = 'read')",
-     :all_read_at => all_read_at(readable_class, user), :true => true]
+    def self.read_conditions(readable_class, user, timestamp)
+      ["(readings.state IS NULL    AND COALESCE(#{readable_class.table_name}.#{timestamp} <= :all_read_at, FALSE))
+     OR (readings.state = 'unread' AND COALESCE(readings.updated_at <= :all_read_at, FALSE))
+     OR (readings.state = 'read'   AND #{readable_class.table_name}.#{timestamp} <= readings.#{timestamp})",
+     :all_read_at => all_read_at(readable_class, user)]
     end
 
-    def self.unread_conditions(readable_class, user)
+    def self.unread_conditions(readable_class, user, timestamp)
       # IF there is no reading and it has been updated since we last read all OR there is an unreading and we haven't read all since then
-      ["(readings.state IS NULL    AND COALESCE(#{readable_class.table_name}.updated_at > :all_read_at, :true))
-     OR (readings.state = 'unread' AND COALESCE(readings.updated_at > :all_read_at, :true))
-     OR (readings.state = 'read'   AND COALESCE(#{readable_class.table_name}.updated_at > readings.updated_at, :true))",
-     :all_read_at => all_read_at(readable_class, user), :true => true]
+      ["(readings.state IS NULL    AND COALESCE(#{readable_class.table_name}.#{timestamp} > :all_read_at, TRUE))
+     OR (readings.state = 'unread' AND COALESCE(readings.updated_at > :all_read_at, TRUE))
+     OR (readings.state = 'read'   AND #{readable_class.table_name}.#{timestamp} > readings.#{timestamp})",
+     :all_read_at => all_read_at(readable_class, user)]
     end
 
     def self.all_read_at(readable_class, user)
@@ -67,7 +69,7 @@ module ActsAsReadable
     # If a :cache option has been set in acts_as_readable, a timestamp will be updated on the user instead of creating individual readings for each record
     def read_by!(user)
       if user.has_attribute?(acts_as_readable_options[:cache])
-        Reading.delete_all(:user_id => user.id, :readable_type => name)
+        Reading.where(:user_id => user.id, :readable_type => name).delete_all
         user.update_column(acts_as_readable_options[:cache], Time.now)
       else
         unread_by(user).find_each do |record|

data/spec/acts_as_readable_spec.rb

@@ -28,16 +28,23 @@ describe 'acts_as_readable' do
       expect( Comment.unread_by(@user) ).to include(@comment)
     end
 
+    it "should return records explicitly marked as unread after the user 'read all'" do
+      @comment.read_by! @user
+      Comment.read_by! @user
+      @comment.unread_by! @user
+      expect( Comment.unread_by(@user) ).to include(@comment)
+    end
+
     it "should not return records explicitly marked as unread if the user has 'read all' after the record was marked unread" do
       @comment.unread_by! @user
       Comment.read_by! @user
       expect( Comment.unread_by(@user) ).not_to include(@comment)
     end
 
-    it "should return records that have been updated since they were last read" do
+    it "should not return records that have been updated since they were last read" do
       @comment.read_by! @user
       @comment.touch
-      expect( Comment.unread_by(@user) ).to include(@comment)
+      expect( Comment.unread_by(@user) ).not_to include(@comment)
     end
 
     it "should return records that have been updated since they were last unread" do
@@ -48,6 +55,10 @@ describe 'acts_as_readable' do
   end
 
   describe "the read scope" do
+    it "should not return records without readings if the user has not 'read all'" do
+      expect( Comment.read_by(@user) ).not_to include(@comment)
+    end
+
     it "should return records without readings if the user has 'read all' since the last time the record was updated" do
       Comment.read_by! @user
       expect( Comment.read_by(@user) ).to include(@comment)
@@ -58,17 +69,101 @@ describe 'acts_as_readable' do
       expect( Comment.read_by(@user) ).to include(@comment)
     end
 
-    it "should return records explicitly marked as read if the user has 'read all' before the record was marked unread" do
+    it "should return records explicitly marked as read if the user has 'read all' before the record was marked read" do
       Comment.read_by! @user
       @comment.read_by! @user
       expect( Comment.read_by(@user) ).to include(@comment)
     end
 
+    it "should not return records explicitly marked as unread after the user 'read all'" do
+      @comment.read_by! @user
+      Comment.read_by! @user
+      @comment.unread_by! @user
+      expect( Comment.read_by(@user) ).not_to include(@comment)
+    end
+
     it "should return records explicitly marked as unread if the user has 'read all' after the record was marked unread" do
       @comment.unread_by! @user
       Comment.read_by! @user
       expect( Comment.read_by(@user) ).to include(@comment)
     end
+
+    it "should return records that have been updated since they were last read" do
+      @comment.read_by! @user
+      @comment.touch
+      expect( Comment.read_by(@user) ).to include(@comment)
+    end
+  end
+
+  describe "the latest_update_read_by scope" do
+    it "should return records without readings if the user has 'read all' since the last time the record was updated" do
+      Comment.read_by! @user
+      expect( Comment.latest_update_read_by(@user) ).to include(@comment)
+    end
+
+    it "should return records explicitly marked as read if the user hasn't 'read all'" do
+      @comment.read_by! @user
+      expect( Comment.latest_update_read_by(@user) ).to include(@comment)
+    end
+
+    it "should return records explicitly marked as read if the user has 'read all' before the record was marked unread" do
+      Comment.read_by! @user
+      @comment.read_by! @user
+      expect( Comment.latest_update_read_by(@user) ).to include(@comment)
+    end
+
+    it "should return records explicitly marked as unread if the user has 'read all' after the record was marked unread" do
+      @comment.unread_by! @user
+      Comment.read_by! @user
+      expect( Comment.latest_update_read_by(@user) ).to include(@comment)
+    end
+
+    it "should not return records that have been updated since they were last read" do
+      @comment.read_by! @user
+      @comment.touch
+      expect( Comment.latest_update_read_by(@user) ).not_to include(@comment)
+    end
+
+    it "should return records updated after being read after a bulk read_by" do
+      @comment.read_by! @user
+      @comment.touch
+      Comment.read_by! @user
+      expect( Comment.latest_update_read_by(@user) ).to include(@comment)
+    end
+  end
+
+  describe "the latest_update_unread_by scope" do
+    it "should not return records explicitly marked as read" do
+      @comment.read_by! @user
+      expect( Comment.latest_update_unread_by(@user) ).not_to include(@comment)
+    end
+
+    it "should return records without readings if the user hasn't 'read all'" do
+      expect( Comment.latest_update_unread_by(@user) ).to include(@comment)
+    end
+
+    it "should return records explicitly marked as unread if the user hasn't 'read all'" do
+      @comment.unread_by! @user
+      expect( Comment.latest_update_unread_by(@user) ).to include(@comment)
+    end
+
+    it "should return records explicitly marked as unread if the user has 'read all' before the record was marked unread" do
+      Comment.read_by! @user
+      @comment.unread_by! @user
+      expect( Comment.latest_update_unread_by(@user) ).to include(@comment)
+    end
+
+    it "should not return records explicitly marked as unread if the user has 'read all' after the record was marked unread" do
+      @comment.unread_by! @user
+      Comment.read_by! @user
+      expect( Comment.latest_update_unread_by(@user) ).not_to include(@comment)
+    end
+
+    it "should return records that have been updated since they were last read" do
+      @comment.read_by! @user
+      @comment.touch
+      expect( Comment.latest_update_unread_by(@user) ).to include(@comment)
+    end
   end
 
   describe "when checking a specific record for read_by?" do

data/spec/spec_helper.rb

@@ -2,7 +2,14 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'active_record'
 require 'acts_as_readable'
 
-ActiveRecord::Base.establish_connection(:adapter => "postgresql", :database => "acts_as_readable_test") # Not using sqlite3 for testing because of its ridiculous boolean handling
+ActiveRecord::Base.establish_connection(
+  :adapter => "postgresql",
+  :host => "localhost",
+  :encoding => "unicode",
+  :database => "acts_as_readable_test",
+  :username => ENV["POSTGRES_USER"],
+  :password => ENV["POSTGRES_PASSWORD"]
+)
 
 ActiveRecord::Schema.define(:version => 0) do
   create_table :users, :force => true do |t|

metadata

@@ -1,31 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_readable
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Nicholas Jakobsen
 - Ryan Wallace
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '8'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-description:
+        version: '4'
+description: 
 email: contact@culturecode.ca
 executables: []
 extensions: []
@@ -42,7 +76,7 @@ files:
 homepage: http://github.com/culturecode/acts_as_readable
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -57,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.3.23
+signing_key: 
 specification_version: 4
 summary: Allows records to be marked as readable. Optimized for bulk, 'mark all as
   read' operations