read_activity 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a505cc9665d3fbc592d8e08c232aecab8c8f955
-  data.tar.gz: 3ed4a918d476407b1c4186a354bc40903f8017f4
+  metadata.gz: 1f23a993cd5ea8af4de3fe027645d22413746d39
+  data.tar.gz: f999afb9b8bc45f737658abec73edb706f94ac63
 SHA512:
-  metadata.gz: 99ce880aace3ccdcaa1ba0706cdb10ef8c1c428404901f673b81c66c69d088c599d9684bc57b57692a34a7a668e29364403453df010b7276dd4cdff56ecd9926
-  data.tar.gz: 91b45d17da9f3f8f742e945fa24b058fb462cf5cb84cb2e88dc3b13124d1197488ad55a67c20e4762f056fedc5e8893b05616056459c562c3b89f2c9fd260176
+  metadata.gz: c8b52e2215b02a37524e4576c1a4f0a7abbbfe15e13f853c07d5b520fc1a0134e120f4b9f92eba57ad527fe863fdfb8b480248bc7fdd7ea4eda046b4f6d29660
+  data.tar.gz: 2ed81496b4533bb17b1b840d10b38e62736d882e8bf3a6c23baee8ce93db9821951d7754cfd6b97c047b1eaa74b1c41dad50a0fcc8bec63775bc1b8d0d5ed65e

data/README.md

@@ -20,9 +20,51 @@ Or install it yourself as:
 
     $ gem install read_activity
 
-## Usage
+## Usage example
 
-TODO: Write usage instructions here
+```ruby
+
+class User < ActiveRecord::Base
+  acts_as_reader
+end
+
+class Article < ActiveRecord::Base
+  acts_as_readable
+end
+
+user = User.create!
+article = Article.create!
+
+user.read!(article)
+# or article.read_by!(user)
+
+user.read?(article) # == true
+# or article.read_by?(user) == true
+
+user.read_at(article)
+# or article.read_by_at(user)
+
+article.readers # == [user]
+# or user.read_articles == [article]
+# user.read_#{reader_table_name} (the plural form)
+
+article.unreaders # == []
+# or user.unread_articles == []
+# user.unread_#{readable_table_name} (the plural form)
+
+reader = article.readers.first
+reader.read_at # no required params when you have fetched readers using #readers
+
+read_article = user.read_articles.first
+read_article.read_by_at
+
+User.find_who_read(article)
+User.find_who_unread(article)
+
+Article.find_read_by(user)
+Article.find_unread_by(user)
+
+```
 
 ## Contributing
 

data/lib/generators/read_activity/templates/create_read_activity_marks.rb

@@ -1,8 +1,8 @@
 class CreateReadActivityMarks < ActiveRecord::Migration
   def change
     create_table :read_activity_marks do |t|
-      t.references :reader, null: false
-      t.references :readable, polymorphic: true
+      t.references :reader, null: false, index: true
+      t.references :readable, polymorphic: true, index: true
       t.integer :mark, default: 0
 
       t.timestamps

data/lib/read_activity/readable.rb

@@ -10,7 +10,7 @@ module ReadActivity
 
     module ClassMethods
       def find_read_by(reader)
-        self.joins(:read_activity_marks).merge(ReadActivityMark.where(reader: reader))
+        self.includes(:read_activity_marks).merge(ReadActivityMark.where(reader: reader)).references(:read_activity_marks)
       end
 
       def find_unread_by(reader)
@@ -31,14 +31,25 @@ module ReadActivity
       end
 
       def read_by?(reader)
-        mark = self.read_activity_marks.where(reader: reader)
-        mark.exists?
+        mark = self.read_activity_marks.exists?(reader: reader)
       end
 
-      def read_by_at(reader)
-        mark = ReadActivityMark.find_by(readable: self, reader: reader)
-        return mark.created_at if mark
-        return nil
+      def read_by_at(reader = nil)
+        read_by_at = nil
+
+        if self.read_activity_marks.loaded?
+          read_by_at = self.read_activity_marks.first.try(:created_at)
+        end
+
+        if read_by_at.nil? && reader
+          if reader.read_activity_marks.loaded?
+            read_by_at = reader.read_activity_marks.first.try(:created_at)
+          else
+            read_by_at = self.read_activity_marks.where(reader: reader).first.try(:created_at)
+          end
+        end
+
+        return read_by_at
       end
 
       def readers

data/lib/read_activity/reader.rb

@@ -9,7 +9,7 @@ module ReadActivity
 
     module ClassMethods
       def find_who_read(readable)
-        self.joins(:read_activity_marks).merge(ReadActivityMark.where(readable: readable))
+        self.includes(:read_activity_marks).merge(ReadActivityMark.where(readable: readable)).references(:read_activity_marks)
       end
 
       def find_who_unread(readable)
@@ -40,9 +40,22 @@ module ReadActivity
         klass.send(:find_unread_by, self)
       end
 
-      # inverse of Readable#read_by_at
-      def read_at(readable)
-        readable.read_by_at(self)
+      def read_at(readable = nil)
+        read_at = nil
+
+        if self.read_activity_marks.loaded?
+          read_at = self.read_activity_marks.first.try(:created_at)
+        end
+
+        if read_at.nil? && readable
+          if readable.read_activity_marks.loaded?
+            read_at = readable.read_activity_marks.first.try(:created_at)
+          else
+            read_at = self.read_activity_marks.where(readable: readable).first.try(:created_at)
+          end
+        end
+
+        return read_at
       end
 
       def method_missing(method, *arguments, &block)

data/lib/read_activity/version.rb

@@ -1,3 +1,3 @@
 module ReadActivity
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/read_activity/readable_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe ReadActivity::Readable do
       expect(mark.reader).to eq(user)
       expect(mark.readable).to eq(article)
     end
-    
+
     it "should create only ReadActivityMark for specific readable" do
       user = FactoryGirl.create(:user)
       article = FactoryGirl.create(:article)
@@ -87,7 +87,7 @@ RSpec.describe ReadActivity::Readable do
   end
 
   describe "#read_by_at" do
-    it "should return when user read readables" do
+    it "should return when users read readables" do
       user = FactoryGirl.create(:user)
       article = FactoryGirl.create(:article)
 
@@ -96,5 +96,15 @@ RSpec.describe ReadActivity::Readable do
 
       expect(article.read_by_at(user)).to eq(user.read_activity_marks.take.created_at)
     end
+
+    it "should return when readers read readables" do
+      user = FactoryGirl.create(:user)
+      article = FactoryGirl.create(:article)
+
+      article.read_by!(user)
+
+      articles = user.read_articles
+      expect(articles.first.read_by_at).to eq(user.read_activity_marks.take.created_at)
+    end
   end
 end

data/spec/read_activity/reader_spec.rb

@@ -132,10 +132,28 @@ RSpec.describe ReadActivity::Reader do
       user = FactoryGirl.create(:user)
       article = FactoryGirl.create(:article)
 
-      expect(user.read_at(article)).to eq(nil)
       user.read!(article)
 
       expect(user.read_at(article)).to eq(user.read_activity_marks.take.created_at)
     end
+
+    it "should return when readers read readables" do
+      user = FactoryGirl.create(:user)
+      article = FactoryGirl.create(:article)
+
+      user.read!(article)
+
+      readers = article.readers
+      expect(readers.first.read_at).to eq(user.read_activity_marks.take.created_at)
+    end
+
+    it "should be optimized" do
+      users = FactoryGirl.create_list(:user, 3)
+      article = FactoryGirl.create(:article)
+
+      users.each { |user| user.read!(article) }
+
+      expect { article.readers.each{ |user| user.read_at } }.to under_query_limit(1)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ SimpleCov.start
 require "active_record"
 require "database_cleaner"
 require "factory_girl"
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
 require "read_activity"
 

data/spec/support/matchers/under_query_limit.rb

@@ -0,0 +1,19 @@
+# https://gist.github.com/rsutphin/af06c9e3dadf658d2293
+# Derived from http://stackoverflow.com/a/13423584/153896. Updated for RSpec 3.
+RSpec::Matchers.define :under_query_limit do |expected|
+  supports_block_expectations
+
+  match do |block|
+    query_count(&block) <= expected
+  end
+
+  failure_message do |actual|
+    "Expected to run maximum #{expected} queries, got #{@counter.query_count}"
+  end
+
+  def query_count(&block)
+    @counter = ActiveRecord::QueryCounter.new
+    ActiveSupport::Notifications.subscribed(@counter.to_proc, 'sql.active_record', &block)
+    @counter.query_count
+  end
+end

data/spec/support/query_counter.rb

@@ -0,0 +1,18 @@
+# Derived from http://stackoverflow.com/a/13423584/153896
+module ActiveRecord
+  class QueryCounter
+    attr_reader :query_count
+
+    def initialize
+      @query_count = 0
+    end
+
+    def to_proc
+      lambda(&method(:callback))
+    end
+
+    def callback(name, start, finish, message_id, values)
+      @query_count += 1 unless %w(CACHE SCHEMA).include?(values[:name])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: read_activity
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Hong ChulJu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,6 +169,8 @@ files:
 - spec/read_activity/reader_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/matchers/under_query_limit.rb
+- spec/support/query_counter.rb
 homepage: https://github.com/FeGs/read_activity
 licenses:
 - MIT
@@ -202,3 +204,5 @@ test_files:
 - spec/read_activity/reader_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/matchers/under_query_limit.rb
+- spec/support/query_counter.rb