turkish_cities 0.1.0 → 0.2.1

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/district.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'yaml'
+
+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
+  end
+
+  def list_neighborhoods(city_name, district_name, subdistrict_name)
+    district_list = create_district_list(city_name)
+
+    if !district_list[district_name].nil?
+      neighborhoods = create_neighborhoods(district_list, city_name,
+                                           district_name, subdistrict_name)
+
+      neighborhoods.is_a?(Array) ? sort_alphabetically(neighborhoods) : neighborhoods
+    else
+      district_not_found_error(district_name, city_name)
+    end
+  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
+
+      create_neighborhoods_with_subdistrict_name(district_list, district_name, subdistrict_name)
+    end
+  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
+  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
+  end
+end

data/lib/turkish_cities/helpers/decomposer_helper.rb

@@ -0,0 +1,96 @@
+# 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 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.dig(: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.dig(: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
+end

data/lib/turkish_cities/postcode.rb

@@ -0,0 +1,27 @@
+# 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|
+        if subdistrict[1]['postcode'] == postcode.to_i
+          return [city_name, district_name, subdistrict[0]]
+        end
+      end
+    end
+    postcode_not_found_error(postcode)
+  end
+end

data/lib/turkish_cities/version.rb

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

data/turkish_cities.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'turkish_cities/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'turkish_cities'
+  s.version               = TurkishCities::VERSION
+  s.required_ruby_version = '>= 2.5.1'
+  s.authors               = ['Semih Arslanoglu']
+  s.email                 = 'arslanoglusemih93@gmail.com'
+
+  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.homepage              = 'https://github.com/sarslanoglu/turkish_cities'
+  s.license               = 'MIT'
+
+  s.files                 = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.test_files            = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths         = ['lib']
+
+  s.add_dependency 'i18n', ['>= 0.6.4', '<= 2']
+
+  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'
+
+  if s.respond_to?(:metadata)
+    s.metadata['changelog_uri'] = 'https://github.com/sarslanoglu/turkish_cities/blob/master/CHANGELOG.md'
+    s.metadata['source_code_uri'] = 'https://github.com/sarslanoglu/turkish_cities'
+    s.metadata['bug_tracker_uri'] = 'https://github.com/sarslanoglu/turkish_cities/issues'
+  end
+end

metadata

@@ -1,28 +1,211 @@
 --- !ruby/object:Gem::Specification
 name: turkish_cities
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Semih Arslanoglu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
-dependencies: []
-description: Simple ruby gem for listing turkish cities
+date: 2020-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  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
 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"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
 - lib/turkish_cities.rb
 - lib/turkish_cities/city.rb
-- lib/turkish_cities/data/city_list.rb
-homepage: https://rubygems.org/gems/turkish_cities
+- 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/district.rb
+- lib/turkish_cities/helpers/decomposer_helper.rb
+- lib/turkish_cities/postcode.rb
+- lib/turkish_cities/version.rb
+- turkish_cities.gemspec
+homepage: https://github.com/sarslanoglu/turkish_cities
 licenses:
 - MIT
-metadata: {}
+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: 
 rdoc_options: []
 require_paths:
@@ -31,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -41,5 +224,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Discover The Potential
+summary: List and find Turkish cities
 test_files: []