japan_etc 0.1.0

data/japan_etc.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'japan_etc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'japan_etc'
+  spec.version       = JapanETC::VERSION
+  spec.authors       = ['Yuji Nakayama']
+  spec.email         = ['nkymyj@gmail.com']
+
+  spec.summary       = 'Japan ETC (Electronic Toll Collection System) database'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/yujinakayama/japan_etc'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 0.15'
+  spec.add_runtime_dependency 'pdf-reader', '~> 2.2'
+  spec.add_runtime_dependency 'spreadsheet', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+end

data/lib/japan_etc.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'japan_etc/version'
+
+module JapanETC
+end

data/lib/japan_etc/database.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'japan_etc/database_provider'
+require 'csv'
+
+module JapanETC
+  class Database
+    CSV_HEADER = %i[
+      road_number
+      tollbooth_number
+      road_name
+      route_name
+      tollbooth_name
+      direction
+      entrance_or_exit
+      notes
+    ].freeze
+
+    def roads
+      tollbooths.map(&:road).uniq
+    end
+
+    def tollbooths
+      @tollbooths ||= providers.map(&:fetch_tollbooths).flatten.uniq
+    end
+
+    def save_as_csv(filename: 'database/japan_etc_tollbooths.csv')
+      CSV.open(filename, 'w') do |csv|
+        csv << CSV_HEADER
+        tollbooths.each { |tollbooth| csv << tollbooth.to_a }
+      end
+    end
+
+    def providers
+      DatabaseProvider::Base.all.map(&:new)
+    end
+  end
+end

data/lib/japan_etc/database_provider.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'japan_etc/database_provider/metropolitan_expressway'
+require 'japan_etc/database_provider/hanshin_expressway'
+require 'japan_etc/database_provider/central_nexco'

data/lib/japan_etc/database_provider/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JapanETC
+  module DatabaseProvider
+    class Base
+      def self.inherited(subclass)
+        all << subclass
+      end
+
+      def self.all
+        @all ||= []
+      end
+
+      def fetch_tollbooths
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/japan_etc/database_provider/central_nexco.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'japan_etc/database_provider/base'
+require 'japan_etc/tollbooth'
+require 'japan_etc/util'
+require 'faraday'
+require 'pdf-reader'
+
+module JapanETC
+  module DatabaseProvider
+    # https://highwaypost.c-nexco.co.jp/faq/etc/use/50.html
+    class CentralNEXCO < Base
+      include Util
+
+      URL = 'https://highwaypost.c-nexco.co.jp/faq/etc/use/documents/190423-2etcriyoukanouic.pdf'
+
+      WHITESPACE = /[\s　]/.freeze
+
+      TOLLBOOTH_LINE_PATTERN = /
+        \A
+        (?:
+          #{WHITESPACE}{,10}(?<road_name>[^#{WHITESPACE}\d（【][^#{WHITESPACE}]*)#{WHITESPACE}+
+          |
+          #{WHITESPACE}{,10}(?:[（【][^#{WHITESPACE}]+)#{WHITESPACE}+ # Obsolete road name
+          |
+          #{WHITESPACE}{10,}
+        )
+        (?:
+          (?<tollbooth_name>[^#{WHITESPACE}\d（【][^#{WHITESPACE}]*)
+          #{WHITESPACE}+
+        )?
+        (?<identifiers>\d{2}#{WHITESPACE}+\d{3}\b.*?)
+        (?:
+          ※
+          (?<note>.+?)
+          #{WHITESPACE}*
+        )?
+        \z
+      /x.freeze
+
+      IDENTIFIER_PATTERN = /\b(\d{2})#{WHITESPACE}+(\d{3})\b/.freeze
+
+      attr_reader :current_road_name, :current_route_name, :current_tollbooth_name
+
+      def fetch_tollbooths
+        lines.flat_map { |line| parse_line(line) }.compact
+      end
+
+      def parse_line(line)
+        match = line.match(TOLLBOOTH_LINE_PATTERN)
+        return unless match
+
+        if match[:road_name]
+          @current_road_name, @current_route_name =
+            extract_route_name_from_road_name(match[:road_name])
+          @current_road_name = canonicalize(@current_road_name)
+        end
+
+        @current_tollbooth_name = match[:tollbooth_name] if match[:tollbooth_name]
+
+        identifiers = match[:identifiers].scan(IDENTIFIER_PATTERN)
+
+        identifiers.map do |identifier|
+          Tollbooth.create(
+            road_number: identifier.first,
+            tollbooth_number: identifier.last,
+            road_name: current_road_name,
+            route_name: current_route_name,
+            name: current_tollbooth_name,
+            note: match[:note]
+          )
+        end
+      end
+
+      def extract_route_name_from_road_name(road_name)
+        road_name = normalize(road_name)
+        match = road_name.match(/\A(?<road_name>.+?)(?<route_name>\d+号.+)?\z/)
+        road_name = match[:road_name].sub(/高速\z/, '高速道路')
+        [road_name, match[:route_name]]
+      end
+
+      def canonicalize(road_name)
+        road_name = '首都圏中央連絡自動車道' if road_name == '首都圏中央連絡道'
+        road_name = road_name.sub(/高速\z/, '高速道路')
+        road_name
+      end
+
+      def lines
+        pdf.pages.flat_map { |page| page.text.each_line.map(&:chomp).to_a }
+      end
+
+      def pdf
+        response = Faraday.get(URL)
+        PDF::Reader.new(StringIO.new(response.body))
+      end
+    end
+  end
+end

data/lib/japan_etc/database_provider/hanshin_expressway.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'japan_etc/database_provider/base'
+require 'japan_etc/tollbooth'
+require 'faraday'
+require 'spreadsheet'
+
+module JapanETC
+  module DatabaseProvider
+    # https://www.hanshin-exp.co.jp/drivers/ryoukin/etc_ryokinsyo/
+    class HanshinExpressway < Base
+      URL = 'https://www.hanshin-exp.co.jp/drivers/ryoukin/files/code_20170516.xls'
+
+      def fetch_tollbooths
+        rows.flat_map do |row|
+          process_row(row)
+        end.compact
+      end
+
+      def process_row(row)
+        route_name, road_number, tollbooth_number, tollbooth_name, _, note = row
+
+        return nil if !road_number.is_a?(Numeric) || !tollbooth_number.is_a?(Numeric)
+
+        tollbooth = Tollbooth.create(
+          road_number: road_number,
+          tollbooth_number: tollbooth_number,
+          road_name: '阪神高速道路',
+          route_name: route_name,
+          name: tollbooth_name,
+          note: note
+        )
+
+        remove_redundant_name_suffix!(tollbooth)
+
+        tollbooth
+      end
+
+      def remove_redundant_name_suffix!(tollbooth)
+        return unless tollbooth.entrance_or_exit
+
+        tollbooth.name.sub!(/[入出]\z/) do |match|
+          found_entrance_or_exit = EntranceOrExit.from(match)
+          found_entrance_or_exit == tollbooth.entrance_or_exit ? '' : match
+        end
+      end
+
+      def rows
+        workbook.worksheets.first.rows
+      end
+
+      def workbook
+        response = Faraday.get(URL)
+        Spreadsheet.open(StringIO.new(response.body))
+      end
+    end
+  end
+end

data/lib/japan_etc/database_provider/metropolitan_expressway.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'japan_etc/database_provider/base'
+require 'japan_etc/tollbooth'
+require 'csv'
+require 'faraday'
+
+module JapanETC
+  module DatabaseProvider
+    # https://www.shutoko.jp/fee/tollbooth/
+    class MetropolitanExpressway < Base
+      URL = 'https://www.shutoko.jp/fee/tollbooth/~/media/pdf/customer/fee/tollbooth/code190201.csv/'
+
+      OPPOSITE_DIRECTIONS = {
+        '上' => '下',
+        '下' => '上',
+        '外' => '内',
+        '内' => '外',
+        '東' => '西',
+        '西' => '東'
+      }.freeze
+
+      DIRECTION_SUFFIX_PATTERN = /[#{OPPOSITE_DIRECTIONS.keys.join('')}]\z/.freeze
+
+      def fetch_tollbooths
+        original_tollbooths.map do |original_tollbooth|
+          tollbooth = original_tollbooth.dup
+          extract_direction_from_name!(tollbooth)
+          tollbooth
+        end
+      end
+
+      def extract_direction_from_name!(tollbooth)
+        match = tollbooth.name.match(DIRECTION_SUFFIX_PATTERN)
+
+        return unless match
+
+        direction = match.to_s
+
+        return if %w[東 西].include?(direction) && tollbooth.road.route_name != '湾岸線'
+
+        opposite_name = tollbooth.name.sub(DIRECTION_SUFFIX_PATTERN, OPPOSITE_DIRECTIONS[direction])
+
+        opposite_tollbooth_exists = original_tollbooths.find do |other_tollbooth|
+          other_tollbooth.road == tollbooth.road && other_tollbooth.name == opposite_name
+        end
+
+        return unless opposite_tollbooth_exists
+
+        tollbooth.direction = Direction.from(direction)
+        tollbooth.name.sub!(DIRECTION_SUFFIX_PATTERN, '')
+      end
+
+      def original_tollbooths
+        @original_tollbooths ||= rows.map do |row|
+          Tollbooth.create(
+            road_number: row[0],
+            tollbooth_number: row[1],
+            road_name: '首都高速道路',
+            route_name: row[2],
+            name: row[3],
+            entrance_or_exit: EntranceOrExit.from(row[4])
+          )
+        end
+      end
+
+      def rows
+        CSV.parse(csv, headers: :first_row)
+      end
+
+      def csv
+        shiftjis_csv.encode(Encoding::UTF_8)
+      end
+
+      def shiftjis_csv
+        response = Faraday.get(URL)
+        response.body.force_encoding(Encoding::Shift_JIS)
+      end
+    end
+  end
+end

data/lib/japan_etc/direction.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JapanETC
+  module Direction
+    INBOUND          = '上り'
+    OUTBOUND         = '下り'
+    CLOCKWISE        = '外回り'
+    COUNTERCLOCKWISE = '内回り'
+    NORTH            = '北行き'
+    SOUTH            = '南行き'
+    EAST             = '東行き'
+    WEST             = '西行き'
+
+    def self.from(text)
+      case text
+      when '上り', '上'
+        INBOUND
+      when '下り', '下'
+        OUTBOUND
+      when '外回り', '外'
+        CLOCKWISE
+      when '内回り', '内'
+        COUNTERCLOCKWISE
+      when /北行/, '北'
+        NORTH
+      when /南行/, '南'
+        SOUTH
+      when /東行/, '東'
+        EAST
+      when /西行/, '西'
+        WEST
+      end
+    end
+  end
+end

data/lib/japan_etc/entrance_or_exit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module JapanETC
+  module EntranceOrExit
+    ENTRANCE = '入口'
+    EXIT     = '出口'
+
+    def self.from(text)
+      case text
+      when /入口/, /（入）/, '入'
+        ENTRANCE
+      when /出口/, /（出）/, '出'
+        EXIT
+      end
+    end
+  end
+end

data/lib/japan_etc/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JapanETC
+  class Error < StandardError
+  end
+
+  class ValidationError < Error
+  end
+end

data/lib/japan_etc/road.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'japan_etc/error'
+require 'japan_etc/util'
+
+module JapanETC
+  Road = Struct.new(:name, :route_name) do
+    include Util
+
+    IRREGULAR_ABBREVIATIONS = {
+      '首都圏中央連絡自動車道' => '圏央道',
+      '名古屋第二環状自動車道' => '名二環'
+    }
+
+    def initialize(name, route_name = nil)
+      raise ValidationError, '#name cannot be nil' if name.nil?
+
+      super(normalize(name), normalize(route_name))
+    end
+
+    def abbreviation
+      @abbreviation ||=
+        if (irregular_abbreviation = IRREGULAR_ABBREVIATIONS[name])
+          irregular_abbreviation
+        else
+          regular_abbreviation
+        end
+    end
+
+    def regular_abbreviation
+      abbreviation = name.dup
+
+      if abbreviation.start_with?('第')
+        abbreviation = abbreviation.sub(/高速道路|自動車道|道路/, '')
+      end
+
+      abbreviation = abbreviation
+        .sub('高速道路', '高速')
+        .sub('自動車道', '道')
+        .sub('道路', '道')
+        .sub('有料', '')
+
+      abbreviation
+    end
+  end
+end