Project

shiroyagi

0.01
Low commit activity in last 3 years
No release in over a year
shiroyagifindy/shiroyagiHomepageDocumentationSource CodeBug TrackerWiki
Read/Unread status management module for Rails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
28,164
Stars
13
Forks
6
Watchers
33
 Releases
Current version
1.4.0
Total releases
10
First release
2017-11-28
Latest release
2022-08-01
 Pull Requests
Open Pull Requests
10
Closed Pull Requests
33
Merged Pull Requests
30
Pull Request Acceptance Rate
41%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-03-22
Reverse Dependencies
0

 Dependencies

Development

factory_bot_rails
>= 0
pry-byebug
>= 0
rspec-rails
~> 4.0.2
sqlite3
~> 1.4

Runtime

rails
>= 5.2.2
 Project Readme

Shiroyagi

Shiroyagi is a thin Rails plugin which manages Read/Unread status of a Model.

Usage

Add a column name read_at to your model. This column is used by status management.

bin/rails g migration AddColumnToYourModels read_at:datetime

Include the Shiroyagi::ActsAsShiroyagi module in your class.

class Message < ApplicationRecord
  include Shiroyagi::ActsAsShiroyagi
end

If you want to use a different column, you can specify it with acts_as_shiroyagi

class Message < ApplicationRecord
  include Shiroyagi::ActsAsShiroyagi

  acts_as_shiroyagi column: 'user_read_at'
end

That's it! Then you can use the following methods.

# Class methods

Message.reads
=> [#<Message id: 1, read_at: Tue, 28 Nov 2017 07:59:47 UTC +00:00>]

Message.unreads
=> [#<Message id: 2, read_at: nil>]

Message.reads_count
=> 1

Message.unreads_count
=> 1

Message.mark_all_as_read
=> [#<Message id: 2, read_at: Tue, 28 Nov 2017 08:04:44 UTC +00:00>]

Message.mark_all_as_unread
=> [#<Message id: 1, read_at: nil>,
#<Message id: 2, read_at: nil>]


# Instance methods

message.mark_as_read
=> true
message
=> #<Message id: 1, read_at: Tue, 28 Nov 2017 08:10:20 UTC +00:00>
message.read?
=> true
message.unread?
=> false

message.mark_as_unread
=> true
message
=> #<Message id: 1, read_at: nil>
message.read?
=> false
message.unread?
=> true

Installation

Add this line to your application's Gemfile:

gem 'shiroyagi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shiroyagi

Contributing

Fork this repository and throw your contributing pull requests to this repository.

License

The gem is available as open source under the terms of the MIT License.