turkish_cities 0.1.2 → 0.4.0

data/lib/turkish_cities/data/neighborhoods_parser.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'yaml'
+
+require_relative '../helpers/decomposer_helper'
+
+module NeighborhoodsParser
+  include DecomposerHelper
+
+  district_hash = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+  mahalle_array = []
+  last_city = 'Adana'
+  last_district = ''
+  last_subdistrict = ''
+  last_postcode = 1720
+
+  # rubocop:disable Metrics/BlockLength
+  CSV.parse(File.read('ptt_list.csv'), headers: true).each do |row|
+    data_array = row['il;ilçe;semt_bucak_belde;Mahalle;PK'].split(';')
+
+    if data_array[0].downcase(:turkic).strip.capitalize(:turkic) != last_city ||
+       data_array[4].to_i != last_postcode
+      district_hash[last_district][last_subdistrict]['postcode'] = last_postcode
+      district_hash[last_district][last_subdistrict]['neighborhoods'] = mahalle_array
+      mahalle_array = []
+      if data_array[0].downcase(:turkic).strip.capitalize(:turkic) != last_city
+        file_name = create_file_path(last_city)
+        File.write("#{file_name}.yaml", district_hash.to_yaml)
+        district_hash = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+      end
+    end
+
+    mahalle = []
+    data_array[3].downcase(:turkic).strip.split(' ').each do |word|
+      if word[0] == '('
+        word[1] = word[1].capitalize!(:turkic) unless word[1].to_i.to_s == word[1]
+      else
+        word.capitalize!(:turkic)
+      end
+      mahalle << word
+    end
+
+    mahalle_array << mahalle.join(' ')
+
+    last_city = data_array[0].downcase(:turkic).strip.capitalize(:turkic)
+    last_district = data_array[1].downcase(:turkic).strip.capitalize(:turkic)
+    last_subdistrict = data_array[2].downcase(:turkic).strip.capitalize(:turkic)
+    last_postcode = data_array[4].to_i
+  end
+  # rubocop:enable Metrics/BlockLength
+end

data/lib/turkish_cities/distance.rb

@@ -0,0 +1,131 @@
+# 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
+    city_array = find_city_attributes
+    case city_array
+    when String
+      city_array
+    when Array
+      results = []
+      results[0] = calculate_land_distance(city_array)
+      results[1] = description_text('Land', city_array, results)
+      results
+    end
+  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
+
+  # rubocop:disable Metrics/AbcSize
+  def calculate_land_distance(city_array)
+    # Distance information between cities are kept in yaml files in a plate number order
+    # For example if distance between plate number 10 with plate number 3
+    # Order should be 3 to 10 not 10 to 3
+    if city_array[0]['plate_number'] > city_array[1]['plate_number']
+      return city_array[1]['land_distance'][city_array[0]['plate_number'] - city_array[1]['plate_number'] - 1]
+    end
+
+    city_array[0]['land_distance'][city_array[1]['plate_number'] - city_array[0]['plate_number'] - 1]
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  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)
+    if travel_method == 'Air'
+      return "#{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
+
+    "#{travel_method} travel distance between #{city_array[0]['name']} and #{city_array[1]['name']} is " \
+        "#{result_set[0]} km."
+  end
+end

data/lib/turkish_cities/district.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'yaml'
+
+require_relative '../turkish_cities/helpers/decomposer_helper'
+
+class District
+  include DecomposerHelper
+
+  def initialize(city_name, district_name)
+    @city_name = city_name
+    @district_name = district_name
+    @district_list = create_district_list(city_name)
+  end
+
+  def subdistricts
+    return district_not_found_error(@district_name, @city_name) if district_item.nil?
+
+    sort_alphabetically(district_item.keys)
+  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(subdistrict_name)
+    return create_neighborhoods_without_subdistrict_name if subdistrict_name.nil?
+
+    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_item.values.map { |subdistrict| subdistrict['neighborhoods'] }.flatten
+  end
+
+  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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module DecomposerHelper
+  def check_input_range(input, min, max)
+    return if input.to_i.between?(min, max)
+
+    raise RangeError, "Given value [#{input}] is outside bounds of #{min} to #{max}."
+  end
+
+  def city_not_found_error(input)
+    "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
+
+  def create_district_list(city_name)
+    file_name = create_file_path(city_name)
+    file_path = File.join(File.dirname(__FILE__), "../data/districts/#{file_name}.yaml")
+    begin
+      YAML.load_file(file_path)
+    rescue Errno::ENOENT => e
+      "Caught the exception: #{e}"
+    end
+  end
+
+  def create_file_path(city_name)
+    char_fallbacks = { 'ç' => 'c', 'ğ' => 'g', 'ı' => 'i', 'ö' => 'o', 'ş' => 's', 'ü' => 'u' }
+    city_name.downcase(:turkic).encode('ASCII', 'UTF-8', fallback: char_fallbacks)
+  end
+
+  def district_not_found_error(district_input, city_input)
+    "Couldn't find district name with '#{district_input}' of '#{city_input}'"
+  end
+
+  def postcode_not_found_error(postcode_input)
+    "Couldn't find any subdistrict with postcode '#{postcode_input}'"
+  end
+
+  def prepare_city_list(city_list, options)
+    if options[:with]
+      city_list.map do |city|
+        result = {}
+        result[:name] = city['name']
+
+        add_plate_number_if_requested(result, city, options)
+        add_phone_code_if_requested(result, city, options)
+        add_metropolitan_municipality_if_requested(result, city, options)
+
+        result[:region] = city['region'] if options.dig(:with, :region) || options.dig(:with, :all)
+        result
+      end
+    else
+      city_list.map do |city|
+        city['name']
+      end
+    end
+  end
+
+  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[:with].nil?
+                       item
+                     else
+                       item[:name]
+                     end
+      item_to_sort.downcase(:turkic).chars.map { |char| turkish_alphabet.index(char) }
+    end
+  end
+
+  def subdistrict_not_found_error(subdistrict_input, district_input, city_input)
+    "Couldn't find subdistrict with '#{subdistrict_input}' of '#{district_input}'/'#{city_input}'"
+  end
+
+  private
+
+  def add_plate_number_if_requested(result, city, options = nil)
+    return unless options.dig(:with, :plate_number) || options.dig(:with, :all)
+
+    result[:plate_number] = city['plate_number']
+  end
+
+  def add_phone_code_if_requested(result, city, options = nil)
+    return unless options.dig(:with, :phone_code) || options.dig(:with, :all)
+
+    result[:phone_code] = city['phone_code']
+  end
+
+  def add_metropolitan_municipality_if_requested(result, city, options = nil)
+    return unless options.dig(:with, :metropolitan_municipality_since) || options.dig(:with, :all)
+
+    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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'yaml'
+
+require_relative '../turkish_cities/helpers/decomposer_helper'
+
+class Postcode
+  include DecomposerHelper
+
+  def find_by_postcode(postcode)
+    check_input_range(postcode, 1010, 81_952)
+
+    city_name = City.new.find_by_id(postcode.to_i / 1000)
+    city_file = create_district_list(city_name)
+
+    city_file.each do |district|
+      district_name = district[0]
+      district[1].each do |subdistrict|
+        return [city_name, district_name, subdistrict[0]] if subdistrict[1]['postcode'] == postcode.to_i
+      end
+    end
+    postcode_not_found_error(postcode)
+  end
+end

data/lib/turkish_cities/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TurkishCities
-  VERSION = '0.1.2'
+  VERSION = '0.4.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'
 
@@ -21,10 +21,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'i18n', ['>= 0.6.4', '<= 2']
 
-  s.add_development_dependency 'bundler', '~> 2.1.4'
+  s.add_development_dependency 'bundler', '~> 2.2.16'
   s.add_development_dependency 'coveralls', '~> 0.8.23'
-  s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.80.1'
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turkish_cities
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Semih Arslanoglu
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.16
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -64,35 +64,40 @@ 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.80.1
+        version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.1
-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: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
@@ -100,6 +105,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -107,7 +113,99 @@ files:
 - lib/turkish_cities.rb
 - lib/turkish_cities/city.rb
 - lib/turkish_cities/data/cities.yaml
+- lib/turkish_cities/data/districts/adana.yaml
+- lib/turkish_cities/data/districts/adiyaman.yaml
+- lib/turkish_cities/data/districts/afyon.yaml
+- lib/turkish_cities/data/districts/agri.yaml
+- lib/turkish_cities/data/districts/aksaray.yaml
+- lib/turkish_cities/data/districts/amasya.yaml
+- lib/turkish_cities/data/districts/ankara.yaml
+- lib/turkish_cities/data/districts/antalya.yaml
+- lib/turkish_cities/data/districts/ardahan.yaml
+- lib/turkish_cities/data/districts/artvin.yaml
+- lib/turkish_cities/data/districts/aydin.yaml
+- lib/turkish_cities/data/districts/balikesir.yaml
+- lib/turkish_cities/data/districts/bartin.yaml
+- lib/turkish_cities/data/districts/batman.yaml
+- lib/turkish_cities/data/districts/bayburt.yaml
+- lib/turkish_cities/data/districts/bilecik.yaml
+- lib/turkish_cities/data/districts/bingol.yaml
+- lib/turkish_cities/data/districts/bitlis.yaml
+- lib/turkish_cities/data/districts/bolu.yaml
+- lib/turkish_cities/data/districts/burdur.yaml
+- lib/turkish_cities/data/districts/bursa.yaml
+- lib/turkish_cities/data/districts/canakkale.yaml
+- lib/turkish_cities/data/districts/cankiri.yaml
+- lib/turkish_cities/data/districts/corum.yaml
+- lib/turkish_cities/data/districts/denizli.yaml
+- lib/turkish_cities/data/districts/diyarbakir.yaml
+- lib/turkish_cities/data/districts/duzce.yaml
+- lib/turkish_cities/data/districts/edirne.yaml
+- lib/turkish_cities/data/districts/elazig.yaml
+- lib/turkish_cities/data/districts/erzincan.yaml
+- lib/turkish_cities/data/districts/erzurum.yaml
+- lib/turkish_cities/data/districts/eskisehir.yaml
+- lib/turkish_cities/data/districts/gaziantep.yaml
+- lib/turkish_cities/data/districts/giresun.yaml
+- lib/turkish_cities/data/districts/gumushane.yaml
+- lib/turkish_cities/data/districts/hakkari.yaml
+- lib/turkish_cities/data/districts/hatay.yaml
+- lib/turkish_cities/data/districts/igdir.yaml
+- lib/turkish_cities/data/districts/isparta.yaml
+- lib/turkish_cities/data/districts/istanbul.yaml
+- lib/turkish_cities/data/districts/izmir.yaml
+- lib/turkish_cities/data/districts/kahramanmaras.yaml
+- lib/turkish_cities/data/districts/karabuk.yaml
+- lib/turkish_cities/data/districts/karaman.yaml
+- lib/turkish_cities/data/districts/kars.yaml
+- lib/turkish_cities/data/districts/kastamonu.yaml
+- lib/turkish_cities/data/districts/kayseri.yaml
+- lib/turkish_cities/data/districts/kilis.yaml
+- lib/turkish_cities/data/districts/kirikkale.yaml
+- lib/turkish_cities/data/districts/kirklareli.yaml
+- lib/turkish_cities/data/districts/kirsehir.yaml
+- lib/turkish_cities/data/districts/kocaeli.yaml
+- lib/turkish_cities/data/districts/konya.yaml
+- lib/turkish_cities/data/districts/kutahya.yaml
+- lib/turkish_cities/data/districts/malatya.yaml
+- lib/turkish_cities/data/districts/manisa.yaml
+- lib/turkish_cities/data/districts/mardin.yaml
+- lib/turkish_cities/data/districts/mersin.yaml
+- lib/turkish_cities/data/districts/mugla.yaml
+- lib/turkish_cities/data/districts/mus.yaml
+- lib/turkish_cities/data/districts/nevsehir.yaml
+- lib/turkish_cities/data/districts/nigde.yaml
+- lib/turkish_cities/data/districts/ordu.yaml
+- lib/turkish_cities/data/districts/osmaniye.yaml
+- lib/turkish_cities/data/districts/rize.yaml
+- lib/turkish_cities/data/districts/sakarya.yaml
+- lib/turkish_cities/data/districts/samsun.yaml
+- lib/turkish_cities/data/districts/sanliurfa.yaml
+- lib/turkish_cities/data/districts/siirt.yaml
+- lib/turkish_cities/data/districts/sinop.yaml
+- lib/turkish_cities/data/districts/sirnak.yaml
+- lib/turkish_cities/data/districts/sivas.yaml
+- lib/turkish_cities/data/districts/tekirdag.yaml
+- lib/turkish_cities/data/districts/tokat.yaml
+- lib/turkish_cities/data/districts/trabzon.yaml
+- lib/turkish_cities/data/districts/tunceli.yaml
+- lib/turkish_cities/data/districts/usak.yaml
+- lib/turkish_cities/data/districts/van.yaml
+- lib/turkish_cities/data/districts/yalova.yaml
+- 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:
@@ -131,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: List and find Turkish cities