turkish_cities 0.2.1 → 0.3.0

data/lib/turkish_cities/distance.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'yaml'
+
+require_relative '../turkish_cities/helpers/decomposer_helper'
+
+class Distance
+  include DecomposerHelper
+
+  file_path = File.join(File.dirname(__FILE__), 'data/cities.yaml')
+  CITY_LIST = YAML.load_file(file_path)
+  RADIUS_OF_EARTH = 6371 # Earth radius in km is 6371
+
+  def initialize(from, to, travel_method)
+    @from = from
+    @to = to
+    @travel_method = travel_method
+  end
+
+  def distance_between
+    case @travel_method
+    when 'land'
+      distance_between_land
+    when 'sea'
+      distance_between_sea
+    when 'air'
+      distance_between_air
+    else
+      unsupported_travel_method(@travel_method)
+    end
+  end
+
+  private
+
+  def distance_between_land
+    # TODO
+  end
+
+  def distance_between_sea
+    # TODO
+  end
+
+  def distance_between_air
+    city_array = find_city_attributes
+    case city_array
+    when String
+      city_array
+    when Array
+      results = []
+      results[0] = calculate_flight_distance(city_array).round(2)
+      results[1] = distance_time_estimation(results[0]).to_i
+      results[2] = description_text('Air', city_array, results)
+      results
+    end
+  end
+
+  def find_city_attributes
+    from_city = to_city = nil
+
+    CITY_LIST.each do |city|
+      from_city = city if convert_chars(@from) == convert_chars(city['name'])
+      to_city = city if convert_chars(@to) == convert_chars(city['name'])
+    end
+
+    from_city.nil? || to_city.nil? ? cities_not_found_error(@from, @to) : [from_city, to_city]
+  end
+
+  def degree_to_radian(degree)
+    degree * Math::PI / 180
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def calculate_flight_distance(city_array)
+    lat_diff = degree_to_radian(city_array[1]['latitude'] - city_array[0]['latitude'])
+    lng_diff = degree_to_radian(city_array[1]['longitude'] - city_array[0]['longitude'])
+
+    from_lat = degree_to_radian(city_array[0]['latitude'])
+    to_lat = degree_to_radian(city_array[1]['latitude'])
+
+    cosines_var = (Math.sin(lat_diff / 2)**2) + ((Math.sin(lng_diff / 2)**2) * (Math.cos(from_lat) * Math.cos(to_lat)))
+    result = 2 * Math.atan2(Math.sqrt(cosines_var), Math.sqrt(1 - cosines_var))
+    RADIUS_OF_EARTH * result
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # Time estimation for air travel. For planes take-off and landing took nearly same amount.
+  # Longer the distance shorter the time. Flying out at high altitude makes less air resistance / more speed
+  def distance_time_estimation(air_distance)
+    case air_distance
+    when 0..400
+      (air_distance / 10) + 30
+    when 400..1000
+      (air_distance / 11.25) + 30
+    else
+      (air_distance / 12.5) + 25
+    end
+  end
+
+  def description_text(travel_method, city_array, result_set)
+    "#{travel_method} travel distance between #{city_array[0]['name']} and #{city_array[1]['name']} is " \
+      "#{result_set[0]} km. Estimated air travel would take #{result_set[1]} minutes."
+  end
+end

data/lib/turkish_cities/district.rb

@@ -8,62 +8,46 @@ require_relative '../turkish_cities/helpers/decomposer_helper'
 class District
   include DecomposerHelper
 
-  def list_subdistricts(city_name, district_name)
-    district_list = create_district_list(city_name)
-
-    if !district_list[district_name].nil?
-      subdistricts = []
-      district_list[district_name].each do |subdistrict|
-        subdistricts << subdistrict[0]
-      end
-      sort_alphabetically(subdistricts)
-    else
-      district_not_found_error(district_name, city_name)
-    end
+  def initialize(city_name, district_name)
+    @city_name = city_name
+    @district_name = district_name
+    @district_list = create_district_list(city_name)
   end
 
-  def list_neighborhoods(city_name, district_name, subdistrict_name)
-    district_list = create_district_list(city_name)
+  def subdistricts
+    return district_not_found_error(@district_name, @city_name) if district_item.nil?
 
-    if !district_list[district_name].nil?
-      neighborhoods = create_neighborhoods(district_list, city_name,
-                                           district_name, subdistrict_name)
+    sort_alphabetically(district_item.keys)
+  end
 
-      neighborhoods.is_a?(Array) ? sort_alphabetically(neighborhoods) : neighborhoods
-    else
-      district_not_found_error(district_name, city_name)
-    end
+  def neighborhoods(subdistrict_name)
+    return district_not_found_error(@district_name, @city_name) if district_item.nil?
+
+    neighborhoods = create_neighborhoods(subdistrict_name)
+    neighborhoods.is_a?(Array) ? sort_alphabetically(neighborhoods) : neighborhoods
   end
 
   private
 
-  def create_neighborhoods(district_list, city_name, district_name, subdistrict_name)
-    if subdistrict_name.nil?
-      create_neighborhoods_without_subdistrict_name(district_list, district_name)
-    else
-      if district_list[district_name][subdistrict_name].nil?
-        return subdistrict_not_found_error(subdistrict_name, district_name, city_name)
-      end
+  def create_neighborhoods(subdistrict_name)
+    return create_neighborhoods_without_subdistrict_name if subdistrict_name.nil?
 
-      create_neighborhoods_with_subdistrict_name(district_list, district_name, subdistrict_name)
+    if district_item[subdistrict_name].nil?
+      return subdistrict_not_found_error(subdistrict_name, @district_name, @city_name)
     end
+
+    create_neighborhoods_with_subdistrict_name(subdistrict_name)
   end
 
-  def create_neighborhoods_without_subdistrict_name(district_list, district_name)
-    neighborhoods = []
-    district_list[district_name].each do |subdistrict|
-      subdistrict[1]['neighborhoods'].each do |neighborhood|
-        neighborhoods << neighborhood
-      end
-    end
-    neighborhoods
+  def create_neighborhoods_without_subdistrict_name
+    district_item.values.map { |subdistrict| subdistrict['neighborhoods'] }.flatten
   end
 
-  def create_neighborhoods_with_subdistrict_name(district_list, district_name, subdistrict_name)
-    neighborhoods = []
-    district_list[district_name][subdistrict_name]['neighborhoods'].each do |neighborhood|
-      neighborhoods << neighborhood
-    end
-    neighborhoods
+  def create_neighborhoods_with_subdistrict_name(subdistrict_name)
+    district_item[subdistrict_name]['neighborhoods']
+  end
+
+  def district_item
+    @district_list[@district_name]
   end
 end

data/lib/turkish_cities/helpers/decomposer_helper.rb

@@ -11,6 +11,10 @@ module DecomposerHelper
     "Couldn't find city name with '#{input}'"
   end
 
+  def cities_not_found_error(first, second)
+    "Couldn't find cities combination with '#{first}/#{second}'"
+  end
+
   def convert_chars(string)
     I18n.transliterate(string.downcase(:turkic))
   end
@@ -39,7 +43,7 @@ module DecomposerHelper
   end
 
   def prepare_city_list(city_list, options)
-    if options.dig(:with)
+    if options[:with]
       city_list.map do |city|
         result = {}
         result[:name] = city['name']
@@ -61,7 +65,7 @@ module DecomposerHelper
   def sort_alphabetically(list, options = nil)
     turkish_alphabet = ' -0123456789abcçdefgğhıijklmnoöprsştuüvyz'
     list.sort_by do |item|
-      item_to_sort = if options.nil? || options.dig(:with).nil?
+      item_to_sort = if options.nil? || options[:with].nil?
                        item
                      else
                        item[:name]
@@ -93,4 +97,8 @@ module DecomposerHelper
 
     result[:metropolitan_municipality_since] = city['metropolitan_municipality_since']
   end
+
+  def unsupported_travel_method(input)
+    "Travel method '#{input}' is unsupported"
+  end
 end

data/lib/turkish_cities/postcode.rb

@@ -17,9 +17,7 @@ class Postcode
     city_file.each do |district|
       district_name = district[0]
       district[1].each do |subdistrict|
-        if subdistrict[1]['postcode'] == postcode.to_i
-          return [city_name, district_name, subdistrict[0]]
-        end
+        return [city_name, district_name, subdistrict[0]] if subdistrict[1]['postcode'] == postcode.to_i
       end
     end
     postcode_not_found_error(postcode)

data/lib/turkish_cities/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TurkishCities
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/turkish_cities.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
 
   s.date                  = '2020-04-13'
   s.summary               = 'List and find Turkish cities'
-  s.description           = 'Simple ruby gem for listing and finding Turkish cities via name, plate number or size'
+  s.description           = 'List and find Turkish cities via name, district name, post code, plate number. Calculate air travel distance between cities and get realistic estimates of travel time'
   s.homepage              = 'https://github.com/sarslanoglu/turkish_cities'
   s.license               = 'MIT'
 
@@ -23,8 +23,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler', '~> 2.1.4'
   s.add_development_dependency 'coveralls', '~> 0.8.23'
-  s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.86.0'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+  s.add_development_dependency 'rubocop', '~> 1.3.1'
 
   if s.respond_to?(:metadata)
     s.metadata['changelog_uri'] = 'https://github.com/sarslanoglu/turkish_cities/blob/master/CHANGELOG.md'

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: turkish_cities
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Semih Arslanoglu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-04-13 00:00:00.000000000 Z
@@ -64,30 +64,31 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
-description: Simple ruby gem for listing and finding Turkish cities via name, plate
-  number or size
+        version: 1.3.1
+description: List and find Turkish cities via name, district name, post code, plate
+  number. Calculate air travel distance between cities and get realistic estimates
+  of travel time
 email: arslanoglusemih93@gmail.com
 executables: []
 extensions: []
@@ -194,10 +195,17 @@ files:
 - lib/turkish_cities/data/districts/yozgat.yaml
 - lib/turkish_cities/data/districts/zonguldak.yaml
 - lib/turkish_cities/data/neighborhoods_parser.rb
+- lib/turkish_cities/distance.rb
 - lib/turkish_cities/district.rb
 - lib/turkish_cities/helpers/decomposer_helper.rb
 - lib/turkish_cities/postcode.rb
 - lib/turkish_cities/version.rb
+- public/assets/img/TurkishCities_darkblue-on-yellow_800X800@3x-8.png
+- public/assets/img/TurkishCities_darkblue-on-yellow_914X343@3x-8.png
+- public/assets/img/TurkishCities_darkblue-on-yellow_horizontal_914X343@3x-8.png
+- public/assets/img/TurkishCities_yellow-on-darkblue_800X800@3x-8.png
+- public/assets/img/TurkishCities_yellow-on-darkblue_914X343@3x-8.png
+- public/assets/img/TurkishCities_yellow-on-darkblue_horizontal_914X343@3x-8.png
 - turkish_cities.gemspec
 homepage: https://github.com/sarslanoglu/turkish_cities
 licenses:
@@ -206,7 +214,7 @@ metadata:
   changelog_uri: https://github.com/sarslanoglu/turkish_cities/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/sarslanoglu/turkish_cities
   bug_tracker_uri: https://github.com/sarslanoglu/turkish_cities/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: List and find Turkish cities
 test_files: []