like_system 0.0.6

data/lib/like_system/likee.rb

@@ -0,0 +1,58 @@
+###
+# LikeSystem module
+#
+# This module defines common behavior in like system
+###
+module LikeSystem
+  ###
+  # Likee module
+  #
+  # This module defines likee behavior in like system
+  ###
+  module Likee
+    ###
+    # Extends ActiveSupport::Concern
+    ###
+    extend ActiveSupport::Concern
+
+    ###
+    # Included configuration
+    ###
+    included do
+      ###
+      # Has many likers association configuration
+      ###
+      has_many :likers, class_name: "LikeSystem::Like", as: :likee, dependent: :destroy
+    end
+
+    ###
+    # Specifies if self can be liked by {Liker} objects
+    #
+    # @return [Boolean]
+    ###
+    def is_likee?
+      true
+    end
+
+    ###
+    # Specifies if self is liked by a {Liker} object
+    #
+    # @param [Liker] liker - the {Liker} object to test against
+    # @return [Boolean]
+    ###
+    def liked_by?(liker)
+      Like.likes?(liker, self)
+    end
+
+    ###
+    # Retrieves a scope of {Like} objects that likes self filtered {Liker} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def likers_by(klass)
+      Like.scope_by_likee(self).scope_by_liker_type(klass)
+    end
+  end
+end
+

data/lib/like_system/liker.rb

@@ -0,0 +1,88 @@
+###
+# LikeSystem module
+#
+# This module defines common behavior in like system
+###
+module LikeSystem
+  ###
+  # Liker module
+  #
+  # This module defines liker behavior in like system
+  ###
+  module Liker
+    ###
+    # Extends ActiveSupport::Concern
+    ###
+    extend ActiveSupport::Concern
+
+    ###
+    # Included configuration
+    ###
+    included do
+      ###
+      # Has many likees association configuration
+      ###
+      has_many :likees, class_name: "LikeSystem::Like", as: :liker, dependent: :destroy
+    end
+
+    ###
+    # Specifies if self can like {Likee} objects
+    #
+    # @return [Boolean]
+    ###
+    def is_liker?
+      true
+    end
+
+    ###
+    # Creates a {Like} relationship between self and a {Likee} object
+    #
+    # @param [Likee] likee - the likee of the {Like} relationship
+    # @return [Boolean]
+    ###
+    def like(likee)
+      Like.like(self, likee)
+    end
+
+    ###
+    # Destroys a {Like} relationship between self and a {Likee} object
+    #
+    # @param [Likee] likee - the likee of the {Like} relationship
+    # @return [Boolean]
+    ###
+    def unlike(likee)
+      Like.unlike(self, likee)
+    end
+
+    ###
+    # Toggles a {Like} relationship between self and a {Likee} object
+    #
+    # @param [Likee] likee - the likee of the {Like} relationship
+    # @return [Boolean]
+    ###
+    def toggle_like(likee)
+      Like.toggle_like(self, likee)
+    end
+
+    ###
+    # Specifies if self likes a {Liker} object
+    #
+    # @param [Likee] likee - the {Likee} object to test against
+    # @return [Boolean]
+    ###
+    def likes?(likee)
+      Like.likes?(self, likee)
+    end
+
+    ###
+    # Retrieves a scope of {Like} objects that are liked by self
+    #
+    # @param [Class] klass - the {Class} to include
+    # @return [ActiveRecord::Relation]
+    ###
+    def likees_by(klass)
+      Like.scope_by_liker(self).scope_by_likee_type(klass)
+    end
+  end
+end
+

data/lib/like_system/version.rb

@@ -0,0 +1,12 @@
+###
+# LikeSystem module
+#
+# This module defines common behavior in like system
+###
+module LikeSystem
+  ###
+  # Version constant definition
+  ###
+  VERSION = "0.0.6"
+end
+

data/like_system.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'like_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "like_system"
+  spec.version       = LikeSystem::VERSION
+  spec.authors       = ["Pablo Martin Viva"]
+  spec.email         = ["pmviva@gmail.com"]
+  spec.summary       = %q{An active record like system.}
+  spec.description   = %q{An active record like system developed using ruby on rails 4.1 applying domain driven design and test driven development principles.}
+  spec.homepage      = "http://github.com/pmviva/like_system"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+
+  spec.add_dependency "rails", [ ">= 4.1", "< 5" ]
+
+  spec.add_development_dependency "appraisal", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "shoulda-matchers", "~> 2.7"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end
+

data/spec/db/migrate/20140926000000_create_likes.rb

@@ -0,0 +1,47 @@
+###
+# CreateLikes class
+#
+# This class defines the test 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/spec/db/migrate/20140926000005_create_dummy_likers.rb

@@ -0,0 +1,22 @@
+###
+# CreateDummyLikers class
+#
+# This class defines the create dummy likers migration in like system
+###
+class CreateDummyLikers < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Dummy likers table creation
+    ###
+    create_table :dummy_likers do |t|
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+  end
+end
+

data/spec/db/migrate/20140926000010_create_dummy_likees.rb

@@ -0,0 +1,22 @@
+###
+# CreateDummyLikees class
+#
+# This class defines the create dummy likees migration in like system
+###
+class CreateDummyLikees < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Dummy likees table creation
+    ###
+    create_table :dummy_likees do |t|
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+  end
+end
+

data/spec/like_system/like_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+
+###
+# Describes LikeSystem::Like
+###
+describe LikeSystem::Like do
+  ###
+  # Let likee be DummyLikee.create
+  ###
+  let(:likee) { DummyLikee.create }
+
+  ###
+  # Let liker be DummyLiker.create
+  ###
+  let(:liker) { DummyLiker.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should belong to likee
+    ###
+    it "should belong to likee" do
+      should belong_to(:likee)
+    end
+
+    ###
+    # Should belong to liker
+    ###
+    it "should belong to liker" do
+      should belong_to(:liker)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should raise argument error on invalid likee when likes
+    ###
+    it "should raise argument error on invalid likee when likes" do
+      expect { LikeSystem::Like.like(liker, liker) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid liker when likes
+    ###
+    it "should raise argument error on invalid liker when likes " do
+      expect { LikeSystem::Like.like(likee, likee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should like
+    ###
+    it "should like" do
+      expect(LikeSystem::Like.like(liker, likee)).to equal(true)
+    end
+
+    ###
+    # Should not like
+    ###
+    it "should not like" do
+      LikeSystem::Like.like(liker, likee)
+
+      expect(LikeSystem::Like.like(liker, likee)).to equal(false)
+    end
+
+    ###
+    # Should raise argument error on invalid likee when unlikes
+    ###
+    it "should raise argument error on invalid likee when unlikes" do
+      expect { LikeSystem::Like.unlike(liker, liker) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid liker when unlikes
+    ###
+    it "should raise argument error on invalid liker when unlikes" do
+      expect { LikeSystem::Like.unlike(likee, likee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should unlike
+    ###
+    it "should unlike" do
+      LikeSystem::Like.like(liker, likee)
+
+      expect(LikeSystem::Like.unlike(liker, likee)).to equal(true)
+    end
+
+    ###
+    # Should not unlike
+    ###
+    it "should not unlike" do
+      expect(LikeSystem::Like.unlike(liker, likee)).to equal(false)
+    end
+
+    ###
+    # Should raise argument error on invalid likee when toggle like
+    ###
+    it "should raise argument error on invalid likee when toggle like" do
+      expect { LikeSystem::Like.toggle_like(liker, liker) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid liker when toggle like
+    ###
+    it "should raise argument error on invalid liker when toggle like" do
+      expect { LikeSystem::Like.toggle_like(likee, likee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should toggle like
+    ###
+    it "should toggle like" do
+      expect(LikeSystem::Like.likes?(liker, likee)).to equal(false)
+
+      LikeSystem::Like.toggle_like(liker, likee)
+
+      expect(LikeSystem::Like.likes?(liker, likee)).to equal(true)
+
+      LikeSystem::Like.toggle_like(liker, likee)
+
+      expect(LikeSystem::Like.likes?(liker, likee)).to equal(false)
+    end
+
+    ###
+    # Should specify if likes
+    ###
+    it "should specify if likes" do
+      expect(LikeSystem::Like.likes?(liker, likee)).to equal(false)
+
+      LikeSystem::Like.like(liker, likee)
+
+      expect(LikeSystem::Like.likes?(liker, likee)).to equal(true)
+    end
+
+    ###
+    # Should scope likes by likee
+    ###
+    it "should scope likes by likee" do
+      scope = LikeSystem::Like.where(likee: likee)
+
+      expect(LikeSystem::Like.scope_by_likee(likee)).to eq(scope)
+    end
+
+    ###
+    # Should scope likes by likee type
+    ####
+    it "should scope likes by likee type" do
+      scope = LikeSystem::Like.where(likee_type: DummyLikee)
+
+      expect(LikeSystem::Like.scope_by_likee_type(DummyLikee)).to eq(scope)
+    end
+
+    ###
+    # Should scope likes by liker
+    ###
+    it "should scope likes by liker" do
+      scope = LikeSystem::Like.where(liker: liker)
+
+      expect(LikeSystem::Like.scope_by_liker(liker)).to eq(scope)
+    end
+
+    ###
+    # Should scope likes by liker type
+    ####
+    it "should scope likes by liker type" do
+      scope = LikeSystem::Like.where(liker_type: DummyLiker)
+
+      expect(LikeSystem::Like.scope_by_liker_type(DummyLiker)).to eq(scope)
+    end
+  end
+end
+