shiroyagi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f3af95d866483aebdc0add25d148f9b07b4d3df
+  data.tar.gz: ac166dbf8ec135c78b67df3342429f2cfcd9b9aa
+SHA512:
+  metadata.gz: a19db89f032a7fa33ebf74df353dfb4fef5ea57da58f5ac06ba49581210142d462800fe8e10af4330008ea3d762f2f02956d80208a49e8f565f8e39287b198b0
+  data.tar.gz: 3ebcd1594defac9c4239d5b3ca09433fb959e4454bc90a9130a66eca702ebcbd7cc1ce7a62edab0f370939251509a95a4d40b6d8b500fe878031183bc2fe8973

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Rui Onodera
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# 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.
+
+```ruby
+class Message < ApplicationRecord
+  include Shiroyagi::ActsAsShiroyagi
+end
+```
+
+That's it! Then you can use the following methods.
+
+```ruby
+# 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:
+
+```ruby
+gem 'shiroyagi'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install shiroyagi
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Shiroyagi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/shiroyagi.rb

@@ -0,0 +1,4 @@
+require 'shiroyagi/acts_as_shiroyagi'
+
+module Shiroyagi
+end

data/lib/shiroyagi/acts_as_shiroyagi.rb

@@ -0,0 +1,56 @@
+module Shiroyagi
+  module ActsAsShiroyagi
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # TODO: The read_at column name should be customizable via an argument.
+      def acts_as_shiroyagi(options = {})
+      end
+
+      def reads_count
+        reads.count
+      end
+
+      def unreads_count
+        unreads.count
+      end
+
+      def mark_all_as_read
+        unreads.update(read_at: Time.current)
+      end
+
+      def mark_all_as_unread
+        reads.update(read_at: nil)
+      end
+    end
+
+    included do
+      scope :reads,   -> { where.not(read_at: nil) }
+      scope :unreads, -> { where(read_at: nil) }
+
+      def mark_as_read
+        update(read_at: Time.current) if unread?
+      end
+
+      def mark_as_unread
+        update(read_at: nil) if read?
+      end
+
+      def mark_as_read!
+        update!(read_at: Time.current) if unread?
+      end
+
+      def mark_as_unread!
+        update!(read_at: nil) if read?
+      end
+
+      def read?
+        read_at.present?
+      end
+
+      def unread?
+        read_at.blank?
+      end
+    end
+  end
+end

data/lib/shiroyagi/version.rb

@@ -0,0 +1,3 @@
+module Shiroyagi
+  VERSION = '1.0.0'
+end

data/lib/tasks/shiroyagi_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :shiroyagi do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: shiroyagi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rui Onodera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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: pry-byebug
+  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'
+description: Read/Unread status management module for Rails.
+email:
+- deraru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/shiroyagi.rb
+- lib/shiroyagi/acts_as_shiroyagi.rb
+- lib/shiroyagi/version.rb
+- lib/tasks/shiroyagi_tasks.rake
+homepage: https://github.com/Findy/shiroyagi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Read/Unread status management module for Rails.
+test_files: []