osrm_text_instructions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d887dde853324fc44802ae648b09b74488276ac4
+  data.tar.gz: 5561d37272acde6c1c691bdfb09950841895bcfc
+SHA512:
+  metadata.gz: c8a0a4d5b0a9ac6b1ebed2d292de475da5fa91efa8e55e437bb0d64b7bd79ab697c328feb3dc968fbd468084c07cabc6fd6b8c7888421d9247beb129b08a3a12
+  data.tar.gz: f5d6c3b4314c1888805d68fcab3d18e6ab18928c6efe155fd752013be67ad8d8aec0db98e8185a445d264b264867b4db4caabfb26a509f915951a677729d4ebf

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at felipe@zavan.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Felipe Zavan
+
+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,51 @@
+# OSRMTextInstructions
+
+OSRMTextInstructions is a gem to transform OSRM steps into text instructions.
+
+This is an almost verbatim port of [osrm-text-instructions.js](https://github.com/Project-OSRM/osrm-text-instructions).
+
+Only version 5 of the API and the english locale is supported for now.  
+This is not stable yes and we still don't have any tests. Use at your own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'osrm_text_instructions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install osrm_text_instructions
+
+## Usage
+
+```ruby
+# make your request against the API
+
+legs.each do |leg|
+  leg.steps.each do |step|
+    instruction = OSRMTextInstructions.compile(step)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/zavan/osrm_text_instructions. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'osrm_text_instructions'
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/i18n/en.yml

@@ -0,0 +1,99 @@
+---
+v5:
+  templates:
+    destination: " towards {destination}"
+  arrive:
+    defaultInstruction: You have arrived at your destination #{nth}
+    left: You have arrived at your destination #{nth}, on the left
+    right: You have arrived at your destination #{nth}, on the right
+    sharp left: You have arrived at your destination #{nth}, on the left
+    sharp right: You have arrived at your destination #{nth}, on the right
+    slight right: You have arrived at your destination #{nth}, on the right
+    slight left: You have arrived at your destination #{nth}, on the left
+    straight: You have arrived at your destination #{nth}, straight ahead
+  continue:
+    defaultInstruction: Continue {modifier}[ onto {way_name}]
+    slight left: Continue slightly left[ onto {way_name}]
+    slight right: Continue slightly right[ onto {way_name}]
+  depart:
+    defaultInstruction: Head {modifier}[ on {way_name}]
+  end of road:
+    defaultInstruction: Turn {modifier}[ onto {way_name}] at the end of the road
+    straight: Continue straight[ onto {way_name}]
+    uturn: Make a U-turn[ onto {way_name}] at the end of the road
+  ferry:
+    defaultInstruction: Take the ferry[ - {way_name}]
+  fork:
+    defaultInstruction: Keep {modifier} at the fork[ onto {way_name}]
+    slight left: Keep left at the fork[ onto {way_name}]
+    slight right: Keep right at the fork[ onto {way_name}]
+    sharp left: Take a sharp left at the fork[ onto {way_name}]
+    sharp right: Take a sharp right at the fork[ onto {way_name}]
+    uturn: Make a U-turn [ onto {way_name}]
+  merge:
+    defaultInstruction: Merge {modifier}[ onto {way_name}]
+    slight left: Merge slightly left[ onto {way_name}]
+    slight right: Merge slightly right[ onto {way_name}]
+    sharp left: Merge sharply left[ onto {way_name}]
+    sharp right: Merge sharply right[ onto {way_name}]
+  new name:
+    defaultInstruction: Continue {modifier}[ onto {way_name}]
+    sharp left: Take a sharp left[ onto {way_name}]
+    sharp right: Take a sharp right[ onto {way_name}]
+    slight left: Continue slightly left[ onto {way_name}]
+    slight right: Continue slightly right[ onto {way_name}]
+    uturn: Make a U-turn[ onto {way_name}]
+  notification:
+    defaultInstruction: Continue {modifier}[ onto {way_name}]
+  off ramp:
+    defaultInstruction: Take the ramp[ onto {way_name}]
+    left: Take the ramp on the left[ onto {way_name}]
+    right: Take the ramp on the right[ onto {way_name}]
+    sharp left: Take the ramp on the left[ onto {way_name}]
+    sharp right: Take the ramp on the right[ onto {way_name}]
+    slight left: Take the ramp on the left[ onto {way_name}]
+    slight right: Take the ramp on the right[ onto {way_name}]
+  on ramp:
+    defaultInstruction: Take the ramp[ onto {way_name}]
+    left: Take the ramp on the left[ onto {way_name}]
+    right: Take the ramp on the right[ onto {way_name}]
+    sharp left: Take the ramp on the left[ onto {way_name}]
+    sharp right: Take the ramp on the right[ onto {way_name}]
+    slight left: Take the ramp on the left[ onto {way_name}]
+    slight right: Take the ramp on the right[ onto {way_name}]
+  pushing bike:
+    defaultInstruction: Get off the bike and push[ onto {way_name}]
+  rotary:
+    defaultInstruction: Enter {rotary_name}
+  roundabout:
+    defaultInstruction: Enter the roundabout
+  roundabout turn:
+    defaultInstruction: At the roundabout make a {modifier}[ onto {way_name}]
+    left: At the roundabout turn left[ onto {way_name}]
+    right: At the roundabout turn right[ onto {way_name}]
+    straight: At the roundabout continue straight
+  train:
+    defaultInstruction: Take the train[ - {way_name}]
+  turn:
+    defaultInstruction: Make a {modifier}[ onto {way_name}]
+    left: Turn left[ onto {way_name}]
+    right: Turn right[ onto {way_name}]
+    straight: Go straight[ onto {way_name}]
+  use lane:
+    defaultInstruction: Continue straight[ onto {way_name}]
+    left: "{laneInstruction} to turn left[ onto {way_name}]"
+    right: "{laneInstruction} to turn right[ onto {way_name}]"
+    sharp left: "{laneInstruction} to make a sharp left[ onto {way_name}]"
+    sharp right: "{laneInstruction} to make a sharp right[ onto {way_name}]"
+    slight left: "{laneInstruction} to make a slight left[ onto {way_name}]"
+    slight right: "{laneInstruction} to make a slight right[ onto {way_name}]"
+    uturn: "{laneInstruction} to make a U-turn[ onto {way_name}]"
+    laneTypes:
+      xo: Keep right
+      ox: Keep left
+      oox: Keep left
+      xoo: Keep right
+      xxo: Keep right
+      oxx: Keep left
+      xox: Use the middle lane
+      oxo: Use the left or right lane

data/lib/osrm_text_instructions/compiler.rb

@@ -0,0 +1,155 @@
+module OSRMTextInstructions
+  class Compiler
+    attr_accessor :instructions, :version
+
+    def initialize(instructions, version)
+      @instructions = instructions
+      @version = version
+    end
+
+    def compile(step)
+      unless instructions[version]
+        raise "Version #{version} not found for locale #{locale}"
+      end
+
+      raise 'No step maneuver provided' unless step['maneuver']
+
+      type = step['maneuver']['type']
+      modifier = step['maneuver']['modifier']
+
+      raise 'Missing step maneuver type' unless type
+
+      if type != 'depart' && type != 'arrive' && !modifier
+        raise 'Missing step maneuver modifier'
+      end
+
+      unless instructions[version][type]
+        # osrm specification assumes turn types can be added without
+        # major voersion changes and unknown types are treated
+        # as type `turn` by clients
+        type = 'turn'
+      end
+
+      # First check if the modifier for this maneuver has a special instruction
+      # If not, use the `defaultInstruction`
+      instruction =
+        if instructions[version][type][modifier]
+          instructions[version][type][modifier]
+        else
+          instructions[version][type]['defaultInstruction']
+        end
+
+      # Special cases, code here should be kept to a minimum
+      # If possible, change the instruction in `i18n/{locale}.yml`
+      # This switch statement is for specical cases that occur at runtime
+      case type
+      when 'arrive'
+        nth_waypoint = ''
+        instruction = instruction.gsub('{nth}', nth_waypoint).gsub('  ', ' ')
+      when 'depart'
+        # Always use cardinal direction for departure.
+        instruction = instruction.gsub('{modifier}', get_direction_from_degree(step['maneuver']['bearing_after'])[0])
+      when 'notification'
+        # TODO
+      when 'roundabout', 'rotary'
+        instruction = instruction.gsub('{rotary_name}', step['rotary_name'] || 'the rotary')
+        if step['name'] && step['maneuver']['exit']
+          instruction += " and take the #{step['maneuver']['exit']} exit onto {way_name}"
+        elsif step['maneuver']['exit']
+          instruction += " and take the #{step['maneuver']['exit']} exit"
+        elsif step['name']
+          instruction += ' and exit onto {way_name}'
+        end
+      when 'use lane'
+        lane_diagram = useLane(step)
+        lane_instruction = instructions[version][type]['laneTypes'][lane_diagram]
+
+        if lane_instruction
+          instruction = instruction.gsub('{laneInstruction}', lane_instruction)
+        else
+          # If the lane combination is not found, default to continue
+          instruction = instructions[version][type]['defaultInstruction']
+        end
+      end
+
+      # Handle instructions with destinations and names
+      if step['destinations'] && step['destinations'] != ''
+        # only use the first destination for text instruction
+        d = step['destinations'].split(',')[0]
+        t = instructions[version]['templates']['destination']
+
+        instruction = instruction
+          .gsub(/\[.+\]/, t.gsub('{destination}', d))
+      elsif step['name'] && step['name'] != ''
+        # if no destination found, try name
+        instruction = instruction
+          .gsub('[', '')
+          .gsub(']', '')
+          .gsub('{way_name}', step['name'])
+       else
+         # do not use name information if not included in step
+         instruction = instruction.gsub(/\[.+\]/, '')
+       end
+
+       # Cleaning for all instructions
+       # If a modifier is not provided, calculate direction given bearing
+       instruction = instruction
+         .gsub('{modifier}', modifier || get_direction_from_degree(step['maneuver']['bearing_after'])[0])
+         .strip
+
+       instruction
+    end
+
+    def get_direction_from_degree(degree)
+      OSRMTextInstructions::Utils.get_direction_from_degree(degree)
+    end
+
+    def use_lane(step)
+      raise 'No lanes hash' if !step['intersections'] || !step['intersections'][0]['lanes']
+
+      # Reduce any lane combination down to a string representing the lane config
+      #
+      # If the valid lanes look like:
+      # "lanes": [
+      #   {
+      #     "valid": true
+      #   },
+      #   {
+      #     "valid": true
+      #   },
+      #   {
+      #     "valid": true
+      #   },
+      #   {
+      #      "valid": false
+      #   },
+      #   {
+      #      "valid": false
+      #   },
+      #   {
+      #      "valid": true
+      #   }
+      # ]
+      #
+      # This would map to `oxo`
+      # And the instruction would `Keep left or right...`
+
+      diagram = []
+      current_lane_type = nil
+
+      step['intersections'][0]['lanes'].each do |lane|
+        if current_lane_type.nil? || current_lane_type != lane['valid']
+          if lane['valid']
+            diagram.push('o')
+          else
+            diagram.push('x')
+          end
+
+          current_lane_type = lane['valid']
+        end
+      end
+
+      diagram.join('')
+    end
+  end
+end

data/lib/osrm_text_instructions/utils.rb

@@ -0,0 +1,25 @@
+module OSRMTextInstructions
+  module Utils
+    def self.get_direction_from_degree(degree)
+      if degree >= 340 || degree <= 20
+        ['north', 'N']
+      elsif degree > 20 && degree < 70
+        ['northeast', 'NE']
+      elsif degree >= 70 && degree < 110
+        ['east', 'E']
+      elsif degree >= 110 && degree <= 160
+        ['southeast', 'SE']
+      elsif degree > 160 && degree <= 200
+        ['south', 'S']
+      elsif degree > 200 && degree < 250
+        ['southwest', 'SW']
+      elsif degree >= 250 && degree <= 290
+        ['west', 'W']
+      elsif degree > 290 && degree < 340
+        ['northwest', 'NW']
+      else
+        raise "Degree #{degree} invalid"
+      end
+    end
+  end
+end

data/lib/osrm_text_instructions/version.rb

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

data/lib/osrm_text_instructions.rb

@@ -0,0 +1,16 @@
+require 'yaml'
+require 'osrm_text_instructions/version'
+require 'osrm_text_instructions/utils'
+require 'osrm_text_instructions/compiler'
+
+module OSRMTextInstructions
+  def self.compile(step, locale: 'en', version: 'v5')
+    Compiler.new(load_instruction_yaml(locale), version).compile(step)
+  end
+
+  def self.load_instruction_yaml(locale)
+    YAML.load_file(File.expand_path("#{__dir__}/../i18n/#{locale}.yml"))
+  rescue Errno::ENOENT => e
+    raise "Locale #{locale} not available"
+  end
+end

data/osrm_text_instructions.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'osrm_text_instructions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'osrm_text_instructions'
+  spec.version       = OSRMTextInstructions::VERSION
+  spec.authors       = ['Felipe Zavan']
+  spec.email         = ['felipe@zavan.me']
+
+  spec.summary       = %q{A gem to transform OSRM steps into text instructions.}
+  spec.homepage      = 'https://github.com/zavan/osrm_text_instructions'
+  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.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: osrm_text_instructions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felipe Zavan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- felipe@zavan.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n/en.yml
+- lib/osrm_text_instructions.rb
+- lib/osrm_text_instructions/compiler.rb
+- lib/osrm_text_instructions/utils.rb
+- lib/osrm_text_instructions/version.rb
+- osrm_text_instructions.gemspec
+homepage: https://github.com/zavan/osrm_text_instructions
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to transform OSRM steps into text instructions.
+test_files: []