likeable 0.0.5 → 0.1.0

data/README.md

@@ -40,6 +40,11 @@ Likeable is the easiest way to allow your models to be liked by users, just drop
 
 ```
 
+## Screencast
+
+You can view a [screencast of likeable in action on youtube](http://youtu.be/iJoMXUQ33Jw?hd=1). There is also an example [Likeable rails application](https://github.com/schneems/likeable_example) that you can use to follow along.
+
+
 
 Setup
 =======
@@ -74,8 +79,71 @@ Finally add `Likeable` module to any model you want to be liked:
     end
 ```
 
+## Rails Info
+If you're using Likeable in Rails this should help you get started
+
+ controllers/likes_controller.rb
+
+```ruby
+
+  class LikesController < ApplicationController
+
+    def create
+      target = Likeable.find_by_resource_id(params[:resource_name], params[:resource_id])
+      current_user.like!(target)
+      redirect_to :back, :notice => 'success'
+    end
+
+    def destroy
+      target = Likeable.find_by_resource_id(params[:resource_name], params[:resource_id])
+      current_user.unlike!(target)
+      redirect_to :back, :notice => 'success'
+    end
+  end
+
+```
+
+config/routes.rb
+
+```ruby
+
+    delete  'likes/:resource_name/:resource_id' => "likes#destroy", :as => 'like'
+    post    'likes/:resource_name/:resource_id' => "likes#create",  :as => 'like'
+
+```
+
+helpers/like_helper.rb
+
+```ruby
+
+    def like_link_for(target)
+      link_to "like it!!", like_path(:resource_name => target  .class, :resource_id => target.id), :method => :post
+    end
+
+    def unlike_link_for(target)
+      link_to "unlike it!!", like_path(:resource_name => target.class, :resource_id => target.id), :method => :delete
+    end
+
+```
+
+Then in any view you can simply call the helper methods to give your user a link
+
+```ruby
+
+    <%- if @user.likes? @comment -%>
+      <%= unlike_link_for @comment  %>
+    <%- else -%>
+      <%= like_link_for @comment %>
+    <%- end -%>
+
+
+```
+
+Why
+===
+
+We chose Redis because it is screaming fast, and very simple to work with. By using redis for likeable we take load off of our relational database and speed up individual calls retrieve information about the "liked" state of an object. If you're not using redis in production, and don't want to, there are many other great liking/voting libraries out there such as [thumbs up](https://github.com/brady8/thumbs_up).
 
-Thats about it.
 
                RedisRed            RedisRedi
             RedisRedisRedi       RedisRedisRedisR

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'bundler'
 begin
-  Bundler.setup(:default, :development)
+  Bundler.setup(:default, :development, :test)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"
@@ -24,3 +24,6 @@ Jeweler::Tasks.new do |gem|
   gem.add_development_dependency "rspec"
 end
 Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/lib/likeable.rb

@@ -59,7 +59,7 @@ module Likeable
   end
 
   def liked_users(limit = nil)
-    @liked_users ||= User.where(:id => like_user_ids)
+    @liked_users ||= Likeable.user_class.where(:id => like_user_ids)
   end
 
   def likes

data/lib/likeable/module_methods.rb

@@ -84,50 +84,26 @@ module Likeable
       end
 
       def user_class
-        @user_class ||= ::User
+        begin
+          @user_class ||= ::User
+        rescue NameError
+          nil
+        end
       end
 
-      def user_class=(user)
-        raise "User must be a class #{user.inspect}" unless user.class == Class
-        @user_class = user
+      def user_class=(klass)
+        raise ArgumentError, "Argument must be a class" unless klass.is_a?(Class)
+        @user_class = klass
       end
 
       # Likeable.setup do |like|
       #  like.redis     = Redis.new(#...)
       #  like.find_one  = lambda {|klass, id | klass.where(:id => id)}
       #  like.find_many = lambda {|klass, ids| klass.where(:id => ids)}
-      #  like.classes   = Spot, Comment
       # end
-
-
-      def include_in_class(klass, include_item)
-        case
-        when defined?(Rails::Application)
-          Rails::Application.class_eval do
-            config.to_prepare do
-              klass.send :include, include_item
-            end
-          end
-        else
-          klass.send :include, include_item
-        end
-      end
-
-      def make_classes_likeable
-        classes.each do |klass|
-          include_in_class(klass, Likeable)
-        end
-      end
-
-      def give_users_like_ability
-        include_in_class user_class, ::Likeable::UserMethods
-      end
-
       def setup(&block)
         yield self unless block.blank?
-        make_classes_likeable
-        give_users_like_ability
         true
       end
     end
-end
+end

data/likeable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "likeable"
-  s.version = "0.0.5"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]
-  s.date = "2011-10-31"
+  s.date = "2011-11-15"
   s.description = "\n    Likeable allows you to make your models...well...likeable using redis.\n  "
   s.email = "richard.schneeman@gmail.com"
   s.extra_rdoc_files = [
@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "autotest/discover.rb",
-    "lib/.DS_Store",
     "lib/likeable.rb",
     "lib/likeable/facepile.rb",
     "lib/likeable/like.rb",

data/spec/likeable/like_spec.rb

@@ -8,12 +8,13 @@ describe Likeable::Like do
       like = Likeable::Like.new(:target => @target, :user => @user, :time => @time)
       like.user.should        eq(@user)
       like.target.should      eq(@target)
-      like.created_at.should  eq(@time)
+      # Times often fail equality checks due to microsec precision
+      like.created_at.should  be_within(1).of(@time)
     end
 
     it 'converts float time to propper Time object' do
       like = Likeable::Like.new(:time => @time.to_f)
-      like.created_at.should eq(@time)
+      like.created_at.should be_within(1).of(@time)
     end
   end
 end

data/spec/likeable/setup_spec.rb

@@ -22,45 +22,44 @@ class SetupCleanTestClassForLikeable
 end
 
 describe Likeable do
-  before(:each) do
-    reload_user!
-    Likeable.user_class = User
-    @user   = User.new
-    @target = SetupCleanTestClassForLikeable.new
-  end
+  describe "setup" do
+    context "when the User class is defined" do
+      before(:each) do
+        reload_user!
+        Likeable.user_class = User
+        @user   = User.new
+        @target = SetupCleanTestClassForLikeable.new
+      end
 
+      it "" do
+        result = "foo"
+        Likeable.setup
 
-  describe "Likeable setup" do
-    it "adds Likeable::UserMethods to User" do
-      describe User.ancestors do
-        it {should_not include Likeable::UserMethods}
-      end
-      Likeable.setup
-      describe User.ancestors do
-        it {should include Likeable::UserMethods}
+        Likeable.after_like do |like|
+          result = "after_like_called_successfully"
+        end
+
+        @user.like! @target
+        result.should == "after_like_called_successfully"
       end
     end
 
-    it "adds likeable to class" do
-      Likeable.setup do |like|
-        like.classes = LikeableIncludedInSetup
+    context "when the User class doesn't exist" do
+      before do
+        # Need a cleaner way to do this, but the setter
+        # prevents it
+        Likeable.instance_variable_set(:@user_class, nil)
+        unload_user!
       end
 
-      describe LikeableIncludedInSetup.ancestors do
-        it {should include Likeable}
+      after do
+        build_user!
+        Likeable.setup
       end
-    end
-
-    it "" do
-      result = "foo"
-      Likeable.setup
 
-      Likeable.after_like do |like|
-        result = "after_like_called_successfully"
+      it "won't raise an exception" do
+        lambda { Likeable.setup }.should_not raise_error
       end
-
-      @user.like! @target
-      result.should == "after_like_called_successfully"
     end
   end
 end

data/spec/likeable_spec.rb

@@ -54,6 +54,14 @@ describe Likeable do
       end
     end
 
+    describe "#liked_users" do
+      it "finds the users that like it" do
+        @target.should_receive(:like_user_ids).and_return([1,2])
+        User.should_receive(:where).with(:id => [1,2])
+        @target.liked_users(@user)
+      end
+    end
+
     describe "#likes" do
       it "returns set of likes" do
         Likeable.redis.should_receive(:hkeys).with("like_key").once

data/spec/spec_helper.rb

@@ -6,9 +6,13 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../..', 'lib'))
 
 
+require 'likeable'
+
+
 def build_user!
   eval %Q{
       class User
+        include Likeable::UserMethods
         def id
           @time ||= Time.now.to_f.to_s
         end
@@ -37,7 +41,6 @@ end
 
 build_user!
 
-require 'likeable'
 
 require 'rspec'
 require 'rspec/autorun'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: likeable
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 5
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Schneems
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-31 00:00:00 Z
+date: 2011-11-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -167,7 +167,6 @@ files:
 - Rakefile
 - VERSION
 - autotest/discover.rb
-- lib/.DS_Store
 - lib/likeable.rb
 - lib/likeable/facepile.rb
 - lib/likeable/like.rb