likeit 0.0.1

data/README.rdoc

@@ -0,0 +1,106 @@
+= Likeit
+
+Rails gem for building a liking systems by using Active Records.
+
+by Gagan Sharma <developer.gagan@gmail.com>
+
+GitHub Project: https://github.com/gagansharma/likeit
+
+-----
+
+TODO List:
+
+* Better documentation (Making use of rdoc and ri)
+* Write tests
+
+== Installation
+
+=== Rails 3
+
+If you would like to install it as gem, put this in your Gemfile:
+
+    gem 'likeit'
+
+If you would rather like to install it as plugin, run this command in your console:
+
+    rails plugin install git://github.com/gagansharma/likeit.git
+
+And then run:
+
+    rails generate likeit
+    rake db:migrate
+
+== Usage
+
+Just add `acts_as_liker` and `acts_as_likeable` to your models. You could mix them in the same model if you like. See the example below:
+
+    # A user can like on users or story
+    
+    class User < ActiveRecord::Base
+      acts_as_liker
+      acts_as_likeable
+    end
+    
+    class Story < ActiveRecord::Base
+      acts_as_likeable
+    end
+    
+    ------------------------------------------------------------------------------------------------
+    
+    # To like:
+    
+    @user = User.find(1)
+    @user2 = User.find(2)
+    @story = Story.find(1)
+    
+    @user1.like(@story)
+    @user1.like(@user2)
+    
+    ------------------------------------------------------------------------------------------------
+        
+    # To dis-like:
+    @user = User.find(1)
+    @user2 = User.find(2)
+    @story = Story.find(1)
+    
+    @user1.dislike(@story)
+    @user1.dislike(@user2)
+    
+    ------------------------------------------------------------------------------------------------
+    
+    # To check like status:
+    @user = User.find(1)
+    @user3 = User.find(3)
+    @story = Story.find(1)
+    
+    @user1.is_like(@story) #checks if @user1 already likes the @story or not -> return true or false
+    @user1.is_like(@user3) #checks if @user1 already likes @user3 or not -> return true or false
+    
+    ------------------------------------------------------------------------------------------------
+    
+    # To read all liked items by a user:
+    
+    @user = User.find(1)
+    @user.likings #return all the users and stories which are liked by @user
+    
+    ------------------------------------------------------------------------------------------------
+    
+    # To get all the users who liked any story or user:
+    
+    @user = User.find(1)
+    @user2 = User.find(2)
+    @story = Story.find(1)
+    
+    @user2.likes #return all the users who liked @user2
+    @story.likes #return all the users who liked @story
+    
+    ------------------------------------------------------------------------------------------------
+    
+    # To get count of all the users who liked any story or user:
+    
+    @user = User.find(1)
+    @user2 = User.find(2)
+    @story = Story.find(1)
+    
+    @user2.likes.count #return count of all the users who liked @user2
+    @story.likes.count #return count of all the users who liked @story

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('likeit', '0.0.1') do |p|
+  p.description     = "A generic Liking system."
+  p.url             = "https://github.com/gagansharma/likeit"
+  p.author          = "Gagan Sharma"
+  p.email           = "developer.gagan@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.take"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1 @@
+require 'likeit'

data/lib/generators/likeit_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class LikeitGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/likeit_migration.rb'
+  end
+  
+  def create_model
+    template 'model.rb', File.join('app/models', 'like.rb')
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,16 @@
+class LikeitMigration < ActiveRecord::Migration
+  def self.up
+    create_table :likes, :force => true do |t|
+      t.references :liker,    :polymorphic => true, :null => false
+      t.references :likeable,  :polymorphic => true, :null => false
+      t.timestamps
+    end
+    
+    add_index :likes, [:liker_id, :liker_type]
+    add_index :likes, [:likeable_id, :likeable_type]
+  end
+  
+  def self.down
+    drop_table :likes
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,11 @@
+class Like < ActiveRecord::Base
+  belongs_to :liker, :polymorphic => true
+  belongs_to :likeable, :polymorphic => true
+  validates_uniqueness_of :liker_id, :scope => [:liker_type, :likeable_id, :likeable_type]
+
+  class << self	
+    def likes_on(likeable)
+      where(["likeable_id = ? AND likeable_type = ?", likeable.id, likeable.class.name])
+    end
+  end
+end

data/lib/likeit/likeable.rb

@@ -0,0 +1,13 @@
+module Likeit
+  module Likeable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_likeable
+        has_many :likes, :as => :likeable, :dependent => :destroy
+      end
+    end
+  end
+end

data/lib/likeit/liker.rb

@@ -0,0 +1,34 @@
+module Likeit
+  module Liker
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_liker
+        has_many :likings, :as => :liker, :dependent => :destroy, :class_name => "Like"
+        include Likeit::Liker::InstanceMethods
+      end
+    end
+    
+    module InstanceMethods      
+      def like(likeable)
+        self.likings.create(:likeable => likeable)
+      end
+      
+      def dislike(likeable)
+        likes = self.likings.likes_on(likeable)
+        likes.destroy_all if likes.present?
+      end
+      
+      def is_like(likeable)
+        likes = self.likings.likes_on(likeable)
+        if likes.present?
+			true
+		else
+			false
+		end
+      end
+    end
+  end
+end

data/lib/likeit.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + "/likeit/liker"
+require File.dirname(__FILE__) + "/likeit/likeable"
+
+ActiveRecord::Base.send(:include, Likeit::Liker)
+ActiveRecord::Base.send(:include, Likeit::Likeable)

data/likeit.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{likeit}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gagan Sharma"]
+  s.date = %q{2012-07-20}
+  s.description = %q{A generic liking system.}
+  s.email = %q{developer.gagan@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/likeit.rb", "lib/likeit/likeable.rb", "lib/likeit/liker.rb", "lib/generators/likeit_generator.rb", "lib/generators/templates/migration.rb", "lib/generators/templates/model.rb"]
+  s.files = ["README.rdoc", "Rakefile", "likeit.gemspec", "init.rb", "lib/likeit.rb", "lib/likeit/likeable.rb", "lib/likeit/liker.rb", "lib/generators/likeit_generator.rb", "lib/generators/templates/migration.rb", "lib/generators/templates/model.rb"]
+  s.homepage = %q{https://github.com/gagansharma/likeit}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Likeit", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{likeit}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A generic Liking system.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 1
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: likeit
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gagan Sharma
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-20 00:00:00 Z
+dependencies: []
+
+description: A generic liking system.
+email: developer.gagan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/likeit.rb
+- lib/likeit/likeable.rb
+- lib/likeit/liker.rb
+- lib/generators/likeit_generator.rb
+- lib/generators/templates/migration.rb
+- lib/generators/templates/model.rb
+files: 
+- README.rdoc
+- Rakefile
+- likeit.gemspec
+- init.rb
+- lib/likeit.rb
+- lib/likeit/likeable.rb
+- lib/likeit/liker.rb
+- lib/generators/likeit_generator.rb
+- lib/generators/templates/migration.rb
+- lib/generators/templates/model.rb
+homepage: https://github.com/gagansharma/likeit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Likeit
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: likeit
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 1
+summary: A generic Liking system.
+test_files: []
+