mongoid-likeable 1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012, diowa
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+mongoid-voteable is licensed under the MIT License - Copyright (c) 2012 Tom Bell

data/README.md

@@ -0,0 +1,58 @@
+# mongoid-likeable
+
+Add like to your Mongoid documents
+
+## Installation
+
+Install the gem
+
+    $ gem install mongoid-likeable
+
+or add the gem to your `Gemfile`
+
+    gem 'mongoid-likeable', '~> 0.1.0'
+
+## Usage
+
+Include the `Mongoid::Likeable` module into your models you want to like.
+
+```ruby
+class Story
+  include Mongoid::Document
+  include Mongoid::Likeable
+
+  # ...
+end
+```
+
+You can then like by simply using the `like` method on the model.
+
+```ruby
+@story = Story.first
+@user = User.where(name: 'Simon')
+
+@story.like @user  # you like it
+@story.unlike @user # you don't like it anymore
+```
+
+You also have access to a couple of helpful methods.
+
+```ruby
+@story.liked? @user # true if the user has already liked this
+
+@story.likes_count   # total number of likes
+```
+
+**Note** if your users are not stored in a Mongo collection or the ID field is
+not called `_id` you can still pass the ID in as the second parameter instead.
+
+```ruby
+@story.like @user.id
+
+@story.liked? @user.id
+```
+
+## License
+
+mongoid-likeable is licensed under the BSD 2-Clause License
+mongoid-voteable is licensed under the MIT License - Copyright (c) 2012 Tom Bell

data/Rakefile

@@ -0,0 +1,13 @@
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/mongoid/likeable.rb"
+end

data/lib/mongoid/likeable.rb

@@ -0,0 +1,46 @@
+require 'mongoid'
+
+module Mongoid
+  module Likeable
+
+    extend ActiveSupport::Concern
+
+    included do
+      field :likers, :type => Array, :default => []
+    end
+
+    def like(liker)
+      id = liker_id(liker)
+      unless liked?(id)
+        self.push :likers, id
+      end
+    end
+
+    def unlike(liker)
+      id = liker_id(liker)
+      if liked?(id)
+        self.pull :likers, id
+      end
+    end
+
+    def liked?(liker)
+      id = liker_id(liker)
+      likers.include?(id)
+    end
+
+    def like_count
+      likers.count
+    end
+
+    private
+
+    def liker_id(liker)
+      if liker.respond_to?(:_id)
+        liker._id
+      else
+        liker
+      end
+    end
+  end
+
+end

data/mongoid-likeable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid-likeable"
+  s.version     = "1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Diowa"]
+  s.email       = ["dev@diowa.com"]
+  s.homepage    = "https://github.com/diowa/mongoid-likeable"
+  s.summary     = "Add likes to your Mongoid documents"
+  s.description = s.summary
+
+  s.rubyforge_project = "mongoid-likeable"
+
+  s.add_dependency "mongoid", "~> 3.0.5"
+
+  s.add_development_dependency "database_cleaner", "~> 0.8.0"
+  s.add_development_dependency "rake", "~> 0.9.2.2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/models/story.rb

@@ -0,0 +1,6 @@
+class Story
+  include Mongoid::Document
+  include Mongoid::Likeable
+
+  field :name
+end

data/test/models/user.rb

@@ -0,0 +1,5 @@
+class User
+  include Mongoid::Document
+
+  field :name
+end

data/test/mongoid_likeable_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class TestMongoidLikeable < MiniTest::Unit::TestCase
+  def setup
+    DatabaseCleaner.start
+
+    @simon = User.create name: 'Simon'
+    @emily = User.create name: 'Emily'
+    @story = Story.create name: 'Mongoid Rocks'
+  end
+
+  def teardown
+    DatabaseCleaner.clean
+  end
+
+  def test_add_likers_field_to_document
+    refute_nil Story.fields['likers']
+  end
+
+  def test_defines_like_method
+    story = Story.new
+    refute_nil story.respond_to?('like')
+  end
+
+  def test_defines_unlike_method
+    story = Story.new
+    refute_nil story.respond_to?('unlike')
+  end
+
+  def test_defines_liked_method
+    story = Story.new
+    refute_nil story.respond_to?('liked?')
+  end
+
+  def test_defines_like_count_method
+    story = Story.new
+    refute_nil story.respond_to?('like_count')
+  end
+
+  def test_tracks_number_of_likers
+    @story.like @simon
+    @story.like @emily
+    assert_equal 2, @story.like_count
+  end
+
+  def test_can_like_by_user_id
+    @story.like @simon._id
+    assert_equal 1, @story.like_count
+  end
+
+  def test_can_like_by_user
+    @story.like @simon
+    assert_equal 1, @story.like_count
+  end
+
+  def test_can_unlike_by_user
+    @story.like @simon
+    assert_equal 1, @story.like_count
+    @story.unlike @simon
+    assert_equal 0, @story.like_count
+  end
+
+  def test_limits_one_like_per_liker
+    @story.like @simon
+    @story.like @simon
+    assert_equal 1, @story.like_count
+  end
+
+  def test_knows_who_has_liked
+    @story.like @simon
+    assert @story.liked? @simon
+    refute @story.liked? @emily
+  end
+
+  def test_updates_collection_correctly
+    @story.like @simon
+    @story.like @emily
+    story = Story.where(:name => 'Mongoid Rocks').first
+    assert_equal 2, story.like_count
+    assert story.liked? @simon
+    assert story.liked? @emily
+    story.unlike @simon
+    story = Story.where(:name => 'Mongoid Rocks').first
+    assert_equal 1, story.like_count
+    refute story.liked? @simon
+    assert story.liked? @emily
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require 'minitest/autorun'
+require 'database_cleaner'
+
+require 'mongoid'
+require 'mongoid/likeable'
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+Mongoid.connect_to('mongoid-likeable-test')
+Mongoid.logger = Logger.new $stdout
+
+DatabaseCleaner.orm = 'mongoid'
+DatabaseCleaner.strategy = :truncation

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-likeable
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Diowa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+description: Add likes to your Mongoid documents
+email:
+- dev@diowa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid/likeable.rb
+- mongoid-likeable.gemspec
+- test/models/story.rb
+- test/models/user.rb
+- test/mongoid_likeable_test.rb
+- test/test_helper.rb
+homepage: https://github.com/diowa/mongoid-likeable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mongoid-likeable
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add likes to your Mongoid documents
+test_files:
+- test/models/story.rb
+- test/models/user.rb
+- test/mongoid_likeable_test.rb
+- test/test_helper.rb