connections 0.0.2 → 0.0.3

data/README.md

@@ -1,12 +1,14 @@
 # Connections
 
-Most social apps needs some kind of follow/like/watch/stalk/etc
-feature that connects one model to another.
+Most social apps need some kind of follow/like/watch/stalk/etc
+features that connects one model to another.
 
-Instead of having to recreate this functionality for every project we
+Instead of having to recreate this functionality for every project I
 decided to create a gem that easily allows you to add these features
 using any naming you prefer.
 
+[![Build Status](https://secure.travis-ci.org/balvig/connections.png?branch=master)](http://travis-ci.org/balvig/connections)
+
 ## Installation
 
 Add the gem to the gemfile:
@@ -20,7 +22,8 @@ keeping track of what is connected to what.
 
 ## Usage
 
-Use `connects_with` and `connectable_with` to add connection capabilities to any model using
+Use `connects_with` to enable a model to connect to other models and
+`connectable_with ` to allow a model to be connected to using
 whatever naming scheme you prefer (follow, like, watch, etc)
 
     class User < ActiveRecord::Base
@@ -32,14 +35,16 @@ whatever naming scheme you prefer (follow, like, watch, etc)
       connectable_with :like
     end
 
-This will add following methods:
+Depending on the naming scheme you choose Connections will try to figure out the
+grammar and add appropriately named methods. For example in the case of
+"Follow" and "Like" the following methods will be added:
 
     # Follow
     user.follow(other_user) # Creates a 'Follow' connection from user -> other_user
     user.unfollow(other_user) # Removes 'Follow' connection between user -> other_user
     user.toggle_follow(other_user) # Toggles the connection on/off (useful for toggle buttons)
     user.follows?(other_user) # Returns true if the user if following other_user
-    user.followings(:user) # Returns a list of all the users the user is following
+    user.following(:user) # Returns a list of all the users the user is following
     other_user.followers(:user) #Returns a list of all the user's followers
 
     # Like
@@ -47,7 +52,7 @@ This will add following methods:
     user.unlike(post)
     user.toggle_like(post)
     user.likes?(post)
-    user.likings(:post)
+    user.liking(:post)
     post.likers(:user)
 
 That's it! If you want to add extra functionality to the join model (such
@@ -60,7 +65,7 @@ project like this:
 
 ## Credits
 
-This gem was inspired by [socialization](https://github.com/cmer/socialization) that although it didn't quite do what we needed is a pretty useful tool.
+This gem was inspired by [socialization](https://github.com/cmer/socialization) that although it didn't quite do what I needed is a pretty useful tool in itself.
 
 
 ## Copyright

data/lib/connections/connectable.rb

@@ -11,7 +11,7 @@ module Connections
             # user.followers(:user)
             define_method :"#{t.to_s.sub(/e$/,'')}ers" do |class_name|
               klass = class_name.to_s.classify.constantize
-              klass.joins(:connections).where("connections_connections.type = ? AND connectable_type = ? AND connectable_id = ?", t.to_s.classify, self.class.table_name.classify, self)
+              klass.joins(:connections).where("connections_connections.type = ? AND connectable_type = ? AND connectable_id = ?", t.to_s.classify, self.class.base_class.to_s, self)
             end
           end
         end

data/lib/connections/connector.rb

@@ -44,7 +44,7 @@ module Connections
             # user.following(:user)
             define_method :"#{t.to_s.sub(/e$/,'')}ing" do |class_name|
               klass = class_name.to_s.classify.constantize
-              klass.joins(:incoming_connections).where("connections_connections.type = ? AND connector_type = ? AND connector_id = ?", t.to_s.classify, self.class.table_name.classify, self)
+              klass.joins(:incoming_connections).where("connections_connections.type = ? AND connector_type = ? AND connector_id = ?", t.to_s.classify, self.class.base_class.to_s, self)
             end
           end
         end

data/lib/connections/version.rb

@@ -1,3 +1,3 @@
 module Connections
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/connections_test.rb

@@ -8,78 +8,74 @@ class ConnectionsTest < ActiveSupport::TestCase
     @post = Post.create!
   end
 
-  context 'No Follow class defined for join table' do
-    test '#follow' do
-      assert !@follower.follows?(@user)
-      @follower.follow(@user)
-      assert @follower.follows?(@user)
-    end
-
-    test '#unfollow' do
-      @follower.follow(@user)
-      assert @follower.follows?(@user)
-      @follower.unfollow(@user)
-      assert !@follower.follows?(@user)
-    end
-
-    test '#toggle_follow' do
-      @follower.toggle_follow(@user)
-      assert @follower.follows?(@user)
-      @follower.toggle_follow(@user)
-      assert !@follower.follows?(@user)
-    end
+  # No explicit Follow class defined
+  test '#follow' do
+    assert !@follower.follows?(@user)
+    @follower.follow(@user)
+    assert @follower.follows?(@user)
+  end
 
-    test '#following' do
-      @follower.follow(@user)
-      @follower.follow(@post)
-      assert_equal [@user], @follower.following(:user)
-      assert_equal [@post], @follower.following(:post)
-    end
+  test '#unfollow' do
+    @follower.follow(@user)
+    assert @follower.follows?(@user)
+    @follower.unfollow(@user)
+    assert !@follower.follows?(@user)
+  end
 
-    test '#follows' do
-      #TODO: What should happen if the Follow model isn't defined?
-      #assert !@user.respond_to?(:follows)
-    end
+  test '#toggle_follow' do
+    @follower.toggle_follow(@user)
+    assert @follower.follows?(@user)
+    @follower.toggle_follow(@user)
+    assert !@follower.follows?(@user)
+  end
 
-    test '#followers' do
-      @follower.follow(@user)
-      @follower.follow(@post)
-      assert_equal [@follower], @user.followers(:user)
-      assert_equal [@follower], @post.followers(:user)
-    end
+  test '#following' do
+    @follower.follow(@user)
+    @follower.follow(@post)
+    assert_equal [@user], @follower.following(:user)
+    assert_equal [@post], @follower.following(:post)
   end
 
-  context 'Like class defined for join table' do
+  test '#follows' do
+    #TODO: What should happen if the Follow model isn't defined?
+    #assert !@user.respond_to?(:follows)
+  end
 
-    test '#like' do
-      assert !@user.likes?(@post)
-      @user.like(@post)
-      assert @user.likes?(@post)
-    end
+  test '#followers' do
+    @follower.follow(@user)
+    @follower.follow(@post)
+    assert_equal [@follower], @user.followers(:user)
+    assert_equal [@follower], @post.followers(:user)
+  end
 
-    test '#unlike' do
-      @user.like(@post)
-      assert @user.likes?(@post)
-      @user.unlike(@post)
-      assert !@user.likes?(@post)
-    end
+  # Explicit Like class defined
+  test '#like' do
+    assert !@user.likes?(@post)
+    @user.like(@post)
+    assert @user.likes?(@post)
+  end
 
-    test '#toggle_like' do
-      @user.toggle_like(@post)
-      assert @user.likes?(@post)
-      @user.toggle_like(@post)
-      assert !@user.likes?(@post)
-    end
+  test '#unlike' do
+    @user.like(@post)
+    assert @user.likes?(@post)
+    @user.unlike(@post)
+    assert !@user.likes?(@post)
+  end
 
-    test '#liking' do
-      @user.like(@post)
-      assert_equal [@post], @user.liking(:post)
-    end
+  test '#toggle_like' do
+    @user.toggle_like(@post)
+    assert @user.likes?(@post)
+    @user.toggle_like(@post)
+    assert !@user.likes?(@post)
+  end
 
-    test '#likes' do
-      @user.like(@post)
-      assert_equal [@post], @user.likes.map(&:connectable)
-    end
+  test '#liking' do
+    @user.like(@post)
+    assert_equal [@post], @user.liking(:post)
+  end
 
+  test '#likes' do
+    @user.like(@post)
+    assert_equal [@post], @user.likes.map(&:connectable)
   end
 end