unread 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05b6ec999b0b08aecbed6fc07c6e1d8e24fa5220d9b360b1fb6a1aa7293cbadc
-  data.tar.gz: be06fff51e62ecdaeddb2d5d86e89c950c3080db70dbed8b4736d976e17ab1a5
+  metadata.gz: '0849de50af252049e5309e1ca544df5053ba3c6351d67e391866682b33fa8163'
+  data.tar.gz: 1f64b206feac17afb3870ecb2bc218388a908fab0087132cc6ebad180e888ae5
 SHA512:
-  metadata.gz: 9b0c1ac98cdf02095d66c6b77959a039083f5dc9e0a5d350aff8274ba9d6589cf873a46872a32c9a09080bc52f5dce4ab4fcf9450fbe0f4088f2efe6bec80224
-  data.tar.gz: '0879f93f42eee16f150e64bce7a1271dce8dc5c728f1ece62d7da2ed8c47d7d034c98a7a3619564fb6f8e4a4d35e7e111d123c0dad6e7e0234328e73b47321da'
+  metadata.gz: aa99055d954ba4f8b26a2e4d57891631865f1a424926c537aad9c270fe07447c7648813ecd4fb3d4ef41e7d90dfca2e5efc20a3c9bdaea6cd9819babc7239a3c
+  data.tar.gz: 19c235ff12ad3ce70d5b7f360dfb162eef10fa4190e6eb6c2a2cebae58eb7d3fb63d5e4e0dd87a2596d730e2ebf13d30b8032ad8a3bdc748256519f518d2db78

data/.github/workflows/main.yml

@@ -0,0 +1,129 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test_sqlite:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1' ]
+        rails: [ '6.0', '6.1', '7.0' ]
+
+    name: SQLite / Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install gems
+      env:
+        MATRIX_RAILS_VERSION: ${{ matrix.rails }}
+      run: |
+        export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/gemfiles/rails_${MATRIX_RAILS_VERSION}.gemfile"
+        bundle install --jobs 4 --retry 3
+
+    - name: RSpec
+      run: bundle exec rake
+
+  test_mysql:
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: password
+        ports:
+        - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1' ]
+        rails: [ '6.0', '6.1', '7.0' ]
+
+    name: MySQL / Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install gems
+      env:
+        MATRIX_RAILS_VERSION: ${{ matrix.rails }}
+      run: |
+        export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/gemfiles/rails_${MATRIX_RAILS_VERSION}.gemfile"
+        bundle install --jobs 4 --retry 3
+
+    - name: Setup database
+      run: |
+        mysql -e 'create database IF NOT EXISTS unread_test;' -u root --password=password -P 3306 -h 127.0.0.1
+
+    - name: RSpec
+      run: bundle exec rake
+
+  test_postgres:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1' ]
+        rails: [ '6.0', '6.1', '7.0' ]
+
+    name: PostgreSQL / Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install gems
+      env:
+        MATRIX_RAILS_VERSION: ${{ matrix.rails }}
+      run: |
+        export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/gemfiles/rails_${MATRIX_RAILS_VERSION}.gemfile"
+        bundle install --jobs 4 --retry 3
+
+    - name: Setup database
+      run: |
+        PGPASSWORD=postgres psql -c 'create database unread_test;' -U postgres -p 5432 -h localhost
+
+    - name: RSpec
+      run: bundle exec rake

data/Appraisals

@@ -1,29 +1,20 @@
-appraise "rails-5-2" do
-  gem "activerecord", "~> 5.2.0.beta2"
-  gem "mysql2", ">= 0.3.18", "< 0.5", "!= 0.4.3"
+appraise "rails-7.0" do
+  gem "activerecord", "~> 7.0.0"
+  gem "mysql2", "~> 0.5"
+  gem "pg", "~> 1.1"
+  gem "sqlite3", "~> 1.4"
 end
 
-appraise "rails-5-1" do
-  gem "activerecord", "~> 5.1.0"
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
+appraise "rails-6.1" do
+  gem "activerecord", "~> 6.1.2", ">= 6.1.2.1"
+  gem "mysql2", "~> 0.5"
+  gem "pg", "~> 1.1"
+  gem "sqlite3", "~> 1.4"
 end
 
-appraise "rails-5-0" do
-  gem "activerecord", "~> 5.0.0"
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-end
-
-appraise "rails-4-2" do
-  gem "activerecord", "~> 4.2.5"
-  gem 'mysql2', '>= 0.3.13', '< 0.5'
-end
-
-appraise "rails-4-1" do
-  gem "activerecord", "~> 4.1.14"
-  gem "mysql2", '~> 0.3.13'
-end
-
-appraise "rails-4-0" do
-  gem "activerecord", "~> 4.0.13"
-  gem "mysql2", '~> 0.3.10'
+appraise "rails-6.0" do
+  gem "activerecord", "~> 6.0.0"
+  gem "mysql2", ">= 0.4.4"
+  gem "pg", ">= 0.18", "< 2.0"
+  gem "sqlite3", "~> 1.4"
 end

data/MIT-LICENSE

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

@@ -3,7 +3,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)
+[![Build Status](https://github.com/ledermann/unread/workflows/Test/badge.svg?branch=master)](https://github.com/ledermann/unread/actions)
 [![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)
 
@@ -19,8 +19,8 @@ Ruby gem to manage read/unread status of ActiveRecord objects - and it's fast.
 
 ## Requirements
 
-* Ruby 2.2 or newer
-* Rails 4.0 or newer (including Rails 5.1 and 5.2)
+* Ruby 2.7 or newer
+* Rails 6.0 or newer (including Rails 7)
 * MySQL, PostgreSQL or SQLite
 * Needs a timestamp field in your models (like created_at or updated_at) with a database index on it
 
@@ -160,6 +160,30 @@ users[1].have_read?(message2)
 Message.cleanup_read_marks!
 ```
 
+## Getting read/unread stats through a relationship
+
+```ruby
+class Document < ApplicationRecord
+  has_many :comments
+end
+
+class Comment < ApplicationRecord
+  acts_as_readable on: :created_at
+  belongs_to :document
+end
+
+# Get unread comments count for a document
+document = Document.find(1)
+default_hash = Hash.new { |h, k| h[k] = { unread: 0, total: 0 } }
+document.comments.with_read_marks_for(current_user).reduce(default_hash) do |hash, comment|
+  hash[comment.id][:unread] += 1 if comment.unread?(current_user)
+  hash[comment.id][:total] += 1
+  hash
+end
+# => {20=>{:unread=>1, :total=>10}, 82=>{:unread=>0, :total=>4}
+```
+
+Using `with_read_marks_for` here is the key. It uses just one query and makes sure that the following `unread?` invocations use the result of the first query.
 
 ## How does it work?
 
@@ -199,4 +223,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-2018 [Georg Ledermann](http://www.georg-ledermann.de) and [contributors](https://github.com/ledermann/unread/graphs/contributors), released under the MIT license
+Copyright (c) 2010-2022 [Georg Ledermann](https://ledermann.dev) and [contributors](https://github.com/ledermann/unread/graphs/contributors), released under the MIT license

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+gem "mysql2", ">= 0.4.4"
+gem "pg", ">= 0.18", "< 2.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.2", ">= 6.1.2.1"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.1"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.0.0"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.1"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

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

@@ -1,9 +1,9 @@
-class UnreadMigration < Unread::MIGRATION_BASE_CLASS
+class UnreadMigration < ActiveRecord::Migration[6.0]
   def self.up
     create_table ReadMark, force: true, options: create_options do |t|
       t.references :readable, polymorphic: { null: false }
       t.references :reader,   polymorphic: { null: false }
-      t.datetime :timestamp
+      t.datetime :timestamp, null: false
     end
 
     add_index ReadMark, [:reader_id, :reader_type, :readable_type, :readable_id], name: 'read_marks_reader_readable_index', unique: true

data/lib/generators/unread/polymorphic_reader_migration/templates/unread_polymorphic_reader_migration.rb

@@ -1,4 +1,4 @@
-class UnreadPolymorphicReaderMigration < Unread::MIGRATION_BASE_CLASS
+class UnreadPolymorphicReaderMigration < ActiveRecord::Migration[6.0]
   def self.up
     remove_index :read_marks, [:user_id, :readable_type, :readable_id]
     rename_column :read_marks, :user_id, :reader_id

data/lib/unread/base.rb

@@ -8,7 +8,7 @@ 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, optional: true
 
         has_many :read_marks, dependent: :delete_all, as: :reader, inverse_of: :reader
 

data/lib/unread/reader.rb

@@ -16,7 +16,13 @@ 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
+
+        # Memoize with NIL handling
+        if @read_mark_global.has_key?(readable_klass)
+          @read_mark_global[readable_klass]
+        else
+          @read_mark_global[readable_klass] = read_marks.where(readable_type: readable_klass.name).global.first
+        end
       end
 
       def forget_memoized_read_mark_global

data/lib/unread/reader_scopes.rb

@@ -12,7 +12,7 @@ module Unread
 
         joins "LEFT JOIN #{ReadMark.quoted_table_name}
                 ON #{ReadMark.quoted_table_name}.readable_type  = '#{readable.class.readable_parent.name}'
-               AND (#{ReadMark.quoted_table_name}.readable_id   = #{readable.id} OR #{ReadMark.quoted_table_name}.readable_id IS NULL)
+               AND (#{ReadMark.quoted_table_name}.readable_id   = #{quote_bound_value(readable.id)} OR #{ReadMark.quoted_table_name}.readable_id IS NULL)
                AND #{ReadMark.quoted_table_name}.reader_id      = #{quoted_table_name}.#{quoted_primary_key}
                AND #{ReadMark.quoted_table_name}.reader_type    = '#{connection.quote_string base_class.name}'
                AND #{ReadMark.quoted_table_name}.timestamp     >= '#{connection.quoted_date readable.send(readable.class.readable_options[:on])}'"
@@ -31,8 +31,8 @@ module Unread
 
         join_read_marks(readable).select("#{quoted_table_name}.*,
                                           #{ReadMark.quoted_table_name}.id AS read_mark_id,
-                                          #{quote_bound_value readable.class.name}#{postgresql_string_cast} AS read_mark_readable_type,
-                                          #{readable.id} AS read_mark_readable_id")
+                                          #{quote_bound_value(readable.class.name)}#{postgresql_string_cast} AS read_mark_readable_type,
+                                          #{quote_bound_value(readable.id)} AS read_mark_readable_id")
       end
     end
   end

data/lib/unread/version.rb

@@ -1,3 +1,3 @@
 module Unread
-  VERSION = '0.10.1'
+  VERSION = '0.12.0'
 end

data/lib/unread.rb

@@ -1,7 +1,6 @@
 require 'active_record'
 
 require 'unread/base'
-require 'unread/read_mark'
 require 'unread/readable'
 require 'unread/reader'
 require 'unread/readable_scopes'
@@ -9,10 +8,8 @@ require 'unread/reader_scopes'
 require 'unread/garbage_collector'
 require 'unread/version'
 
-ActiveRecord::Base.send :include, Unread
+ActiveSupport.on_load(:active_record) do
+  require 'unread/read_mark'
 
-Unread::MIGRATION_BASE_CLASS = if ActiveRecord::VERSION::MAJOR >= 5
-  ActiveRecord::Migration[5.0]
-else
-  ActiveRecord::Migration
+  include Unread
 end

data/unread.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |s|
   s.version     = Unread::VERSION
   s.licenses    = ['MIT']
   s.authors     = ["Georg Ledermann"]
-  s.email       = ["mail@georg-ledermann.de"]
+  s.email       = ["georg@ledermann.dev"]
   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.2'
+  s.required_ruby_version = '>= 2.7'
 
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -28,7 +28,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', '< 1'
+  s.add_development_dependency 'pg'
   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.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Georg Ledermann
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2022-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -98,16 +98,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,13 +181,13 @@ dependencies:
 description: 'This gem creates a scope for unread objects and adds methods to mark
   objects as read '
 email:
-- mail@georg-ledermann.de
+- georg@ledermann.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - Gemfile
 - MIT-LICENSE
@@ -195,12 +195,9 @@ files:
 - Rakefile
 - UPGRADE.md
 - bin/console
-- 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
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.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
@@ -219,7 +216,7 @@ homepage: https://github.com/ledermann/unread
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -227,16 +224,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Manages read/unread status of ActiveRecord objects
 test_files: []

data/.travis.yml

@@ -1,33 +0,0 @@
-language: ruby
-rvm:
-  - 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
-matrix:
-  exclude:
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_4_0.gemfile
-    - 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
-env:
-  - DB=sqlite
-  - 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/gemfiles/rails_4_0.gemfile

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

data/gemfiles/rails_4_1.gemfile

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

data/gemfiles/rails_4_2.gemfile

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

data/gemfiles/rails_5_0.gemfile

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

data/gemfiles/rails_5_1.gemfile

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

data/gemfiles/rails_5_2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.2.0.beta2"
-gem "mysql2", ">= 0.3.18", "< 0.5", "!= 0.4.3"
-
-gemspec path: "../"