like 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 747351a7296d5e1927d738f5a96b160c15e2c376
-  data.tar.gz: 90097bcf0a08a378a37c86ef12ab79d1e51a8f3f
+  metadata.gz: 155b369ed874cd99a36550bd59743e5dff9244e3
+  data.tar.gz: 9bf44af699eee62027b0e36f9dabea7f68e337b2
 SHA512:
-  metadata.gz: b20bc6c902121ff7e055677fd8b8abde771e6d542fc08fa767e72bdaf6892a7602a7f360772a4f56f864a8e80ca05f782e102e49be76345cd17659b3803d8497
-  data.tar.gz: 54012e5f2bee7f2f00669734059eac5d10b3cdd2b18bda50631bdb3645ae385586e7f1fa49b8cfb9ba4d0641bbfa56d11acb26e8771954b216d3d7a7a0c60908
+  metadata.gz: 35faff491ee821bf3c0255e236613a8904ca5e816371775316af688bbc27621d15d33e3fb951297e8b359ee44e16fbf6dad1ac620e26cd6aec9cce7aca0c8e5e
+  data.tar.gz: a2a78b255a646c9cbb75317e5eabeb58694ab6464c25162911b51aed56f647c9b94702aad300ced1c700a492d8fa7764843a85daea4fa2dff426bcaf096c87a9

data/.gitignore

@@ -11,6 +11,7 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+spec/internal/db/*.sqlite
 spec/reports
 test/tmp
 test/version_tmp

data/README.md

@@ -6,7 +6,7 @@ A simple Rails engine for liking ActiveRecord objects.
 
 Add this line to your application's Gemfile:
 
-    gem 'like', '0.0.1'
+    gem 'like', '0.1.0'
 
 Don't forget to bundle:
 
@@ -16,7 +16,46 @@ Then, add the migrations to your app and update your database accordingly:
 
     $ rake like:install:migrations db:migrate
 
-### Contributing
+## Usage
+
+All you need to do to use this engine is have something like the following in your views:
+
+```erb
+<% if Like::Like.liking?(current_user, article) %>
+  <%= link_to 'Unlike', like_path_for(article), method: :delete %>
+<% else %>
+  <%= link_to 'Like', like_path_for(article), method: :post %>
+<% end %>
+```
+
+And then, probably in an initializer, tell Like how to determine who the currently signed in user is, along with any filters you wish the underlying controller to implement:
+
+```ruby
+Like.controllers[:user]   = lambda { |controller|
+  controller.current_user
+}
+Like.controllers[:filter] = lambda { |controller|
+  controller.authenticate_user!
+}
+```
+
+The above example is exactly what you'd need if you're using Devise with a User model.
+
+Of course, you probably want to know how many likes an object has:
+
+```ruby
+Like::Like.with_likeable(article).count
+```
+
+Or even how many likes a user has made:
+
+```ruby
+Like::Like.with_liker(user).count
+```
+
+Like doesn't care if your user model is called something else - it's a polymorphic association under the hood, so anything is accepted as the 'liker'. The same applies for 'likeable' as well.
+
+## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/app/controllers/like/likes_controller.rb

@@ -0,0 +1,29 @@
+class Like::LikesController < ActionController::Base
+  before_filter :like_filters
+
+  def create
+    Like::Like.like user, likeable
+
+    redirect_to :back
+  end
+
+  def destroy
+    Like::Like.unlike user, likeable
+
+    redirect_to :back
+  end
+
+  private
+
+  def like_filters
+    Like.controllers[:filter].call self
+  end
+
+  def likeable
+    likeable = params[:likeable_type].constantize.find params[:likeable_id]
+  end
+
+  def user
+    Like.controllers[:user].call self
+  end
+end

data/app/helpers/like/likes_helper.rb

@@ -0,0 +1,13 @@
+module Like::LikesHelper
+  def like_path_for(likeable)
+    like_likes_path likeable_to_params(likeable)
+  end
+
+  def like_url_for(likeable)
+    like_likes_url likeable_to_params(likeable)
+  end
+
+  def likeable_to_params(likeable)
+    {likeable_type: likeable.class.name, likeable_id: likeable.id}
+  end
+end

data/app/models/like/like.rb

@@ -6,4 +6,25 @@ class Like::Like < ActiveRecord::Base
 
   validates :liker,    presence: true
   validates :likeable, presence: true
+
+  scope :with_liker,    lambda { |liker|
+    where liker_type: liker.class.name, liker_id: liker.id
+  }
+  scope :with_likeable, lambda { |likeable|
+    where likeable_type: likeable.class.name, likeable_id: likeable.id
+  }
+
+  def self.like(liker, likeable)
+    create liker: liker, likeable: likeable
+  end
+
+  def self.liking?(liker, likeable)
+    return false if liker.nil? || likeable.nil?
+
+    with_liker(liker).with_likeable(likeable).count > 0
+  end
+
+  def self.unlike(liker, likeable)
+    with_liker(liker).with_likeable(likeable).each &:destroy
+  end
 end

data/config.ru

@@ -3,5 +3,5 @@ require 'bundler'
 
 Bundler.require :default, :development
 
-Combustion.initialize!
+Combustion.initialize! :all
 run Combustion::Application

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  namespace :like do
+    post   'likes', to: 'likes#create', as: :likes
+    delete 'likes', to: 'likes#destroy'
+  end
+end

data/lib/like.rb

@@ -1,6 +1,11 @@
+require 'rails'
+
 module Like
-  def self.link(liker, likeable)
-    Like::Like.create liker: liker, likeable: likeable
+  def self.controllers
+    @controllers ||= {
+      user:   lambda { |controller| controller.current_user },
+      filter: lambda { |controller| true }
+    }
   end
 end
 

data/like.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'like'
-  spec.version       = '0.0.1'
+  spec.version       = '0.1.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = %q{Rails Engine for liking}
@@ -16,7 +16,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rails', '>= 3.2'
 
+  spec.add_development_dependency 'capybara',    '~> 2.2.0'
   spec.add_development_dependency 'combustion',  '~> 0.5.1'
+  spec.add_development_dependency 'devise',      '~> 3.2.2'
   spec.add_development_dependency 'rspec-rails', '~> 2.14.0'
   spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
 end

data/spec/acceptance/liking_spec.rb

@@ -1,11 +1,26 @@
 require 'spec_helper'
 
 describe 'Liking an object' do
-  let(:user)    { User.create! }
+  let(:user)    { User.create! email: 'pat@test.com', password: 'password',
+    password_confirmation: 'password' }
   let(:article) { Article.create! }
 
   it "saves the like" do
-    Like.link user, article
+    Like::Like.like user, article
+
+    likes = Like::Like.where(
+      liker_type:    'User',    liker_id:    user.id,
+      likeable_type: 'Article', likeable_id: article.id
+    )
+
+    expect(likes.count).to eq(1)
+  end
+
+  it "saves the like through a web request" do
+    Like.controllers[:user] = lambda { |controller| user }
+
+    post '/like/likes', {likeable_type: 'Article', likeable_id: article.id},
+      {'HTTP_REFERER' => '/'}
 
     likes = Like::Like.where(
       liker_type:    'User',    liker_id:    user.id,

data/spec/acceptance/liking_with_devise_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe 'Liking an object' do
+  let(:user)    { User.create! email: 'pat@test.com', password: 'password',
+    password_confirmation: 'password' }
+  let(:article) { Article.create! }
+
+  before :each do
+    Like.controllers[:user]   = lambda { |controller| controller.current_user }
+    Like.controllers[:filter] = lambda { |controller|
+      controller.authenticate_user!
+    }
+  end
+
+  context 'authenticated' do
+    before :each do
+      visit new_user_session_path
+
+      fill_in 'Email',    with: user.email
+      fill_in 'Password', with: user.password
+
+      click_button 'Sign in'
+    end
+
+    it "saves the like" do
+      visit article_path(article)
+      click_link 'Like'
+
+      likes = Like::Like.where(
+        liker_type:    'User',    liker_id:    user.id,
+        likeable_type: 'Article', likeable_id: article.id
+      )
+
+      expect(likes.count).to eq(1)
+    end
+
+    it "can delete the like" do
+      visit article_path(article)
+      click_link 'Like'
+      click_link 'Unlike'
+
+      likes = Like::Like.where(
+        liker_type:    'User',    liker_id:    user.id,
+        likeable_type: 'Article', likeable_id: article.id
+      )
+
+      expect(likes.count).to eq(0)
+    end
+  end
+
+  context 'unauthenticated' do
+    it "redirects to the sign in page" do
+      visit article_path(article)
+      click_link 'Like'
+
+      expect(page).to have_content('Sign in')
+    end
+
+    it "doesn't save a like" do
+      visit article_path(article)
+      click_link 'Like'
+
+      likes = Like::Like.where(
+        liker_type:    'User',    liker_id:    user.id,
+        likeable_type: 'Article', likeable_id: article.id
+      )
+
+      expect(likes.count).to eq(0)
+    end
+  end
+end

data/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/internal/app/controllers/articles_controller.rb

@@ -0,0 +1,9 @@
+class ArticlesController < ApplicationController
+  def index
+    @articles = Article.all
+  end
+
+  def show
+    @article = Article.find params[:id]
+  end
+end

data/spec/internal/app/models/user.rb

@@ -1,3 +1,4 @@
 class User < ActiveRecord::Base
-  #
+  devise :database_authenticatable, :registerable,
+   :recoverable, :rememberable, :trackable, :validatable
 end

data/spec/internal/app/views/articles/index.html.erb

@@ -0,0 +1,5 @@
+<h1>Articles</h1>
+
+<% @articles.each do |article| %>
+  <%= link_to "View #{article.id}", article %>
+<% end %>

data/spec/internal/app/views/articles/show.html.erb

@@ -0,0 +1,5 @@
+<% if Like::Like.liking?(current_user, @article) %>
+  <%= link_to 'Unlike', like_path_for(@article), method: :delete %>
+<% else %>
+  <%= link_to 'Like', like_path_for(@article), method: :post %>
+<% end %>

data/spec/internal/config/initializers/devise.rb

@@ -0,0 +1,16 @@
+Devise.setup do |config|
+  config.secret_key = 'aa5e96a76400191fc1f76c44a6c3e0f4f37d9097be933fa5280c25fd3111ab9382d5a72c5a6879ebf0bfce62e18d5eabd5121fd2ef3bb8df49521f6e257223ac'
+
+  config.mailer_sender = 'pat@test.com'
+
+  require 'devise/orm/active_record'
+
+  config.case_insensitive_keys = [ :email ]
+  config.strip_whitespace_keys = [ :email ]
+  config.skip_session_storage = [:http_auth]
+  config.stretches = 1
+  config.allow_unconfirmed_access_for = 1.day
+  config.password_length = 8..128
+  config.reset_password_within = 6.hours
+  config.sign_out_via = :delete
+end

data/spec/internal/config/routes.rb

@@ -1,3 +1,7 @@
 Rails.application.routes.draw do
-  #
+  devise_for :users
+
+  resources :articles
+
+  root to: 'articles#index'
 end

data/spec/internal/db/schema.rb

@@ -4,6 +4,16 @@ ActiveRecord::Schema.define do
   end
 
   create_table :users, :force => true do |t|
+    t.string   :email,                  default: "", null: false
+    t.string   :encrypted_password,     default: "", null: false
+    t.string   :reset_password_token
+    t.datetime :reset_password_sent_at
+    t.datetime :remember_created_at
+    t.integer  :sign_in_count,          default: 0,  null: false
+    t.datetime :current_sign_in_at
+    t.datetime :last_sign_in_at
+    t.string   :current_sign_in_ip
+    t.string   :last_sign_in_ip
     t.timestamps
   end
 end

data/spec/spec_helper.rb

@@ -4,13 +4,20 @@ Bundler.setup :default, :development
 
 require 'combustion'
 require 'like'
+require 'devise'
 
 Combustion.initialize! :action_controller, :active_record
 
 require 'rspec/rails'
+require 'capybara/rails'
 
 Dir["./spec/support/**/*.rb"].each { |file| require file }
 
 RSpec.configure do |config|
   config.use_transactional_fixtures = true
+
+  config.include RSpec::Rails::RequestExampleGroup, type: :request,
+    example_group: {file_path: /spec\/acceptance/}
+  config.include Capybara::DSL, type: :request,
+    example_group: {file_path: /spec\/acceptance/}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: like
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -78,18 +106,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/like/likes_controller.rb
+- app/helpers/like/likes_helper.rb
 - app/models/like/like.rb
 - config.ru
+- config/routes.rb
 - db/migrate/1_create_likes.rb
 - lib/like.rb
 - lib/like/engine.rb
 - like.gemspec
 - spec/acceptance/liking_spec.rb
+- spec/acceptance/liking_with_devise_spec.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/controllers/articles_controller.rb
 - spec/internal/app/models/article.rb
 - spec/internal/app/models/user.rb
+- spec/internal/app/views/articles/index.html.erb
+- spec/internal/app/views/articles/show.html.erb
 - spec/internal/config/database.yml
+- spec/internal/config/initializers/devise.rb
 - spec/internal/config/routes.rb
-- spec/internal/db/combustion_test.sqlite
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
@@ -120,11 +156,16 @@ specification_version: 4
 summary: Rails Engine for liking
 test_files:
 - spec/acceptance/liking_spec.rb
+- spec/acceptance/liking_with_devise_spec.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/controllers/articles_controller.rb
 - spec/internal/app/models/article.rb
 - spec/internal/app/models/user.rb
+- spec/internal/app/views/articles/index.html.erb
+- spec/internal/app/views/articles/show.html.erb
 - spec/internal/config/database.yml
+- spec/internal/config/initializers/devise.rb
 - spec/internal/config/routes.rb
-- spec/internal/db/combustion_test.sqlite
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico