blakstar_like 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.3"
+  gem "jeweler", "~> 1.8.3"
+  gem 'simplecov', :platforms => :mri_19
+  gem 'rcov', :platforms => :mri_18
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    multi_json (1.2.0)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.3)
+  jeweler (~> 1.8.3)
+  rcov
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Fekete Ferenc
+
+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.textile

@@ -0,0 +1,53 @@
+h1. Blakstar Like
+
+Simple plugin for handling positive and negative likes.
+This stuff has been made for Blakstar cms and used in production, but released as a free solution.
+
+h2. Examples
+
+First, generate the migration file.
+<pre><code>
+script/generate blakstar_like_migration
+</code></pre>
+
+Include blakstar_like in a model you want to like.
+<pre><code>Class Post < ActiveRecord::Base
+
+  blakstar_like
+  
+end
+</code></pre>
+
+The following methods will be available:
+
+<pre><code>
+@post.like!( @user_1 )
+
+@post.dislike!( @user_2 )
+
+@post.average_like #=> 0
+
+@post.count_likes! #=> 1
+
+@post.count_dislikes! #=> 1
+</code></pre>
+
+h2. Caching
+
+If you add two new fields to Post - :likes_count and :dislikes_count - the plugin
+automatically caches the total number of likes / dislikes to speed up calculations.
+
+.h2 Contributing to blakstar_like
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+***************************************************************************
+
+Copyright (c) 2010-2012 Ferenc Fekete ("Mr. Black":http://feketeferenc.hu), "Gergő Sulymosi":http://github.com/trekdemo
+rblack.hu), "Gergő Sulymosi":http://github.com/trekdemo

data/Rakefile

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "blakstar_like"
+  gem.homepage = "http://github.com/azabaj/blakstar_like"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple gem for handling positive and negative likes.}
+  gem.description = %Q{Simple gem for handling positive and negative likes.}
+  gem.email = "feketeferenc@gmail.com"
+  gem.authors = ["Azabaj"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+if RUBY_VERSION =~ /^1\.9/
+  desc "Code coverage detail"
+  task :simplecov do
+    ENV['COVERAGE'] = "true"
+    Rake::Task['spec'].execute
+  end
+else
+  RSpec::Core::RakeTask.new(:rcov) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+  end
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "blakstar_like #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/blakstar_like.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "blakstar_like"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Azabaj"]
+  s.date = "2012-04-11"
+  s.description = "Simple gem for handling positive and negative likes."
+  s.email = "feketeferenc@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "blakstar_like.gemspec",
+    "generators/blakstar_like_migration/blakstar_like_migration_generator.rb",
+    "generators/blakstar_like_migration/templates/migration.rb",
+    "init.rb",
+    "lib/blakstar_like.rb",
+    "lib/like.rb",
+    "test/blakstar_like_test.rb",
+    "test/helper.rb",
+    "test/test_blakstar_like.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/azabaj/blakstar_like"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.19"
+  s.summary = "Simple gem for handling positive and negative likes."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/generators/blakstar_like_migration/blakstar_like_migration_generator.rb

@@ -0,0 +1,11 @@
+class BlakstarLikeMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate' 
+    end 
+  end
+  
+  def file_name
+    "blakstar_like_migration"
+  end
+end

data/generators/blakstar_like_migration/templates/migration.rb

@@ -0,0 +1,23 @@
+class BlakstarLikeMigration < ActiveRecord::Migration
+  def self.up    
+    create_table :likes do |t|
+    	t.references :user
+      t.integer :likeable_id
+      t.string :likeable_type, :limit => 32
+      t.integer :value
+      t.timestamps
+    end
+    
+    add_index :likes, :user_id
+    add_index :likes, :likeable_id
+    add_index :likes, :likeable_type
+    add_index :likes, :value
+    add_index :likes, :created_at
+    add_index :likes, [:user_id, :likeable_id, :likeable_type], :unique => true
+    
+  end
+  
+  def self.down
+    drop_table :likes
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/lib/blakstar_like'
+ActiveRecord::Base.send(:include, ActiveRecord::Blakstar::Like)

data/lib/blakstar_like.rb

@@ -0,0 +1,59 @@
+module ActiveRecord
+  module Blakstar
+    module Like
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    
+      module ClassMethods
+        def blakstar_like(options = {})
+          has_many :likes, :as => :likeable, :dependent => :destroy
+          
+          include ActiveRecord::Blakstar::Like::InstanceMethods
+        end
+      end
+      
+      module InstanceMethods
+        # Likes the object by a given value. A user object can be passed to the method.
+        def like!( user )
+          return unless user.class.to_s == 'User'
+          ActiveRecord::Base.transaction do
+            like = likes.create( :value => 1, :user_id => user.id )
+            self.increment!( :likes_count ) if !like.changed? && self.respond_to?( :likes_count )
+            like
+          end
+        end
+        
+        def dislike!( user )
+          return unless user.class.to_s == 'User'
+          ActiveRecord::Base.transaction do
+            like = likes.create( :value => -1, :user_id => user.id )
+            self.increment!( :dislikes_count ) if !like.changed? && self.respond_to?( :dislikes_count )
+            like
+          end
+        end
+        
+        # Calculates the average rating. Calculation based on the already given values.
+        def average_like
+          return 0 if likes.empty?
+          count_likes! + count_dislikes!
+        end
+        
+        def count_likes!
+          self.respond_to?( :likes_count) ? self.likes_count : likes.where('value = 1').count
+        end
+        
+        def count_dislikes!
+          self.respond_to?( :dislikes_count) ? self.dislikes_count : likes.where('value = -1').count
+        end
+        
+        # Checks wheter a user liked or disliked the object or not.
+        def liked_by?( user )
+          return false if user.nil? || user.class.to_s != 'User'
+          likes.detect {|l| l.user_id == user.id }
+        end
+      end
+      
+    end
+  end
+end

data/lib/like.rb

@@ -0,0 +1,7 @@
+class Like < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :likeable, :polymorphic => true
+  
+  validates_uniqueness_of :user_id, :scope => [:likeable_id, :likeable_type]
+  validates_inclusion_of :value, :in => [-1, 1]
+end

data/test/blakstar_like_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'active_record'
+require "#{File.dirname(__FILE__)}/../init"
+require "#{File.dirname(__FILE__)}/../lib/like"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts do |t|
+      t.string :title
+      t.integer :likes_count, :default => 0
+      t.integer :dislikes_count, :default => 0
+      t.timestamps
+    end
+    create_table :users do |t|
+      t.string :name, :null => false
+    end
+    create_table :likes do |t|
+    	t.references :user
+      t.integer :likeable_id
+      t.string :likeable_type, :limit => 32
+      t.integer :value
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class User < ActiveRecord::Base; end
+class Post < ActiveRecord::Base; blakstar_like; end
+
+class BlakstarLikeTest < Test::Unit::TestCase
+  
+  def setup
+    setup_db
+    5.times {|i| Post.create! :title => "Post #{i}"}
+    2.times {|i| User.create! :name => "User #{i}"}
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_like
+    user = User.find 1
+    post = Post.find 1
+    like = post.like! user
+    assert_equal 'Like', like.class.to_s
+    assert !like.changed?
+  end
+  
+  def test_dislike
+    user = User.find 2
+    post = Post.find 1
+    like = post.dislike! user
+    assert_equal 'Like', like.class.to_s
+    assert !like.changed?
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'blakstar_like'
+
+class Test::Unit::TestCase
+end

data/test/test_blakstar_like.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBlakstarLike < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: blakstar_like
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Azabaj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem for handling positive and negative likes.
+email: feketeferenc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.textile
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.textile
+- Rakefile
+- VERSION
+- blakstar_like.gemspec
+- generators/blakstar_like_migration/blakstar_like_migration_generator.rb
+- generators/blakstar_like_migration/templates/migration.rb
+- init.rb
+- lib/blakstar_like.rb
+- lib/like.rb
+- test/blakstar_like_test.rb
+- test/helper.rb
+- test/test_blakstar_like.rb
+- test/test_helper.rb
+homepage: http://github.com/azabaj/blakstar_like
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 90315055
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Simple gem for handling positive and negative likes.
+test_files: []