lat_long 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69381c0358752786e2b7b54d35982c1ab53e0ec2
+  data.tar.gz: bed50f54c59007998f8bcf9293603f702efb30b7
+SHA512:
+  metadata.gz: 09cccfbb22ca309b58f058e8164849f95c97d22a0fdb8fe61686d6c33126414e5d80eeeec68bf0e424cd5be211b80e1a3404bf04a35a184905659896401a90b3
+  data.tar.gz: f9df1234412cfeaeef77ca7346ac62f7c8d714a9665a1b021a6d586417ed65855402dc5c6be1c112c29cbf932e81fe2c0e0ddb1be0e4ade22d191fc508960884

data/.gitignore

@@ -0,0 +1,2 @@
+.byebug_history
+*.gem

data/.reek

@@ -0,0 +1,5 @@
+IrresponsibleModule:
+  enabled: false
+
+TooManyStatements:
+  max_statements: 12

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 matis@craftedcode.com. 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 lat_long.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    lat_long (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (9.0.6)
+    codeclimate-engine-rb (0.3.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    minitest (5.10.1)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    reek (4.1.0)
+      codeclimate-engine-rb (~> 0.3.1)
+      parser (~> 2.3.1, >= 2.3.1.2)
+      rainbow (~> 2.0)
+    rubocop (0.41.1)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    thread_safe (0.3.6)
+    unicode-display_width (1.1.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  byebug (~> 9.0)
+  lat_long!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  reek (~> 4.1)
+  rubocop (~> 0.41)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Matis Masters
+
+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) 2017 Matis Masters
+
+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,102 @@
+# LatLong
+
+## short-FAQ
+### What does this gem do?
+
+Move `lat, long` points based on distance and direction.
+
+### What else?
+
+For now it's just that, you can check the [Usage](#usage) part for details
+
+### What is it for?
+
+I developed it, and use it, to create fake data for my tests when doing mobile
+apps that depend on location based stuff. Things like `people 500 meters away`,
+`people within a certain radius`, and similar.
+
+I would love to hear about it if you find a better use for it.
+
+### IMPORTANT NOTE
+
+```
+There are several ways of calculating distances using geo-coordinates. The different
+approaches vary in accuracy, and are used in different scenarios. This gem uses
+the [Aviation Formula](http://www.edwilliams.org/avform.htm),
+it is the simplest of them all, but it might have big errors
+margins when used with distances over 2km. I'm ok with this for now.
+```
+
+### Future?
+
+I'm planning on understanding (first things first), and implementing all the other
+formulas, so they can be used when needed, or otherwise having the gem automatically
+pick the more accurate depending on the parameters `lat, long, distance, direction`.
+
+Check [Github Issues](https://github.com/matismasters/lat_long/issues) for backlog
+and progress.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lat_long'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lat_long
+
+## Usage
+
+Simply tell distance, distance_unit, direction and get a new location hash
+
+```ruby
+
+require 'lat_long'
+
+washington_ave_and_17st_nw = LatLong::Point.new 38.892133, (-77.039498)
+
+new_location = washington_ave_and_17st_nw.move 250, :meters, :north
+
+new_location[:lat]  # 38.892133
+new_location[:long] # -77.033727
+
+```
+
+Valid directions:
+
+- `:west`
+- `:north_west`
+- `:north`
+- `:north_east`
+- `:east`
+- `:south_east`
+- `:south`
+- `:south_west`
+
+Valid distance units:
+
+- `:meters`
+- `:kilometers`
+- `:miles`
+- `:feet`
+
+## 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/matismasters/lat_long. 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,20 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new :rubocop do |t|
+  t.options = ['--display-cop-names']
+end
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+end
+
+task :default => [:test, :rubocop, :reek]

data/bin/console

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lat_long/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lat_long"
+  spec.version       = LatLong::VERSION
+  spec.authors       = ["Matis Masters"]
+  spec.email         = ["me@matis.io"]
+
+  spec.summary       = %q{Move Lat, Long, coordinates using distance and direction.}
+  spec.description   = %q{LatLong::Point.new(32.000, -41.000).move(5, :miles, :north) => [lat: 32.333, long: -41.000]}
+  spec.homepage      = "https://github.com/matismasters/lat_long"
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug", "~> 9.0"
+  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "reek", "~> 4.1"
+end

data/lib/lat_long.rb

@@ -0,0 +1,3 @@
+require 'lat_long/version'
+require 'lat_long/constants'
+require 'lat_long/point'

data/lib/lat_long/constants.rb

@@ -0,0 +1,21 @@
+module LatLong
+  DIRECTION_MULTIPLIERS = {
+    west:       { y_axis: 0, x_axis: -1 },
+    north_west: { y_axis: 1, x_axis: -1 },
+    north:      { y_axis: 1, x_axis: 0 },
+    north_east: { y_axis: 1, x_axis: 1 },
+    east:       { y_axis: 0, x_axis: 1 },
+    south_east: { y_axis: -1, x_axis: 1 },
+    south:      { y_axis: -1, x_axis: 0 },
+    south_west: { y_axis: -1, x_axis: -1 },
+  }.freeze
+
+  TO_METERS_MULTIPLIERS = {
+    meters: 1,
+    kilometers: 1000,
+    miles: 0.000621371,
+    feet: 3.28084
+  }.freeze
+
+  EARTH_RADIUS = 6378137.freeze
+end

data/lib/lat_long/point.rb

@@ -0,0 +1,51 @@
+module LatLong
+  class Point
+    ARGUMENT_ERRORS_TEXT = {
+      direction:
+        'direction argument is not supported, use any of the following ' +
+        DIRECTION_MULTIPLIERS.keys.join(', '),
+      distance_unit:
+        'distance unit argument not supported, use any of the following ' +
+        TO_METERS_MULTIPLIERS.keys.join(', '),
+    }.freeze
+
+    attr_reader :lat, :long
+
+    def initialize(lat, long)
+      @lat = lat
+      @long = long
+    end
+
+    def starting_point
+      [@lat, @long]
+    end
+
+    def move(raw_distance, unit, direction)
+      direction = direction_multipliers(direction)
+      distance = distance_in_meters(raw_distance, unit)
+
+      lat_offset = distance / EARTH_RADIUS
+      long_offset = distance / (
+        EARTH_RADIUS * Math.cos(Math::PI * @lat/180)
+      )
+
+      new_point_lat = @lat + (lat_offset * 180/Math::PI) * direction[:y_axis]
+      new_point_long = @long + (long_offset * 180/Math::PI) * direction[:x_axis]
+
+      { lat: new_point_lat, long: new_point_long }
+    end
+
+    private
+
+    def direction_multipliers(direction)
+      DIRECTION_MULTIPLIERS[direction] ||
+        raise(ArgumentError, ARGUMENT_ERRORS_TEXT[:direction])
+    end
+
+    def distance_in_meters(distance, unit)
+      unit_multiplier = TO_METERS_MULTIPLIERS[unit] ||
+        raise(ArgumentError, ARGUMENT_ERRORS_TEXT[:distance_unit])
+      distance.to_f * unit_multiplier
+    end
+  end
+end

data/lib/lat_long/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: lat_long
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matis Masters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: 'LatLong::Point.new(32.000, -41.000).move(5, :miles, :north) => [lat:
+  32.333, long: -41.000]'
+email:
+- me@matis.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lat_long.gemspec
+- lib/lat_long.rb
+- lib/lat_long/constants.rb
+- lib/lat_long/point.rb
+- lib/lat_long/version.rb
+homepage: https://github.com/matismasters/lat_long
+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: Move Lat, Long, coordinates using distance and direction.
+test_files: []