popular 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDZkMzQzZDk2OTIzYTc3ZjMzNzA1NWU0NzQ1MTA3ZjcwYzJhNDYzYw==
+    MDZmMzVhOWMxNzU4YTQ0YjlmMTQwODcyNzcyZDBmMTY3MTk5N2I0NQ==
   data.tar.gz: !binary |-
-    OWM2YjUyZTExMTVjYWUwYjJmMTUyNWFiZWNjNjA4ZGQ3N2U3MjQwYg==
+    YmRlZWFlMjNjZTRlZWQ5NjgxZGY1NWIzZDIxZjcxZjIyY2NjMWQ2Yg==
 SHA512:
   metadata.gz: !binary |-
-    ZmFkZjJmZWJkOWU0ZTFhNmJjZDBmNjY1OTJhYmM2YjY3YjI0M2VkNmY2YjYx
-    ZGU0MWJjNTFlYzllYTZkNzFiNDQ4MTAzMjgxNWM0ZWY0NTdmOTk5MDQwMzU5
-    OTdjYWRhYmRjYWJmMWU2MTEzODljYTU1ZDBjYzdhM2MwOWFjYTg=
+    YTUzYjRjNzI2ZTk0YzFiZjA0NjU5YzQ0MzUzOWM2M2ZlMjM1M2JjMWYwYjcw
+    OTQ0YjM1MzljZTBmNWFkNDczNDAxMDVmMzk5ZGQxMTMzNDRhOTk3OGM3ZmFm
+    ZWZjYjlhYjE2NDJiZDhhZDI1OTAxOTVkMjIyZDNiNWRmMTgyYWE=
   data.tar.gz: !binary |-
-    NDRjZThlZWM2YWQ5MWFmOWFhNWYyMDE5OTFlNTJjOGIwZjkwOTc3YzUyMTZm
-    ZTk5MDk3M2IwYmIzZWEwNThhYTFiYWNhOTViMTI0OThjNWZlZjVlZDIyNDU0
-    MzE3N2ZmZTJkNzc3YTE1ZjgyZGVhZTJhNGVlMmM2NzAyYTgyZGE=
+    NTdmODI0Njk3M2ZjYTFkNWYwM2FjODBlOTMyMTA2ZTk2MjE4NzhlZDRjNTFj
+    YjUxNjM2NmQ5MGRmZDk0ODM2MTJjZDg4YTEyZTNlYjcxNmVjYjZhMzkzODI3
+    MmZmOGFiZGE3MDllNGI4YzQwN2UyNzVlZTg3ZGVjYzI3YTY3MGQ=

data/README.md

@@ -3,12 +3,11 @@
 [![Build Status](https://travis-ci.org/thejchap/popular.svg?branch=master)](https://travis-ci.org/thejchap/popular)
 [![Code Climate](https://codeclimate.com/github/thejchap/popular.png)](https://codeclimate.com/github/thejchap/popular)
 [![Code Coverage](https://codeclimate.com/github/thejchap/popular/coverage.png)](https://codeclimate.com/github/thejchap/popular)
+[![Inline docs](http://inch-pages.github.io/github/thejchap/popular.png)](http://inch-pages.github.io/github/thejchap/popular)
 [![Dependency Status](https://gemnasium.com/thejchap/popular.svg)](https://gemnasium.com/thejchap/popular)
 
 Popular is a friendship gem designed for Rails/ActiveRecord models.
 
-### THIS IS A VERY YOUNG GEM. YOU HAVE BEEN WARNED
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,13 +22,61 @@ Or install it yourself as:
 
     $ gem install popular
 
+### Database Migration
+
+Popular uses a friendships table to store friendship relationships.
+To get up and running, use the following command:
+
+    rails g popular:migration
+    rake db:migrate
+
 ## Usage
 
-TODO: Write usage instructions here
+### Model
+
+To get started using Popular, simply add `popular` to your model, (ie: `app/models/user.rb`)
+
+```ruby
+class User < ActiveRecord::Base
+  popular
+end
+
+@sam = User.create name: "Samuel"
+@jackson = User.create name: "Jackson"
+
+@sam.friends_with? @jackson #=> false
+@sam.befriend @jackson
+@sam.friends_with? @jackson #=> true
+@sam.unfriend @jackson
+@sam.friends_with? @jackson #=> false
+```
+
+### Callbacks
+
+Popular provides callbacks that are fired around friendship creation. Available callbacks are:
+  - after_befriend
+  - before_befriend
+
+
+```ruby
+class User < ActiveRecord::Base
+  popular
+  after_befriend :notify
+
+  def notify
+    puts "Friendship created successfully"
+  end
+end
+
+@justin = User.create name: "Justin"
+@jenny = User.create name: "Jenny"
+
+@justin.befriend @jenny #=> "Friendship created successfully"
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/popular/fork )
+1. Fork it ( http://github.com/thejchap/popular/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/generators/popular/migration/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module Popular
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for popular (friendships table)"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/popular_migration'
+      end
+    end
+  end
+end

data/lib/generators/popular/migration/templates/active_record/migration.rb

@@ -0,0 +1,18 @@
+class PopularMigration < ActiveRecord::Migration
+  def up
+    create_table :friendships do |t|
+
+      t.references :popular_model, polymorphic: true
+      t.references :friend, polymorphic: true
+
+      t.timestamps
+    end
+
+    add_index :friendships, [:popular_model_id, :popular_model_type]
+    add_index :friendships, [:friend_id, :friend_type]
+  end
+
+  def down
+    drop_table :friendships
+  end
+end

data/lib/popular/version.rb

@@ -1,3 +1,3 @@
 module Popular
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popular
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - thejchap
@@ -152,6 +152,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/popular/migration/migration_generator.rb
+- lib/generators/popular/migration/templates/active_record/migration.rb
 - lib/popular.rb
 - lib/popular/extenders/popular.rb
 - lib/popular/friendship.rb