socialization 0.4.0 → 0.5.0.beta

data/.gitignore

@@ -6,4 +6,8 @@ memory
 *.gem
 .rvmrc
 Gemfile.lock
-log
+log
+doc
+.yardoc
+.rbenv-version
+gemfiles

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## 0.5.0.beta (June 6, 2012)
+
+* **MAJOR REFACTORING:** Your Like, Follow and Mention models should now inherit the Socialization store base class instead of using the acts_as helper. (e.g.: class Follow < Socialization::ActiveRecordStores::FollowStore). See demo app for an example. Your code should be mostly unaffected.
+* Changed: The persistence logic has now been moved to the Socialization::ActiveRecordStores namespace. More stores such as Redis or MongoDB can be easily added.
+* Changed: `like!`, `follow!`, and `mention!` now return a boolean. True when the action was successful, false when it wasn't (e.g.: the relationship already exists).
+* Changed: `unlike!`, `unfollow!` and `unmention!` will now return false if there is no record to destroy rather than raising `ActiveRecord::RecordNotFound`.
+* Changed: Records can now like, follow or mention themselves. If you want to prevent this, it should be enforced directly in your application.
+* Added: `toggle_like!`, `toggle_follow!` and `toggle_mention!` methods. Thanks to [@balvig](https://github.com/balvig).
+* Added: support for single table inheritance. Thanks to [@balvig](https://github.com/balvig).
+
+## v0.4.0 (February 25, 2012)
+
+* **BREAKING CHANGE:** Renamed `mentionner` to `mentioner`. This is proper English.
+* Added: `followees`, `likees` and `mentionees` methods to `Follower`, `Liker` and `Mentioner`. Thanks to [@ihara2525](https://github.com/ihara2525).
+
+## v0.3.0 (February 22, 2012)
+
+* **BREAKING CHANGE:** `likers`, `followers` now return a scope instead of an array. They also require to have the class of the desired scope as an argument. For example: `Movie.find(1).followers(User)`.
+* Added: Mention support.
+* Some refactoring and clean up. Thanks to [@tilsammans](https://github.com/tilsammans)
+
+
+## 0.2.2 (January 15, 2012)
+
+* Improved tests.
+* Changed: Can no longer like or follow yourself.
+
+## 0.2.1 (January 15, 2012)
+
+* Bug fixes
+
+## 0.2.0 (January 15, 2012)
+
+* Bug fixes
+* Made Ruby 1.8.7 compatible
+
+## 0.1.0 (January 14, 2012)
+
+* Initial release

data/README.md

@@ -0,0 +1,246 @@
+# Socialization
+
+Socialization is a Ruby Gem that allows any ActiveRecord model to `Follow`, `Like` and/or `Mention` any other model. ActiveRecord or Redis can be used as a data store.
+
+The Follow feature is similar to Twitter's follow. For example, John follows Jane. Unlike Facebook's "friendship", Follow is a one-way concept. The fact that John follows Jane doesn't mean that Jane follows John.
+
+The Like feature works just like a Facebook Like. For example, John likes Pulp Fiction.
+
+The Mention feature was written with Facebook mentions in mind. For example, John mentions Jane in a comment. Typically, Jane would be highlighted in the comment user interface and possibly notified that John mentioned her. This Facebook feature is occasionally called Tagging, although tagging is generally something [entirely different](http://en.wikipedia.org/wiki/Tag_(metadata).
+
+[![Build Status](https://secure.travis-ci.org/cmer/socialization.png?branch=master)](http://travis-ci.org/cmer/socialization)
+
+## Installation
+
+### Rails 3
+
+Add the gem to the gemfile:
+`gem "socialization"`
+
+Run the generator:
+`rails generate socialization -s`
+
+Or if you want to use Redis as your data store:
+`rails generate socialization -s --store=redis`
+
+This will generate three migration files (when using ActiveRecord) and three models named Follow, Like and Mention. You may delete any of the Follow, Like or Mention models and migrations if you don't need that functionality in your application.
+
+### Rails 2.3.x Support
+
+This gem requires Rails 3 or better. Sorry!
+
+## Usage
+
+### Setup
+
+Allow a model to be followed:
+
+    class Celebrity < ActiveRecord::Base
+      ...
+      acts_as_followable
+      ...
+    end
+
+Allow a model to be a follower:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_follower
+      ...
+    end
+
+
+Allow a model to be liked:
+
+    class Movie < ActiveRecord::Base
+      ...
+      acts_as_likeable
+      ...
+    end
+
+Allow a model to like:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_liker
+      ...
+    end
+
+Allow a model to be mentioned:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_mentionable
+      ...
+    end
+
+Allow a model to mention:
+
+    class Comment < ActiveRecord::Base
+      ...
+      acts_as_mentioner
+      ...
+    end
+
+Or a more complex case where users can like and follow each other:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_follower
+      acts_as_followable
+      acts_as_liker
+      acts_as_likeable
+      acts_as_mentionable
+      ...
+    end
+
+***
+
+
+### acts_as_follower Methods
+
+Follow something
+
+    user.follow!(celebrity)
+
+Stop following
+
+    user.unfollow!(celebrity)
+
+Toggle
+
+    user.toggle_follow!(celebrity)
+
+Is following?
+
+    user.follows?(celebrity)
+
+
+***
+
+
+### acts_as_followable Methods
+
+Find out if an objects follows
+
+    celebrity.followed_by?(user)
+
+All followers
+
+    celebrity.followers(User)
+
+
+***
+
+
+### acts_as_liker Methods
+
+Like something
+
+    user.like!(movie)
+
+Stop liking
+
+    user.unlike!(movie)
+
+Toggle
+
+    user.toggle_like!(celebrity)
+
+Likes?
+
+    user.likes?(movie)
+
+***
+
+
+### acts_as_likeable Methods
+
+Find out if an objects likes
+
+    movie.liked_by?(user)
+
+All likers
+
+    movie.likers(User)
+
+***
+
+
+### acts_as_mentioner Methods
+
+**Note that a "mentioner" is the object containing the mention and not necessarily the actor. For example, John mentions Jane in a comment. The mentioner is the comment object, NOT John.**
+
+Mention something
+
+    comment.mention!(user)
+
+Remove mention
+
+    comment.unmention!(user)
+
+Toggle
+
+    user.toggle_mention!(celebrity)
+
+Mentions?
+
+    comment.mentions?(user)
+
+
+***
+
+
+### acts_as_mentionable Methods
+
+Find out if an objects mentions
+
+    user.mentioned_by?(comment)
+
+All mentioners
+
+    user.mentioners(Comment)
+
+
+***
+
+
+## Documentation
+
+You can find the compiled YARD documentation at http://rubydoc.info/github/cmer/socialization/frames. Documentation for methods inside `include` blocks is not currently generated although it exists in the code. A custom YARD filter needs to be written for YARD to pick those up.
+
+
+***
+
+## Changelog
+
+Here it is: https://github.com/cmer/socialization/blob/master/CHANGELOG.md
+
+## Demo App
+
+For your convenience, I have added a demo app in demo/demo_app. It does not have a web UI, but you can play with Socialization in the Rails console. It should also help you figure out hown to use Socialization in the Real World.
+
+To use the demo app:
+
+    $ cd demo/demo_app
+    $ bundle
+    $ rake db:migrate
+    $ rake db:seed
+    $ rails console
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Send me a pull request. Bonus points for topic branches.
+
+## Similar Projects
+
+[acts_as_follower](https://github.com/tcocca/acts_as_follower) is a similar project that I only discovered when I was 95% finished writing the first version of Socialization. I initially intended to name this project acts_as_follower only to find out the name was taken. You might want to check it out as well so see which one suits your needs better. Socialization is simpler, supports "Likes" and "Mentions" and easilly extendable; acts_as_follower has more "Follow" features, however.
+
+
+## Copyright
+
+Copyright (c) 2012 Carl Mercier --  Released under the MIT license.

data/demo/{demo_app/Gemfile → Gemfile}

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 3.2.1'
-gem 'socialization'
+gem 'socialization', :path => '../'
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
 

data/demo/app/models/follow.rb

@@ -0,0 +1,2 @@
+class Follow < Socialization::ActiveRecordStores::FollowStore
+end

data/demo/app/models/like.rb

@@ -0,0 +1,2 @@
+class Like < Socialization::ActiveRecordStores::LikeStore
+end

data/demo/app/models/mention.rb

@@ -0,0 +1,2 @@
+class Mention < Socialization::ActiveRecordStores::MentionStore
+end

data/demo/{demo_app/config → config}/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-DemoApp::Application.config.session_store :cookie_store, key: '_demo_app_session'
+DemoApp::Application.config.session_store :cookie_store, :key => '_demo_app_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/demo/{demo_app/config → config}/initializers/wrap_parameters.rb

@@ -5,7 +5,7 @@
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
+  wrap_parameters :format => [:json]
 end
 
 # Disable root element in JSON by default.

data/demo/{demo_app/db → db}/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.