tokyo_metro 0.10.1

data/lib/tokyo_metro/api/passenger_survey/info.rb

@@ -0,0 +1,68 @@
+# 個別の駅の乗降者数を扱うクラス
+class TokyoMetro::Api::PassengerSurvey::Info < TokyoMetro::Api::MetaClass::NotRealTime::Info
+
+  include ::TokyoMetro::ClassNameLibrary::Api::PassengerSurvey
+  include ::TokyoMetro::Modules::Common::ToFactory::Seed::Info
+
+  include ::TokyoMetro::Modules::Api::Info::ToStringGeneral
+
+  # Constructor
+  def initialize( id_urn , same_as , operator , survey_year , passenger_journeys )
+    @id_urn = id_urn
+    @same_as = same_as
+    @operator = operator
+    @survey_year = survey_year
+    @passenger_journeys = passenger_journeys
+  end
+
+  # 固有識別子
+  # @return [String]
+  # @note 命名ルールは「odpt.PassengerSurvey:TokyoMetro.駅名.調査年」
+  # @example
+  #  odpt:PassengerSurvey:TokyoMetro.Tokyo.2013
+  attr_reader :same_as
+
+  # 運行会社
+  # @return [String]
+  attr_reader :operator
+
+  # 調査年度
+  # @return [Integer]
+  attr_reader :survey_year
+
+  # 駅の1日あたりの平均乗降人員数
+  # @return [Integer]
+  attr_reader :passenger_journeys
+
+  # インスタンスの情報をハッシュにして返すメソッド
+  # @return [Hash]
+  def to_h
+    h = Hash.new
+
+    set_data_to_hash( h , "\@id" , @id_urn )
+    set_data_to_hash( h , "owl:sameAs" , @same_as )
+    set_data_to_hash( h , "odpt:operator" , @operator )
+    set_data_to_hash( h , "odpt:surveyYear" , @survey_year )
+    set_data_to_hash( h , "odpt:passengerJourneys" , @passenger_journeys )
+
+    h
+  end
+
+  # インスタンスの情報を文字列にして返すメソッド
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [String]
+  def to_s( indent = 0 )
+    str_ary = ::Array.new
+    str_ary << "\[#{self.class.rdf_type}\] #{@same_as}"
+    str_ary << ""
+    h = self.to_h
+    h[ "odpt:passengerJourneys" ] = h[ "odpt:passengerJourneys" ].to_currency
+    h.each do | key , value |
+      str_ary << ( " " * 2 + key.ljust(32) + value.to_s )
+    end
+    str_ary.map { | str | " " * indent + str }.join( "\n" )
+  end
+
+  alias :to_strf :to_s
+
+end

data/lib/tokyo_metro/api/passenger_survey/list.rb

@@ -0,0 +1,40 @@
+# 各駅の乗降者数の配列
+class TokyoMetro::Api::PassengerSurvey::List < TokyoMetro::Api::MetaClass::NotRealTime::List
+
+  include ::TokyoMetro::ClassNameLibrary::Api::PassengerSurvey
+  include ::TokyoMetro::Modules::Common::ToFactory::Seed::List
+
+  # インスタンスの情報を整形した文字列にして返すメソッド
+  # @param indent [Integer (>=0)] インデントの幅
+  # @return [String]
+  def to_strf( indent = 0 )
+    super( indent , 2 )
+  end
+
+  # 乗降客数でソートするメソッド
+  # @return [List]
+  def sort_by_passenger_journeys
+    self.class.new( self.sort_by( &:passenger_journeys ) )
+  end
+
+# 配列を逆順にするメソッド
+  # @return [List]
+  def reverse
+    ary = super
+    self.class.new( ary )
+  end
+
+  # 調査年度を選択するメソッド
+  # @param year_n [::Array <Integer (year)>] 調査年度
+  # @return [List]
+  def select_year( *year_n )
+    self.class.new( self.select { | station |
+      year_n.include?( station.survey_year )
+    } )
+  end
+
+  def seed
+    super( ::Operator.all )
+  end
+
+end

data/lib/tokyo_metro/api/point.rb

@@ -0,0 +1,98 @@
+# 地物情報 ug:Poi を扱うクラス
+# @see https://developer.tokyometroapp.jp/documents/facility
+# @note 地物情報 ug:Poiでは、駅出入口情報を提供する。
+# @note 地物情報は必ず緯度経度情報（geo:long, geo:lat）を持ち、 /places APIを使用した地理領域絞り込み検索が可能。
+class TokyoMetro::Api::Point < TokyoMetro::Api::MetaClass::Hybrid
+
+  include ::TokyoMetro::ClassNameLibrary::Api::Point
+
+  # @!group クラスメソッド - データの取得・保存
+
+  # 地物情報を取得するメソッド
+  # @param http_client [HTTPClient] HTTPClient のインスタンス【必須】
+  # @param id_urn [String] 固有識別子 (ucode) <id - URN>
+  # @param title [String] 地物名。エレベータには「エレベータ」という文字列を含む。「出入口」の文字列の後に出口番号が続く。<dc:title - xsd:string>
+  # @param category_name [String] 地物のカテゴリ（必ず「出入口」となる） <ugsrv:categoryName - xsd:string>
+  # @param parse_json [Boolean] JSONを配列とするか否かの設定（false の場合は文字列とする）
+  # @param generate_instance [Boolean] データ取得後に Ruby のインスタンスを作成するか否かの設定
+  # @param to_inspect [Boolean] データ取得後にコマンドツールに内容を表示するか否かの設定
+  # @return [::Array]
+  def self.get( http_client ,
+    id_urn: nil , title: nil , category_name: nil ,
+    parse_json: false , generate_instance: false , to_inspect: false )
+
+    factory_for_getting.process( http_client , id_urn , title , category_name ,
+      parse_json , generate_instance , to_inspect )
+  end
+
+  # 駅情報を取得し保存するメソッド
+  # @param http_client [HTTPClient] HTTPClient のインスタンス【必須】
+  # @param file_type [Symbol] 保存するファイルの種類【必須】
+  # @param id_urn [String] 固有識別子 (ucode) <id - URN>
+  # @param title [String] 地物名。エレベータには「エレベータ」という文字列を含む。「出入口」の文字列の後に出口番号が続く。<dc:title - xsd:string>
+  # @param category_name [String] 地物のカテゴリ（必ず「出入口」となる） <ugsrv:categoryName - xsd:string>
+  # @param to_inspect [Boolean] データ取得後にコマンドツールに内容を表示するか否かの設定
+  # @return [nil]
+  def self.save( http_client , filename , file_type: :yaml ,
+    id_urn: nil , title: nil , category_name: nil ,
+    to_inspect: false )
+
+    data = get( http_client ,
+      id_urn: id_urn , title: title , category_name: category_name ,
+      parse_json: true , generate_instance: false , to_inspect: false )
+
+    data = eval( data.to_s.gsub( /(?:\r\n|\r)/ ,"\n" ).encode( "UTF-8" ) )
+
+    save_data( data , filename , file_type: file_type )
+  end
+
+  # @!group テスト
+
+  # データ取得のテスト
+  # @return [nil]
+  def self.get_test( http_client )
+    puts "● #{get_test_title}"
+    ary = get( http_client , to_inspect: true , parse_json: true , generate_instance: true )
+    puts ""
+    puts "#{ary.length} datas"
+    puts ""
+
+    h = ary.group_by( &:station_name_in_title )
+    h.keys.sort.each do | station |
+      h[ station ].sort_by( &:code_in_title ).each do | point_info |
+        puts "(#{ point_info.floor.to_s.rjust(2) }) #{ point_info.category_name } #{ point_info.title.to_s }"
+      end
+    end
+
+    ary.each do | point_info |
+      puts point_info.to_strf
+      puts "\n" * 2
+    end
+
+  end
+
+  # データ取得のテスト
+  # @return [nil]
+  def self.get_geo_test( http_client , geo_long , geo_lat , radius )
+    puts "● #{get_test_title} (geo)"
+    result = get_geo( http_client , geo_long , geo_lat , radius , to_inspect: true , parse_json: true , generate_instance: true )
+    puts "(#{result.length})"
+    result.each do | point_info |
+      puts point_info.to_strf
+      puts "" * 2
+    end
+  end
+
+  class << self
+
+    private
+
+    def get_test_title
+      "Point"
+    end
+
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/api/point/info.rb

@@ -0,0 +1,154 @@
+# 個別の地物情報 ug:Poi のクラス
+class TokyoMetro::Api::Point::Info < TokyoMetro::Api::MetaClass::Hybrid::Info
+
+  include ::TokyoMetro::ClassNameLibrary::Api::Point
+  include ::TokyoMetro::Modules::Common::ToFactory::Seed::Info
+
+  # インスタンスメソッドの追加
+  include ::TokyoMetro::Modules::Api::Info::ToJson
+  include ::TokyoMetro::Modules::Api::Info::ToStringGeneral
+  include ::TokyoMetro::Modules::Api::Info::ToStringWithArray
+
+  # Constructor
+  def initialize( id_urn , title , geo_long , geo_lat , region , ug_floor , category_name )
+    @id_urn = id_urn
+
+    @title = title
+    @geo_long = geo_long
+    @geo_lat = geo_lat
+    @region = region
+
+    @floor = ug_floor
+    @category_name = category_name
+  end
+
+  # @!group 地理情報 (For developers)
+
+  # 代表点の経度（10進表記）
+  # @return [Float]
+  attr_reader :geo_long
+
+  # 代表点の緯度（10進表記）
+  # @return [Float]
+  attr_reader :geo_lat
+
+  # 地物の形状データを GeoJSON で取得するためのURL <ug:region - odpt:GeoDocument>
+  # @return [Integer]
+  # @note 取得にはアクセストークンの付与が必要
+  attr_reader :region
+
+  # @!group 一般の情報
+
+  # 地物のカテゴリ（必ず「出入口」となる） <ugsrv:categoryName - xsd:string>
+  # @return [String]
+  attr_reader :category_name
+
+  # 地物の階数（高さ情報） <ug:floor - xsd:double>
+  # @return [Integer]
+  attr_reader :floor
+
+  # 地物名 <dc:title - xsd:string>
+  # @return [String]
+  # @note エレベータには「エレベータ」という文字列を含む。「出入口」の文字列の後に出口番号が続く。
+  attr_reader :title
+
+  alias :longitude :geo_long
+  alias :latitude :geo_lat
+  alias :geo_json :region
+
+  alias :category_name_ja :category_name
+
+  # @!group 駅情報の取得
+
+  # インスタンスの情報を文字列にして返すメソッド
+  # @param indent [Integer (>=0)] インデントの幅
+  # @return [String]
+  def to_s( indent = 0 )
+    to_s_with_array( [] , indent )
+  end
+
+  alias :to_strf :to_s
+
+  # インスタンスの情報をハッシュにして返すメソッド
+  # @return [Hash]
+  def to_h
+    h = Hash.new
+
+    set_data_to_hash( h , "\@id" , @id_urn )
+    set_data_to_hash( h , "dc:title" , @title.to_s )
+    set_data_to_hash( h , "ug:region" , @region )
+
+    set_data_to_hash( h , "ug:floor" , @floor )
+    set_data_to_hash( h , "ugsrv:categoryName" , @category_name )
+
+    set_data_to_hash( h , "geo:long" , @geo_long )
+    set_data_to_hash( h , "geo:lat" , @geo_lat )
+
+    h
+  end
+
+  # @!endgroup
+
+  def additional_name
+    _additional_name = @title.additional_name
+    if _additional_name.blank?
+      nil
+    else
+      _additional_name
+    end
+  end
+
+  alias :additional_name_ja :additional_name
+
+  def category_name_en
+    str = ::TokyoMetro::Dictionary.english[ category_name_ja ]
+    unless str.present?
+      raise "Error: The category name of \"#{ @title.to_s }\" is not defined yet."
+    end
+
+    str
+  end
+
+  def additional_name_en
+    str = ::TokyoMetro::Dictionary.english[ additional_name_ja ]
+    #----
+    str
+  end
+
+  [ :code , :has_elevator? , :closed? ].each do | method_name |
+    eval <<-DEF
+      def #{ method_name }
+        @title.#{ method_name }
+      end
+    DEF
+  end
+
+  [ :station_name , :code ].each do | method_base_name |
+    eval <<-DEF
+      def #{ method_base_name }_in_title
+        @title.#{ method_base_name }
+      end
+    DEF
+  end
+
+  def station
+    station_facility_key = nil
+    ::TokyoMetro::Api::stations.each do | sta |
+      if sta.exit_list.include?( @id_urn )
+        if sta.facility.string?
+          station_facility_key = sta.facility
+        else
+          station_facility_key = sta.facility.same_as
+        end
+        break
+      end
+    end
+
+    if station_facility_key.present?
+      station_facility_key
+    else
+      raise "Error"
+    end
+  end
+
+end

data/lib/tokyo_metro/api/point/info/title.rb

@@ -0,0 +1,50 @@
+# 駅の出入口の名称を扱うクラス
+class TokyoMetro::Api::Point::Info::Title
+
+  include ::TokyoMetro::ClassNameLibrary::Api::Point
+  include ::TokyoMetro::Modules::Common::ToFactory::Generate::Info
+
+  # Constructor
+  def initialize( station_name , code , additional_name , elevator , closed )
+    @station_name = station_name
+    @code = code
+    @additional_name = additional_name
+    @elevator = elevator
+    @closed = closed
+  end
+
+  attr_reader :station_name , :code , :additional_name , :elevator , :closed
+
+  alias :has_elevator? :elevator
+  alias :closed? :closed
+
+  def to_s
+    str_1 = to_s_sub_1
+    unless @additional_name == ""
+      str_1 += ( "/" + @additional_name )
+    end
+    if @elevator
+      str_1 += "/【EV】"
+    end
+    if @closed
+      str_1 += "/【閉】"
+    end
+
+    str_1
+  end
+
+  def to_s_sub_1
+    if @code.blank?
+      @station_name
+    else
+      [ @station_name , @code ].join( " " )
+    end
+  end
+
+  private :to_s_sub_1
+
+  def self.factory_for_this_class
+    factory_for_generating_title_from_hash
+  end
+
+end

data/lib/tokyo_metro/api/point/info/title/code.rb

@@ -0,0 +1,83 @@
+class TokyoMetro::Api::Point::Info::Title::Code
+
+  def initialize( code , additional_info_ja )
+    @first_char = nil
+    @number = nil
+    @last_char = nil
+    @another_info = nil
+    @additional_info_ja = nil
+
+    if code.string?
+      if /\A([A-Z]?)(\d{1,2})([a-z]?)/ =~ code
+        @first_char = $1
+        @number = $2.to_i
+        @last_char = $3
+      else
+        @another_info = code
+      end
+    else
+      unless code.nil?
+        raise "Error: TokyoMetro::Api::Point::Info::Title::Code - #{ code } is not valid."
+      end
+    end
+
+    if additional_info_ja.present?
+      @additional_info_ja = additional_info_ja
+    end
+  end
+
+  attr_reader :first_char
+  attr_reader :number
+  attr_reader :last_char
+  attr_reader :another_info
+  attr_reader :additional_info_ja
+
+  def <=>( other )
+    #-------- first_char が異なる場合
+    c_first_char = compare_by( other , :first_char )
+    if c_first_char.present?
+      return c_first_char
+    end
+
+    #-------- first_char が同じで number が異なる場合
+    c_number = compare_by( other , :number )
+    if c_number.present?
+      return c_number
+    end
+
+    #-------- first_char, number が同じで last_char が異なる場合
+    c_last_char = compare_by( other , :last_char )
+    if c_last_char.present?
+      return c_last_char
+    end
+
+    c_another_info = compare_by( other , :another_info )
+    if c_another_info.present?
+      return c_another_info
+    end
+
+    c_additional_info_ja = compare_by( other , :additional_info_ja )
+    if c_additional_info_ja.present?
+      return c_additional_info_ja
+    end
+
+    return 0
+  end
+
+  private
+
+  def compare_by( other , method_name )
+    if send( method_name ).blank? and other.send( method_name ).present?
+      return -1
+    elsif send( method_name ).present? and other.send( method_name ).present?
+      unless send( method_name ) == other.send( method_name )
+        return ( send( method_name ) <=> other.send( method_name ) )
+      end
+    elsif send( method_name ).present? and other.send( method_name ).blank?
+      return 1
+    else
+      nil
+    end
+  end
+
+end