is_rateable 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cacf75857fb169b5a451217c907216a376c22b9
-  data.tar.gz: ed563dfbe246777073cb28c79c62e468021f31a9
+  metadata.gz: 4f3bcffc749baa5893e0114cff2181930112b5b9
+  data.tar.gz: 561b773c80ef4fd89724ab48930c798f971761a8
 SHA512:
-  metadata.gz: 0707cd528f170a9d8d44afe01e1f18a39bf912ebc534851b7676d200b451594d41b0c565a56f5106543fd377c23075cf54fbd8266436c81ccfcda745ea2dfd84
-  data.tar.gz: 8fd01f8552e7186d08240e563ca9b405ea1db4456903538eb1181a66c1abf19698385a53a4206b77b85117f5df02cab6006bc0952f27e1bc6664723ec235223d
+  metadata.gz: bc052d062be289510a13d0185d0eabd40caae01fa1f7682033719e87d75c80b926475403733bc5bb148dd1590d90ab26105cd8ec0e31fe3f5820be515c4fc789
+  data.tar.gz: 892be645487d653acd682347893e686249e7d12a0b677c11c4d20091288e3255d4bb0e8d74b8b3226fbfe7d68be57247bc944958d84b15b58ea8c1be67ef914d

data/.gitignore

@@ -7,3 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/README.md

@@ -22,13 +22,11 @@ Or install it yourself as:
 
 ## Getting Started
 
-### Adding the ratings table.
+### Adding the ratings table and initializer.
 
     $ rails generate is_rateable:install
     $ rake db:migrate 
 
-This will create a migration adding a ratings table for you.
-
 **If you are using UUIDS:** 
 
     $ rails generate is_rateable:install --id_column_type uuid
@@ -36,6 +34,14 @@ This will create a migration adding a ratings table for you.
 
 This makes sure that the references to your `rater` and `ratee` uses a `:uuid` column rather than an `:integer` one
 
+### Configuring the initializer
+
+in `config/initializers/is_rateable.rb`:
+
+`minimum_ratings_for_average` sets the amount of ratings an object must have before the average is calculated. This stops the ratings swaying wildly when an object is new.
+
+`default_rating` sets the rating that is returned if the object does not have enough ratings for the average, and you ask for it's `average_rating`
+
 ### Configuring your models
 
 For the object that you wish to be rateable:
@@ -118,13 +124,22 @@ This shows the average of all ratings applied to an object. Rounded to the neare
 
 **All Ratings that an object as given to another object:**
 
-Ratings that an object has applied to another object are stored as `rater_ratings`.
+Ratings that an object has applied to another object are stored as `rated_ratings`.
 
 ```ruby
-@user.rater_ratings
+@user.rated_ratings
 => ActiveRecord::Association: []
 ```
 
+**Rating that a rater has given to a particular object:**
+
+If the object has rated something more than once, then it will return the average rating they have provided for that object (eg. Uber if you have had the same driver multiple times).
+
+```ruby
+@user.rating_for(@movie)
+=> 5.0
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,2 +1,21 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/is_rateable/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/is_rateable.gemspec

@@ -2,6 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'is_rateable/version'
+require 'rails/all'
 
 Gem::Specification.new do |spec|
   spec.name          = "is_rateable"
@@ -26,4 +27,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
+  spec.add_development_dependency 'factory_girl_rails'
+  spec.add_development_dependency 'pry'
 end

data/lib/generators/is_rateable/install/install_generator.rb

@@ -6,6 +6,10 @@ module IsRateable
 
     source_root File.expand_path('../templates', __FILE__)
 
+    def create_initializer
+      template 'initializer.rb', 'config/initializers/is_rateable.rb'
+    end
+
     def copy_migrations
       migration_template 'migration_ratings.rb', "db/migrate/create_is_rateable_ratings.rb"
     end

data/lib/generators/is_rateable/install/templates/initializer.rb

@@ -0,0 +1,6 @@
+IsRateable.setup do |config|
+  # Return the default raitng for ratee, when they have not received any ratings
+  config.default_rating = 5.0
+  # Limit the amount of ratings an object must have received before it returns the average
+  config.minimum_ratings_for_average = 0
+end

data/lib/is_rateable/acts_as_rateable.rb

@@ -10,6 +10,7 @@ module IsRateable
         include IsRateable::ActsAsRateable::LocalInstanceMethods
 
         has_many :ratee_ratings, as: :ratee, class_name: 'IsRateable::Rating'
+
       end
     end
 
@@ -17,6 +18,7 @@ module IsRateable
       # Find the Average rating for the ratee.
       # Return 0.0 if they have not been rated yet.
       def average_rating
+        return IsRateable.default_rating unless enough_ratings_for_average?
         any_ratings? ? ((ratee_ratings.average(:score) * 10).round / 10.0) : 0.0
       end
 
@@ -25,6 +27,11 @@ module IsRateable
         ratee_ratings.any?
       end
 
+      # Has the object received enough ratings to show the average?
+      def enough_ratings_for_average?
+        any_ratings? && ratee_ratings.length > IsRateable.minimum_ratings_for_average
+      end
+
       # Easily add a new rating to the object by calling Object.add_rating(score: 5, rater: user)
       # Pass in the entire rater object in, rather than the id.
       def add_rating(options = {})

data/lib/is_rateable/acts_as_rater.rb

@@ -19,6 +19,12 @@ module IsRateable
       def rated_any?
         rated_ratings.any?
       end
+
+      # Return the objects rating for another object
+      def rating_for(ratee)
+        return nil unless rated_ratings.where(ratee: ratee).first
+        ((rated_ratings.where(ratee: ratee).average(:score) * 10).round / 10.0)
+      end
     end
   end
 end

data/lib/is_rateable/version.rb

@@ -1,3 +1,3 @@
 module IsRateable
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

data/lib/is_rateable.rb

@@ -7,6 +7,14 @@ module IsRateable
   autoload :ActsAsRateable,'is_rateable/acts_as_rateable'
   autoload :ActsAsRater, 'is_rateable/acts_as_rater'
 
+  # Method retrieve the default rating:
+  mattr_accessor :default_rating
+  @@default_rating = nil
+
+  # Method to retrieve minimum ratings before we show the average:
+  mattr_accessor :minimum_ratings_for_average
+  @@minimum_ratings_for_average = nil
+
   # Default way to setup IsRateable:
   def self.setup
     yield self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: is_rateable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Isaac Norman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allow any model to become rateable by any other model in your rails app.
 email:
 - idn@papercloud.com.au
@@ -75,9 +131,11 @@ files:
 - Rakefile
 - app/models/is_rateable/rating.rb
 - bin/console
+- bin/rails
 - bin/setup
 - is_rateable.gemspec
 - lib/generators/is_rateable/install/install_generator.rb
+- lib/generators/is_rateable/install/templates/initializer.rb
 - lib/generators/is_rateable/install/templates/migration_ratings.rb
 - lib/is_rateable.rb
 - lib/is_rateable/acts_as_rateable.rb
@@ -109,4 +167,3 @@ signing_key:
 specification_version: 4
 summary: 5 star ratings for your Rails models
 test_files: []
-has_rdoc: