tokyo_metro 0.10.1

data/lib/tokyo_metro/factory/get/api/meta_class/fundamental/generator.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator
+end

data/lib/tokyo_metro/factory/get/api/meta_class/fundamental/generator/new_array.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray
+end

data/lib/tokyo_metro/factory/get/api/meta_class/fundamental/generator/new_array/common.rb

@@ -0,0 +1,24 @@
+class TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray::Common
+
+  def process
+    _info_class = info_class
+    list_class.new( @ary.map { | item |
+      _info_class.generate_from_hash( item )
+    } )
+  end
+
+  private
+
+  def check_validity_of_ary
+    raise unless @ary.all? { | item | item.instance_of?( ::Hash ) }
+  end
+
+  def list_class
+    @namespace.list_class
+  end
+
+  def info_class
+    @namespace.info_class
+  end
+
+end

data/lib/tokyo_metro/factory/get/api/meta_class/fundamental/generator/new_array/find.rb

@@ -0,0 +1,53 @@
+class TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray::Find < TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray::Common
+
+  def initialize( ary )
+    @ary = ary
+
+    check_validity_of_ary
+    check_length_of_ary
+    set_namespace
+  end
+
+  def self.process( ary )
+    if ary.empty?
+      return ::Array.new
+    else
+      self.new( ary ).process
+    end
+  end
+
+  private
+
+  def check_length_of_ary
+    raise unless @ary.length == 1
+  end
+
+  def set_namespace
+    @namespace = ::TokyoMetro::Api.const_get( namespace_basename )
+  end
+
+  def namespace_basename
+    _rdf_type_from_api = rdf_type_from_api
+
+    _namespace_basename = namespace_basenames.find { | item | ::TokyoMetro::Api.const_get( item ).rdf_type == _rdf_type_from_api }
+    raise unless _namespace_basename.present?
+    _namespace_basename
+  end
+
+  def rdf_type_from_api
+    rdf = @ary.first[ "@type" ]
+    raise unless rdf.present?
+    rdf
+  end
+
+  def namespace_basenames
+    [
+      :Fare , :PassengerSurvey , :Point ,
+      :Station , :StationFacility , :RailwayLine ,
+      :StationTimetable , :TrainTimetable ,
+      :TrainLocation , :TrainOperation ,
+      :MlitRailwayLine , :MlitStation
+    ]
+  end
+
+end

data/lib/tokyo_metro/factory/get/api/meta_class/fundamental/generator/new_array/search.rb

@@ -0,0 +1,13 @@
+class TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray::Search < TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray::Common
+
+  def initialize( ary , namespace )
+    @ary = ary
+    @namespace = namespace
+    check_validity_of_ary
+  end
+
+  def self.process( ary , namespace )
+    self.new( ary , namespace ).process
+  end
+
+end

data/lib/tokyo_metro/factory/get/api/meta_class/search.rb

@@ -0,0 +1,25 @@
+class TokyoMetro::Factory::Get::Api::MetaClass::Search < TokyoMetro::Factory::Get::Api::MetaClass::Fundamental
+
+  private
+
+  def check_validity_of_settings( http_client )
+    super( http_client )
+    unless self.class.rdf_type.string?
+      raise "Error"
+    end
+  end
+
+  # JSON や YAML をパースして得られた配列を処理し、配列のクラスの変更と中身のハッシュのインスタンスへの置き換えを行うメソッド
+  # @param ary [::Array] JSON や YAML をパースして得られた配列
+  # @return [TokyoMetro::Api::Fundamental::List (or its sub-class)]
+  def generate_new_array_instance( ary )
+    ::TokyoMetro::Factory::Get::Api::MetaClass::Fundamental::Generator::NewArray::Search.process( ary , self.class )
+  end
+
+  # パラメータを格納したハッシュを取得するメソッド
+  # @return [Hash]
+  def parameters
+    super().merge( { "rdf:type" => self.class.rdf_type } )
+  end
+
+end

data/lib/tokyo_metro/factory/get/api/meta_class/search/data_search.rb

@@ -0,0 +1,29 @@
+# API からデータを取得するための Factory Pattern のクラス（データ検索 API を利用する場合）
+class TokyoMetro::Factory::Get::Api::MetaClass::Search::DataSearch < TokyoMetro::Factory::Get::Api::MetaClass::Search
+
+  private
+
+  # HTTP クライアントに渡すパラメーターを設定するメソッド (private)
+  # @param h [Hash] パラメーターのハッシュ
+  # @param key [String] パラメーターのハッシュに設定するキー
+  # @param value [Object] パラメーターのハッシュに設定するキーに対応する値
+  # @param class_type [::Array <Const>] value のクラス
+  # @return [nil]
+  def set_parameter_send_to_api( h , key , value , *class_type )
+    if ( class_type.include?( Integer ) and value.integer? ) or class_type.include?( value.class )
+      h[ key ] = value.to_s
+    elsif value.present?
+      raise "Error"
+    end
+    return nil
+  end
+
+  def self.rdf_type
+    self.info_class.rdf_type
+  end
+
+  def access_point_url
+    ::TokyoMetro::DATAPOINTS_URL
+  end
+
+end

data/lib/tokyo_metro/factory/get/api/meta_class/search/geo.rb

@@ -0,0 +1,48 @@
+# API からデータを取得するための Factory Pattern のクラス（地物検索 API を利用する場合）
+class TokyoMetro::Factory::Get::Api::MetaClass::Search::Geo < TokyoMetro::Factory::Get::Api::MetaClass::Search
+
+  def initialize( long , lat , radius , *args )
+    super( *args )
+    @long = long
+    @lat = lat
+    @radius = radius
+  end
+
+  # パラメータを格納したハッシュを取得するメソッド
+  # @return [Hash]
+  def parameters
+    super().merge({
+      "lon" => @long.to_s ,
+      "lat" => @lat.to_s ,
+      "radius" => @radius.to_s
+    })
+  end
+
+  # @!group クラスメソッド - データの取得・保存（地物情報検索 API から）
+
+  # 地物情報検索 API からデータを取得するメソッド（クラスメソッド）
+  # @param http_client [HTTPClient] HTTPClient のインスタンス【必須】
+  # @param long [Numeric] 検索範囲の中心点の経度（10進表記）【必須】
+  # @param lat [Numeric] 検索範囲の中心点の緯度（10進表記）【必須】
+  # @param radius [Numeric] 検索範囲の半径 (m)【必須】
+  # @param parse_json [Boolean] JSONを配列とするか否かの設定（false の場合は文字列とする）【必須】
+  # @param generate_instance [Boolean] データ取得後に Ruby のインスタンスを作成するか否かの設定【必須】
+  # @param to_inspect [Boolean] データ取得後にコマンドツールに内容を表示するか否かの設定【必須】
+  def self.process( http_client , long , lat , radius , parse_json , generate_instance , to_inspect )
+    self.new( long , lat , radius , parse_json , generate_instance , to_inspect ).get_data( http_client )
+  end
+
+  private
+
+  def check_validity_of_settings( http_client )
+    super( http_client )
+    raise "Error" unless @long.number?
+    raise "Error" unless @lat.number?
+    raise "Error" unless @radius.number?
+  end
+
+  def access_point_url
+    ::TokyoMetro::PLACES_URL
+  end
+
+end

data/lib/tokyo_metro/factory/save.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Factory::Save
+end

data/lib/tokyo_metro/factory/save/api.rb

@@ -0,0 +1,3 @@
+# API からのデータを取得し保存するための Factory Pattern のクラスを格納する名前空間
+module TokyoMetro::Factory::Save::Api
+end

data/lib/tokyo_metro/factory/save/api/fare.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Factory::Save::Api::Fare
+end

data/lib/tokyo_metro/factory/save/api/fare/each_file.rb

@@ -0,0 +1,3 @@
+class TokyoMetro::Factory::Save::Api::Fare::EachFile < TokyoMetro::Factory::Save::Api::MetaClass::EachFile::DataSearch
+  include ::TokyoMetro::ClassNameLibrary::Api::Fare
+end

data/lib/tokyo_metro/factory/save/api/fare/group.rb

@@ -0,0 +1,4 @@
+# グループ化された運賃 odpt:RailwayFare のデータを保存するためのクラス
+class TokyoMetro::Factory::Save::Api::Fare::Group < TokyoMetro::Factory::Save::Api::MetaClass::Group
+  include ::TokyoMetro::ClassNameLibrary::Api::Fare
+end

data/lib/tokyo_metro/factory/save/api/fare/group/file_info.rb

@@ -0,0 +1,3 @@
+class TokyoMetro::Factory::Save::Api::Fare::Group::FileInfo < TokyoMetro::Factory::Save::Api::MetaClass::Group::FileInfo::Normal
+  include ::TokyoMetro::ClassNameLibrary::Api::Fare
+end

data/lib/tokyo_metro/factory/save/api/fare/group/list.rb

@@ -0,0 +1,3 @@
+class TokyoMetro::Factory::Save::Api::Fare::Group::List < TokyoMetro::Factory::Save::Api::MetaClass::Group::List
+  include ::TokyoMetro::ClassNameLibrary::Api::Fare
+end

data/lib/tokyo_metro/factory/save/api/meta_class.rb

@@ -0,0 +1,3 @@
+# API から（など）のデータを取得し保存するための Factory Pattern のクラスを格納する名前空間
+module TokyoMetro::Factory::Save::Api::MetaClass
+end

data/lib/tokyo_metro/factory/save/api/meta_class/each_file.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Factory::Save::Api::MetaClass::EachFile
+end

data/lib/tokyo_metro/factory/save/api/meta_class/each_file/data_search.rb

@@ -0,0 +1,3 @@
+# API から取得したデータを保存するための Factory Pattern クラス
+class TokyoMetro::Factory::Save::Api::MetaClass::EachFile::DataSearch < TokyoMetro::Factory::Save::Api::MetaClass::EachFile::Fundamental
+end

data/lib/tokyo_metro/factory/save/api/meta_class/each_file/fundamental.rb

@@ -0,0 +1,122 @@
+# API から取得したデータなどを保存するための Factory Pattern クラス
+class TokyoMetro::Factory::Save::Api::MetaClass::EachFile::Fundamental
+
+  # Constructor
+  # @param db_dir [String (dirname) or Const (Class)] 「データベースのディレクトリを示す文字列」または「クラスを表す定数」
+  def initialize( data , filename = Time.now.strftime( "%Y%m%d" ) ,
+    db_dir: nil ,
+    dirname_sub: nil ,
+    file_type: :yaml
+  )
+    check_validity_of_data( data )
+    @data = data
+    @filename = filename
+    @db_dir = set_db_dirname( db_dir )
+    @dirname_base = set_dirname_base( dirname_sub )
+    @file_type = file_type
+  end
+
+  attr_reader :data , :filename , :db_dir , :dirname_base , :file_type
+
+  def filename_fullpass
+    if /[\.\/]/ === @filename
+      splited_ary = @filename.split( /[\.\/]/ )
+      filename = splited_ary.pop
+      "#{ @dirname_base }\/#{ splited_ary.join( "\/" ) }\/#{ filename }"
+    else
+      "#{ @dirname_base }\/#{ @filename }"
+    end
+  end
+
+  def save_to_file
+    chdir_to_dir_of_file
+    filename = File.basename( self.filename_fullpass )
+    case @file_type
+    when :txt
+      save_as_txt( filename )
+    when :json
+      save_as_json( filename )
+    when :yaml , :yml
+      save_as_yaml( filename )
+    else
+      raise "Error"
+    end
+  end
+
+  def self.process( data , filename , db_dir , dirname_sub , file_type )
+    # puts "\n" * 2
+    # puts "Begin Process"
+    # puts "db_dir: #{ db_dir }"
+    # puts "file_type: #{ file_type }"
+    # puts ""
+
+    info = self.new( data , filename , db_dir: db_dir , dirname_sub: dirname_sub , file_type: file_type )
+
+    # puts "filename: #{ info.filename }"
+    # puts "db_dir: #{ info.db_dir }"
+    # puts "dirname_base: #{ info.dirname_base }"
+    # puts "Fullpass: #{ info.filename_fullpass }"
+
+    info.save_to_file
+  end
+
+  private
+
+  def check_validity_of_data( data )
+    unless data.instance_of?( Hash ) or data.instance_of?( ::Array )
+      raise "Error: The data is not valid. (Class: #{data.class.name})"
+    end
+  end
+
+  # 保存先のディレクトリの名称を返すメソッド
+  # @note db_dir が「クラスを表す定数」である場合は、指定されたクラスのクラスメソッド db_dirname が呼び出される。それ以外の場合はインスタンス変数 db_dir を返す。
+  def set_db_dirname( db_dir ) # set_db_base_dirname
+    if db_dir.instance_of?( ::Class )
+      str = db_dir.db_dirname
+    else
+      str = db_dir
+    end
+    raise "Error" if str.nil?
+    str
+  end
+
+  def set_dirname_base( dirname_sub )
+    if dirname_sub.nil?
+      @db_dir
+    elsif dirname_sub.string?
+      "#{ @db_dir }\/#{ dirname_sub }"
+    elsif dirname_sub.instance_of?( ::Array ) and dirname_sub.all?{ | element | element.string? }
+      "#{ @db_dir }\/#{ dirname_sub.join( "\/" ) }"
+    else
+      raise "Error: The instance variable \"dirname_sub\" is not valid. (Class: #{ dirname_sub.class.name })"
+    end
+  end
+
+  def chdir_to_dir_of_file
+    dirname_l = File.dirname( self.filename_fullpass )
+    unless Dir.pwd == dirname_l
+      ::FileUtils.mkdir_p( dirname_l )
+      Dir.chdir( dirname_l )
+    end
+  end
+
+  def save_as_txt( filename )
+    file = File.open( "#{filename}.txt" , "w:UTF-8" )
+    file.print( @data.to_s )
+    file.close
+  end
+
+  def save_as_json( filename )
+    open( "#{filename}.json" , "w:UTF-8" ) do | f |
+      ::JSON.dump( @data , f )
+    end
+  end
+
+  def save_as_yaml( filename )
+    open( "#{filename}.yaml" , "w:UTF-8" ) do | f |
+      ::YAML.dump( @data , f )
+      #YAML.unespace( @data , f )
+    end
+  end
+
+end

data/lib/tokyo_metro/factory/save/api/meta_class/group.rb

@@ -0,0 +1,133 @@
+# グループ化されたデータを保存するためのクラス（メタクラス）
+class TokyoMetro::Factory::Save::Api::MetaClass::Group
+
+  # Constructor
+  def initialize( db_dir , file_type , generate_instance , to_inspect )
+    @db_dir = db_dir
+    @file_type = file_type
+
+    @generate_instance = generate_instance
+    @to_inspect = to_inspect
+  end
+
+  attr_reader :db_dir
+  attr_reader :file_type
+
+  def get_and_set_data( http_client )
+    @data = self.class.toplevel_namespace.get( http_client , parse_json: true , generate_instance: @generate_instance , to_inspect: @to_inspect )
+  end
+
+  # （JSON から生成した）インスタンスが与えられているか否かを判定するメソッド
+  # @return [Boolean]
+  def instance_will_be_generated?
+    @generate_instance
+  end
+
+  # データの保存に必要なインスタンス（配列）を返すメソッド (1) - インスタンスメソッド
+  # @return [::TokyoMetro::Factory::Save::Api::MetaClass::Group::List <FileInfo>]
+  def to_data_list
+    ary = self.class.list_class_for_saving_grouped_infos.new
+    grouped_data.each do | key , value_ary |
+      ary << self.class.file_info_class_for_saving.new( value_ary , key )
+    end
+    ary
+  end
+
+  # API の情報を取得し、ディレクトリに分けて保存するメソッド
+  # @param http_client [HTTPClient] HTTPClient のインスタンス【必須】
+  # @note 可変長引数 必須の引数
+  #   [TokyoMetro::Factory::Save::Api::TrainLocation::Group のみ]
+  #     @param railway_line [String] 鉄道路線【必須】 <odpt:railway - odpt:Railway>
+  #   [すべて]
+  #   @param db_dir [String] 保存先のディレクトリの名称【必須】
+  #   @param file_type [Symbol] 保存するファイルの種類【必須】
+  #   @param generate_instance [Boolean] データ取得後に Ruby のインスタンスを作成するか否かの設定【必須】
+  #   @param to_inspect [Boolean] データ取得後にコマンドツールに内容を表示するか否かの設定【必須】
+  # @note このメソッドは、各クラスのクラスメソッド save_datas_of_each_group から呼び出される。
+  # @return [nil]
+  def self.process( http_client , *variables , display_inspect_info: true )
+    info = self.new( *variables )
+    info.get_and_set_data( http_client )
+    ary = info.to_data_list
+    ary.save_datas( info.db_dir , info.file_type )
+
+    return nil
+  end
+
+  def self.list_class_for_saving_grouped_infos
+    error_msg = [
+      "Error: This class method \'#{ __method__ }\' is not defind yet in this class \'#{self.name}\'." ,
+      "Please set an constant indicating sub-class of \'::TokyoMetro::Factory::Save::Api::MetaClass::Group::List\'."
+    ].join( "\n" )
+    raise error_msg
+  end
+
+  def self.file_info_class_for_saving
+    error_msg = [
+      "Error: This class method \'#{ __method__ }\' is not defind yet in this class \'#{self.name}\'." ,
+      "Please set an constant indicating sub-class of \'::TokyoMetro::Factory::Save::Api::MetaClass::Group::FileInfo\'."
+    ].join( "\n" )
+    raise error_msg
+  end
+
+  # API の情報（generate_instance が true のときの、インスタンスの配列）の各成分をディレクトリ分けするときに使用するキーの設定
+  def self.method_name_for_determining_dir_when_saving_grouped_infos_and_instance_is_generated
+    error_msg = [
+      "Error: This class method \'#{ __method__ }\' is not defind yet in this class \'#{self.name}\'." ,
+      "Please set a symbol indicating method name."
+    ].join( "\n" )
+    raise error_msg
+  end
+
+  # API の情報（ハッシュの配列）の各成分をディレクトリ分けするときに使用するキーの設定
+  def self.key_name_for_determining_dir_when_saving_grouped_infos_and_instance_is_not_generated
+    error_msg = [
+      "Error: This class method \'#{ __method__ }\' is not defind yet in this class \'#{self.name}\'." ,
+      "Please set a string indicating hash key name."
+    ].join( "\n" )
+    raise error_msg
+  end
+
+  # ディレクトリ、ファイル名の設定
+  # @return [::Symbol or nil]
+  def self.settings_for_dirname_and_filename
+    nil
+  end
+
+  private
+
+  # @return [Hash]
+  def grouped_data
+    check_validity_before_grouping_data
+    if instance_will_be_generated?
+      grouped_data_when_instance_is_generated
+    else
+      grouped_data_when_instance_is_not_generated
+    end
+  end
+
+  def check_validity_before_grouping_data
+    if @data.nil?
+      raise "Error"
+    end
+  end
+
+  def grouped_data_when_instance_is_generated
+    h = @data.group_by { | element_of_list |
+      element_of_list.send( self.class.method_name_for_determining_dir_when_saving_grouped_infos_and_instance_is_generated )
+    }
+
+    h_new = ::Hash.new
+    h.each do | key , ary |
+      h_new[ key ] = ary.map( &:to_h )
+    end
+    h_new
+  end
+
+  def grouped_data_when_instance_is_not_generated
+    @data.group_by { | element_of_list |
+      element_of_list[ self.class.key_name_for_determining_dir_when_saving_grouped_infos_and_instance_is_not_generated ]
+    }
+  end
+
+end