is_rateable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f5e220972a5694adf478b2053074fc90411e855
+  data.tar.gz: e82e8da2e5e0bdd73f8d3d4434c516fb5478dcd9
+SHA512:
+  metadata.gz: 0bb6f90f10352c14b70fbed38f54f7d0a1b7f72e5c04fa8f9509ed8e00201999c76b4e9ed9d82ca51fab99a1a676db2c902844610a4938cf0c3826cfed899212
+  data.tar.gz: 30f163df295fb93cdc27dd7dd914cbd096eeb2e25584b38bc6bf2283a6bc4bdb41e06911001a8f80460d05c54aa7ffd4fb73c2bcbfdf5ef437bc40473e4b7115

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in is_rateable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Isaac Norman
+
+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.md

@@ -0,0 +1,131 @@
+# IsRateable
+
+### Easily drop a rating system into your Rails project. 
+
+IsRateable allows any object to be rateable by any other object with very little setup. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'is_rateable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install is_rateable
+
+## Getting Started
+
+### Adding the ratings table.
+
+    $ 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
+    $ rake db:migrate 
+
+This makes sure that the references to your `rater` and `ratee` uses a `:uuid` column rather than an `:integer` one
+
+### Configuring your models
+
+For the object that you wish to be rateable:
+
+```ruby 
+class MyModel < ActiveRecord::Base
+  acts_as_rateable
+
+  # your code here...
+end
+```
+
+For the object you wish to be able to submit ratings:
+
+```ruby
+class MyModel < ActiveRecord::Base
+  acts_as_rater
+
+  # your code here...
+end
+```
+
+This will give you access to all the methods describe below.
+
+## Usage
+
+### Adding a new rating
+
+The `Rating` is created from the object that `acts_as_rateable`. It takes 2 options:
+
+* `rater:` The object setting the rating.
+* `score:` The score of the rating.
+
+As an example lets say that we have a `Movie` model, that can be rated by `Users`.
+
+```ruby
+@user = User.first
+@movie = Movie.find_by(name: 'Toy Story 2')
+
+@movie.add_rating(score: 5, rater: user)
+```
+
+**NOTE:** The `add_rating` method expects the object of the rater to be passed in, not just the `id`.
+
+### Viewing Ratings
+
+**All ratings that have been added to the object:**
+
+Ratings applied to an object are called `ratee_ratings`
+
+```ruby 
+@movie.ratee_ratings
+=> ActiveRecord::Association: []
+```
+
+**Average rating of an object:**
+
+This shows the average of all ratings applied to an object. Rounded to the nearest `0.1`
+
+```ruby 
+@movie.average_rating
+=> 4.8
+```
+
+**Has the object been rated at all?:**
+
+```ruby
+@movie.any_ratings?
+=> true
+```
+
+### Viewing Raters
+
+**Has the object rated anything?:
+
+```ruby
+@user.rated_any?
+=> true
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/Papercloud/is_rateable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/models/is_rateable/rating.rb

@@ -0,0 +1,12 @@
+module IsRateable
+  class Rating < ActiveRecord::Base
+    # Associations
+    belongs_to :rater, polymorphic: true
+    belongs_to :ratee, polymorphic: true
+
+    # Validations
+    validates :rater, presence: true
+    validates :ratee, presence: true
+    validates :score, presence: true
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "is_rateable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/is_rateable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'is_rateable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "is_rateable"
+  spec.version       = IsRateable::VERSION
+  spec.authors       = ["Isaac Norman"]
+  spec.email         = ["idn@papercloud.com.au"]
+
+  if spec.respond_to?(:metadata)
+  end
+
+  spec.summary       = '5 star ratings for your Rails models'
+  spec.description   = 'Allow any model to become rateable by any other model in your rails app.'
+  spec.homepage      = "https://github.com/Papercloud/is_rateable."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

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

@@ -0,0 +1,23 @@
+module IsRateable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    class_option :id_column_type, type: :string, aliases: '-id', default: 'integer', desc: 'Column type used for ids. Either integer(default) or uuid'
+    desc 'Add the ratings table, allowing models to be rated.'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_migrations
+      migration_template 'migration_ratings.rb', "db/migrate/create_is_rateable_ratings.rb"
+    end
+
+    # Implement the required interface for Rails::Generators::Migration.
+    def self.next_migration_number(dirname)
+      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
+  end
+end

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

@@ -0,0 +1,15 @@
+class CreateIsRateableRatings < ActiveRecord::Migration
+  def change
+    create_table :is_rateable_ratings do |t|
+      t.<%= options['id_column_type'] -%> :rater_id, nil: false
+      t.<%= options['id_column_type'] -%> :ratee_id, nil: false
+      t.string :rater_type
+      t.string :ratee_type
+      t.integer :score, nil: false, default: 0
+      t.timestamps
+    end
+    add_index :is_rateable_ratings, :rater_id
+    add_index :is_rateable_ratings, :ratee_id
+    add_index :is_rateable_ratings, :score
+  end
+end

data/lib/is_rateable/acts_as_rateable.rb

@@ -0,0 +1,35 @@
+module IsRateable
+  module ActsAsRateable
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_rateable(options = {})
+        include IsRateable::ActsAsRateable::LocalInstanceMethods
+
+        has_many :ratee_ratings, as: :ratee, class_name: 'IsRateable::Rating'
+      end
+    end
+
+    module LocalInstanceMethods
+      # Find the Average rating for the ratee.
+      # Return 0.0 if they have not been rated yet.
+      def average_rating
+        any_ratings? ? ((ratee_ratings.average(:score) * 10).round / 10.0) : 0.0
+      end
+
+      # Has this object been rated before?
+      def any_ratings?
+        ratee_ratings.any?
+      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 = {})
+        Rating.create(score: options[:score], rater: options[:rater], ratee: self)
+      end
+    end
+  end
+end

data/lib/is_rateable/acts_as_rater.rb

@@ -0,0 +1,24 @@
+module IsRateable
+  module ActsAsRater
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_rater(options = {})
+        include IsRateable::ActsAsRater::LocalInstanceMethods
+
+        has_many :rated_ratings, as: :rater, class_name: 'IsRateable::Rating'
+      end
+    end
+
+    module LocalInstanceMethods
+
+      # Has this object rated anything yet?
+      def rated_any?
+        rated_ratings.any?
+      end
+    end
+  end
+end

data/lib/is_rateable/engine.rb

@@ -0,0 +1,12 @@
+module IsRateable
+  class Engine < ::Rails::Engine
+    isolate_namespace IsRateable
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/is_rateable/version.rb

@@ -0,0 +1,3 @@
+module IsRateable
+  VERSION = "0.1.0"
+end

data/lib/is_rateable.rb

@@ -0,0 +1,21 @@
+require "is_rateable/engine"
+require "is_rateable/version"
+
+module IsRateable
+  extend ActiveSupport::Autoload
+
+  autoload :ActsAsRateable,'is_rateable/acts_as_rateable'
+  autoload :ActsAsRater, 'is_rateable/acts_as_rater'
+
+  # Default way to setup IsRateable:
+  def self.setup
+    yield self
+  end
+end
+
+module ActiveRecord
+  class Base
+    include IsRateable::ActsAsRateable
+    include IsRateable::ActsAsRater
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: is_rateable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isaac Norman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Allow any model to become rateable by any other model in your rails app.
+email:
+- idn@papercloud.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/is_rateable/rating.rb
+- bin/console
+- bin/setup
+- is_rateable.gemspec
+- lib/generators/is_rateable/install/install_generator.rb
+- lib/generators/is_rateable/install/templates/migration_ratings.rb
+- lib/is_rateable.rb
+- lib/is_rateable/acts_as_rateable.rb
+- lib/is_rateable/acts_as_rater.rb
+- lib/is_rateable/engine.rb
+- lib/is_rateable/version.rb
+homepage: https://github.com/Papercloud/is_rateable.
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: 5 star ratings for your Rails models
+test_files: []
+has_rdoc: