itudes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 85204104c51203d27fcbd302843c7d3bad8b3b20
+  data.tar.gz: 80b1ca017577dcafd66b5ecf6d27a1e11df40919
+!binary "U0hBNTEy":
+  metadata.gz: e9923ee0ffa3eebb134fb6eda622e4c6c03a521e309d8f74d0e82c75b55fdd0a84d9d7657345812bc7dd772429208823b98bcafe90b2cf164430aae2eb2ef6ef
+  data.tar.gz: 33c310c83daf6fb4e1dae50ce48e87cbeb7d09de0ea9bc1e415fccc222aa324c1d542af473356eb756548ad582192463e6fd0c088656ecbad8532c139d60244a

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/nbproject/private/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alexei Matyushkin
+
+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,22 @@
+Copyright (c) 2013 Alexei Matyushkin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Itudes
+
+This is a small utitility class to simplify multitude handling in ruby.
+
+There are few handy things:
+- `String` class is monkeypatched with `to_itude` method, which does
+converts to `Float` any of the following strings:
+  - 53.1234565
+  - 53°11′18″N
+  - 53 11 18N 
+- The distance between two points on the Earth is calculated with one
+single method call.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'itudes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install itudes
+
+## Usage
+
+      itudes = Geo::Itudes.new 53.15, -18.44
+      puts itudes - "53°11′18″N,37°5′18″E"
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/README.rdoc

@@ -0,0 +1,17 @@
+= itudes
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2013 Alexei Matyushkin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+
+require 'bueller'
+Bueller::Tasks.new
+# Bueller::GemcutterTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:examples) do |examples|
+  examples.rspec_opts = '-Ispec'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rspec_opts = '-Ispec'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :examples
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'features/**/*.feature', 'features/**/*.rb']
+#   t.options = ['--any', '--extra', '--opts'] # optional
+end

data/features/itudes.feature

@@ -0,0 +1,57 @@
+Feature: itudes library helps to handle everything against [lat,long]itudes
+   In order to improve developer experience with [lat,long]itude handling
+  A developer simply includes the library and yields class
+
+   Scenario: handy instantiation with floats
+      Given the itudes are instantiated with floats (57.3,37.5)
+      When I call `to_s` method
+      And I call `to_a` method
+      Then the proper string is to be created
+      And the proper array is to be created
+      And the value is considered to be valid
+
+   Scenario: handy instantiation with strings
+      Given the itudes are instantiated with strings (57.3,37.5)
+      When I call `to_s` method
+      And I call `to_a` method
+      Then the proper string is to be created
+      And the proper array is to be created
+      And the value is considered to be valid
+
+   Scenario: handy instantiation with an array
+      Given the itudes are instantiated with an array (57.3,37.5)
+      When I call `to_s` method
+      And I call `to_a` method
+      Then the proper string is to be created
+      And the proper array is to be created
+      And the value is considered to be valid
+
+   Scenario: handy instantiation with string
+      Given the itudes are instantiated with a string (53°11′18″N,37°5′18″E)
+      When I call `to_s` method
+      And I call `to_a` method
+      Then the proper string is to be created
+      And the proper array is to be created
+      And the value is considered to be valid
+      And the rounded value should equal to (53.0,37.0)
+
+   Scenario: invalid instantiation
+      Given the itudes are instantiated with a string (foo:bad)
+      Then the value is not considered to be valid
+
+   Scenario: distance between two points
+      Given the itudes are instantiated with a string (53°11′18″N,37°5′18″E)
+      When the other itudes are instantiated with an array (58 38 38N,003 04 12W)
+      Then the value is considered to be valid
+      And the distance equals to 2533 km
+      And the distance in miles equals to 1574 mi
+
+   Scenario: distance between two points with lazy Itudes instantiation
+      Given the itudes are instantiated with a string (53°11′18″N,37°5′18″E)
+      When the distance is calculated by implicit “- "58 38 38N,003 04 12W"”
+      Then the calculated distance equals to 2533 km
+
+   Scenario: distance between two points thru class method
+      Given the itudes are given with a string (53°11′18″N,37°5′18″E)
+      And the other itudes are given with a string (58 38 38N,003 04 12W)
+      Then the classs method gives distance equals to 2533 km

data/features/step_definitions/itudes_steps.rb

@@ -0,0 +1,86 @@
+Given(/^the itudes are instantiated with strings \((\d+\.\d+),(\d+\.\d+)\)$/) do |lat, lon|
+  @lat, @lon = lat, lon
+  @itudes = Geo::Itudes.new lat.to_s, lon.to_s
+end
+
+Given(/^the itudes are instantiated with floats \((\d+\.\d+),(\d+\.\d+)\)$/) do |lat, lon|
+  @lat, @lon = lat, lon
+  @itudes = Geo::Itudes.new lat.to_f, lon.to_f
+end
+
+Given(/^the itudes are instantiated with an array \((\d+\.\d+),(\d+\.\d+)\)$/) do |lat, lon|
+  @lat, @lon = lat, lon
+  @itudes = Geo::Itudes.new [lat, lon]
+end
+
+Given(/^the itudes are instantiated with a string \((\d+°\d+′\d+″N),(\d+°\d+′\d+″E)\)$/) do |lat, lon|
+  @lat, @lon = lat, lon
+  @itudes = Geo::Itudes.new "#{@lat},#{@lon}"
+end
+
+Given(/^the itudes are instantiated with a string \(([a-z]+):([a-z]+)\)$/) do |lat, lon|
+  @lat, @lon = lat, lon
+  @itudes = Geo::Itudes.new "#{@lat},#{@lon}"
+end
+
+When(/^I call `to_s` method$/) do
+  @itudes_to_s = @itudes.to_s
+end
+
+When(/^I call `to_a` method$/) do
+  @itudes_to_a = @itudes.to_a
+end
+
+Then(/^the proper string is to be created$/) do
+  @itudes_to_s.should == "#{@lat.to_itude},#{@lon.to_itude}"
+end
+
+Then(/^the proper array is to be created$/) do
+  @itudes_to_a.should == [@lat.to_itude.to_f, @lon.to_itude.to_f]
+end
+
+Then(/^the value is considered to be valid$/) do
+  @itudes.valid?.should == true
+end
+
+Then(/^the value is not considered to be valid$/) do
+  @itudes.valid?.should == false
+end
+
+When(/^the other itudes are instantiated with an array \((\d+ \d+ \d+N),(\d+ \d+ \d+W)\)$/) do |lat, lon|
+  @itudes_other_km = Geo::Itudes.new lat, lon
+  @itudes_other_mi = Geo::Itudes.new(lat, lon).miles!
+end
+
+Then(/^the distance equals to (\d+) km$/) do |dist_km|
+  (@itudes_other_km - @itudes).to_i.should == dist_km.to_i
+end
+
+Then(/^the distance in miles equals to (\d+) mi$/) do |dist_mi|
+  (@itudes_other_mi - @itudes).to_i.should == dist_mi.to_i
+end
+
+Given(/^the itudes are given with a string \((.+)\)$/) do |i1|
+  @i1 = i1
+end
+
+Given(/^the other itudes are given with a string \((.+)\)$/) do |i2|
+  @i2 = i2
+end
+
+Then(/^the classs method gives distance equals to (\d+) km$/) do |dist_km|
+  Geo::Itudes.distance(@i2, @i1).to_i.should == dist_km.to_i
+end
+
+Then(/^the rounded value should equal to \((.+)\)$/) do |rounded|
+  @itudes.round.should == Geo::Itudes.new(rounded)
+  @itudes.round.should == rounded
+end
+
+When(/^the distance is calculated by implicit “\- "(.*?)"”$/) do |other|
+  @calc_dist = @itudes - other
+end
+
+Then(/^the calculated distance equals to (\d+) km$/) do |dist|
+  dist.to_i.should == @calc_dist.to_i
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+
+require 'itudes'
+
+require 'rspec/expectations'

data/itudes.gemspec

@@ -0,0 +1,34 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'itudes/version'
+
+Gem::Specification.new do |s|
+  s.name = 'itudes'
+  s.version = Geo::Itudes::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.date = '2013-08-25'
+  s.authors = ['Alexei Matyushkin']
+  s.email = 'am@mudasobwa.ru'
+  s.homepage = 'http://github.com/mudasobwa/itudes'
+  s.summary = %Q{Small utility library to work with [lat,lang]itudes}
+  s.description = %Q{Utility library to simplify dealing with multitudes}
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'README.rdoc',
+  ]
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7')
+  s.rubygems_version = '1.3.7'
+  s.specification_version = 3
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'yard-cucumber'
+  s.add_development_dependency 'bueller'
+end
+

data/lib/itudes.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+# @author Alexei Matyushkin
+
+require "itudes/version"
+
+class String
+# Monkeypatches {String} class to parse strings representing multitudes.
+#   Accepts the following formats:
+#   - 53.1234565
+#   - 53°11′18″N
+#   - 53 11 18N
+#
+# @param strict [Boolean] the strictness of convertion (the method raises
+#   an exception if set to _true_
+# @return [Float] the multitude or `nil` if the convertion was not possible.
+  def to_itude strict = false
+    case self
+    when /^(?<val>[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?)$/ # -53.133333
+      $~[:val].to_f
+    when /(?<deg>\d+)[°\s]*(?<min>\d*)['’′\s]*(?<sec>\d*)["”″\s]*(?<ss>[NESWnesw]?)$/ # 53°11′18″N, 000°08′00″E
+      f = $~[:deg].to_f + $~[:min].to_f / 60.0 + $~[:sec].to_f / 3600.0
+      ($~[:ss].to_s.downcase =~ /[sw]/).nil? ? f : -f
+    else
+      strict ? raise(TypeError.new "no implicit conversion of string “#{self}” to [Lat,Long]itude") : nil
+    end
+  end
+end
+
+module Geo
+  # Convenience class to operate w/ multitudes.
+  class Itudes
+      attr_reader :latitude, :longitude, :units
+      # Earth radius in different measurement units (needed to calc distance
+      # between two points on the Earth.)
+      RADIUS = {
+        :km => 6_371, # km
+        :mi => 3_959  # mi
+      }
+      # Constructs the {Geo::Itudes} instance.
+      # If there are two parameters, they may be either strings or floats (or
+      # string and float.) If there is the only param, it may be one of the 
+      # following: 
+      #   - {Itudes} — produces a dup copy of it, 
+      #   - {String} — tries to parse string (see String#to_itude)
+      #   - {Array} — tries to parse elements
+      #
+      # @param v1 either latitude or one of possible multitudes representations
+      # @param v2 longitude (if given)
+      # @return [Itudes] the multitudes object
+      def initialize v1, v2 = nil
+        @latitude, @longitude = (v2.nil? ?
+            case v1
+              when Itudes  then [v1.latitude, v1.longitude]
+              when String then v1.split(',').map(&:to_itude)
+              when Array  then v1.map { |m| Itudes.tudify m }
+            end :
+            [Itudes.tudify(v1), Itudes.tudify(v2)]).map(&:to_f)
+        kilometers!
+      end
+      # Sets the internal measurement to miles (see #distance)
+      def miles!
+        @units = :mi
+        self
+      end
+      # Sets the internal measurement to kilometers (see #distance)
+      def kilometers!
+        @units = :km
+        self
+      end
+      # Compares against another instance. 
+      # @return [Boolean] _true_ if other value represents the same
+      #   multitudes values, _false_ otherwise
+      def == other
+        other = Itudes.new other
+        (@latitude == other.latitude) && (@longitude == other.longitude)
+      end
+      # String representation of multitudes.
+      # @return [String] in the form "53.121231231, -18.43534656"
+      def to_s
+        "#{@latitude},#{@longitude}"
+      end
+      # Array representation of multitudes.
+      # @return [Array] [@latitude, @longitude]
+      def to_a
+        [@latitude, @longitude]
+      end
+      # Calculates the nearest [lat,long] location, basing in the value of
+      #   parameter. E. g. for [53.121231231, -18.4353465] will return [53.0, -18.5].
+      #   It might be useful if we need to round multitudes to present them.
+      # @param slice [Number] the “modulo” to calculate nearest “rounded” value
+      # @return [Itudes] the rounded value
+      def round slice = 0.5
+        Itudes.new @latitude - @latitude.modulo(slice), @longitude - @longitude.modulo(slice)
+      end
+      # Checks if the multitudes behind represent the correct place on the Earth.
+      # @return [Boolean] _true_ if the multitudes are OK 
+      def valid?
+        !@latitude.nil? && !@longitude.nil? && !(@latitude.zero? && @longitude.zero?) && \
+            @latitude > -90 && @latitude < 90 && @longitude > -90 && @longitude < 90
+      end
+      # Calculates distance between two points on the Earth.
+      # @param other the place on the Earth to calculate distance to
+      # @return [Float] the distance between two places on the Earth
+      def distance other
+        o = Itudes.new other
+        raise ArgumentError.new "operand must be lat-/longitudable" if (o.latitude.nil? || o.longitude.nil?)
+
+        dlat = Itudes.radians(o.latitude - @latitude)
+        dlon = Itudes.radians(o.longitude - @longitude)
+        lat1 = Itudes.radians(@latitude)
+        lat2 = Itudes.radians(o.latitude);
+
+        a = Math::sin(dlat/2)**2 + Math::sin(dlon/2)**2 * Math::cos(lat1) * Math::cos(lat2)
+        (RADIUS[@units] * 2.0 * Math::atan2(Math.sqrt(a), Math.sqrt(1-a))).abs
+      end
+      alias :- :distance
+
+      # Calculates distance between two points on the Earth. Convenient method.
+      def self.distance start, finish
+        Itudes.new(start) - Itudes.new(finish)
+      end
+
+    private
+      def self.tudify val #:nodoc:
+        String === val ? val.to_itude : val
+      end
+      def self.radians degrees #:nodoc:
+        Math::PI * degrees / 180
+      end
+  end
+end

data/lib/itudes/version.rb

@@ -0,0 +1,5 @@
+module Geo
+  class Itudes
+    VERSION = "0.0.1"
+  end
+end

data/spec/itudes_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Geo::Itudes do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+
+require 'itudes'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: itudes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexei Matyushkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: cucumber
+  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: yard-cucumber
+  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: bueller
+  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: Utility library to simplify dealing with multitudes
+email: am@mudasobwa.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- features/itudes.feature
+- features/step_definitions/itudes_steps.rb
+- features/support/env.rb
+- itudes.gemspec
+- lib/itudes.rb
+- lib/itudes/version.rb
+- spec/itudes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mudasobwa/itudes
+licenses: []
+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: 1.3.7
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 3
+summary: Small utility library to work with [lat,lang]itudes
+test_files: []
+has_rdoc: