acts_as_favoritor 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51b26144e2f4621c21c2733217190573550f4457
-  data.tar.gz: 7ac65f0fd1d99f1a22186a975d11031cc79ed047
+  metadata.gz: 94041c9376e8e337edf53d7c84397c30b9e2b562
+  data.tar.gz: f0d6c7694c0c3c3b218a5a9fc800d63ce29e68ce
 SHA512:
-  metadata.gz: bbb04b517631931b8fc8cd4eb091eb43f3a1b09635ca7aecc2d5d0979731177989db605b8114bcf7de871a58ea5ee9744b20b22fc0f00fee74ac4206d5102c13
-  data.tar.gz: d710797509f89e5bf16936a9f8da7f8d72f47cf0eb635dc229b04b23d9081be374e2a3718db12855c1044cb5bcd13b139baacffa1139fa2176b09d0eb3c29d05
+  metadata.gz: aa60c403515beb2407e424220641c8d9ba8f796ee5892863da3c187c93b9e1f1a9bffe11638f487419bc2fac53fd9c79d298c67395989cacd65df144c9508d31
+  data.tar.gz: fb30725d86c0c6b3815975fdc33cfc9d9490dcf9cca5191e47b7900d193b227aec7978fb63059596fb782a37cb3e7640b8691a7eee0a5225a0860e6baece42a8

data/.gitignore

@@ -4,4 +4,5 @@ rdoc
 memory
 *.gem
 .rvmrc
+Gemfile.lock
 log

data/.travis.yml

@@ -1,4 +1,3 @@
 language: ruby
 rvm:
     - 2.3.3
-install: bundle install --without development --deployment --jobs=3 --retry=3

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * nothing yet
 
+### 1.0.2 - 2017-08-22
+
+* minor improvements
+
 ### 1.0.1 - 2017-08-22
 
 * bug fixes

data/README.md

@@ -1,14 +1,28 @@
-# acts_as_favoritor - Add Favorites to you Rails app
+# `acts_as_favoritor` - Add Favorites to you Rails app
 
 <img src="https://travis-ci.org/slooob/acts_as_favoritor.svg?branch=master" />
 
-acts_as_favoritor is a Rubygem to allow any ActiveRecord model to favorite any other model. This is accomplished through a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records.
+`acts_as_favoritor` is a Rubygem to allow any ActiveRecord model to favorite any other model. This is accomplished through a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Setup](#setup)
+    * [`acts_as_favoritor` methods](#acts_as_favoritor-methods)
+    * [`acts_as_favoritable` methods](#acts_as_favoritable-methods)
+    * [`Favorite` model](#favorite-model)
+* [To Do List](#to-do-list)
+* [Contributors](#contributors)
+* [License](#license)
 
 ---
 
 ## Installation
 
-acts_as_favoritor works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+`acts_as_favoritor` works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
 
 ```ruby
 gem 'acts_as_favoritor'
@@ -40,6 +54,149 @@ This will create a Favorite model as well as a migration file.
 
 ## Usage
 
+### Setup
+
+Add `acts_as_favoritable` to the models you want to be able to get favorited:
+
+```ruby
+class User < ActiveRecord::Base
+    acts_as_favoritable
+end
+
+class Book < ActiveRecord::Base
+    acts_as_favoritable
+end
+```
+
+Specify which models can favorite other models by adding `acts_as_favoritor`:
+
+```ruby
+class User < ActiveRecord::Base
+    acts_as_favoritor
+end
+```
+
+### `acts_as_favoritor` methods
+
+```ruby
+book = Book.find 1
+user = User.find 1
+
+# `user` favorites `book`.
+user.favorite book
+
+# `user` removes `book` from favorites.
+user.remove_favorite book
+
+# Whether `user` has marked `book` as his favorite. Returns `true` or `false`.
+user.favorited? book
+
+# Total number of favorites by `user`.
+user.favorite_count
+
+# Returnes `user`'s favorites that have not been blocked as an array of Favorite records.
+user.all_favorites
+
+# Returns all favorited objects of `user` as an array (unblocked). This can be a collection of different object types, eg: `User`, `Book`.
+user.all_favorited
+
+# Returns an array of Favorite records where the `favoritable_type` is `Book`.
+user.favorites_by_type 'Book'
+
+# Returns an array of all favorited objects of `user` where `favoritable_type` is 'Book', this can be a collection of different object types, eg: `User`, `Book`.
+user.favorited_by_type 'Book'
+
+# Returns the exact same result as `user.favorited_by_type 'User'`.
+user.favorited_users
+
+# Total number of favorited books by `user`.
+user.favorited_by_type_count 'Book'
+
+# Returns the exact same result as `user.favorited_by_type_count 'Book'`.
+user.favorited_books_count
+
+# Returns the Arel scope for favorites.
+# This does not return the actual favorites, just the scope of favorited including the favoritables, essentially: `book.favorites.unblocked.includes(:favoritable)`.
+book.favorites_scoped
+```
+
+These methods take an optional hash parameter of ActiveRecord options (`:limit`, `:order`, etc...)
+
+    favorites_by_type, all_favorites, all_favorited, favorited_by_type
+
+### `acts_as_favoritable` methods
+
+```ruby
+# Returns all favoritors of a model that `acts_as_favoritable`
+book.favoritors
+
+# Returns the Arel scope for favoritors. This does not return the actual favoritors, just the scope of favorited records including the favoritors, essentially:  `book.favorited.includes(:favoritors)`.
+book.favoritors_scoped
+
+# Total number of favoritors.
+book.favoritors_count
+
+# Returns an array of records with type `User` following `book`.
+book.favoritors_by_type 'User'
+
+# Returns the exact same as `book.favoritors_by_type 'User'`.
+book.user_favoritors
+
+# Total number of favoritors with type `User`.
+book.favoritors_by_type_count 'User'
+
+# Returns the exact same as `book.favoritors_by_type_count 'User'`.
+book.count_user_favoritors
+
+To see is a model that acts_as_followable is followed by a model that acts_as_follower use the following
+# Whether `book` has been favorited by `user`. Returns `true` or `false`.
+book.favorited_by? user
+
+# Block a favoritor
+book.block user
+
+# Unblock a favoritor
+book.unblock user
+
+# Returns an array including all blocked Favoritor records.
+book.blocks
+
+# Total number of `book`'s favoritors blocked.
+book.blocked_favoritors_count
+```
+
+These methods take an optional hash parameter of ActiveRecord options (`:limit`, `:order`, etc...)
+
+    favoritors_by_type, favoritors, blocks
+
+### `Favorite` model
+
+```ruby
+# Scopes
+## Returns all Favorite records where `blocked` is `false`.
+Favorite.unblocked
+## Returns all Favorite records where `blocked` is `true`.
+Favorite.blocked
+## Returns an ordered array of the latest create Favorite records.
+Favorite.descending
+
+# Returns all Favorite records in an array, which have been created in a specified timeframe. Default is 2 weeks.
+Favorite.recent
+Favorite.recent 1.month.ago
+
+# Returns all favorites of `user`, including those who were blocked.
+Favorite.for_favoritor user
+
+# Returns all favoritors of `book`, including those who were blocked.
+Favorite.for_favoritable book
+```
+
+---
+
+## To Do List
+
+* Allow Favorites to be scoped, supporting multiple sets of favorites between models.
+
 ---
 
 ## Contributors

data/lib/acts_as_favoritor/favoritable.rb

@@ -92,7 +92,7 @@ module ActsAsFavoritor #:nodoc:
             end
 
             def unblock favoritor
-                get_favorite_for(favoritor).try(:delete)
+                get_favorite_for(favoritor).update_attribute :blocked, false
             end
 
             def get_favorite_for favoritor

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 module ActsAsFavoritor
 
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
 
 end

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

@@ -3,7 +3,7 @@ class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MA
         create_table :favorites, force: true do |t|
             t.references :favoritable, polymorphic: true, null: false
             t.references :favoritor, polymorphic: true, null: false
-            t.string :lists, default: [:favorites].to_yaml, null: false
+            t.string :scopes, default: [:favorites].to_yaml, null: false
             t.boolean :blocked, default: false, null: false
             t.timestamps
         end

data/lib/generators/templates/model.rb

@@ -3,7 +3,7 @@ class Favorite < ActiveRecord::Base
     extend ActsAsFavoritor::FavoritorLib
     extend ActsAsFavoritor::FavoriteScopes
 
-    serialize :lists
+    serialize :scopes
 
     # NOTE: Favorites belong to the 'favoritable' and 'favoritor' interface
     belongs_to :favoritable, polymorphic: true

data/test/schema.rb

@@ -5,7 +5,7 @@ ActiveRecord::Schema.define version: 0 do
         t.string   'favoritable_type', null: false
         t.integer  'favoritor_id', null: false
         t.string   'favoritor_type', null: false
-        t.string   'lists', default: [:favorites].to_yaml, null: false
+        t.string   'scopes', default: [:favorites].to_yaml, null: false
         t.boolean  'blocked', default: false, null: false
         t.datetime 'created_at'
         t.datetime 'updated_at'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jonas Hübotter
@@ -108,7 +108,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,131 +0,0 @@
-PATH
-  remote: .
-  specs:
-    acts_as_favoritor (1.0.1)
-      activerecord (>= 4.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actioncable (5.1.3)
-      actionpack (= 5.1.3)
-      nio4r (~> 2.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.1.3)
-      actionpack (= 5.1.3)
-      actionview (= 5.1.3)
-      activejob (= 5.1.3)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.1.3)
-      actionview (= 5.1.3)
-      activesupport (= 5.1.3)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.3)
-      activesupport (= 5.1.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.3)
-      activesupport (= 5.1.3)
-      globalid (>= 0.3.6)
-    activemodel (5.1.3)
-      activesupport (= 5.1.3)
-    activerecord (5.1.3)
-      activemodel (= 5.1.3)
-      activesupport (= 5.1.3)
-      arel (~> 8.0)
-    activesupport (5.1.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (8.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    erubi (1.6.1)
-    factory_girl (4.8.0)
-      activesupport (>= 3.0.0)
-    globalid (0.4.0)
-      activesupport (>= 4.2.0)
-    i18n (0.8.6)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.6)
-      mime-types (>= 1.16, < 4)
-    method_source (0.8.2)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.2.0)
-    minitest (5.10.3)
-    nio4r (2.1.0)
-    nokogiri (1.8.0-x86-mingw32)
-      mini_portile2 (~> 2.2.0)
-    rack (2.0.3)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (5.1.3)
-      actioncable (= 5.1.3)
-      actionmailer (= 5.1.3)
-      actionpack (= 5.1.3)
-      actionview (= 5.1.3)
-      activejob (= 5.1.3)
-      activemodel (= 5.1.3)
-      activerecord (= 5.1.3)
-      activesupport (= 5.1.3)
-      bundler (>= 1.3.0)
-      railties (= 5.1.3)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.3)
-      actionpack (= 5.1.3)
-      activesupport (= 5.1.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (12.0.0)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.2)
-    shoulda-matchers (2.8.0)
-      activesupport (>= 3.0.0)
-    shoulda_create (0.0.9)
-    sprockets (3.7.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.0)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.3.13-x86-mingw32)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.3)
-      thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.2)
-
-PLATFORMS
-  x86-mingw32
-
-DEPENDENCIES
-  acts_as_favoritor!
-  factory_girl (~> 4.8)
-  rails (>= 4.0)
-  shoulda (~> 3.5)
-  shoulda_create (~> 0.0)
-  sqlite3 (~> 1.3)
-
-BUNDLED WITH
-   1.15.4