slide_rule 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 006868b9cca39594d800bf786a49dc9fd3b733cd
+  data.tar.gz: 09282b0628ea97599120d36e53602b9ec7819a9a
+SHA512:
+  metadata.gz: 22599f361ab8bd3a3cb514f786b3e314ef4e8f7c20c74732cf225e471722d0c8262c67fb57b4b3fc30905ba34c5719ca773e7185f363ce4911b5cdf2bcff0216
+  data.tar.gz: 3a712c9ff14c6d08e26847ff0d8308524528a00e2e10eed5ffd03884affee53acc8c42b498e3d03d2555ad6d648f3ab25991bbdd27fe4d96317cbef53f8791de

data/.gitignore

@@ -0,0 +1,3 @@
+.rspec
+**.DS_Store
+Guardfile

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'bin/**/*'
+    - 'coverage/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'lib/core_ext/pkcs12.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*'
+    - 'slide_rule.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,41 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-11-02 16:38:15 -0700 using RuboCop version 0.34.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/slide_rule/distance_calculator.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Style/Next:
+  Exclude:
+    - 'lib/slide_rule/distance_calculator.rb'
+
+# Offense count: 1
+# Configuration parameters: Methods.
+Style/SingleLineBlockParams:
+  Exclude:
+    - 'lib/slide_rule/distance_calculator.rb'

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'
+source 'http://gems.moneydesktop.com'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    slide_rule (0.0.1)
+      levee (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  remote: http://gems.moneydesktop.com/
+  specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    ffi (1.9.10-java)
+    levee (2.0.0)
+      ffi
+    method_source (0.8.2)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry (0.10.1-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.34.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    slop (3.6.0)
+    spoon (0.0.4)
+      ffi
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  pry (~> 0)
+  rake (~> 10)
+  rspec (~> 3)
+  rubocop (~> 0)
+  slide_rule!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matt Nichols
+
+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,81 @@
+# SlideRule
+Ruby object distance calculator
+
+##Distance
+
+The distance between 2 objects is calculated as a float between 0.0 (perfect match) and 1.0 (farthest distance).
+
+All calculators result in a distance between 0.0 and 1.0.
+
+    Total distance = sum of all weighted distances.
+
+Weights are normalized as follows:
+
+    weight = weight * (% of sum of all weights)
+
+_Note: weights are assumed to be equal if not provided_
+
+#API
+
+##Describe the field calculators
+
+Each field to be considered in the distance calculation should be described 
+with a calculation method and weight(optional)
+
+Valid calculators:
+
+* day_of_month (this needs to be factored into configurable date_recurrence)
+* float_range_distance
+
+```ruby
+distance_rules = {
+  :description => {
+    :weight => 0.80,
+    :type => :levenshtein,
+  },
+  :date => {
+    :weight => 0.90,
+    :type => :day_of_month,
+  },
+}
+```
+
+## Build the object distance calculator
+
+```ruby
+matcher = ::SlideRule::DistanceCalculator.new(distance_rules)
+```
+
+## Use the calculator
+
+```ruby
+# Example data
+example = ::ExampleTransaction.new(
+  :amount => 25.00,
+  :date => '2015-02-05',
+  :description => 'Audible.com'
+)
+example2 = ::ExampleTransaction.new(
+  :amount => 250.00,
+  :date => '2015-02-16',
+  :description => 'Wells Fargo Dealer Services'
+)
+candidate = ::ExampleTransaction.new(
+  :amount => 25.00,
+  :date => '2015-06-08',
+  :description => 'Audible Inc'
+)
+
+# Calculate distance
+matcher.calculate_distance(example, candidate)
+=> 0.2318181818181818
+
+# Find closest match to examples in an array
+matcher.closest_match(candidate, [example, example2])
+=> example
+
+# Find closest match to examples in an array, using a threshold
+matcher.closest_match(candidate, [example, example2], 0.2)
+=> example
+
+```

data/Rakefile

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

data/lib/slide_rule/distance_calculator.rb

@@ -0,0 +1,80 @@
+module SlideRule
+  class DistanceCalculator
+    def initialize(rules)
+      @rules = normalize_weights(rules)
+    end
+
+    # TODO: Figure this out. Very inefficient!
+    # Probably should calculate using a suggestions algorythm
+    def group(array)
+      array.map do |item|
+        {
+          item: item,
+          matches: (array - [item]).map do |item_cmp|
+            {
+              match: item_cmp,
+              distance: calculate_distance(item, item_cmp)
+            }
+          end
+        }
+      end
+    end
+
+    def closest_match(obj, array, threshold)
+      matches(obj, array, threshold).sort { |match| match[:distance] }.first
+    end
+
+    def matches(obj, array, threshold)
+      array.map do |item|
+        distance = calculate_distance(obj, item)
+        if distance < threshold
+          {
+            item: item,
+            distance: distance
+          }
+        end
+      end.compact
+    end
+
+    # All distances represented as 0..1
+    #  0 = perfect match
+    #  1 = farthest distance
+    # Calculate distances for all attributes, then apply weight, and average them out.
+    # Rules format:
+    # {
+    #   :attribute_name => {
+    #     :weight => 0.90,
+    #     :type => :distance_calculator,
+    #   }
+    # }
+    def calculate_distance(i1, i2)
+      @rules.map do |attribute, rule|
+        val1 = i1.send(attribute)
+        val2 = i2.send(attribute)
+        calculator = get_calculator(rule[:type])
+        calculator.calculate(val1, val2).to_f * rule[:weight]
+      end.inject(0.0) { |calculated_dist, dist| calculated_dist + dist }
+    end
+
+    def get_calculator(calculator)
+      return calculator.new if calculator.is_a?(Class)
+
+      klass_name = "#{calculator.to_s.split('_').collect(&:capitalize).join}"
+      klass = ::SlideRule::DistanceCalculators.const_get(klass_name)
+
+      fail ArgumentError, "Unable to find calculator #{klass_name}" if klass.nil?
+
+      klass.new
+    end
+
+    # Ensures all weights add up to 1.0
+    #
+    def normalize_weights(rules_hash)
+      rules = rules_hash.dup
+      weight_total = rules.map { |_attr, rule| rule[:weight] }.reduce(0.0, &:+)
+      rules.each do |_attr, rule|
+        rule[:weight] = rule[:weight] / weight_total
+      end
+    end
+  end
+end

data/lib/slide_rule/distance_calculators/day_of_month.rb

@@ -0,0 +1,27 @@
+module SlideRule
+  module DistanceCalculators
+    class DayOfMonth
+      MAX_DAYS = 15
+
+      #
+      # Calculates distance using 15 as the max point.
+      #   Does not take into account the number of days in the actual month being considered.
+      #
+      def calculate(first, second)
+        first = Date.parse(first) unless first.is_a?(::Date) || first.is_a?(::Time)
+        second = Date.parse(second) unless second.is_a?(::Date) || second.is_a?(::Time)
+
+        first = first.to_date if first.is_a?(::Time)
+        second = second.to_date if second.is_a?(::Time)
+
+        difference_in_days(first, second).to_f / MAX_DAYS
+      end
+
+      def difference_in_days(first, second)
+        distance = (first.mday - second.mday).abs
+        return distance if distance <= MAX_DAYS
+        MAX_DAYS - (distance - MAX_DAYS)
+      end
+    end
+  end
+end

data/lib/slide_rule/distance_calculators/day_of_year.rb

@@ -0,0 +1,22 @@
+module SlideRule
+  module DistanceCalculators
+    class DayOfYear
+      DAYS_IN_YEAR = 365
+
+      def calculate(date_1, date_2)
+        date_1 = Date.parse(date_1) unless date_1.is_a?(::Date) || date_1.is_a?(::Time)
+        date_2 = Date.parse(date_2) unless date_2.is_a?(::Date) || date_2.is_a?(::Time)
+
+        date_1 = date_1.to_date if date_1.is_a?(::Time)
+        date_2 = date_2.to_date if date_2.is_a?(::Time)
+
+        days_apart = (date_1.mjd - date_2.mjd).abs
+
+        return 1 if days_apart >= DAYS_IN_YEAR
+
+        distance = days_apart.to_f / DAYS_IN_YEAR
+        distance.round(2)
+      end
+    end
+  end
+end

data/lib/slide_rule/distance_calculators/levenshtein.rb

@@ -0,0 +1,18 @@
+require 'levee'
+
+module SlideRule
+  module DistanceCalculators
+    class Levenshtein
+      def calculate(first, second)
+        distance = Levee.distance(first, second).to_f
+
+        # Lower bound is difference in length
+        # distance = matrix.last.last.to_f - (first.length - second.length).abs
+
+        # Upper bound is length of longest string
+        # This will decrease distance more for longer strings.
+        distance / ([first.length, second.length].max)
+      end
+    end
+  end
+end

data/lib/slide_rule/version.rb

@@ -0,0 +1,3 @@
+module SlideRule
+  VERSION = "0.0.1"
+end

data/lib/slide_rule.rb

@@ -0,0 +1,5 @@
+require_relative './slide_rule/version.rb'
+require_relative './slide_rule/distance_calculator.rb'
+require_relative './slide_rule/distance_calculators/day_of_month.rb'
+require_relative './slide_rule/distance_calculators/day_of_year.rb'
+require_relative './slide_rule/distance_calculators/levenshtein.rb'

data/slide_rule.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'slide_rule/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'slide_rule'
+  s.version       = ::SlideRule::VERSION
+  s.authors       = %w(mattnichols fergmastaflex)
+  s.email         = ['dev@mx.com']
+  s.homepage      = 'https://github.com/mattnichols/slide_rule'
+  s.summary       = 'Ruby object distance calculator'
+  s.description   = 'Calculates the distance between 2 arbitrary objects using specified fields and algorithms.'
+  s.license       = 'MIT'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  ##
+  # Dependencies
+  #
+  s.add_runtime_dependency 'levee', '~> 2'
+
+  ##
+  # Development Dependencies
+  #
+  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rubocop', '~> 0'
+end

data/slide_rulee/.gitignore

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

data/slide_rulee/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/slide_rulee/Gemfile

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

data/slide_rulee/README.md

@@ -0,0 +1,41 @@
+# SlideRulee
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slide_rulee`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slide_rulee'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slide_rulee
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/slide_rulee. 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/slide_rulee/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slide_rulee"
+
+# 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/slide_rulee/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/slide_rulee/lib/slide_rulee/version.rb

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

data/slide_rulee/lib/slide_rulee.rb

@@ -0,0 +1,5 @@
+require "slide_rulee/version"
+
+module SlideRulee
+  # Your code goes here...
+end

data/slide_rulee/slide_rulee.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slide_rulee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slide_rulee"
+  spec.version       = SlideRulee::VERSION
+  spec.authors       = ["matthew-nichols"]
+  spec.email         = ["matthew.nichols@mx.com"]
+
+  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/slide_rulee/spec/slide_rulee_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SlideRulee do
+  it 'has a version number' do
+    expect(SlideRulee::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/slide_rulee/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'slide_rulee'

data/spec/slide_rule/distance_calculator_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe ::SlideRule::DistanceCalculator do
+  class ExampleTransaction
+    attr_accessor :amount
+    attr_accessor :description
+    attr_accessor :date
+
+    def initialize(attrs = {})
+      @amount = attrs[:amount]
+      @description = attrs[:description]
+      @date = attrs[:date]
+    end
+  end
+
+  class CustomCalc
+    def calculate(_first, _second)
+      0.9
+    end
+  end
+
+  let(:examples) do
+    [
+      ::ExampleTransaction.new(amount: 25.00,   date: '2015-02-05', description: 'Audible.com'),
+      ::ExampleTransaction.new(amount: 34.89,   date: '2015-04-01', description: 'Questar Gas'),
+      ::ExampleTransaction.new(amount: 1200.00, date: '2015-05-04', description: 'US Bank'),
+      ::ExampleTransaction.new(amount: 560.00,  date: '2015-06-17', description: 'Wells Fargo Dealer Services'),
+      ::ExampleTransaction.new(amount: 25.44,   date: '2015-06-03', description: 'Walmart'),
+      ::ExampleTransaction.new(amount: 6.55,    date: '2015-06-01', description: 'Taco Bell'),
+      ::ExampleTransaction.new(amount: 45.30,   date: '2015-06-26', description: 'Shell')
+    ]
+  end
+
+  describe '#closest_match' do
+    let(:calculator) do
+      ::SlideRule::DistanceCalculator.new(
+        description: {
+          weight: 0.80,
+          type: :levenshtein
+        },
+        date: {
+          weight: 0.90,
+          type: :day_of_month
+        }
+      )
+    end
+
+    it 'finds recurring transaction' do
+      example = ExampleTransaction.new(description: 'Wells Fargo Dealer SVC', date: '2015-06-17')
+      expect(calculator.closest_match(example, examples, 0.2)[:item]).to eq(examples[3])
+
+      example = ExampleTransaction.new(description: 'Audible.com', date: '2015-06-05')
+      expect(calculator.closest_match(example, examples, 0.2)[:item]).to eq(examples[0])
+    end
+  end
+
+  describe '#calculate_distance' do
+    context 'uses built-in calculator' do
+      it 'should calculate perfect match' do
+        calculator = ::SlideRule::DistanceCalculator.new(
+          description: {
+            weight: 1.00,
+            type: :levenshtein
+          },
+          date: {
+            weight: 0.50,
+            type: :day_of_month
+          }
+        )
+        example = ::ExampleTransaction.new(amount: 25.00, date: '2015-02-05', description: 'Audible.com')
+        candidate = ::ExampleTransaction.new(amount: 25.00, date: '2015-06-05', description: 'Audible.com')
+        expect(calculator.calculate_distance(example, candidate)).to eq(0.0)
+      end
+
+      it 'should calculate imperfect match' do
+        calculator = ::SlideRule::DistanceCalculator.new(
+          description: {
+            weight: 0.50,
+            type: :levenshtein
+          },
+          date: {
+            weight: 0.50,
+            type: :day_of_month
+          }
+        )
+        example = ::ExampleTransaction.new(amount: 25.00, date: '2015-02-05', description: 'Audible.com')
+        candidate = ::ExampleTransaction.new(amount: 25.00, date: '2015-06-08', description: 'Audible Inc')
+
+        # <--------------------------------------->
+        #  Distance Calculation:
+        # <--------------------------------------->
+        #   + Day of month distance = 3 * 0.5 / 15
+        #   + Levenshtein distance = 4 * 0.5 / 11
+        # -----------------------------------------
+        #   = 0.2318181818181818
+        distance = calculator.calculate_distance(example, candidate)
+        expect(distance).to eq((3.0 * 0.5 / 15) + (4.0 * 0.5 / 11))
+      end
+    end
+
+    context 'uses custom calculator' do
+      it 'should load custom calculator' do
+        calculator = ::SlideRule::DistanceCalculator.new(
+          description: {
+            weight: 1.00,
+            type: CustomCalc
+          }
+        )
+        example = ::ExampleTransaction.new
+        candidate = ::ExampleTransaction.new
+
+        distance = calculator.calculate_distance(example, candidate)
+        expect(distance).to eq(0.9)
+      end
+    end
+  end
+end

data/spec/slide_rule/distance_calculators/day_of_month_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe ::SlideRule::DistanceCalculators::DayOfMonth do
+  describe '#calculate' do
+    it 'should give 0 on exact match' do
+      expect(described_class.new.calculate('2012-03-19', '2014-08-19')).to eq(0.0)
+    end
+
+    it 'should calculate when date is in the same month' do
+      expect(described_class.new.calculate('2012-03-19', '2014-08-22')).to eq(3.0 / 15)
+      expect(described_class.new.calculate('2012-03-19', '2014-08-09')).to eq(10.0 / 15)
+    end
+
+    it 'should calculate when date wraps to next month, using 15 as max number of days' do
+      expect(described_class.new.calculate('2012-03-30', '2014-04-02')).to eq(2.0 / 15)
+    end
+  end
+
+  describe '#difference_in_days' do
+    describe 'calculates using 15 day max' do
+      [
+        ['same day',       Date.parse('2012-03-30'), Date.parse('2014-04-30'),  0],
+        ['one day after',  Date.parse('2012-03-19'), Date.parse('2014-04-20'),  1],
+        ['one day before', Date.parse('2012-03-18'), Date.parse('2014-04-19'),  1],
+
+        ['14 days before', Date.parse('2012-03-15'), Date.parse('2014-04-01'), 14],
+        ['14 days after',  Date.parse('2012-03-15'), Date.parse('2014-04-01'), 14],
+
+        ['15 days before', Date.parse('2012-03-16'), Date.parse('2014-04-01'), 15],
+        ['15 days after',  Date.parse('2012-03-01'), Date.parse('2014-04-16'), 15],
+
+        ['16 days before', Date.parse('2012-03-17'), Date.parse('2014-04-01'), 14],
+        ['16 days after',  Date.parse('2012-03-01'), Date.parse('2014-04-17'), 14],
+
+        ['last day of month and first of next month (30 day month)',  Date.parse('2012-04-30'), Date.parse('2014-05-01'), 1],
+
+        ## Not sure how to account for these
+        ['last day of month and first of next month (leap year)',     Date.parse('2012-02-29'), Date.parse('2014-04-01'), 2], # should be 1 day?
+        ['last day of month and first of next month (31 day month)',  Date.parse('2012-03-31'), Date.parse('2014-04-01'), 0], # should be 1 day?
+        ['last day of month and first of next month (28 day month)',  Date.parse('2012-02-28'), Date.parse('2014-04-01'), 3], # should be 1 day?
+      ].each do |example|
+        it "when dates are #{example[0]}" do
+          expect(described_class.new.difference_in_days(example[1], example[2])).to eq(example[3])
+        end
+      end
+    end
+  end
+end

data/spec/slide_rule/distance_calculators/day_of_year_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ::SlideRule::DistanceCalculators::DayOfYear do
+  context 'when dates are an exact match' do
+    it 'should return a 0 distance' do
+      expect(described_class.new.calculate('2015-10-8', '2015-10-8')).to eq(0.0)
+    end
+  end
+
+  context 'when dates are more than a year apart' do
+    it 'should return a 1 distance' do
+      expect(described_class.new.calculate('2015-10-8', '2016-10-8')).to eq(1)
+    end
+  end
+
+  context 'when dates are in the same year but different' do
+    it 'should return a calculated distance distance' do
+      expect(described_class.new.calculate('2015-10-8', '2015-11-8')).to eq(0.08)
+    end
+  end
+end

data/spec/slide_rule/distance_calculators/levenshtein_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ::SlideRule::DistanceCalculators::Levenshtein do
+  it 'should calculate perfect match' do
+    expect(described_class.new.calculate('this is a test', 'this is a test')).to eq(0.0)
+  end
+
+  it 'should calculate distance as distance divided by length of longest string' do
+    expect(described_class.new.calculate('this is a test', 'this is a test!')).to eq(1.0 / 15)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require_relative '../lib/slide_rule.rb'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: slide_rule
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mattnichols
+- fergmastaflex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: levee
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Calculates the distance between 2 arbitrary objects using specified fields
+  and algorithms.
+email:
+- dev@mx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/slide_rule.rb
+- lib/slide_rule/distance_calculator.rb
+- lib/slide_rule/distance_calculators/day_of_month.rb
+- lib/slide_rule/distance_calculators/day_of_year.rb
+- lib/slide_rule/distance_calculators/levenshtein.rb
+- lib/slide_rule/version.rb
+- slide_rule.gemspec
+- slide_rulee/.gitignore
+- slide_rulee/.travis.yml
+- slide_rulee/Gemfile
+- slide_rulee/README.md
+- slide_rulee/bin/console
+- slide_rulee/bin/setup
+- slide_rulee/lib/slide_rulee.rb
+- slide_rulee/lib/slide_rulee/version.rb
+- slide_rulee/slide_rulee.gemspec
+- slide_rulee/spec/slide_rulee_spec.rb
+- slide_rulee/spec/spec_helper.rb
+- spec/slide_rule/distance_calculator_spec.rb
+- spec/slide_rule/distance_calculators/day_of_month_spec.rb
+- spec/slide_rule/distance_calculators/day_of_year_spec.rb
+- spec/slide_rule/distance_calculators/levenshtein_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mattnichols/slide_rule
+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: Ruby object distance calculator
+test_files:
+- spec/slide_rule/distance_calculator_spec.rb
+- spec/slide_rule/distance_calculators/day_of_month_spec.rb
+- spec/slide_rule/distance_calculators/day_of_year_spec.rb
+- spec/slide_rule/distance_calculators/levenshtein_spec.rb
+- spec/spec_helper.rb