fav_star 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/CHANGELOG.markdown

@@ -0,0 +1,3 @@
+2010-08-15
+==========
+* Branched FavStar off of ThumbsUp: favourites instead of votes.

data/MIT-LICENSE

@@ -0,0 +1,66 @@
+Copyright (c) 2010 Brady Bouchard (ldawn.com)
+
+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.
+
+Major portions of this package were adapted from VoteFu, which is subject to the same license. Here is the original copyright notice for VoteFu:
+
+Copyright (c) 2008 Peter Jackson (peteonrails.com)
+
+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.
+
+Major portions of this package were adapted from ActsAsFaveable, which is subject to the same license. Here is the original copyright notice for ActsAsFaveable:
+
+Copyright (c) 2006 Cosmin Radoi
+
+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,15 @@
+FavStar
+=======
+
+Run the generator to add the migration and model to your project:
+
+    rails g fav_star
+    rake db:migrate
+
+Add to your users / voters:
+
+    acts_as_faver
+
+Add to your faveable models:
+
+   acts_as_faveable

data/Rakefile

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fav_star"
+    gem.summary = "Mark your ActiveRecord models as favourites with only a couple of lines of code."
+    gem.description = "fav_star provides a fairly straightforward module that allows you to keep track of which models your users have favourited."
+    gem.email = "brady@ldawn.com"
+    gem.homepage = "http://github.com/brady8/favstar"
+    gem.authors = ["Brady Bouchard"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/fav_star.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fav_star}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brady Bouchard"]
+  s.date = %q{2010-08-19}
+  s.description = %q{fav_star provides a fairly straightforward module that allows you to keep track of which models your users have favourited.}
+  s.email = %q{brady@ldawn.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.markdown",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "fav_star.gemspec",
+     "lib/acts_as_faveable.rb",
+     "lib/acts_as_faver.rb",
+     "lib/fav_star.rb",
+     "lib/generators/fav_star/fav_star_generator.rb",
+     "lib/generators/fav_star/templates/fave.rb",
+     "lib/generators/fav_star/templates/migration.rb"
+  ]
+  s.homepage = %q{http://github.com/brady8/favstar}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Mark your ActiveRecord models as favourites with only a couple of lines of code.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/acts_as_faveable.rb

@@ -0,0 +1,41 @@
+module FavStar
+  module ActsAsFaveable #:nodoc:
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_faveable
+        has_many :favs, :as => :faveable, :dependent => :nullify
+
+        include FavStar::ActsAsFaveable::InstanceMethods
+        extend  FavStar::ActsAsFaveable::SingletonMethods
+      end
+    end
+
+    module SingletonMethods
+    end
+
+    module InstanceMethods
+
+      def favs
+        Fave.where(:faveable_id => id, :faveable_type => self.class.name).count
+      end
+
+      def favers_who_faved
+        self.faves.map(&:faver).uniq
+      end
+
+      def faved_by?(faver)
+        0 < Fave.where(
+              :faveable_id => self.id,
+              :faveable_type => self.class.name,
+              :faver_type => faver.class.name,
+              :faver_id => faver.id
+            ).count
+      end
+
+    end
+  end
+end

data/lib/acts_as_faver.rb

@@ -0,0 +1,56 @@
+module FavStar #:nodoc:
+  module ActsAsFaver #:nodoc:
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_faver
+
+        has_many :votes, :as => :faver, :dependent => :destroy
+
+        include FavStar::ActsAsFaver::InstanceMethods
+        extend  FavStar::ActsAsFaver::SingletonMethods
+
+      end
+    end
+
+    module SingletonMethods
+    end
+
+    module InstanceMethods
+
+      def faved?(faveable)
+        0 < Fave.where(
+              :faver_id => self.id,
+              :faver_type => self.class.name,
+              :faveable_id => faveable.id,
+              :faveable_type => faveable.class.name
+            ).count
+      end
+
+      def fave!(faveable)
+        Fave.create!(:faveable => faveable, :faver => self) unless self.faved?(faveable)
+      end
+
+      def unfave!(faveable)
+        Fave.where(
+          :faver_id => self.id,
+          :faver_type => self.class.name,
+          :faveable_id => faveable.id,
+          :faveable_type => faveable.class.name
+        ).map(&:destroy)
+      end
+
+      def toggle_fave!(faveable)
+        if self.faved?(faveable)
+          unfave!(faveable)
+        else
+          fave!(faveable)
+        end
+      end
+
+    end
+  end
+end

data/lib/fav_star.rb

@@ -0,0 +1,5 @@
+require 'acts_as_faveable'
+require 'acts_as_faver'
+
+ActiveRecord::Base.send(:include, FavStar::ActsAsFaveable)
+ActiveRecord::Base.send(:include, FavStar::ActsAsFaver)

data/lib/generators/fav_star/fav_star_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/active_record'
+
+class FavStarGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  # Implement the required interface for Rails::Generators::Migration.
+  def self.next_migration_number(dirname) #:nodoc:
+    next_migration_number = current_migration_number(dirname) + 1
+    if ActiveRecord::Base.timestamped_migrations
+      [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+    else
+      "%.3d" % next_migration_number
+    end
+  end
+
+  def create_migration
+    migration_template 'migration.rb', File.join('db', 'migrate', 'fav_star_migration.rb')
+  end
+
+  def move_fav_model
+    template 'fave.rb', File.join('app', 'models', 'fave.rb')
+  end
+
+end

data/lib/generators/fav_star/templates/fave.rb

@@ -0,0 +1,15 @@
+class Fave < ActiveRecord::Base
+
+  scope :for_faver, lambda { |*args| where(["faver_id = ? AND faver_type = ?", args.first.id, args.first.class.name]) }
+  scope :for_faveable, lambda { |*args| where(["faveable_id = ? AND faveable_type = ?", args.first.id, args.first.class.name]) }
+  scope :recent, lambda { |*args| where(["created_at > ?", (args.first || 2.weeks.ago)]) }
+  scope :descending, order("created_at DESC")
+
+  belongs_to :faveable, :polymorphic => true
+  belongs_to :faver, :polymorphic => true
+
+  attr_accessible :faver, :faveable
+
+  validates_uniqueness_of :faveable_id, :scope => [:faveable_type, :faver_type, :faver_id]
+
+end

data/lib/generators/fav_star/templates/migration.rb

@@ -0,0 +1,22 @@
+class FavStarMigration < ActiveRecord::Migration
+  def self.up
+
+    create_table :faves, :force => true do |t|
+      t.references :faveable, :polymorphic => true, :null => false
+      t.references :faver,    :polymorphic => true
+      t.timestamps
+    end
+
+    add_index :faves, ["faver_id", "faver_type"],       :name => "fk_favers"
+    add_index :faves, ["faveable_id", "faveable_type"], :name => "fk_faveables"
+    add_index :faves, ["faver_id", "faver_type", "faveable_id", "faveable_type"], :unique => true, :name => "only_one_fav_per_user"
+
+  end
+
+  def self.down
+
+    drop_table :faves
+
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: fav_star
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Brady Bouchard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-19 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: fav_star provides a fairly straightforward module that allows you to keep track of which models your users have favourited.
+email: brady@ldawn.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- CHANGELOG.markdown
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- fav_star.gemspec
+- lib/acts_as_faveable.rb
+- lib/acts_as_faver.rb
+- lib/fav_star.rb
+- lib/generators/fav_star/fav_star_generator.rb
+- lib/generators/fav_star/templates/fave.rb
+- lib/generators/fav_star/templates/migration.rb
+has_rdoc: true
+homepage: http://github.com/brady8/favstar
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mark your ActiveRecord models as favourites with only a couple of lines of code.
+test_files: []
+