like_system 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3168bfa085ef7fa2e484644fc12c8179695c15b
+  data.tar.gz: 8dc6b2f9eeb7a65e21ff138144f91603f109035e
+SHA512:
+  metadata.gz: 46e84bd220a8d5f0c5668a623fba58d68749a092a89a08c6d629b1276e284994d94da097e7f96d5bc9508985b2b3eda44de8ed4f1cce5819d4832b72dd2d3b1f
+  data.tar.gz: 2920dcd80fe68f965c7dc2646d3ea7ee90d426ece10226cabe61e9939614a66f1c33adebeba8fa3b5fb20b2b918c33a315f625fc97616bbb3678a530a290a717

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/gemfiles/*.lock
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+like_system

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,23 @@
+language:
+  - ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.3
+  - 2.2.1
+
+gemfile:
+  - gemfiles/rails4.1.gemfile
+  - gemfiles/rails4.2.gemfile
+
+install:
+  - "travis_retry bundle install"
+
+before_script:
+
+script:
+  - "bundle exec rake"
+
+branches:
+  only:
+    - master

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails4.1" do
+  gem "rails", "4.1.10"
+end
+
+appraise "rails4.2" do
+  gem "rails", "4.2.1"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in like_system.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pablo Martin Viva
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# LikeSystem
+
+[![Build Status](https://travis-ci.org/pmviva/like_system.png?branch=master)](https://travis-ci.org/pmviva/like_system)
+[![Gem Version](https://badge.fury.io/rb/like_system.svg)](http://badge.fury.io/rb/like_system)
+
+An active record like system developed using ruby on rails 4.1 applying domain driven design and test driven development principles.
+
+This gem is heavily influenced by cmer/socialization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'like_system'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install like_system
+```
+
+## Usage
+
+### Run the generator
+
+```ruby
+$ rails g like_system
+```
+
+Let's suppose for a moment that you have a blog application and a User can like a Post or several Post models.
+The user model becomes the liker and the post model becomes the likee.
+
+### Post object
+```ruby
+class Post < ActiveRecord::Base
+  act_as_likee
+
+  validates :content, presence: true
+end
+```
+
+### User object
+```ruby
+class User < ActiveRecord::Base
+  act_as_liker
+
+  validates :username, { presence: true, uniqueness: true }
+end
+```
+
+### Likee object methods
+```ruby
+post.is_likee? # returns true
+
+post.liked_by?(user) # returns true if user likes the post object, false otherwise
+
+post.likers_by(User) # returns a scope of LikeSystem::Like join model that belongs to the post object and belongs to liker objects of type User
+```
+
+
+### Liker object methods
+```ruby
+user.is_liker? # returns true
+
+user.like(post) # Creates an instance of LikeSystem::Like join model associating the user object and the post object, returns true if succeded, false otherwise
+
+user.unlike(post) # Destroys an instance of LikeSystem::Like join model that associates the user object and the post object, returns true if succeded, false otherwise
+
+user.toggle_like(post) # Likes / unlikes the post
+
+user.likes?(post) # returns true if the user object likes the post object, false otherwise
+
+user.likees_by(Post) # returns a scope of LikeSystem::Like join model that belongs to the user object and belongs to likee objects of type Post
+```
+
+For more information read the [api documentation](http://rubydoc.info/gems/like_system).
+
+## Contributing
+
+1. Fork it ( https://github.com/pmviva/like_system/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`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end
+

data/gemfiles/rails4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1.10"
+
+gemspec :path => "../"

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2.1"
+
+gemspec :path => "../"

data/lib/generators/like_system/like_system_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+###
+# LikeSystemGenerator class
+#
+# This class generates the like model migration in like system
+###
+class LikeSystemGenerator < Rails::Generators::Base
+  ###
+  # Includes Rails::Generators::Migration
+  ###
+  include Rails::Generators::Migration
+
+  ###
+  # Generator description definition
+  ###
+  desc "Generates a migration for the Like model"
+
+  ###
+  # Retrieves the source root
+  #
+  # @return [String]
+  ###
+  def self.source_root
+    @source_root ||= File.dirname(__FILE__) + '/templates'
+  end
+
+  ###
+  # Retrieves the next migration number
+  #
+  # @path [String] path - the path to calculate the next migration number
+  # @return [String]
+  ###
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  ###
+  # Generates the migration
+  ###
+  def generate_migration
+    migration_template 'migration.rb', 'db/migrate/create_likes.rb'
+  end
+end
+

data/lib/generators/like_system/templates/migration.rb

@@ -0,0 +1,47 @@
+###
+# CreateLikes class
+#
+# This class defines the create likes migration in like system
+###
+class CreateLikes < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Likes table creation
+    ###
+    create_table :likes do |t|
+      ###
+      # Likee id field and likee type field definition
+      ###
+      t.references :likee, polymorphic: true
+
+      ###
+      # Liker id fiel and liker type field definition
+      ###
+      t.references :liker, polymorphic: true
+
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+
+    ###
+    # Likes table likee id field and likee type field index addition
+    ###
+    add_index :likes, [:likee_id, :likee_type], name: "likes_likee_idx"
+
+    ###
+    # Likes table liker id field and liker type field index addition
+    ###
+    add_index :likes, [:liker_id, :liker_type], name: "likes_liker_idx"
+
+    ###
+    # Likes table likee id field and likee type field and liker id field and liker type field unique index addition
+    ###
+    add_index :likes, [:likee_id, :likee_type, :liker_id, :liker_type], name: "likes_likee_liker_idx", unique: true
+  end
+end
+

data/lib/like_system.rb

@@ -0,0 +1,45 @@
+require 'like_system/like'
+require 'like_system/likee'
+require 'like_system/liker'
+
+###
+# LikeSystem module
+#
+# This module defines common behavior in like system
+###
+module LikeSystem
+  ###
+  # Specifies if self can be liked by {Liker} objects
+  #
+  # @return [Boolean]
+  ###
+  def is_likee?
+    false
+  end
+
+  ###
+  # Specifies if self can like {Likee} objects
+  #
+  # @return [Boolean]
+  ###
+  def is_liker?
+    false
+  end
+
+  ###
+  # Instructs self to act as likee
+  ###
+  def act_as_likee
+    include Likee
+  end
+
+  ###
+  # Instructs self to act as liker
+  ###
+  def act_as_liker
+    include Liker
+  end
+end
+
+ActiveRecord::Base.extend LikeSystem
+

data/lib/like_system/like.rb

@@ -0,0 +1,155 @@
+###
+# LikeSystem module
+#
+# This module defines common behavior in like system
+###
+module LikeSystem
+  ###
+  # Like class
+  #
+  # This class defines the like model in like system
+  ###
+  class Like < ActiveRecord::Base
+    ###
+    # Belongs to likee association configuration
+    ###
+    belongs_to :likee, polymorphic: :true
+
+    ###
+    # Belongs to liker association configuration
+    ###
+    belongs_to :liker, polymorphic: :true
+
+    ###
+    # Creates a {Like} relationship between a {Liker} object and a {Likee} object
+    #
+    # @param [Liker] liker - the {Liker} of the relationship
+    # @param [Likee] likee - the {Likee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.like(liker, likee)
+      validate_likee(likee)
+      validate_liker(liker)
+
+      if likes?(liker, likee)
+        false
+      else
+        like = scope_by_liker(liker).scope_by_likee(likee).build
+        like.save
+        true
+      end
+    end
+
+    ###
+    # Destroys a {Like} relationship between a {Liker} object and a {Likee} object
+    #
+    # @param [Liker] liker - the {Liker} of the relationship
+    # @param [Likee] likee - the {Likee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.unlike(liker, likee)
+      validate_likee(likee)
+      validate_liker(liker)
+
+      if likes?(liker, likee)
+        like = scope_by_liker(liker).scope_by_likee(likee).take
+        like.destroy
+        true
+      else
+        false
+      end
+    end
+
+    ###
+    # Toggles a {Like} relationship between a {Liker} object and a {Likee} object
+    #
+    # @param [Liker] liker - the {Liker} of the relationship
+    # @param [Likee] likee - the {Likee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.toggle_like(liker, likee)
+      validate_likee(likee)
+      validate_liker(liker)
+
+      if likes?(liker, likee)
+        unlike(liker, likee)
+      else
+        like(liker, likee)
+      end
+    end
+
+    ###
+    # Specifies if a {Liker} object likes a {Likee} object
+    #
+    # @param [Liker] liker - the {Liker} object to test against
+    # @param [Likee] likee - the {Likee} object to test against
+    # @return [Boolean]
+    ###
+    def self.likes?(liker, likee)
+      validate_likee(likee)
+      validate_liker(liker)
+
+      scope_by_liker(liker).scope_by_likee(likee).exists?
+    end
+
+    ###
+    # Retrieves a scope of {Like} objects filtered by a {Likee} object
+    #
+    # @param [Likee] likee - the {Likee} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_likee(likee)
+      where(likee: likee)
+    end
+
+    ###
+    # Retrieves a scope of {Like} objects filtered by a {Likee} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_likee_type(klass)
+      where(likee_type: klass.to_s.classify)
+    end
+
+    ###
+    # Retrieves a scope of {Like} objects filtered by a {Liker} object
+    #
+    # @param [Liker] liker - the {Liker} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_liker(liker)
+      where(liker: liker)
+    end
+
+    ###
+    # Retrieves a scope of {Like} objects filtered by a {Liker} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_liker_type(klass)
+      where(liker_type: klass.to_s.classify)
+    end
+
+    private
+      ###
+      # Validates a likee object
+      #
+      # @raise [ArgumentError] if the likee object is invalid
+      ###
+      def self.validate_likee(likee)
+        raise ArgumentError.new unless likee.respond_to?(:is_likee?) && likee.is_likee?
+      end
+
+      ###
+      # Validates a liker object
+      #
+      # @raise [ArgumentError] if the liker object is invalid
+      ###
+      def self.validate_liker(liker)
+        raise ArgumentError.new unless liker.respond_to?(:is_liker?) && liker.is_liker?
+      end
+  end
+end
+