syobocal 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b32b7dbb64cf8d4b48bd87da408f5607b845ab85073c025327bc6e9d6294df6
-  data.tar.gz: 4f2ed089906d9f1560d5b0aeeaa0f009d284337069cc2794521e235ee082899c
+  metadata.gz: 7edc7c39022835637c4c5683b9e9192f98f5f8722b3f77218b6203227a055e17
+  data.tar.gz: 78e539ace20bd227556bcea06508733f8f6e30e07377bbd058e6084308a69485
 SHA512:
-  metadata.gz: a29a2ba9cfb401f13fc69862cb283f9081fe55edb26e26618649393d0de42c97ce3759a9be5345d8bb852c59d1af453b5d4f66485dbc788851cdc7e9419cce2c
-  data.tar.gz: 8f71e8e5941a9a40837648e9300d7cd110b1512f00bc0169185206e12e709c0a1e7c1943e8710a55684c361da01a981459511180cb217db5f425043664dc6d5b
+  metadata.gz: 343c5fd86a55a8d630e70660555b18e463a3fe3401b10f210dd5e1f44b619a32c4fe7f1cff2de2e7b5ada88a9bf03f7603f970ec69bc7e32d7e981409e0142a4
+  data.tar.gz: f0c1727b6e11244f4af5d3b9ef14eba96deb4244e7aef2322277f21a70d23414d5ce36b333a2ed853761822d3d1c6b1e0c09923afea85f66e0976d8be50a3e6a

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,110 @@ 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:0x00005646000afc98
+#  @category="オープニングテーマ",
+#  @data_list=
+#   [#<Syobocal::Comment::MusicData:0x00005646000a0b30
+#     @attr="作詞・作曲",
+#     @value="渡辺翔">,
+#    #<Syobocal::Comment::MusicData:0x00005646000a06a8
+#     @attr="主題歌協力",
+#     @value="外村敬一">,
+#    #<Syobocal::Comment::MusicData:0x00005646000a0428
+#     @attr="歌",
+#     @value="ClariS">,
+#    #<Syobocal::Comment::MusicData:0x00005646000afd38
+#     @attr="使用話数",
+#     @value="#1～#9、#11">],
+#  @title="コネクト">
+```
 
 ## おまけ
 
@@ -109,7 +206,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.rb

@@ -1,15 +1,31 @@
-require 'open-uri'
-require 'rexml/document'
-require 'delegate'
-require 'json'
-require 'rss'
+require "open-uri"
+require "rexml/document"
+require "delegate"
+require "json"
+require "rss"
 require "syobocal/version"
 
-require 'syobocal/util.rb'
-require 'syobocal/calchk.rb'
-require 'syobocal/db.rb'
-require 'syobocal/json.rb'
-require 'syobocal/rss.rb'
-require 'syobocal/rss2.rb'
+require "syobocal/util"
+require "syobocal/calchk"
+require "syobocal/db"
+require "syobocal/json"
+require "syobocal/rss"
+require "syobocal/rss2"
+require "syobocal/comment/element/blank"
+require "syobocal/comment/element/header1"
+require "syobocal/comment/element/header2"
+require "syobocal/comment/element/link"
+require "syobocal/comment/element/list"
+require "syobocal/comment/element/row"
+require "syobocal/comment/element/text"
+require "syobocal/comment/element/text_node"
+require "syobocal/comment/element/root"
+require "syobocal/comment/parser"
+require "syobocal/comment/staff"
+require "syobocal/comment/cast"
+require "syobocal/comment/person"
+require "syobocal/comment/music"
+require "syobocal/comment/music_data"
+require "syobocal/comment/section"
 
 module Syobocal; end

data/lib/syobocal/calchk.rb

@@ -5,7 +5,7 @@ module Syobocal
     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