weighted_score 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf9b789f6fe7b367bb6e5d93f8f2530be7a73bd9
+  data.tar.gz: fe9f3e164943751f0aa47e35b0fb29a7e0181af5
+SHA512:
+  metadata.gz: cb13747fb4259622252300f5d10275ec830bf9482f8a41b44d81da1cacbfae2a4686e34ec19e69bd5442d1b7759967ab9456ccea833890f2ef6c6938591b5ba6
+  data.tar.gz: 5a417b1f8c45f70472bf3b4037b3e916e9e05157605d145ee7ffb94668f44b947f9aaaaaf11ba5cf9395ef2d59085c44cc5b4fba139cfbd1aa4d918f9589d87d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 alexpeachey
+
+MIT License
+
+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,120 @@
+# WeightedScore
+
+Weighted Score provides a light weight framework for creating weighted
+scoring systems. It allows you to calculate weighted scores using score
+calculator classes for each of the weighted components.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'weighted_score'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weighted_score
+
+## Usage
+
+Start by creating one or more score calculating classes.
+You can optionally subclass `WeightedScore::Score`.
+If you do not subclass the provided `Score` class then
+you your initializer should accept one argument which represents
+the scorable item and you must implement a `calculate` method.
+
+**Either way the `calculate` method must return a numeric value.**
+
+```ruby
+require 'weighted_score'
+
+class CriteriaOne < WeightedScore::Score
+  def calculate
+    return 1 if scorable >= 10
+    0
+  end
+end
+
+class CriteriaTwo < WeightedScore::Score
+  def calculate
+    return 1 if scorable.even?
+    0
+  end
+end
+
+class CriteriaThree < WeightedScore::Score
+  def calculate
+    return 1 if scorable % 4 == 0
+    0
+  end
+end
+```
+
+Then create a weighted score calculator class:
+
+```ruby
+require 'weighted_score'
+
+class Calculator < WeightedScore::WeightedScore
+  score CriteriaOne => 0.5
+  score CriteriaTwo => 0.25
+  score CriteriaThree => 0.25
+end
+```
+
+Finally, you can then use it like this:
+
+```ruby
+Calculator.new(5).calculate      #=> 0
+Calculator.new(2).calculate      #=> 0.25
+Calculator.new(4).calculate      #=> 0.5
+Calculator.new(12).calculate     #=> 1
+Calculator.new(13).calculate     #=> 0.5
+Calculator.new(14).calculate     #=> 0.75
+```
+
+## An Example Customer Valuation Calculator
+
+```ruby
+require 'weighted_score'
+
+class EmailScore < WeightedScore::Score
+  def calculate
+    return 1 if scorable.email.present?
+    0
+  end
+end
+
+class NewsletterScore < WeightedScore::Score
+  def calculate
+    return 1 if scorable.newsletter_status == 'subscribed'
+    0
+  end
+end
+
+class OrdersScore < WeightedScore::Score
+  def calculate
+    scorable.orders.size - scorable.returns.size
+  end
+end
+
+class CustomerValuation < WeightedScore::WeightedScore
+  score EmailScore => 5
+  score NewsletterScore => 10
+  score OrdersScore => 1
+end
+
+CustomerValuation.new(user).calculate
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/Originate/weighted_score/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,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'weighted_score'
+  ARGV.clear
+  IRB.start
+end

data/lib/weighted_score/score.rb

@@ -0,0 +1,13 @@
+module WeightedScore
+  class Score
+    attr_reader :scorable
+
+    def initialize(scorable)
+      @scorable = scorable
+    end
+
+    def calculate
+      1
+    end
+  end
+end

data/lib/weighted_score/version.rb

@@ -0,0 +1,3 @@
+module WeightedScore
+  VERSION = '0.0.1'
+end

data/lib/weighted_score/weighted_score.rb

@@ -0,0 +1,23 @@
+module WeightedScore
+  class WeightedScore
+    attr_reader :scorable
+
+    def initialize(scorable)
+      @scorable = scorable
+    end
+
+    def self.score_map
+      @score_map ||= {}
+    end
+
+    def self.score(score_value)
+      @score_map = score_map.merge score_value
+    end
+
+    def calculate
+      self.class.score_map.keys.reduce(0) do |total, score|
+        total += score.new(scorable).calculate * self.class.score_map[score]
+      end
+    end
+  end
+end

data/lib/weighted_score.rb

@@ -0,0 +1,6 @@
+require 'weighted_score/version'
+require 'weighted_score/weighted_score'
+require 'weighted_score/score'
+
+module WeightedScore
+end

data/spec/examples.rb

@@ -0,0 +1,26 @@
+class CriteriaOne < WeightedScore::Score
+  def calculate
+    return 1 if scorable >= 10
+    0
+  end
+end
+
+class CriteriaTwo < WeightedScore::Score
+  def calculate
+    return 1 if scorable.even?
+    0
+  end
+end
+
+class CriteriaThree < WeightedScore::Score
+  def calculate
+    return 1 if scorable % 4 == 0
+    0
+  end
+end
+
+class Calculator < WeightedScore::WeightedScore
+  score CriteriaOne => 0.5
+  score CriteriaTwo => 0.25
+  score CriteriaThree => 0.25
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'weighted_score'
+require 'examples'

data/spec/weighted_score_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'Exercising the scoring system' do
+  subject(:calculator) { Calculator.new(test_case) }
+
+  describe '#calculate' do
+    context 'when the test_case is 5' do
+      let(:test_case) { 5 }
+
+      specify { expect(calculator.calculate).to eq 0 }
+    end
+  end
+
+  describe '#calculate' do
+    context 'when the test_case is 2' do
+      let(:test_case) { 2 }
+
+      specify { expect(calculator.calculate).to eq 0.25 }
+    end
+  end
+
+  describe '#calculate' do
+    context 'when the test_case is 4' do
+      let(:test_case) { 4 }
+
+      specify { expect(calculator.calculate).to eq 0.5 }
+    end
+  end
+
+  describe '#calculate' do
+    context 'when the test_case is 12' do
+      let(:test_case) { 12 }
+
+      specify { expect(calculator.calculate).to eq 1 }
+    end
+  end
+
+  describe '#calculate' do
+    context 'when the test_case is 13' do
+      let(:test_case) { 13 }
+
+      specify { expect(calculator.calculate).to eq 0.5 }
+    end
+  end
+
+  describe '#calculate' do
+    context 'when the test_case is 14' do
+      let(:test_case) { 14 }
+
+      specify { expect(calculator.calculate).to eq 0.75 }
+    end
+  end
+end

data/weighted_score.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weighted_score/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'weighted_score'
+  spec.version       = WeightedScore::VERSION
+  spec.authors       = ['alexpeachey']
+  spec.email         = ['alex.peachey@gmail.com']
+  spec.summary       = %q{Calculate Weighted Scores}
+  spec.description   = %q{Calculate Weighted Scores}
+  spec.homepage      = 'https://github.com/Originate/weighted_score'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: weighted_score
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: Calculate Weighted Scores
+email:
+- alex.peachey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/weighted_score.rb
+- lib/weighted_score/score.rb
+- lib/weighted_score/version.rb
+- lib/weighted_score/weighted_score.rb
+- spec/examples.rb
+- spec/spec_helper.rb
+- spec/weighted_score_spec.rb
+- weighted_score.gemspec
+homepage: https://github.com/Originate/weighted_score
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Calculate Weighted Scores
+test_files:
+- spec/examples.rb
+- spec/spec_helper.rb
+- spec/weighted_score_spec.rb