five-star 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 408c38478386dfd30afac94401ef9f609a4102c1
+  data.tar.gz: ce73a704c2f2ef208f45d5ab95759e05f30f19be
+SHA512:
+  metadata.gz: f8fb0c43adac3af9fd729f1326ab1e3b8dfc0e18ea1e72f4a7065582cdfc5ece24ca2b7b7c5d867380ca6919d06ab1d80a8f3037ab973b1fcee873962c9af6ee
+  data.tar.gz: f988375e92f8224ae05b7d5956da34134fe47080ea74d5d1510631017760ad8e184e3bd81d57e17fc2682fb3a272aee7b80e3110ca57fd7642f1238715070355

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
+  - rbx
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx
+
+before_install: gem install bundler
+
+addons:
+   code_climate:
+     repo_token: aaa2bcd71ac641474a13caabe294beeb26abcc7c4dd82f3395a7b9193bb20d02

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, ethnicity, 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 five-star.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Robert Murray
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rob Murray
+
+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,167 @@
+# FiveStar
+### A generic rating library :star:
+
+[![Build Status](https://travis-ci.org/rob-murray/five-star.svg?branch=master)](https://travis-ci.org/rob-murray/five-star)
+[![Code Climate](https://codeclimate.com/github/rob-murray/five-star.png)](https://codeclimate.com/github/rob-murray/five-star)
+[![Coverage Status](https://coveralls.io/repos/rob-murray/five-star/badge.png)](https://coveralls.io/r/rob-murray/five-star)
+[![Dependency Status](https://gemnasium.com/rob-murray/five-star.svg)](https://gemnasium.com/rob-murray/five-star)
+[![Gem Version](https://badge.fury.io/rb/five-star.svg)](http://badge.fury.io/rb/five-star)
+
+:star: **FiveStar** :star: is a library to build a rating system - it allows you to rate *something* in your domain by classification or criteria you define. This library gives you the structure to rate your object with as many of these different classifications as you like with the overall rating as a weighted average.
+
+This uses Plain Old Ruby Objects so can be used in any project. Implement or use whatever persistence layer you want.
+
+> Not sure if this is a gem or just a code design pattern :/
+
+## Example
+
+Say you implemented a film rating system, you have lots of `Film` objects each with different attributes and you would like to show an overall rating for each film based on classifications below.
+
+* Gore - Amount of blood in the movie - weighting: 40%
+* Sex - Number of references to sex in the movie - weighting: 40%
+* Swearing - Number of swear words in the movie - weighting: 20%
+
+This could be implemented as follows.
+
+```ruby
+class Film
+  include FiveStar.rateable
+
+  rate_with GoreRater, SwearingRater, SexRater
+
+  # rest of you implementation
+end
+
+class GoreRater < FiveStar.base_rater
+  rating_weight 0.4
+
+  def description
+    "This Film was rated #{rating} for gore"
+  end
+
+  def rating
+    # count the pints of blood spilt in the film
+  end
+end
+
+class SwearingRater < FiveStar.base_rater
+  rating_weight 0.2
+
+  def description
+    "This Film was has #{number_of_swear_words} and was rated at #{rating}"
+  end
+
+  def rating
+    # count the number of swear words in the film
+  end
+end
+
+film = Film.new
+film.rating # => 6
+film.rating_descriptions # => ["This Film was rated 8 for gore", ...]
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'five-star'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install five-star
+
+
+## Usage
+
+There are two components required, the thing being rated and how it is rated - the thing you want rated is defined as being rateable and you can have one or more "raters" to give it a rating. You must implement your these raters and provide the classes to the item being rated, this library takes care of the rest.
+
+* `Rateable` - This is the object that can be rated based on
+* `Rater` - A class that knows how to give a rating to the object being rated
+
+Each `Rater` must return a rating within the scale given and a weighting which will be used to calculate the overall rating.
+
+The current rating scale used is 0 - 10 as floating point numbers that can be rounded as you require.
+
+### Rateable
+
+This module when included gives the object the following interface on the instance.
+
+* `rating` - `[Float]` -  The overall rating calculated
+* `rating_descriptions` - `[Array]` - A list of the description from each rater class
+
+The classes used to rate the object can be specified using the class method `rate_with(*class_names)` and passing in one or more rating classes.
+
+```ruby
+class Film
+  include FiveStar.rateable
+
+  rate_with GoreRater, SwearingRater, SexRater
+...
+
+film = Film.new
+film.rating # => 6
+film.rating_descriptions # => ["This Film was rated 8 for gore", ...]
+```
+
+### Rater
+
+You can create your own rating classes however you like but they should respond to the following methods;
+
+* `rating` - `[Float]` - The rating for the object being rated
+* `description` - `[String]` - A description of the rating, eg reason it was rated at that value
+* `weighting` - `[Float]` - The weighting for this classification
+
+The **FiveStar** will call `build` method on the `Rater` with the argument of the instance of class being rated which should do any setup and return an instance of the rater.
+
+For simplicity you can subclass `FiveStar.base_rater` and get the following for free.
+
+* `rating_weight` - Class method to set the weighting for this rater
+* `rateable` - Instance method referencing the object being rated
+* `min_rating` - Instance method returning the minimum rating value
+* `max_rating` - Instance method returning the maximum rating value
+
+For example a basic version could be something like this;
+
+```ruby
+class GoreRater < FiveStar.base_rater
+  rating_weight 0.4
+
+  def description
+    "This Film was rated #{rating} for gore"
+  end
+
+  def rating
+    # calculate rating somehow
+  end
+end
+```
+
+### Rating calculation
+
+The calculation used will be a weighted average based on each rating and the weighting. If weighting is not required then all will be use the default value and therefore be weighted the same which is just a normal mean average calculation.
+
+The minimum rating is 0.0 and the maximum is 10.0
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/five-star. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "five-star"
+
+# 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

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/five-star.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "five-star/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "five-star"
+  spec.version       = FiveStar::VERSION
+  spec.authors       = ["Rob Murray"]
+  spec.email         = ["robmurray17@gmail.com"]
+
+  spec.summary       = %q{:star: A generic rating library :star:}
+  spec.description   = %q{A Rating system for your Ruby objects; Rate an object with one or more rating classifications.}
+  spec.homepage      = "https://github.com/rob-murray/five-star"
+  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.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/five-star.rb

@@ -0,0 +1,16 @@
+require "five-star/version"
+require "five-star/base_rater"
+require "five-star/rateable"
+require "five-star/rating_calculator"
+
+module FiveStar
+  class << self
+    def rateable
+      Rateable
+    end
+
+    def base_rater
+      BaseRater
+    end
+  end
+end

data/lib/five-star/base_rater.rb

@@ -0,0 +1,43 @@
+module FiveStar
+  class BaseRater
+    def self.build(rateable)
+      new(rateable)
+    end
+
+    def self.rating_weight(weighting)
+      @weighting = weighting
+    end
+
+    def self.weighting
+      @weighting ||= 1.0
+    end
+
+    def initialize(rateable)
+      @rateable = rateable
+    end
+
+    def description
+      "#{self.class} rated #{rateable.class} at #{rating} with weighting of #{weighting}"
+    end
+
+    def rating
+      0
+    end
+
+    def weighting
+      self.class.weighting
+    end
+
+    protected
+
+    attr_reader :rateable
+
+    def max_rating
+      10
+    end
+
+    def min_rating
+      0
+    end
+  end
+end

data/lib/five-star/rateable.rb

@@ -0,0 +1,45 @@
+module FiveStar
+  module Rateable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def rate_with(*klasses)
+        @rating_klasses = Array(klasses)
+      end
+
+      def rating_klasses
+        @rating_klasses ||= []
+      end
+    end
+
+    def rating
+      rating_calculator.rate(raters)
+    end
+
+    def rating_descriptions
+      raters.map { |rater| rater.description }
+    end
+
+    protected
+
+    def rateable
+      self
+    end
+
+    private
+
+    def raters
+      @raters ||= rating_klasses.map { |rater| rater.build(rateable) }
+    end
+
+    def rating_klasses
+      rateable.class.rating_klasses
+    end
+
+    def rating_calculator
+      RatingCalculator
+    end
+  end
+end

data/lib/five-star/rating_calculator.rb

@@ -0,0 +1,24 @@
+module FiveStar
+  class RatingCalculator
+    def self.rate(raters)
+      new(raters).calculate_rating
+    end
+
+    def initialize(raters)
+      @raters = raters
+    end
+
+    def calculate_rating
+      return 0 unless raters.any?
+
+      sum_total = raters.map { |rater| rater.rating * rater.weighting }.inject(&:+)
+      weights_total = raters.map(&:weighting).inject(&:+)
+
+      sum_total / weights_total.to_f
+    end
+
+    private
+
+    attr_reader :raters
+  end
+end

data/lib/five-star/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: five-star
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Murray
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: codeclimate-test-reporter
+  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: A Rating system for your Ruby objects; Rate an object with one or more
+  rating classifications.
+email:
+- robmurray17@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- five-star.gemspec
+- lib/five-star.rb
+- lib/five-star/base_rater.rb
+- lib/five-star/rateable.rb
+- lib/five-star/rating_calculator.rb
+- lib/five-star/version.rb
+homepage: https://github.com/rob-murray/five-star
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: ":star: A generic rating library :star:"
+test_files: []