socialization 0.2.2 → 0.3.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+
+script: bundle exec rake test

data/Appraisals

@@ -1,11 +1,11 @@
-appraise "activerecord23" do
-  gem "activerecord", "~> 2.3.14"
-end
-
 appraise "activerecord30" do
   gem "activerecord", "~> 3.0.10"
 end
 
 appraise "activerecord31" do
   gem "activerecord", "~> 3.1.1"
+end
+
+appraise "activerecord32" do
+  gem "activerecord", "~> 3.2.1"
 end

data/README.rdoc

@@ -1,22 +1,30 @@
 = Socialization
 
-Socialization is a Ruby Gem that allows any model to Follow and/or Like any other model. This is accomplished through a double polymorphic relationship on the Follow and Like models. But you don't need to know that since all the complexity is hidden from you.
+Socialization is a Ruby Gem that allows any model to Follow, Like and/or Mention any other model. This is accomplished through double polymorphic relationships, but you don't need to know that since all the complexity is hidden from you.
+
+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)].
+
+{<img src="https://secure.travis-ci.org/cmer/socialization.png" />}[http://travis-ci.org/cmer/socialization]
 
 == Installation
 
-=== Rails 3 Support
+=== Rails 3
 
 Add the gem to the gemfile:
   gem "socialization"
 
 Run the generator:
-  rails generate socialization
+  rails generate socialization -s
 
-This will generate two migration files and two models named Follow and Like. You may delete the Follow or Like model and migration if you don't need that functionality in your application.
+This will generate three migration files and threww models named Follow, Like and Mention. You may delete the Follow, Like or Mention model and migration if you don't need that functionality in your application.
 
 === Rails 2.3.x Support
 
-I haven't tested it nor do I care much about Rails 2.3.x. Sorry!
+This gem requires Rails 3 or better. Sorry!
 
 == Usage
 
@@ -51,6 +59,20 @@ Allow a model to like:
     ...
   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_mentionner
+    ...
+  end
+
 Or a more complex case where users can like and follow each other:
   class User < ActiveRecord::Base
     ...
@@ -58,6 +80,7 @@ Or a more complex case where users can like and follow each other:
     acts_as_followable
     acts_as_liker
     acts_as_likeable
+    acts_as_mentionable
     ...
   end
 
@@ -82,7 +105,7 @@ Find out if an objects follows
   celebrity.followed_by?(user)
 
 All followers
-  celebrity.followers
+  celebrity.followers(User)
 
 ---
 
@@ -105,7 +128,44 @@ Find out if an objects likes
   movie.liked_by?(user)
 
 All likers
-  movie.likers
+  movie.likers(User)
+
+=== acts_as_mentionner Methods
+
+<b>Note that a "mentionner" is the object containing the mention and not necessarily the actor. For example, John mentions Jane in a comment. The mentionner is the comment object, NOT John.</b>
+
+Mention something
+  comment.mention!(user)
+
+Remove mention
+  comment.unmention!(user)
+
+Mentions?
+  comment.mentions?(user)
+
+---
+
+=== acts_as_mentionable Methods
+
+Find out if an objects mentions
+  user.mentioned_by?(comment)
+
+All mentionners
+  user.mentionners(Comment)
+
+---
+
+== 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
@@ -117,7 +177,7 @@ All likers
 
 == 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 easilly extendable; acts_as_follower has more "Follow" features.
+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

data/demo/demo_app/Gemfile

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

data/demo/demo_app/app/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+  acts_as_mentionner
+  belongs_to :user
+  belongs_to :movie
+end

data/demo/demo_app/app/models/mention.rb

@@ -0,0 +1,3 @@
+class Mention < ActiveRecord::Base
+  acts_as_mention_store
+end

data/demo/demo_app/app/models/user.rb

@@ -3,4 +3,5 @@ class User < ActiveRecord::Base
   acts_as_followable
 
   acts_as_liker
+  acts_as_mentionable
 end

data/demo/demo_app/db/migrate/20120221200644_create_mentions.rb

@@ -0,0 +1,14 @@
+class CreateMentions < ActiveRecord::Migration
+  def change
+    create_table :mentions do |t|
+      t.string  :mentionner_type
+      t.integer :mentionner_id
+      t.string  :mentionable_type
+      t.integer :mentionable_id
+      t.datetime :created_at
+    end
+
+    add_index :mentions, ["mentionner_id", "mentionner_type"],   :name => "fk_mentions"
+    add_index :mentions, ["mentionable_id", "mentionable_type"], :name => "fk_mentionables"
+  end
+end

data/demo/demo_app/db/migrate/20120221202703_create_comments.rb

@@ -0,0 +1,9 @@
+class CreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.integer :user_id
+      t.integer :movie_id
+      t.string :body
+    end
+  end
+end

data/demo/demo_app/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120115054647) do
+ActiveRecord::Schema.define(:version => 20120221202703) do
 
   create_table "celebrities", :force => true do |t|
     t.string   "name"
@@ -19,6 +19,12 @@ ActiveRecord::Schema.define(:version => 20120115054647) do
     t.datetime "updated_at", :null => false
   end
 
+  create_table "comments", :force => true do |t|
+    t.integer "user_id"
+    t.integer "movie_id"
+    t.string  "body"
+  end
+
   create_table "follows", :force => true do |t|
     t.string   "follower_type"
     t.integer  "follower_id"
@@ -41,6 +47,17 @@ ActiveRecord::Schema.define(:version => 20120115054647) do
   add_index "likes", ["likeable_id", "likeable_type"], :name => "fk_likeables"
   add_index "likes", ["liker_id", "liker_type"], :name => "fk_likes"
 
+  create_table "mentions", :force => true do |t|
+    t.string   "mentionner_type"
+    t.integer  "mentionner_id"
+    t.string   "mentionable_type"
+    t.integer  "mentionable_id"
+    t.datetime "created_at"
+  end
+
+  add_index "mentions", ["mentionable_id", "mentionable_type"], :name => "fk_mentionables"
+  add_index "mentions", ["mentionner_id", "mentionner_type"], :name => "fk_mentions"
+
   create_table "movies", :force => true do |t|
     t.string   "name"
     t.datetime "created_at", :null => false

data/demo/demo_app/db/seeds.rb

@@ -12,3 +12,6 @@ Celebrity.create :name => 'Uma Thurman'
 Celebrity.create :name => 'John Travlota'
 Celebrity.create :name => 'Samuel L. Jackson'
 Celebrity.create :name => 'Bruce Willis'
+
+c = Comment.create :user_id => 1, :movie_id => 1, :body => 'Awesome movie. Vincent Vega is awesome in it!'
+c.mention!(User.find_by_name("Vincent Vega"))

data/gemfiles/activerecord30.gemfile

@@ -0,0 +1,6 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.0.10"
+

data/gemfiles/activerecord30.gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.11)
+    arel (2.0.10)
+    builder (2.1.2)
+    i18n (0.5.0)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.10)

data/gemfiles/activerecord31.gemfile

@@ -0,0 +1,6 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.1.1"
+

data/gemfiles/activerecord31.gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.2)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.1.0)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1.1)

data/gemfiles/activerecord32.gemfile

@@ -0,0 +1,6 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.2.1"
+

data/gemfiles/activerecord32.gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.1)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.1.0)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.1)

data/generators/socialization/USAGE

@@ -1 +1 @@
-Generates the Follow and Like models as well as their migrations.
+Generates the Follow, Like and Mention models as well as their migrations.

data/generators/socialization/socialization_generator.rb

@@ -1,11 +1,15 @@
 class SocializationGenerator < Rails::Generator::Base
   def manifest
     record do |m|
-      m.template 'model_follow.rb', 'app/models/follow.rb'
-      m.template 'model_like.rb', 'app/models/like.rb'
-      m.migration_template 'migration_follows.rb', 'db/migrate', :migration_file_name => 'create_follows'
+      m.template 'model_follow.rb',  'app/models/follow.rb'
+      m.template 'model_like.rb',    'app/models/like.rb'
+      m.template 'model_mention.rb', 'app/models/mention.rb'
+
+      m.migration_template 'migration_follows.rb', 'db/migrate',  :migration_file_name => 'create_follows'
       sleep 1  # force unique migration timestamp
-      m.migration_template 'migration_likes.rb', 'db/migrate',   :migration_file_name => 'create_likes'
+      m.migration_template 'migration_likes.rb', 'db/migrate',    :migration_file_name => 'create_likes'
+      sleep 1  # force unique migration timestamp
+      m.migration_template 'migration_mentions.rb', 'db/migrate', :migration_file_name => 'create_mentions'
     end
   end
 end

data/generators/socialization/templates/migration_mentions.rb

@@ -0,0 +1,14 @@
+class CreateMentions < ActiveRecord::Migration
+  def change
+    create_table :mentions do |t|
+      t.string  :mentionner_type
+      t.integer :mentionner_id
+      t.string  :mentionable_type
+      t.integer :mentionable_id
+      t.datetime :created_at
+    end
+
+    add_index :mentions, ["mentionner_id", "mentionner_type"],   :name => "fk_mentions"
+    add_index :mentions, ["mentionable_id", "mentionable_type"], :name => "fk_mentionables"
+  end
+end

data/generators/socialization/templates/model_mention.rb

@@ -0,0 +1,3 @@
+class Mention < ActiveRecord::Base
+  acts_as_mention_store
+end

data/lib/generators/socialization/socialization_generator.rb

@@ -14,10 +14,14 @@ class SocializationGenerator < Rails::Generators::Base
   end
 
   def create_migration_file
-    copy_file 'model_follow.rb', 'app/models/follow.rb'
-    copy_file 'model_like.rb', 'app/models/like.rb'
-    migration_template 'migration_follows.rb', 'db/migrate/create_follows.rb'
+    copy_file 'model_follow.rb',  'app/models/follow.rb'
+    copy_file 'model_like.rb',    'app/models/like.rb'
+    copy_file 'model_mention.rb', 'app/models/mention.rb'
+
+    migration_template 'migration_follows.rb',  'db/migrate/create_follows.rb'
+    sleep 1 # wait a second to have a unique migration timestamp
+    migration_template 'migration_likes.rb',    'db/migrate/create_likes.rb'
     sleep 1 # wait a second to have a unique migration timestamp
-    migration_template 'migration_likes.rb', 'db/migrate/create_likes.rb'
+    migration_template 'migration_mentions.rb', 'db/migrate/create_mentions.rb'
   end
 end

data/lib/socialization/follow_store.rb

@@ -1,14 +1,14 @@
 module Socialization
   module FollowStore
-    def self.included(base)
-      base.class_eval do
-        belongs_to :follower,   :polymorphic => true
-        belongs_to :followable, :polymorphic => true
+    extend ActiveSupport::Concern
 
-        validates_uniqueness_of :followable_type, :scope => [:followable_id, :follower_type, :follower_id], :message => 'You cannot follow the same thing twice.'
+    included do
+      belongs_to :follower,   :polymorphic => true
+      belongs_to :followable, :polymorphic => true
 
-        def self.human_attribute_name(*args); ''; end
-      end
+      validates_uniqueness_of :followable_type, :scope => [:followable_id, :follower_type, :follower_id], :message => 'You cannot follow the same thing twice.'
+
+      def self.human_attribute_name(*args); ''; end
     end
   end
-end
+end