spleen 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2011 Laurent Arnoud <laurent@spkdev.net>
+
+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,11 @@
+# Ratings for Rails 3
+
+    gem 'spleen'
+
+    bundle exec rails generate spleen:install
+
+# LICENSE
+
+The MIT License
+
+Copyright (c) 2011 Laurent Arnoud <laurent@spkdev.net>

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  rateable:
+    already_rated: Already rated

data/lib/generators/spleen/install_generator.rb

@@ -0,0 +1,39 @@
+require 'securerandom'
+require 'rails/generators/migration'
+
+module Spleen
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Copy model and locale files to your application and generate migration."
+      class_option :orm
+
+      def copy_locale
+        copy_file "../../../../config/locales/en.yml", "config/locales/ratings.en.yml"
+      end
+
+      def copy_model
+        template "model.rb", "app/models/rating.rb"
+      end
+
+      def copy_rating_migration
+        migration_template "migration.rb", "db/migrate/create_ratings"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+      # Taken from ActiveRecord's migration generator
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/generators/spleen/templates/README

@@ -0,0 +1,22 @@
+===============================================================================
+
+    bundle exec rake db:migrate
+
+In your ratable models:
+
+    extend Spleen
+    spleen(:dependent => :destroy)
+
+Add your Rateable types in app/models/ratings.rb:
+  RATEABLE_TYPES = %w{SomeRateableClass}
+
+By default the ratetor is User, you can add some or edit in the same file.
+
+Examples:
+
+    a = Article.create(:title => 'test')
+    a.rate(1, User.last)
+    a.ratings # => [#<Rating id: 1, ...]
+    a.average_rate # => 1.0
+    a.sum_rate # => 1
+    a.count_rate # => 1

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

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+class CreateRatings < ActiveRecord::Migration
+  def self.up
+    create_table(:ratings) do |t|
+      t.column :ratetor_id, :integer, :null => false
+      t.column :ratetor_type, :string, :null => false
+      t.column :rate, :float, :null => false
+      t.column :rateable_id, :integer, :null => false
+      t.column :rateable_type, :string
+
+      t.timestamps
+    end
+
+    add_index :ratings, [:rateable_id, :rateable_type]
+  end
+
+  def self.down
+    drop_table :ratings
+  end
+end

data/lib/generators/spleen/templates/model.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+class Rating < ActiveRecord::Base
+  RATEABLE_TYPES = %w{}
+  RATETOR_TYPES = %w{User}
+  belongs_to :rateable, :polymorphic => true
+  belongs_to :ratetor, :polymorphic => true
+
+  validates_presence_of :rateable, :ratetor
+  validates_inclusion_of :rateable_type, :in => RATEABLE_TYPES
+  validates_inclusion_of :ratetor_type, :in => RATETOR_TYPES
+  validates_uniqueness_of :ratetor_id, :scope => [:rateable_id, :rateable_type],
+    :message => proc {I18n.t('rateable.already_rated')}
+end

data/lib/spleen.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+require 'rails'
+
+module Spleen
+  def self.extended(model_class)
+    model_class.instance_eval do
+      extend Base
+    end
+
+    model_class.class_eval do
+      ##
+      # @param [Float] value
+      # @param [ActiveRecord::Base] ratetor
+      # @return [Boolean] TrueClass is rate saved else FalseClass
+      #
+      def rate(value, ratetor)
+        r = Rating.new(
+          :ratetor => ratetor,
+          :rateable_type => ratetor.class.to_s,
+          :rate => value,
+          :rateable => self,
+          :rateable_type => self.class.to_s,
+          :rateable_id => self.id
+        )
+        if r.valid?
+          r.save
+        else
+          r.errors.full_messages.each do |e|
+            self.errors.add(:base, e)
+          end
+          false
+        end
+      end
+
+      ##
+      # Helper method that returns the average rating
+      #
+      def average_rate
+        Rating.calculate(:average, :rate,
+                         :conditions => {
+          :rateable_type => self.class.to_s,
+          :rateable_id => self.id
+        }).to_f
+      end
+      ##
+      # Helper method that returns the sum rate
+      #
+      def sum_rate
+        Rating.calculate(:sum, :rate,
+                         :conditions => {
+          :rateable_type => self.class.to_s,
+          :rateable_id => self.id
+        }).to_i
+      end
+      ##
+      # Helper method that returns the count rate
+      #
+      def count_rate
+        Rating.calculate(:count, :rate,
+                         :conditions => {
+          :rateable_type => self.class.to_s,
+          :rateable_id => self.id
+        }).to_i
+      end
+    end
+  end
+
+  module Base
+    def spleen(opts={})
+      options = {:as => :rateable}
+      options.merge!(opts)
+      has_many :ratings, options
+    end
+  end
+end

data/spleen.gemspec

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name = "spleen"
+  s.version = '0.0.1'
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Ratings solution for Rails"
+  s.email = "laurent@spkdev.net"
+  s.homepage = "http://github.com/spk/spleen"
+  s.description = "Ratings model solution for Rails"
+  s.authors = ['Laurent Arnoud']
+
+  s.files = `git ls-files`.split("\n")
+  #s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: spleen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Laurent Arnoud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-07 00:00:00.000000000Z
+dependencies: []
+description: Ratings model solution for Rails
+email: laurent@spkdev.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- config/locales/en.yml
+- lib/generators/spleen/install_generator.rb
+- lib/generators/spleen/templates/README
+- lib/generators/spleen/templates/migration.rb
+- lib/generators/spleen/templates/model.rb
+- lib/spleen.rb
+- spleen.gemspec
+homepage: http://github.com/spk/spleen
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Ratings solution for Rails
+test_files: []
+has_rdoc: