has_friends 0.0.1 → 0.0.2

data/README.md

@@ -1,47 +1,37 @@
-has_friends
-===========
-
-**ATTENTION:** This is a new simpler implementation. If you want to use the previous version,
-get the 1.0 tag.
-
-Instalation
------------
-
-Install the plugin with
-
-  script/plugin install git://github.com/fnando/has_friends.git
-
-Then generate a migration with `script/generate migration create_friendships` and add the following code:
-
-  class CreateFriendships < ActiveRecord::Migration
-    def self.up
-      create_table :friendships do |t|
-        t.references :user, :friend
-        t.datetime :requested_at, :accepted_at, :null => true, :default => nil
-        t.string :status
-      end
-
-      add_index :friendships, :user_id
-      add_index :friendships, :friend_id
-      add_index :friendships, :status
-    end
-
-    def self.down
-      drop_table :friendships
-    end
-  end
-
-Finally, run the migrations with `rake db:migrate`
-
-Usage
------
+# Installation
+
+```ruby
+# Gemfile
+gem 'has_friends'
+```
+Then run `bundle`.
+Alternatively
+```
+gem install has_friends
+```
+Then you need add `has_friends` method to your User model and generate friendship migration with
+```
+has_friends install
+```
+and run `rake db:migrate` in order to migrate the new generated migration.
+Case your User model has no `friends_count` column in it's table, you can easily generate a migration
+to accomplish this with
+```
+has_friends counter
+```
+and run `rake db:migrate` again.
+
+# Usage
 
 Add the method call `has_friends` to your model.
-
+```ruby
   class User < ActiveRecord::Base
     has_friends
   end
+```
 
+# Common tasks
+```ruby
   john = User.find_by_login 'john'
   mary = User.find_by_login 'mary'
   paul = User.find_by_login 'paul'
@@ -94,10 +84,30 @@ Add the method call `has_friends` to your model.
   else
     # ...
   end
+```
 
-NOTE: You should have a User model. You should also have a `friends_count` column
-on your model. Otherwise, this won't work! Create a new migration with `script/generate migration add_friends_count_to_user`:
 
+# Generated Migrations
+```ruby
+  class CreateFriendships < ActiveRecord::Migration
+    def self.up
+      create_table :friendships do |t|
+        t.references :user, :friend
+        t.datetime :requested_at, :accepted_at, :null => true, :default => nil
+        t.string :status
+      end
+
+      add_index :friendships, :user_id
+      add_index :friendships, :friend_id
+      add_index :friendships, :status
+    end
+
+    def self.down
+      drop_table :friendships
+    end
+  end
+```
+```ruby
   class AddFriendsCountToUser < ActiveRecord::Migration
     def self.up
       add_column :users, :friends_count, :integer, :default => 0, :null => false
@@ -107,9 +117,9 @@ on your model. Otherwise, this won't work! Create a new migration with `script/g
       remove_column :users, :friends_count
     end
   end
+```
 
-LICENSE:
---------
+# LICENSE:
 
 (The MIT License)
 

data/lib/has_friends/cli.rb

@@ -14,7 +14,7 @@ module HasFriends
     end
 
     desc "counter", "Adds friends_count column to friendly table"
-    def counter(tableName = 'User')
+    def counter(tableName = 'Users')
       HasFriends::Generators::FriendsCounter.start([tableName])
     end
 

data/lib/has_friends/version.rb

@@ -1,3 +1,3 @@
 module HasFriends
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_friends
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - embs