tokyo_metro 0.10.1

data/lib/tokyo_metro/static.rb

@@ -0,0 +1,65 @@
+# 東京メトロの情報のうち、変化のない（or 非常に少ない）ものを扱うモジュール
+# @example
+#   * TokyoMetro::Static.normal_fare
+#     普通運賃の情報
+#       @note {::TokyoMetro::Static::Fare.set_constant} によって定義されている。
+#       @return [::TokyoMetro::Static::Fare::Normal::Table::List]
+#
+#   * TokyoMetro::Static.railway_lines
+#   * TokyoMetro::Static.stations_in_tokyo_metro
+#   * TokyoMetro::Static.stations
+#   * TokyoMetro::Static.stopping_patterns （現在未定義）
+#   * TokyoMetro::Static.train_types_in_api
+#   * TokyoMetro::Static.train_types_color
+#   * TokyoMetro::Static.train_types_other_operator
+#   * TokyoMetro::Static.train_types_default
+#   * TokyoMetro::Static.train_types
+module TokyoMetro::Static
+
+  include ::TokyoMetro::Modules::Common::ConvertConstantToClassMethod
+
+  # 東京メトロ オープンデータに関する定数を定義するメソッド
+  # @return [nil]
+  def self.set_constants
+
+    #---- 運賃
+    TokyoMetro::Static::Fare.set_constant
+
+    #---- 方面
+    TokyoMetro::Static::RailwayDirection.set_constant
+
+    #---- 運行事業者
+    TokyoMetro::Static::Operator.set_constant
+
+    #---- 車両所有事業者
+    ::TokyoMetro::Static::TrainOwner.set_constant
+
+    #---- 鉄道路線
+    ::TokyoMetro::Static::RailwayLine.set_constant
+
+    #---- 駅情報（東京メトロのみ）
+    ::TokyoMetro::Static::StationsInTokyoMetro.set_constant
+
+    #---- 駅（他社も含む）
+    ::TokyoMetro::Static::Station.set_constant
+
+    #---- 停車駅（他社も含む）
+    # ::TokyoMetro::Static::StoppingPattern.set_constant
+
+    #---- 列車種別
+    ::TokyoMetro::Static::TrainType.set_constant
+
+    #---- 列車運行情報
+    ::TokyoMetro::Static::TrainOperationStatus.set_constant
+
+    #---- 曜日
+    ::TokyoMetro::Static::OperationDay.set_constant
+
+    return nil
+ end
+
+  def self.railway_lines_operated_by_tokyo_metro
+    railway_lines.select { | key , value | value[ "operator" ] == "odpt.Operator:TokyoMetro" }
+  end
+
+end

data/lib/tokyo_metro/static/color.rb

@@ -0,0 +1,71 @@
+# 鉄道事業者・路線・種別の色の情報を扱うモジュール
+class TokyoMetro::Static::Color
+
+  include ::TokyoMetro::ClassNameLibrary::Static::Color
+  include ::TokyoMetro::Modules::Common::ToFactory::Generate::Info
+
+  # Constructor
+  # @param web [String] WebColor
+  # @param red [Integer] R 成分の値
+  # @param green [Integer] G 成分の値
+  # @param blue [Integer] B 成分の値
+  def initialize( web , red , green , blue )
+    @web = web
+    @red = red
+    @green = green
+    @blue = blue
+  end
+
+  # WebColor を取得するメソッド
+  # @return [String]
+  attr_reader :web
+  # R 成分の値を返すメソッド
+  # @return [Integer]
+  attr_reader :red
+  # G 成分の値を返すメソッド
+  # @return [Integer]
+  attr_reader :green
+  # B 成分の値を返すメソッド
+  # @return [Integer]
+  attr_reader :blue
+
+  alias :web_color :web
+
+# @!group 文字列への変換
+
+  # インスタンスの情報を文字列に変換して返すメソッド
+  # @param indent [Integer (>=0)] インデントの幅
+  # @return [String]
+  def to_s( indent = 0 )
+    " " * indent + "#{@web} (#{ self.to_a_rgb.join( " , " ) })"
+  end
+
+  # インスタンスの情報を CSV 出力用の文字列（カンマ区切り）にして返すメソッド
+  # @return [String]
+  def to_csv
+    self.to_a.join(",")
+  end
+
+  # Red, Green, Blue の各成分の情報を括弧で囲んだ文字列にして返すメソッド
+  # @return [String]
+  def to_s_rgb_color_in_parentheses
+    "( " + to_a_rgb.join( " , " ) + " )"
+  end
+
+# @!group 色情報の取得
+
+  # Red, Green, Blue の各成分を配列にして返すメソッド
+  # @return [::Array <Integer>]
+  def to_a_rgb
+    [ @red , @green , @blue ]
+  end
+
+  # WebColor, Red, Green, Blue の各成分を配列にして返すメソッド
+  # @return [::Array <Integer>]
+  def to_a
+    [ @web ] + self.to_a_rgb
+  end
+
+# @!endgroup
+
+end

data/lib/tokyo_metro/static/fare.rb

@@ -0,0 +1,21 @@
+# 東京メトロの運賃の情報を扱うモジュール
+module TokyoMetro::Static::Fare
+
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+  include ::TokyoMetro::Modules::Common::ConvertConstantToClassMethod
+
+  # 最後の運賃改定が行われた日付
+  # @return [::DateTime]
+  # @note 現在の運賃は、2014年4月1日改定のもの。旧運賃は2014年3月31日の終電まで適用されていたため、2014年4月1日未明（3月31日の終電後）に現運賃へ切り替えが行われたものとする。
+  # @note TokyoMetro::Static::Fare.last_revision で呼び出すことができる。
+  LAST_REVISION = ::DateTime.new( 2014 , 4 , 1 , ::TokyoMetro.date_changing_hour , 0 , 0 )
+
+  # 定数 {::TokyoMetro::Static::NORMAL_FARE} を設定するメソッド
+  # @note {::TokyoMetro::Static.normal_fare} で呼び出すこともできる。
+  # @note {::TokyoMetro::Static::Fare::Normal.instance.current_faretable.list} は {::TokyoMetro::Static::Fare::Normal::Table::List} クラスのインスタンス
+  # @return [:NORMAL_FARE]
+  def self.set_constant
+    ::TokyoMetro::Static.const_set( :NORMAL_FARE , self.normal_fare_class.instance.current_faretable.list )
+  end
+
+end

data/lib/tokyo_metro/static/fare/normal.rb

@@ -0,0 +1,70 @@
+# 東京メトロの運賃表（普通運賃）を扱うクラス
+# @note 運賃改定などを考慮し、複数の運賃表（改定前と改定後など）を格納することもできる。
+class TokyoMetro::Static::Fare::Normal
+
+  include ::Singleton
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+
+  # Constructor
+  def initialize
+    @tables = ::Array.new
+    @tables << self.class.normal_fare_table_class.generate_from_yaml( "Fare" , "20140401_normal" , self.class.static_toplevel_namespace.last_revision ).freeze
+  end
+
+  # データベースをもとにした運賃表（現在）
+  # @return [::Array <::TokyoMetro::Static::Fare::Normal::Table>]
+  attr_reader :tables
+
+  # 指定された日付の運賃表を取得するメソッド
+  # @note 運賃改定前後に使うことを念頭に、あらかじめ定義しておく。
+  # @return [Table]
+  def as_of( date = ::TokyoMetro.time_now )
+    @tables.select { | table | date >= table.valid_from }.min { | a , b | a.valid_from <=> b.valid_from }
+  end
+
+  def current_faretable
+    table = self.as_of
+    raise "Error" if table.nil?
+    return table
+  end
+
+  # @!group 自身の情報を変換して取得するメソッド
+
+  # 自身の情報を配列にして返すメソッド
+  # @return [::Array]
+  def to_a
+    @tables
+  end
+
+  # 自身の情報をハッシュにして返すメソッド
+  # @return [Hash]
+  def to_h
+    h = ::Hash.new
+    self.to_a.each do | table |
+      h[ table.title.intern ] = table.list
+    end
+    h
+  end
+
+  # 自身の情報を文字列にして返すメソッド
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [Hash]
+  def to_s( indent = 0 )
+    str_ary = ::Array.new
+    self.to_a.each do | table |
+      str_ary << table.to_s( indent + 2 )
+    end
+    str_ary.join( "\n" * 2 )
+  end
+
+  def self.seed
+    self.instance.current_faretable.seed
+  end
+
+  # @!endgroup
+
+  def self.test
+    puts self.instance.current_faretable.to_s
+  end
+
+end

data/lib/tokyo_metro/static/fare/normal/table.rb

@@ -0,0 +1,84 @@
+# 各料金区間の運賃の配列を扱うクラス
+# @note 通常は TokyoMetro::Fare::Normal.table から呼び出す。
+class TokyoMetro::Static::Fare::Normal::Table
+
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+
+  # Constructor
+  # @param title [::String] 運賃表のタイトル
+  # @param list [::TokyoMetro::Static::Fare::Normal::Table::List] 運賃表の配列
+  # @param from [::DateTime] 改定日
+  def initialize( title , ary , from )
+    @title = title
+    @list = ary
+    @from = from
+  end
+
+  # @return [::String] 運賃表のタイトル
+  attr_reader :title
+  # @return [::TokyoMetro::Static::Fare::Normal::Table::List] 運賃表の配列
+  attr_reader :list
+  # @return [::DateTime] 改定日
+  attr_reader :from
+  alias :valid_from :from
+
+  # 運賃表の情報を文字列として返すメソッド
+  # @param indent [::Integer (>0)] インデントの幅
+  # @return [::String]
+  def to_s( indent = 0 )
+    str_ary = ::Array.new
+
+    str_ary << " " * indent + "○ #{@title} (from #{ @from.strftime("%Y.%m.%d") })"
+    str_ary << @list.to_s( indent + 2 )
+
+    str_ary.join( "\n" * 2 )
+  end
+  alias :to_strf :to_s
+
+  def date_of_revision
+    ::Date.new( @from.year , @from.month , @from.day )
+  end
+
+  def seed
+    @list.seed( date_of_revision , ::Operator.find_by_same_as( "odpt.Operator:TokyoMetro" ).id )
+  end
+
+  # YAML のデータからインスタンスを作成するメソッド
+  # @param title [::String] 運賃表のタイトル
+  # @param yaml_file [::String] YAML のファイル名
+  # @return [::TokyoMetro::Static::Fare::Normal::Table]
+  def self.generate_from_yaml( title , yaml_file , from )
+    ary = self.normal_fare_table_list_class.new
+
+    ::YAML.load_file( "#{db_dirname}/#{yaml_file}.yaml" ).each do |h|
+      fares = [ "ticket_fare" , "child_ticket_fare" , "ic_card_fare" , "child_ic_card_fare" ].map { | key | h[ key ] }
+      ary << self.normal_fare_table_pattern_class.new( *fares ).freeze
+    end
+
+    raise_error_of_element( ary )
+    self.new( title , ary , from )
+  end
+
+  class << self
+
+    private
+
+    # 配列の要素をチェックするメソッド
+    # @param ary [::Array] チェックする配列
+    # @return [nil]
+    def raise_error_of_element( ary )
+      unless ary.all?{ |i| i.instance_of?( normal_fare_table_pattern_class ) }
+        raise "Error"
+      end
+      return nil
+    end
+
+    # データを保存するディレクトリ
+    # @return [::String]
+    def db_dirname
+      "#{ ::TokyoMetro::dictionary_dir }/fare"
+    end
+
+  end
+
+end

data/lib/tokyo_metro/static/fare/normal/table/list.rb

@@ -0,0 +1,46 @@
+# 各料金区間の運賃の配列
+class TokyoMetro::Static::Fare::Normal::Table::List < Array
+
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+  include ::TokyoMetro::Modules::Common::ToFactory::Seed::List
+
+  # 運賃の配列を文字列として返すメソッド
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [String]
+  def to_s( indent = 0 )
+    str_ary = ::Array.new
+    str_ary << self.class.header( indent )
+    self.each do | fare |
+      str_ary << fare.to_s_in_a_row( indent )
+    end
+    str_ary.join( "\n" )
+  end
+  alias :to_strf :to_s
+
+  # 運賃情報の整数の列が与えられたときに、配列 (self) から該当する要素を抜き出して返すメソッド
+  # @param ticket_fare [Integer] 普通運賃（大人・切符）
+  # @param child_ticket_fare [Integer] 普通運賃（小児・切符）
+  # @param ic_card_fare [Integer] 普通運賃（大人・ICカード）
+  # @param child_ic_card_fare [Integer] 普通運賃（小児・ICカード）
+  # @return [Pattern]
+  def select_fare( ticket_fare , child_ticket_fare , ic_card_fare , child_ic_card_fare )
+    self.each do |i|
+      if i.match?( ticket_fare , child_ticket_fare , ic_card_fare , child_ic_card_fare )
+        return i
+      end
+    end
+    nil
+  end
+
+  # 運賃の情報を出力する際のヘッダー
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [String]
+  def self.header( indent = 0 )
+    [ "Ticket" , "Ticket (Child)" , "IC Card" , "IC Card (Child)" ].map{ | i | i.ljust(16) }.join( " " * 8 )
+  end
+
+  def self.factory_for_seeding_this_class
+    factory_for_seeding_normal_table_list
+  end
+
+end

data/lib/tokyo_metro/static/fare/normal/table/pattern.rb

@@ -0,0 +1,177 @@
+# 運賃のパターン（各料金区間の運賃）を扱うクラス
+class TokyoMetro::Static::Fare::Normal::Table::Pattern
+
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+  include ::TokyoMetro::Modules::Common::ToFactory::Seed::Info
+
+  # Constructor
+  # @param ticket_fare [Integer] 普通運賃（大人・切符）
+  # @param child_ticket_fare [Integer] 普通運賃（小児・切符）
+  # @param ic_card_fare [Integer] 普通運賃（大人・ICカード）
+  # @param child_ic_card_fare [Integer] 普通運賃（小児・ICカード）
+  def initialize( ticket_fare , child_ticket_fare , ic_card_fare , child_ic_card_fare )
+    @ticket_fare = ticket_fare
+    @child_ticket_fare = child_ticket_fare
+    @ic_card_fare = ic_card_fare
+    @child_ic_card_fare = child_ic_card_fare
+  end
+
+  # @!group 運賃の情報を出力するメソッド
+
+  # 普通運賃（大人・切符）
+  # @return [Integer]
+  attr_reader :ticket_fare
+
+  # 普通運賃（小児・切符）
+  # @return [Integer]
+  attr_reader :child_ticket_fare
+
+  # 普通運賃（大人・ICカード）
+  # @return [Integer]
+  attr_reader :ic_card_fare
+
+  # 普通運賃（小児・ICカード）
+  # @return [Integer]
+  attr_reader :child_ic_card_fare
+
+  # 各種運賃を配列として返すメソッド
+  # @return [::Array]
+  def to_a
+    [ @ticket_fare , @child_ticket_fare , @ic_card_fare , @child_ic_card_fare ]
+  end
+
+  # 運賃の情報を1行で出力するメソッド（簡易版）
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [String]
+  def to_s( indent = 0 )
+    " " * indent + self.to_a.map { | i | i.to_currency.rjust(16) }.join( " " * 8 )
+  end
+
+  # 運賃の情報を1行で出力するメソッド（詳細版）
+  # @param indent [Integer (>0)] インデントの幅
+  # @param header [Boolean] ヘッダーを表示するか否かの設定
+  # @return [String]
+  def to_s_in_a_row( indent = 0 , header: false )
+    str_ary = ::Array.new
+    if header
+      header_str = self.class.header( indent )
+      str_ary << ( " " * indent + header_str.gsub( / +\Z/ , "" ) )
+    end
+    fare = self.to_s
+
+    str_ary << ( " " * indent + fare )
+    str_ary.join( "\n" )
+  end
+
+  # 運賃の情報を表にして出力するメソッド
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [String]
+  def to_s_table( indent = 0 )
+    str_ary = ::Array.new
+    row_1 = ::Array.new
+    row_2 = ::Array.new
+
+    row_1 << ( "odpt:ticketFare".ljust(24) + @ticket_fare.to_currency.rjust(8) )
+    row_1 << ( "odpt:childTicketFare".ljust(24) + @child_ticket_fare.to_currency.rjust(8) )
+    row_2 << ( "odpt:icCardFare".ljust(24) + @ic_card_fare.to_currency.rjust(8) )
+    row_2 << ( "odpt:childIcCardFare".ljust(24) +@child_ic_card_fare.to_currency.rjust(8) )
+
+    [ row_1 , row_2 ].each do | row |
+      str_ary << " " * indent + row.join( " " * 8 )
+    end
+    str_ary.join( "\n" )
+  end
+
+  # @!group データの判定
+
+  # 運賃の情報が与えられたときに、self と一致するか否かを判定するメソッド
+  # @param ticket_fare [Integer] 普通運賃（大人・切符）
+  # @param child_ticket_fare [Integer] 普通運賃（小児・切符）
+  # @param ic_card_fare [Integer] 普通運賃（大人・ICカード）
+  # @param child_ic_card_fare [Integer] 普通運賃（小児・ICカード）
+  # @return [Boolean]
+  def match?( ticket_fare , child_ticket_fare , ic_card_fare , child_ic_card_fare )
+    self.to_a == [ ticket_fare , child_ticket_fare , ic_card_fare , child_ic_card_fare ]
+  end
+
+  # @!group 回数券 (1) - 発売額
+
+  # 回数券（大人）の発売額
+  # @return [Integer]
+  def coupon_ticket_fare
+    @ticket_fare * 10
+  end
+
+  # 回数券（小児）の発売額
+  # @return [Integer]
+  def child_coupon_ticket_fare
+    @child_ticket_fare * 10
+  end
+
+  # @!group 回数券 (2) - 1枚あたりの発売額
+
+  # 普通回数券（大人・11枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def normal_coupon_ticket_per_one_piece
+    coupon_ticket_fare_per_one_piece( :coupon_ticket_fare , 11 )
+  end
+
+  # 時差回数券（大人・12枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def daytime_coupon_ticket_per_one_piece
+    coupon_ticket_fare_per_one_piece( :coupon_ticket_fare , 12 )
+  end
+
+  # 土休回数券（大人・14枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def holiday_coupon_ticket_per_one_piece
+    coupon_ticket_fare_per_one_piece( :coupon_ticket_fare , 14 )
+  end
+
+  # 普通回数券（小児・11枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def child_normal_coupon_ticket_per_one_piece
+    coupon_ticket_fare_per_one_piece( :child_coupon_ticket_fare , 11 )
+  end
+
+  # 時差回数券（小児・12枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def child_daytime_coupon_ticket_per_one_piece
+    coupon_ticket_fare_per_one_piece( :child_coupon_ticket_fare , 12 )
+  end
+
+  # 土休回数券（小児・14枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def child_holiday_coupon_ticket_per_one_piece
+    coupon_ticket_fare_per_one_piece( :child_coupon_ticket_fare , 14 )
+  end
+
+  # @!endgroup
+
+  # @!group クラスメソッド
+
+  # 運賃の情報を出力する際のヘッダー
+  # @return [String]
+  def self.header( indent )
+    self.normal_fare_table_list_class.header( indent )
+  end
+
+  def self.factory_for_seeding_this_class
+    factory_for_seeding_normal_table_pattern
+  end
+
+  # @!endgroup
+
+  private
+
+  # 回数券の1枚あたりの発売額
+  # @param method [Symbol] 呼び出すメソッドの名称
+  # @param whole_pieces [Integer] 発売時の枚数
+  # @return [Numeric]
+  def coupon_ticket_fare_per_one_piece( method , whole_pieces )
+    self.send( method ) * 1.0 / whole_pieces
+  end
+
+  # @!endgroup
+
+end