acts_as_recommended 0.1.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.9"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+
+gem "rspec-rails", ">= 2.0.0.beta"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.rdoc

@@ -0,0 +1,88 @@
+= Acts as Recommended
+
+A simple rails 3 engine to add recommendation functionallity to your application
+
+== Installation
+
+Add to your *Gemfile*
+
+    gem 'acts_as_recommended'
+
+And just run
+
+    bundle
+
+== Usage
+
+First thing we need is the recommendation model himself
+and we have a generator that creates the model's tables
+
+    rails g acts_as_recommended:tables
+
+After that we can add the required fields for our models with
+another generator
+
+    rails g acts_as_recommended:recommendations_for Post
+
+This will add a migration adding the required fields to add
+recommendations to a certain model.
+
+Then all we simply add this line to our desired model
+
+    acts_as_recommended
+
+Now, we can run the migrations and we can already recommend whatever we want!
+
+    post = Post.first
+
+    bob = User.first
+    joe = User.last
+    mary = User.find(100)
+
+    post.recommend!( true, bob  )
+    post.recommend!( 0,    joe  )
+    post.recommend!( true, mary )
+
+    # good minus bad recommendations
+    post.recommendations # 1
+
+    post.recommendations_count # 3
+
+    post.good_recommendations # 2
+    post.bad_recommendations # 1
+
+    post.good_recommendations_percent # 66.67
+    # pass a format optionally
+    post.bad_recommendations_percent( '%.1f' ) # 33.3
+
+    # check if user recommended
+    post.recommended_by?( bob ) # true
+    post.recommended_by?( mary ) # true
+
+    # get user's recommendation
+    post.get_recommendation_of( bob ) # true
+    post.get_recommendation_of( mary ) # false
+
+Note: users can only recommend once, a second recommendation will replace the latter
+
+== Customization
+
+By default the recommendation must be done by a User model
+you can customize that with a simple initializer like *config/initializers/recommendations.rb*
+
+    ActsAsRecommended.owner_model = :admin
+
+
+== Contribution
+
+Want to contribute? Fork, make it, ask for pull request!
+Found an issue? Use the issues tracker!
+
+== TODO
+
+Create a simple controller to create/alter recommendations and generators for customization!
+
+== Author
+
+Created and mantained by Luiz Felipe Garcia Pereira aka {*Draiken*}[http://github.com/Draiken]
+

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsRecommended'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/models/recommendation.rb

@@ -0,0 +1,9 @@
+class Recommendation < ActiveRecord::Base
+  
+  belongs_to :owner, :class_name => ActsAsRecommended.owner_class
+  belongs_to :recommendable, :polymorphic => true
+
+  scope :of_item, lambda { |item| where('recommendable_id = ?', item.id).where('recommendable_type = ?', item.class.base_class.name.to_s) }
+  scope :owned_by, lambda { |owner| where('owner_id = ?', owner.id) }
+  
+end

data/lib/acts_as_recommended.rb

@@ -0,0 +1,8 @@
+module ActsAsRecommended
+
+  mattr_accessor :owner_class
+  @@owner_class = :user
+
+end
+
+require 'acts_as_recommended/engine'

data/lib/acts_as_recommended/engine.rb

@@ -0,0 +1,11 @@
+module ActsAsRecommended
+  class Engine < ::Rails::Engine
+    initializer :acts_as_recommended do |app|
+      ActiveSupport.on_load(:active_record) do
+        require File.join(File.dirname(__FILE__), 'model_extensions')
+        ::ActiveRecord::Base.send :include, ActsAsRecommended::ModelExtensions
+      end
+    end
+  
+  end
+end

data/lib/acts_as_recommended/model_extensions.rb

@@ -0,0 +1,90 @@
+module ActsAsRecommended
+  module ModelExtensions
+
+    def self.included(base)
+      # :nodoc:
+      base.extend(ClassMethods)  
+    end
+
+    module ClassMethods
+
+      def acts_as_recommended(*args)
+        return if self.included_modules.include?(ActsAsRecommended::ModelExtensions::ActsAsRecommendedMethods)
+        send :include, ActsAsRecommended::ModelExtensions::ActsAsRecommendedMethods
+      end
+
+    end
+
+    # Métodos utilizados para incrementar e decrementar os contadores
+    # de contribuição.
+    #
+    module ActsAsRecommendedMethods
+
+      def recommend!(recommendation, owner)
+        raise "Recommendation cannot be nil" if recommendation.nil?
+
+        # either a 1/0 or a true/false
+        recommendation = _normalize_recommendation(recommendation)
+
+        # find last recomendation of this item 
+        # from this user or create a new one
+        new_recommendation = _new_or_last_recommendation_for(owner)
+        new_record = new_recommendation.new_record?
+
+        # return if it's the same recommendation as before
+        ( new_recommendation.touch and return true ) if ( not new_record and new_recommendation.recommendation == recommendation )
+
+        old_recommendation = new_recommendation.recommendation unless new_record
+
+        new_recommendation.recommendation = recommendation
+        new_recommendation.save
+
+        # adds the recommendation count to self if needed
+        self.good_recommendations += 1 if recommendation
+        self.bad_recommendations  += 1 if not recommendation
+
+        # removes the old recomendation count if you are changing an old one
+        unless new_record
+          self.bad_recommendations  -= 1 if recommendation  && ( not old_recommendation )
+          self.good_recommendations -= 1 if !recommendation && old_recommendation
+        end
+
+        self.save
+      end
+
+      def recommendations
+        self.good_recommendations - self.bad_recommendations
+      end
+
+      def recommendations_count
+        self.good_recommendations + self.bad_recommendations
+      end
+
+      def good_recommendations_percent(format = '%.2f')
+        format % ((self.good_recommendations.to_f / (self.recommendations_count == 0 ? 1.to_f : self.recommendations_count.to_f)) * 100)
+      end
+
+      def bad_recommendations_percent(format = '%.2f')
+        format % ((self.bad_recommendations.to_f / (self.recommendations_count == 0 ? 1.to_f : self.recommendations_count.to_f)) * 100)
+      end
+
+      def recommended_by?(user)
+        Recommendation.of_item(self).owned_by(user).first ? true : false
+      end
+
+      def get_recommendation_of(user)
+        Recommendation.of_item(self).owned_by(user).first.recommendation
+      end
+
+      private
+
+      def _normalize_recommendation(recommendation)
+        (( recommendation.is_a?(String) || recommendation.is_a?(Fixnum) ) ? (recommendation.to_i == 1) : recommendation)
+      end
+
+      def _new_or_last_recommendation_for(owner)
+        Recommendation.of_item(self).owned_by(owner).first or Recommendation.new(:owner_id => owner.id, :recommendable_id => self.id, :recommendable_type => self.class.base_class.name)
+      end
+    end
+  end
+end

data/lib/generators/acts_as_recommended/recommendations_for/recommendations_for_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ActsAsRecommended
+  module Generators
+    class RecommendationsForGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def manifest
+        migration_template "migrations/add_recommendations_to_table.rb", "db/migrate/add_recommendations_to_#{table_name}", {:assigns => {:name => name, :table_name => table_name}}
+      end
+    end
+  end
+end

data/lib/generators/acts_as_recommended/recommendations_for/templates/migrations/add_recommendations_to_table.rb

@@ -0,0 +1,11 @@
+class AddRecommendationsTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :good_recommendations, :integer, :default => 0
+    add_column :<%= table_name %>, :bad_recommendations, :integer, :default => 0
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :good_recommendations
+    remove_column :<%= table_name %>, :bad_recommendations
+  end
+end

data/lib/generators/acts_as_recommended/tables/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate acts_as_recommended Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/acts_as_recommended/tables/tables_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ActsAsRecommended
+  module Generators
+    class TablesGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def manifest
+        migration_template "migrations/create_recommendations.rb", "db/migrate/create_recommendations"
+      end
+    end
+  end
+end

data/lib/generators/acts_as_recommended/tables/templates/migrations/create_recommendations.rb

@@ -0,0 +1,19 @@
+class CreateRecommendations < ActiveRecord::Migration
+  def self.up
+    create_table :recommendations do |t|
+      t.references :recommendable, :polymorphic => true, :null => false
+      t.references :owner, :null => false
+      t.boolean    :recommendation, :null => false
+      
+      t.timestamps
+    end
+    
+    add_index :recommendations, [:recommendable_type, :recommendable_id],  :name => 'idx_recommendations'
+    add_index :recommendations, [:recommendable_type, :recommendable_id, :owner_id], :unique => true, :name => 'idx_recommendations_user'
+    add_index :recommendations, [:recommendable_type, :recommendable_id, :recommendation],  :name => 'idx_recommendations_type'
+  end
+
+  def self.down
+    drop_table :recommendations
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_recommended
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Luiz Felipe Garcia Pereira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-17 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Insert ActsAsRecommended description.
+email: 
+- luiz.felipe.gp@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/models/recommendation.rb
+- lib/acts_as_recommended/engine.rb
+- lib/acts_as_recommended/model_extensions.rb
+- lib/acts_as_recommended.rb
+- lib/generators/acts_as_recommended/recommendations_for/recommendations_for_generator.rb
+- lib/generators/acts_as_recommended/recommendations_for/templates/migrations/add_recommendations_to_table.rb
+- lib/generators/acts_as_recommended/tables/tables_generator.rb
+- lib/generators/acts_as_recommended/tables/templates/migrations/create_recommendations.rb
+- lib/generators/acts_as_recommended/tables/USAGE
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Insert ActsAsRecommended summary.
+test_files: []
+