shiroyagi 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ffc00ea34f0a1bc9c02da59494cac36fb363d5b49e5390dd5a0b68125f4f038
-  data.tar.gz: edbb71293868f748798a736ce8c2201d9a858b3ad056b46d4ed092653bbc6f05
+  metadata.gz: ea26658917cd80c6b73a88485ea673c1fc7bb134057e80b829128b5f9e0e3d78
+  data.tar.gz: 578caadf70d4954dfe512e3ec3c813d5374d2badb5feadfb53d3df0a5cb410df
 SHA512:
-  metadata.gz: 7979f168e169a0477902dae8232dbf117d90d64583b105cd099da06eda2d65673b281dcfa18914f2652f26ad45ce31a4b5d8884fc2093844a3d6ef94af8ca3ef
-  data.tar.gz: b10a1ae50ec3effe784cf1ce75bc656c79d744a3f9b82bc09110bdc407b43cc2e7a4cc412bdfaea7b5dcd0ac9a9ba4ba886a046aee0a3638f6bb01482ffff71a
+  metadata.gz: 6f5eef44ffbaaa83d5b48be6c8a5b11f8d446b86aedbaf9e6e683fe7cf8f7d40c8e4940d9e662b01609205f72d26f16a8cdb53750866cfe42dd5b4775e75e0cd
+  data.tar.gz: '091d520a09d03fb0208a24a6d61c93ae83be4b21f340877baf8c28bdf3ef3869a79576e1969282f20de19154b3b9a6c8caad31fd9b40c1c63f4ef242f7816250'

data/README.md

@@ -18,6 +18,16 @@ class Message < ApplicationRecord
 end
 ```
 
+If you want to use a different column, you can specify it with `acts_as_shiroyagi`
+
+```ruby
+class Message < ApplicationRecord
+  include Shiroyagi::ActsAsShiroyagi
+
+  acts_as_shiroyagi column: 'user_read_at'
+end
+```
+
 That's it! Then you can use the following methods.
 
 ```ruby

data/lib/shiroyagi/acts_as_shiroyagi.rb

@@ -3,8 +3,12 @@ module Shiroyagi
     extend ActiveSupport::Concern
 
     class_methods do
-      # TODO: The read_at column name should be customizable via an argument.
       def acts_as_shiroyagi(options = {})
+        @read_management_column_name = options[:column].to_sym if options[:column].present?
+      end
+
+      def read_management_column_name
+        @read_management_column_name || :read_at
       end
 
       def reads_count
@@ -16,41 +20,47 @@ module Shiroyagi
       end
 
       def mark_all_as_read
-        unreads.update(read_at: Time.current)
+        unreads.update(read_management_column_name => Time.current)
       end
 
       def mark_all_as_unread
-        reads.update(read_at: nil)
+        reads.update(read_management_column_name => nil)
       end
     end
 
     included do
-      scope :reads,   -> { where.not(read_at: nil) }
-      scope :unreads, -> { where(read_at: nil) }
+      scope :reads,   -> { where.not(read_management_column_name => nil) }
+      scope :unreads, -> { where(read_management_column_name => nil) }
 
       def mark_as_read
-        update(read_at: Time.current) if unread?
+        update(read_management_column_name => Time.current) if unread?
       end
 
       def mark_as_unread
-        update(read_at: nil) if read?
+        update(read_management_column_name => nil) if read?
       end
 
       def mark_as_read!
-        update!(read_at: Time.current) if unread?
+        update!(read_management_column_name => Time.current) if unread?
       end
 
       def mark_as_unread!
-        update!(read_at: nil) if read?
+        update!(read_management_column_name => nil) if read?
       end
 
       def read?
-        read_at.present?
+        send(read_management_column_name).present?
       end
 
       def unread?
-        read_at.blank?
+        send(read_management_column_name).blank?
       end
     end
+
+    private
+
+    def read_management_column_name
+      self.class.read_management_column_name
+    end
   end
 end

data/lib/shiroyagi/version.rb

@@ -1,3 +1,3 @@
 module Shiroyagi
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiroyagi
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Rui Onodera
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -98,7 +98,7 @@ homepage: https://github.com/Findy/shiroyagi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Read/Unread status management module for Rails.
 test_files: []