tsp_runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4de20bb835ad9abb7ca9b8200d3900881d9445d9
+  data.tar.gz: 4b8b15b499659263bf014641bc2f8b855cc2572d
+SHA512:
+  metadata.gz: deba5646b3df24fca5c236dd821e766ac71b84a64522d622157299b59b64bbdc416f36df6c2bddffb4603b567cc2d3da309db9164e1f9a53138d6600a2113fa0
+  data.tar.gz: 5667cf34f1385ad59ddb692270ad743af61b569462949cedec938231750436e1083222e8e6714ccc91da3db8a2780b77039946ac6c2892014c6d4cce929e3545

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require 'spec_helper'

data/.travis.yml

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

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 tsp_runner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tom Collier
+
+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,39 @@
+# TspRunner
+
+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/tsp_runner`. 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 'tsp_runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tsp_runner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[my-github-username]/tsp_runner/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/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tsp_runner'
+
+# 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/data/input/sample_10.csv

@@ -0,0 +1,10 @@
+Philadelphia,40.00763286606546,-75.13417473522492
+San Antonio,29.472503828830956,-98.52479802769332
+San Diego,32.83530987648001,-117.11948127009282
+Dallas,32.79406551342133,-96.76562905345834
+San Francisco,37.75624104468897,-122.44148308888244
+Milwaukee,43.0642012492431,-87.96704550921461
+Tampa,27.99679690746927,-82.44546311098391
+Kansas City,39.123770613135896,-94.5541998664069
+Cleveland,41.47718512840605,-81.68089809554883
+New Orleans,30.068751467455936,-89.93079810833594

data/data/solutions/solution_10_a.txt

@@ -0,0 +1,10 @@
+San Francisco
+Philadelphia
+San Antonio
+San Diego
+Dallas
+Milwaukee
+Tampa
+Kansas City
+Cleveland
+New Orleans

data/exe/tsp_runner

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'tsp_runner'
+
+filename = File.join(File.dirname(__FILE__), '..', 'data', 'input', 'sample_10.csv')
+
+begin
+  runner = TspRunner::Runner.new(ARGV.join(' '), filename)
+  runner.run(5)
+  distance = runner.validate!('San Francisco')
+  $stdout.puts("Success: #{distance} km")
+rescue TspRunner::Runner::BaseError => error
+  $stderr.puts error.message
+  exit(1)
+end

data/lib/tsp_runner/location.rb

@@ -0,0 +1,49 @@
+module TspRunner
+  class Location
+    RADIANS_PER_DEGREE = Math::PI / 180
+    EARTH_RADIUS       = 6371 * 1000  # in meters
+
+    attr_reader :name, :lat, :lon
+
+    # @param name [String] the name of the location
+    # @param lat [Fixnum] the latitude
+    # @param lon [Fixnum] the longitude
+    def initialize(name, lat, lon)
+      unless lat.in?(-90..90)
+        raise ArgumentError, 'Latitudue should be between -90 and 90'
+      end
+
+      unless lon.in?(-180..180)
+        raise ArgumentError, 'Longitudue should be between -180 and 180'
+      end
+
+      @name, @lat, @lon = name, lat, lon
+    end
+
+    # @return [Fixnum] the latitude in radians
+    def lat_rad
+      lat * RADIANS_PER_DEGREE
+    end
+
+    # @return [Fixnum] the longitude in radians
+    def lon_rad
+      lon * RADIANS_PER_DEGREE
+    end
+
+    # Gleefully stolen from:
+    # http://stackoverflow.com/questions/12966638/how-to-calculate-the-distance-between-two-gps-coordinates-without-using-google-m
+    #
+    # @return [Fixnum] the Haversine distance of the location (from self) as
+    #   measured in meters
+    def distance_from(location)
+      delta_lat = location.lat_rad - lat_rad
+      delta_lon = location.lon_rad - lon_rad
+
+      a = Math.sin(delta_lat / 2) ** 2 + Math.cos(lat_rad) *
+          Math.cos(location.lat_rad) * Math.sin(delta_lon / 2) ** 2
+      c = 2 * Math::atan2(Math::sqrt(a), Math::sqrt(1 - a))
+
+      EARTH_RADIUS * c
+    end
+  end
+end

data/lib/tsp_runner/location_hash.rb

@@ -0,0 +1,30 @@
+module TspRunner
+  class LocationHash
+    attr_reader :locations
+
+    def self.from_file(filename)
+      new.tap do |location_hash|
+        File.open(filename).each do |line|
+          name, lat_str, lon_str = *line.chomp.split(',')
+          location_hash << Location.new(name, Float(lat_str), Float(lon_str))
+        end
+      end
+    end
+
+    def initialize
+      @locations = {}
+    end
+
+    def <<(location)
+      locations[location.name] = location
+    end
+
+    def [](location_name)
+      locations[location_name]
+    end
+
+    def location_names
+      locations.keys
+    end
+  end
+end

data/lib/tsp_runner/runner.rb

@@ -0,0 +1,36 @@
+require 'timeout'
+
+module TspRunner
+  class Runner
+    class BaseError < StandardError; end
+    class TimeoutError < BaseError; end
+    class InvalidError < BaseError; end
+
+    attr_reader :cmd, :input_filename, :output
+
+    def initialize(cmd, input_filename)
+      @cmd, @input_filename  = cmd, input_filename
+    end
+
+    def run(time_limit)
+      @output = Timeout.timeout(time_limit) { `#{cmd} #{input_filename}` }
+    rescue Timeout::Error
+      raise TimeoutError, 'Failed: timeout'
+    end
+
+    def validate!(initial_location_name = nil)
+      solution = TspRunner::Solution.from_string(output, location_hash)
+      if solution.valid?(initial_location_name)
+        solution.total_distance / 1000.0
+      else
+        raise InvalidError, ['Failed: invalid', output].join("\n")
+      end
+    end
+
+    private
+
+    def location_hash
+      @location_hash ||= TspRunner::LocationHash.from_file(input_filename)
+    end
+  end
+end

data/lib/tsp_runner/solution.rb

@@ -0,0 +1,49 @@
+module TspRunner
+  class Solution
+    attr_reader :location_hash, :location_names
+
+    def self.from_file(filename, location_hash)
+      new(location_hash).tap do |solution|
+        File.open(filename).each do |line|
+          solution << line.chomp
+        end
+      end
+    end
+
+    def self.from_string(str, location_hash)
+      new(location_hash).tap do |solution|
+        str.split("\n").each do |line|
+          solution << line.chomp
+        end
+      end
+    end
+
+    def initialize(location_hash)
+      @location_hash = location_hash
+      @location_names = []
+    end
+
+    def <<(location_name)
+      location_names << location_name
+    end
+
+    def valid?(initial_location_name = nil)
+      if initial_location_name
+        return false if initial_location_name != location_names.first
+      end
+      location_hash.location_names.sort == location_names.sort
+    end
+
+    def total_distance
+      distance = 0
+      location_names.each.with_index do |location_name, index|
+        location = location_hash[location_name]
+        next_index = (index + 1) % location_names.length
+        next_location_name = location_names[next_index]
+        next_location = location_hash[next_location_name]
+        distance += location.distance_from(next_location)
+      end
+      distance
+    end
+  end
+end

data/lib/tsp_runner/version.rb

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

data/lib/tsp_runner.rb

@@ -0,0 +1,11 @@
+require 'active_support/core_ext/object/inclusion'
+
+require 'tsp_runner/location'
+require 'tsp_runner/location_hash'
+require 'tsp_runner/runner'
+require 'tsp_runner/solution'
+require 'tsp_runner/version'
+
+module TspRunner
+  # https://gist.github.com/tcollier/3cb895f019b7c3729ba7
+end

data/tsp_runner.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tsp_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tsp_runner'
+  spec.version       = TspRunner::VERSION
+  spec.authors       = ['Tom Collier']
+  spec.email         = ['collier@apartmentlist.com']
+
+  spec.summary       = %q{Script to run a TSP solver and validate/measure its output.}
+  spec.description   = %{qScript to run a TSP solver and validate/measure its output.}
+  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_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: tsp_runner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Collier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: factory_girl
+  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: faker
+  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: mocha
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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'
+description: qScript to run a TSP solver and validate/measure its output.
+email:
+- collier@apartmentlist.com
+executables:
+- tsp_runner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/input/sample_10.csv
+- data/solutions/solution_10_a.txt
+- exe/tsp_runner
+- lib/tsp_runner.rb
+- lib/tsp_runner/location.rb
+- lib/tsp_runner/location_hash.rb
+- lib/tsp_runner/runner.rb
+- lib/tsp_runner/solution.rb
+- lib/tsp_runner/version.rb
+- tsp_runner.gemspec
+homepage: 
+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.5
+signing_key: 
+specification_version: 4
+summary: Script to run a TSP solver and validate/measure its output.
+test_files: []
+has_rdoc: