acts_as_favable 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,47 @@
+Acts As Favable
+=================
+
+Allows for favorite refer to be added to multiple and different models.
+
+## Resources
+
+####Install(on Rails3)
+
+ To install as a plugin
+ 
+    rails plugin install http://github.com/yorzi/acts_as_favable.git
+   
+ To install as a gem
+
+    sudo gem install acts_as_favable
+
+ Generate your favorite model:
+ 
+    rails generate favorite
+ 
+ Then migrate your database:
+ 
+    rake db:migrate
+
+## Usage
+#### Make your ActiveRecord model act as favable.
+
+    class Model < ActiveRecord::Base
+ 	   acts_as_favable
+    end
+ 
+####mark a favorite flag to a model instance
+ 
+    favable = Model.create
+    favable.favorites.create(:note => "I like this and will make it one of my favorites")
+
+####Fetch favorites for a favable model:
+
+    favable = Model.find(1)
+    favorites = favable.favorites.recent.limit(10).all
+
+Attention: This plugin/gem is heavily influenced by Acts As Taggable and almost copied from acts_at_commentable.
+
+## More
+
+Blog post..

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1,2 @@
+puts "To create the favorite model please run:"
+puts "rails generate favorite"

data/lib/acts_as_favable.rb

@@ -0,0 +1,2 @@
+require 'favable_methods'
+require 'favorite_methods'

data/lib/favable_methods.rb

@@ -0,0 +1,44 @@
+require 'active_record'
+
+module Acts #:nodoc:
+  module Favable #:nodoc:
+
+    def self.included(base)
+      base.extend ClassMethods  
+    end
+
+    module ClassMethods
+      def acts_as_favable(options={})
+        has_many :favorites, {:as => :favable, :dependent => :destroy}.merge(options)
+        include Acts::Favable::InstanceMethods
+        extend Acts::Favable::SingletonMethods
+      end
+    end
+    
+    module SingletonMethods
+      def find_favorites_for(obj)
+        favable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+        Favorite.find_favorites_for_favable(favable, obj.id)
+      end
+      
+      def find_favorites_by_user(user) 
+        favable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+        Favorite.where(["user_id = ? and favable_type = ?", user.id, favable]).order("created_at DESC")
+      end
+    end
+    
+    # This module contains instance methods
+    module InstanceMethods
+      def favorites_ordered_by_submitted
+        Favorite.find_favorites_for_favable(self.class.name, id)
+      end
+
+      def add_favorite(favorite)
+        favorites << favorite
+      end
+    end
+    
+  end
+end
+
+ActiveRecord::Base.send(:include, Acts::Favable)

data/lib/favorite_methods.rb

@@ -0,0 +1,24 @@
+module ActsAsFavable
+  module Favorite
+    
+    def self.included(favorite_model)
+      favorite_model.extend Finders
+      favorite_model.scope :in_order, favorite_model.order('created_at ASC')
+      favorite_model.scope :recent, favorite_model.order('created_at DESC')
+    end
+    
+    module Finders
+      def find_favorites_by_user(user)
+        where(["user_id = ?", user.id]).order("created_at DESC")
+      end
+
+      def find_favorites_for_favable(favable_str, favable_id)
+        where(["favable_type = ? and favable_id = ?", favable_str, favable_id]).order("created_at DESC")
+      end
+
+      def find_favable(favable_str, favable_id)
+        favable_str.constantize.find(favable_id)
+      end
+    end
+  end
+end

data/lib/generators/favorite/favorite_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/migration'
+
+class FavoriteGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_acts_as_favable_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    template "favorite.rb", "app/models/favorite.rb"
+    migration_template "create_favorites.rb", "db/migrate/create_favorites.rb"
+  end
+end

data/lib/generators/favorite/templates/create_favorites.rb

@@ -0,0 +1,18 @@
+class CreateFavorites < ActiveRecord::Migration
+  def self.up
+    create_table :favorites do |t|
+      t.string :note, :limit => 50, :default => "" 
+      t.references :favable, :polymorphic => true
+      t.references :user
+      t.timestamps
+    end
+
+    add_index :favorites, :favable_type
+    add_index :favorites, :favable_id
+    add_index :favorites, :user_id
+  end
+
+  def self.down
+    drop_table :favorites
+  end
+end

data/lib/generators/favorite/templates/favorite.rb

@@ -0,0 +1,11 @@
+class Favorite < ActiveRecord::Base
+
+  include ActsAsFavable::Favorite
+
+  belongs_to :favable, :polymorphic => true
+
+  default_scope :order => 'created_at ASC'
+
+  # NOTE: Favorite belongs to a user
+  belongs_to :user
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_favable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andy Wang
+autorequire: acts_as_favable
+bindir: bin
+cert_chain: []
+
+date: 2010-11-29 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Plugin/Gem that provides favorites functionality
+email: wangyaodi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.markdown
+- lib/acts_as_favable.rb
+- lib/favorite_methods.rb
+- lib/favable_methods.rb
+- lib/generators/favorite/favorite_generator.rb
+- lib/generators/favorite/templates/favorite.rb
+- lib/generators/favorite/templates/create_favorites.rb
+- init.rb
+- install.rb
+has_rdoc: true
+homepage: https://github.com/yorzi/acts_as_favable
+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.3.7
+signing_key: 
+specification_version: 1
+summary: Plugin/gem that provides favorite functionality
+test_files: []
+