syobocal 0.10.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b32b7dbb64cf8d4b48bd87da408f5607b845ab85073c025327bc6e9d6294df6
-  data.tar.gz: 4f2ed089906d9f1560d5b0aeeaa0f009d284337069cc2794521e235ee082899c
+  metadata.gz: 737c5456c21b70925571795e9b8f81b35ba89738065dfaec3332c11d3920e19f
+  data.tar.gz: 26ef1a657a390e37fef06c2a0ac7ed681a3bbd951fb6f779f248a61bc08aaddd
 SHA512:
-  metadata.gz: a29a2ba9cfb401f13fc69862cb283f9081fe55edb26e26618649393d0de42c97ce3759a9be5345d8bb852c59d1af453b5d4f66485dbc788851cdc7e9419cce2c
-  data.tar.gz: 8f71e8e5941a9a40837648e9300d7cd110b1512f00bc0169185206e12e709c0a1e7c1943e8710a55684c361da01a981459511180cb217db5f425043664dc6d5b
+  metadata.gz: cb49862e127d7abba99f6a09fe93e2f357d4e331243e6236314c23c1d9e5384cd39af7501009c77ab07ac0a7f8a00ae71082f5f5b6fbb1060da31051160d03b7
+  data.tar.gz: 3aaf9a0a8bdfbf76e703608dadbd97d6f6971ec787772e0507aeeae47109dc179654e5fd56c4e50e0b691df8df5c8cd3525f7395d42c0e43f68de059038efa60

data/README.md

@@ -2,8 +2,7 @@
 
 ## 概要
 
-syobocalは[しょぼいカレンダー](http://cal.syoboi.jp/)からデータを取得するためのRubyスクリプトです。
-sch_uploadを除いて仕様が公開されている以下20種類のエンドポイントすべてに対応しています。
+syobocalは[しょぼいカレンダー](http://cal.syoboi.jp/)からデータを取得するためのRubyスクリプトです。`sch_upload`を除いて仕様が公開されている以下20種類のエンドポイントすべてに対応しています。
 
 - cal_chk.php
 - db.php
@@ -49,12 +48,180 @@ sch_uploadを除いて仕様が公開されている以下20種類のエンド
 XMLやRSSをパースした結果は値が適切な型に変換されたハッシュの配列です。
 JSONをパースした結果はJSONのデータ構造をそのまま返します。
 
-~~~~
+いくつか典型的だろう使い方を紹介します。
+
+以下は`db.php`からアニメごとに採番された`TID`とタイトルを一覧で取得する例です。
+
+```ruby
 require 'syobocal'
 require 'pp'
-params = {"TID" => "1"}
-pp Syobocal::DB::TitleLookup.get(params)
-~~~~
+
+pp Syobocal::DB::TitleLookup.get({'TID' => '*', 'Fields' => 'TID,Title'})
+# [{:tid=>1, :title=>"魔法遣いに大切なこと"},
+#  {:tid=>2, :title=>"ソニックＸ"},
+#  {:tid=>3, :title=>"デ・ジ・キャラットにょ"},
+#  {:tid=>1224, :title=>"魔法先生ネギま！(実写版)"},
+#  {:tid=>3601, :title=>"新妹魔王の契約者"},
+#  {:tid=>3588, :title=>"アイドルマスター シンデレラガールズ"},
+#  {:tid=>4, :title=>"妄想科学シリーズ ワンダバスタイル"},
+#  {:tid=>1086, :title=>"ひとひら"},
+#  {:tid=>5, :title=>"DEARBOYS"},
+#  {:tid=>6, :title=>"LAST EXILE"},
+# ...
+```
+
+以下は`TID`指定で特定のアニメのデータを取得する例です。
+
+```ruby
+require 'syobocal'
+require 'pp'
+
+title = Syobocal::DB::TitleLookup.get({'TID' => '2077'})
+pp title.first
+# {:tid=>2077,
+#  :last_update=>2013-12-02 02:17:55 +0900,
+#  :title=>"魔法少女まどか☆マギカ",
+#  :short_title=>"まどか☆マギカ",
+#  :title_yomi=>"まほうしょうじょまどかまぎか",
+#  :title_en=>"PUELLA MAGI MADOKA MAGICA",
+#  :comment=>
+#   "*リンク\n" +
+#   "-[[公式 http://www.madoka-magica.com/tv/]]\n" +
+#   "-[[MBS http://www.mbs.jp/madoka-magica/]]\n" +
+#   "-[[ニコニコチャンネル http://ch.nicovideo.jp/ch260]]\n" +
+#   "-[[TOKYO MX http://www.mxtv.co.jp/madoka_magica/]]\n" +
+#   "-[[BS11デジタル http://www.bs11.jp/anime/2360/]]\n" +
+#   "*メモ\n" +
+#   "-アニマックスでのリピート放送は放送日の27:00～と日曜26:00～\n" +
+#   "*スタッフ\n" +
+#   ":原作:Magica Quartet\n" +
+#   ":監督:新房昭之\n" +
+#   ":キャラクター原案:蒼樹うめ\n" +
+#   ":キャラクターデザイン:岸田隆宏\n" +
+# ...
+```
+
+APIリクエスト時のパラメータは`syobocal`ライブラリとして解釈しません。しょぼいカレンダーのAPI仕様を参照して下さい。また`'TID' => '*'`に代表される大量のデータ取得はしばしば10MB以上の巨大なレスポンスを返します。しょぼいカレンダー側も大変だろうと思うので、使い方は考えて下さい。
+
+### コメントパーサ(ベータ版)
+
+しょぼいカレンダーの`comment`属性にはスタッフやキャストなど多岐に渡る情報が専用の記法で格納されています。バージョン`0.11`以降の`syobocal`ライブラリはコメントパーサ(`Syobocal::Comment::Parser`)を備え、それらの情報を意味的に扱いやすい形で取り出すことができます。コメントパーサはベータ版です。インタフェースは変更される可能性があります。
+
+```ruby
+require 'syobocal'
+require 'pp'
+
+title = Syobocal::DB::TitleLookup.get({'TID' => '2077'})
+comment = title.first[:comment]
+parser = Syobocal::Comment::Parser.new(comment)
+
+pp parser.links.first
+# #<Syobocal::Comment::Element::Link:0x0000564600b42e30
+#  @str="公式",
+#  @url="http://www.madoka-magica.com/tv/">
+
+pp parser.staffs.first
+# #<Syobocal::Comment::Staff:0x00005645ffc60048
+#  @people=
+#   [#<Syobocal::Comment::Person:0x00005645ffc60368
+#     @name="Magica Quartet",
+#     @note=nil>],
+#  @role="原作">
+
+pp parser.casts.first
+# #<Syobocal::Comment::Cast:0x0000564600051b70
+#  @character="鹿目まどか",
+#  @people=
+#   [#<Syobocal::Comment::Person:0x0000564600051cd8 @name="悠木碧", @note=nil>]>
+
+pp parser.musics.first
+# #<Syobocal::Comment::Music:0x0000561287c8f1a0
+#  @category="オープニングテーマ",
+#  @data_list=
+#   [#<Syobocal::Comment::MusicData:0x0000561287c8b8e8
+#     @attr="作詞・作曲",
+#     @attr_note=nil,
+#     @attr_text="作詞・作曲",
+#     @people=
+#      [#<Syobocal::Comment::Person:0x0000561287c8ba28 @name="渡辺翔", @note=nil>],
+#     @value="渡辺翔">,
+#    #<Syobocal::Comment::MusicData:0x0000561287c8a3d0
+#     @attr="主題歌協力",
+#     @attr_note=nil,
+#     @attr_text="主題歌協力",
+#     @people=
+#      [#<Syobocal::Comment::Person:0x0000561287c8a510 @name="外村敬一", @note=nil>],
+#     @value="外村敬一">,
+#    #<Syobocal::Comment::MusicData:0x0000561287c88e90
+#     @attr="歌",
+#     @attr_note=nil,
+#     @attr_text="歌",
+#     @people=
+#      [#<Syobocal::Comment::Person:0x0000561287c88fd0
+#        @name="ClariS",
+#        @note=nil>],
+#     @value="ClariS">,
+#    #<Syobocal::Comment::MusicData:0x0000561287c8f2e0
+#     @attr="使用話数",
+#     @attr_note=nil,
+#     @attr_text="使用話数",
+#     @people=
+#      [#<Syobocal::Comment::Person:0x0000561287c8f560 @name="#1～#9", @note=nil>,
+#       #<Syobocal::Comment::Person:0x0000561287c8f420 @name="#11", @note=nil>],
+#     @value="#1～#9、#11">],
+#  @title="コネクト">
+```
+
+### サブタイトルパーサ(ベータ版)
+
+しょぼいカレンダーの`sub_titles`属性をパースして扱いやすい形にして取り出すパーサです。
+
+```ruby
+require 'syobocal'
+require 'pp'
+
+title = Syobocal::DB::TitleLookup.get({'TID' => '2077'})
+sub_titles = title.first[:sub_titles]
+parser = Syobocal::SubTitles::Parser.new(sub_titles)
+
+pp parser.parse
+# [#<Syobocal::SubTitles::SubTitle:0x00005591edc37830
+#   @episode="01",
+#   @title="夢の中で会った、ような・・・・・">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc37448
+#   @episode="02",
+#   @title="それはとっても嬉しいなって">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc370b0
+#   @episode="03",
+#   @title="もう何も恐くない">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc36d40
+#   @episode="04",
+#   @title="奇跡も、魔法も、あるんだよ">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc36c00
+#   @episode="05",
+#   @title="後悔なんて、あるわけない">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc36700
+#   @episode="06",
+#   @title="こんなの絶対おかしいよ">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc36408
+#   @episode="07",
+#   @title="本当の気持ちと向き合えますか？">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc36110
+#   @episode="08",
+#   @title="あたしって、ほんとバカ">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc35c88
+#   @episode="09",
+#   @title="そんなの、あたしが許さない">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc34d38
+#   @episode="10",
+#   @title="もう誰にも頼らない">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc34a68
+#   @episode="11",
+#   @title="最後に残った道しるべ">,
+#  #<Syobocal::SubTitles::SubTitle:0x00005591edc34900
+#   @episode="12",
+#   @title="わたしの、最高の友達">]
+```
 
 ## おまけ
 
@@ -109,7 +276,7 @@ $ syobocal-anime
 
 ## 作者
 
-- [xmisao](http://www.xmisao.com/)
+- [xmisao](https://www.xmisao.com/)
 
 ## ライセンス
 

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test

data/lib/syobocal/calchk.rb

@@ -1,11 +1,11 @@
 module Syobocal
   module CalChk
     def get(params = {})
-      parse(open(url(params)))
+      parse(URI.open(url(params)))
     end
 
     def url(params = {})
-      'http://cal.syoboi.jp/cal_chk.php' + Syobocal::Util.format_params(params)
+      "http://cal.syoboi.jp/cal_chk.php" + Syobocal::Util.format_params(params)
     end
 
     def parse(xml)
@@ -13,14 +13,14 @@ module Syobocal
 
       result = Result.new
 
-      syobocal = xml.elements['syobocal']
+      syobocal = xml.elements["syobocal"]
       result.url = syobocal.attribute("url").to_s
       result.version = syobocal.attribute("version").to_s
       result.last_update = Time.parse(syobocal.attribute("LastUpdate").to_s)
       result.spid = syobocal.attribute("SPID").to_s
       result.spname = syobocal.attribute("SPNAME").to_s
 
-      xml.elements.each('syobocal/ProgItems/ProgItem'){|item|
+      xml.elements.each("syobocal/ProgItems/ProgItem") { |item|
         result << {
           :pid => item.attribute("PID").to_s.to_i,
           :tid => item.attribute("TID").to_s.to_i,
@@ -32,7 +32,7 @@ module Syobocal
           :st_offset => item.attribute("StOffset").to_s.to_i,
           :sub_title => item.attribute("SubTitle").to_s,
           :title => item.attribute("Title").to_s,
-          :prog_comment => item.attribute("ProgComment").to_s
+          :prog_comment => item.attribute("ProgComment").to_s,
         }
       }
 

data/lib/syobocal/comment/cast.rb

@@ -0,0 +1,15 @@
+module Syobocal
+  module Comment
+    class Cast
+      attr_reader :character, :people
+
+      def initialize(character, people)
+        @character, @people = character, people
+      end
+
+      def ==(other)
+        other.instance_of?(self.class) && other.character == character && other.people == people
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/blank.rb

@@ -0,0 +1,25 @@
+module Syobocal
+  module Comment
+    module Element
+      class Blank
+        def initialize; end
+
+        def ==(other)
+          other.instance_of?(self.class)
+        end
+
+        def inner_text
+          ""
+        end
+
+        def self.match?(line)
+          line.match(/\A\s*\Z/)
+        end
+
+        def self.parse(line)
+          Element::Blank.new
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/header1.rb

@@ -0,0 +1,27 @@
+module Syobocal
+  module Comment
+    module Element
+      class Header1
+        attr_reader :text_node
+
+        def initialize(text_node)
+          @text_node = text_node
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.text_node == text_node
+        end
+
+        def self.match?(line)
+          !Header2.match?(line) && line.start_with?("*")
+        end
+
+        def self.parse(line)
+          txt = line.match(/\A\*(.*)\Z/)[1]
+
+          Element::Header1.new(Element::TextNode.parse(txt))
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/header2.rb

@@ -0,0 +1,27 @@
+module Syobocal
+  module Comment
+    module Element
+      class Header2
+        attr_reader :text_node
+
+        def initialize(text_node)
+          @text_node = text_node
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.text_node == text_node
+        end
+
+        def self.match?(line)
+          line.start_with?("**")
+        end
+
+        def self.parse(line)
+          txt = line.match(/\A\*\*(.*)\Z/)[1]
+
+          Element::Header2.new(Element::TextNode.parse(txt))
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/link.rb

@@ -0,0 +1,30 @@
+module Syobocal
+  module Comment
+    module Element
+      class Link
+        attr_reader :str, :url
+
+        def initialize(str, url)
+          @str, @url = str, url
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.str == str && other.url == url
+        end
+
+        def self.create(text)
+          inner_str = text.match(/\A\[\[(.*)\]\]\Z/)[1]
+
+          sep = inner_str.split(/ /)
+
+          if ["http://", "https://", "archive://"].any? { |scheme| sep.last.start_with?(scheme) }
+            link = sep.pop
+            new(sep.join(" "), link)
+          else
+            new(sep.join(" "), nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/list.rb

@@ -0,0 +1,27 @@
+module Syobocal
+  module Comment
+    module Element
+      class List
+        attr_reader :text_node
+
+        def initialize(text_node)
+          @text_node = text_node
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.text_node == text_node
+        end
+
+        def self.match?(line)
+          line.start_with?("-")
+        end
+
+        def self.parse(line)
+          txt = line.match(/\A-(.*)\Z/)[1]
+
+          Element::List.new(Element::TextNode.parse(txt))
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/root.rb

@@ -0,0 +1,17 @@
+module Syobocal
+  module Comment
+    module Element
+      class Root
+        attr_reader :elements
+
+        def initialize(elements)
+          @elements = elements
+        end
+
+        def ==(other)
+          other.elements == elements
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/row.rb

@@ -0,0 +1,36 @@
+module Syobocal
+  module Comment
+    module Element
+      class Row
+        attr_reader :attr_node, :value_node
+
+        def initialize(attr_node, value_node)
+          @attr_node, @value_node = attr_node, value_node
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.attr_node == attr_node && other.value_node == value_node
+        end
+
+        def self.match?(line)
+          line.start_with?(":")
+        end
+
+        def self.parse(line)
+          if line.scan(":").length == 1
+            # NOTE :が1つしか含まれない行は:以降が値となる
+            m = line.match(/\A:(.*)\Z/)
+            attr = Element::Blank.new
+            value = Element::TextNode.parse(m[1])
+          else
+            m = line.match(/\A:([^:]*?):(.*)\Z/)
+            attr = Element::TextNode.parse(m[1])
+            value = Element::TextNode.parse(m[2])
+          end
+
+          Element::Row.new(attr, value)
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/text.rb

@@ -0,0 +1,21 @@
+module Syobocal
+  module Comment
+    module Element
+      class Text
+        attr_reader :str
+
+        def initialize(str)
+          @str = str
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.str == str
+        end
+
+        def self.create(text)
+          new(text)
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/element/text_node.rb

@@ -0,0 +1,55 @@
+module Syobocal
+  module Comment
+    module Element
+      class TextNode
+        attr_reader :text_elements
+
+        SUBJECT_SEPARATOR = "、"
+        ENCODED_SEPARATOR = "\t"
+
+        def initialize(text_elements)
+          @text_elements = text_elements
+        end
+
+        def inner_text
+          text_elements.map(&:str).join("")
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) && other.text_elements == text_elements
+        end
+
+        def split
+          buffer = ""
+
+          text_elements.each do |node|
+            case node
+            when Element::Text
+              buffer << node.str.gsub(SUBJECT_SEPARATOR, ENCODED_SEPARATOR)
+            when Element::Link
+              buffer << node.str
+            end
+          end
+
+          buffer.scan(/[^#{ENCODED_SEPARATOR}\(]+(?:\(.*?\))?/).map { |str| str.gsub(ENCODED_SEPARATOR, SUBJECT_SEPARATOR).strip }
+        end
+
+        def self.match?(line)
+          true
+        end
+
+        def self.parse(text)
+          elements = text.split(/(\[\[[^\[\]]*?\]\])/).select { |s| !s.empty? }.map do |s|
+            if s.match(/\A\[\[[^\[\]]*?\]\]\Z/)
+              Link.create(s)
+            else
+              Text.create(s)
+            end
+          end
+
+          Element::TextNode.new(elements)
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/helper/fragment.rb

@@ -0,0 +1,80 @@
+module Syobocal
+  module Comment
+    module Helper
+      class Fragment
+        CHILD_BEGIN = '('
+        CHILD_END = ')'
+        SEPARATOR = '、'
+
+        attr_reader :text, :child, :following
+
+        def initialize(text, child, following)
+          @text, @child, @following = text, child, following
+        end
+
+        def self.parse(str)
+          chars = str.each_char.to_a
+
+          parse_chars(chars)
+        end
+
+        def self.parse_chars(chars)
+          text = ""
+          child = nil
+          following = nil
+
+          until chars.empty?
+            c = chars.shift
+
+            case c
+            when CHILD_BEGIN
+              child = parse_chars(chars)
+            when CHILD_END
+              return Fragment.new(text, child, following)
+            when SEPARATOR
+              following = parse_chars(chars)
+            else
+              text << c
+            end
+          end
+
+          Fragment.new(text, child, following)
+        end
+
+        def pretty_output(level = 0)
+          line = level.times.map{' '}.join
+
+          line << text
+
+          puts line
+
+          child&.pretty_output(level + 1)
+
+          following&.pretty_output(level)
+        end
+
+        def to_a
+          array = [self]
+          target = self
+
+          while target.following
+            array << target.following
+            target = target.following
+          end
+
+          array
+        end
+
+        def to_s
+          to_a.map{|f|
+            if f.child
+              "#{f.text}(#{f.child.to_s})"
+            else
+              "#{f.text}"
+            end
+          }.join(SEPARATOR)
+        end
+      end
+    end
+  end
+end

data/lib/syobocal/comment/music.rb

@@ -0,0 +1,15 @@
+module Syobocal
+  module Comment
+    class Music
+      attr_reader :title, :category, :data_list
+
+      def initialize(title, category, data_list)
+        @title, @category, @data_list = title, category, data_list
+      end
+
+      def ==(other)
+        other.instance_of?(self.class) && other.title == title && other.category == category && other.data_list == data_list
+      end
+    end
+  end
+end

data/lib/syobocal/comment/music_data.rb

@@ -0,0 +1,15 @@
+module Syobocal
+  module Comment
+    class MusicData
+      attr_reader :attr, :attr_text, :attr_note, :value, :people
+
+      def initialize(attr, attr_text, attr_note, value, people)
+        @attr, @attr_text, @attr_note, @value, @people = attr, attr_text, attr_note, value, people
+      end
+
+      def ==(other)
+        other.instance_of?(self.class) && other.attr == attr && other.attr_text == attr_text && other.attr_note == other.attr_note && other.value == value && other.people == people
+      end
+    end
+  end
+end