sleipnir-api 0.1.0

data/lib/sleipnir_api/tab.rb

@@ -0,0 +1,359 @@
+require "sleipnir_api/util"
+require "sleipnir_api/key_state"
+require "sleipnir_api/dialog"
+require "sleipnir_api/security"
+
+module SleipnirAPI
+
+  #
+  # このクラスは Sleipnir の COM オブジェクト (Sleipnir.API) の wrapper クラスです。
+  # Sleipnir のタブを操作する API を定義しています。
+  #
+  # このオブジェクトは Sleipnir.API の ドキュメント ID を抽象化したものです。
+  # 実際のドキュメントオブジェクト (DispHTMLDocument) の抽象化は行いません。
+  #
+  # * このオブジェクトは SleipnirAPI::Sleipnir#tab または SleipnirAPI::Sleipnir#active_tab で取得します。
+  # * SleipnirAPI::KeyState と SleipnirAPI::Dialog で定義されているメソッドが利用できます。
+  #
+  # 例:
+  #
+  #   pnir = SleipnirAPI.new
+  #   tab = pnir.open("http://www.ruby-lang.org/", true)
+  #
+  #   tab.location.href #=> http://www.ruby-lang.org/
+  #   tab.document.getElementsByTagName("h2")
+  #   tab.navigate("http://rubyforge.org")
+  #
+  class Tab
+    include SleipnirAPI::Util
+    include SleipnirAPI::KeyState
+    include SleipnirAPI::Dialog
+
+    # SleipnirAPI::Sleipnir object
+    attr_reader :sleipnir
+
+    # Sleipnir の ドキュメント ID (ドキュメント固有の ID)
+    attr_reader :id
+
+    def initialize(sleipnir, id)
+      @sleipnir = sleipnir
+      @id = id
+    end
+
+    # このタブの Window Object (DispHTMLWindow2 (WIN32OLE オブジェクト)) を取得します。
+    def window
+      self.api.GetWindowObject(self.id)
+    end
+
+    # このタブの HTML Document Object (DispHTMLDocument (WIN32OLE オブジェクト)) を取得します。
+    def document
+      self.api.GetDocumentObject(self.id)
+    end
+
+    # このタブの WebBrowser Object (IWebBrowser2 (WIN32OLE オブジェクト)) を取得します。
+    def browser
+      self.api.GetWebBrowserObject(self.id)
+    end
+    alias web_browser browser
+
+    # このタブの location Object (IHTMLLocation (WIN32OLE オブジェクト)) を取得します。
+    def location
+      document.location
+    end
+
+    # このタブのセキュリティ設定を操作する SleipnirAPI::Security オブジェクトを取得します。
+    def security
+      SleipnirAPI::Security.new(self)
+    end
+
+    # このタブのタブ位置を取得します。
+    def index
+      self.api.GetIndex(self.id)
+    end
+
+    # このタブを閉じます。
+    def close
+      self.api.Close(self.id)
+    end
+
+    # <tt>url</tt> で指定されたドキュメントをこのタブで開きます。
+    def navigate(url)
+      self.api.Navigate(self.id, url)
+    end
+
+    # ページ内を指定されたキーワードで検索します。
+    #
+    # このメソッドを呼ぶたびにキーワードにマッチした次の位置に移動します。
+    # キーワードが発見できない、または先頭のキーワードに戻ってきた場合 false を返します。
+    def search(keyword)
+      self.api.Search(self.id, keyword)
+    end
+
+    # 指定されたキーワードにマッチする部分をハイライトします。
+    def hilight(keyword)
+      self.api.Hilight(self.id, keyword)
+    end
+
+    # ドキュメントが読み込み中の場合 true を返します。
+    def busy?
+      self.api.IsBusy(self.id)
+    end
+
+    # ドキュメントが既読の場合 true を返します。
+    def read?
+      self.api.IsRead(self.id)
+    end
+
+
+    # このタブがアクティブなら true を返します。
+    def active?
+      self.sleipnir.active_index == index
+    end
+
+    # このタブをアクティブにします。
+    def activate
+      self.sleipnir.active_index = index
+    end
+
+
+    # このタブがナビゲートロックされているなら true を返します。
+    def navigate_lock?
+      self.api.IsNavigateLock(self.id)
+    end
+
+    # このタブのナビゲートロックを状態を変更します。
+    #
+    # * <tt>enable</tt> に true を指定するとナビゲートロックします。
+    # * <tt>enable</tt> に false を指定するとナビゲートロックを解除します。
+    def navigate_lock=(enable)
+      self.api.SetNavigateLock(self.id, enable)
+    end
+
+
+    # 自動更新の時間を取得する。
+    def auto_refresh
+      self.api.GetAutoRefresh(self.id)
+    end
+
+    # 自動更新の時間を設定する。
+    def auto_refresh=(sec)
+      self.api.SetAutoRefresh(self.id, sec)
+    end
+
+    # 指定された引き数が同じドキュメントの場合 true を返します。
+    #
+    # 同値性の判定には Sleipnir のドキュメント ID を利用します。
+    def ==(other)
+      return true if self.equal?(other)
+      return false unless SleipnirAPI::Tab === other
+      return self.id == other.id
+    end
+
+    def inspect
+      "#<%s:%d>" % [self.class, self.id]
+    end
+
+  end
+end
+
+
+__END__
+──────────────────
+[IDispatch] GetWindowObject(long id)
+──────────────────
+
+[説明]
+　Window Object を取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　Windows Object の IDispatch
+
+
+───────────────────
+[IDispatch] GetDocumentObject(long id)
+───────────────────
+
+[説明]
+　HTML Document Object を取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　Document Object の IDispatch
+
+
+────────────────────
+[IDispatch] GetWebBrowserObject(long id)
+────────────────────
+
+[説明]
+　WebBrowser Object を取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　WebBrowser Object の IDispatch
+
+
+───────────
+[void] Close(long id)
+───────────
+
+[説明]
+　指定のドキュメントを閉じる。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　なし
+
+
+────────────────────
+[void] Navigate(long id, string strUrl)
+────────────────────
+
+[説明]
+　現在のドキュメントで任意の URL にアクセスする。
+
+[引数]
+　id:     ドキュメント固有の ID
+　strUrl: ナビゲートする Url
+
+[戻り値]
+　なし
+
+
+────────────
+[long] GetIndex(long id)
+────────────
+
+[説明]
+　ドキュメント固有の ID からタブ位置を取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　タブ位置
+
+
+───────────
+[BOOL] IsBusy(long id)
+───────────
+
+[説明]
+　ドキュメントが読み込み中か判断する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　読み込み中の場合は true
+
+
+───────────────
+[BOOL] IsNavigateLock(long id)
+───────────────
+
+[説明]
+　ナビゲートロックが有効か取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　有効ならば true
+
+
+───────────────────────
+[void] SetNavigateLock(long id, BOOL bEnable)
+───────────────────────
+
+[説明]
+　ナビゲートロックを有効・無効にする。
+
+[引数]
+　id:     ドキュメント固有の ID
+　bEnable: 有効にするなら true
+
+[戻り値]
+　なし
+
+
+─────────────────────
+[BOOL] Search(long id, string strKeyword)
+─────────────────────
+
+[説明]
+　ページ内検索を実行する。
+
+[引数]
+　strKeyword: キーワード
+
+[戻り値]
+　キーワードが発見できない、または先頭のキーワードに戻ってきたら false
+
+
+─────────────────────
+[void] Hilight(long id, string strKeyword)
+─────────────────────
+
+[説明]
+　ハイライトを実行する。
+
+[引数]
+　strKeyword: キーワード
+
+[戻り値]
+　なし
+
+
+───────────
+[BOOL] IsRead(long id)
+───────────
+
+[説明]
+　ドキュメントが既読か判断する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　既読の場合は true
+
+
+─────────────────────
+[void] SetAutoRefresh(long id, long nTime)
+─────────────────────
+
+[説明]
+　自動更新の時間を設定する。
+
+[引数]
+　id:    ドキュメント固有の ID
+　nTime: 更新時間（0 ～ 1000 秒）
+
+[戻り値]
+　なし
+
+
+───────────────
+[long] GetAutoRefresh(long id)
+───────────────
+
+[説明]
+　自動更新の時間を取得する。
+
+[引数]
+　id: ドキュメント固有の ID
+
+[戻り値]
+　自動更新の時間（単位 = 秒）
+
+

data/lib/sleipnir_api/util.rb

@@ -0,0 +1,16 @@
+module SleipnirAPI
+  module Util #:nodoc:
+
+    def ensure_version(required_version)
+      if self.sleipnir.version < required_version
+        raise SleipnirAPI::NotImplementedError,
+          "require Sleipnir v#{required_version}, but v#{self.sleipnir.version}"
+      end
+    end
+
+    def api
+      self.sleipnir.api
+    end
+
+  end
+end

data/lib/sleipnir_api/version.rb

@@ -0,0 +1,9 @@
+module SleipnirAPI
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/sleipnir_api/win32api.rb

@@ -0,0 +1,17 @@
+require "Win32API"
+
+module SleipnirAPI
+  module Win32API #:nodoc:
+
+    GetLongPathName = ::Win32API.new("kernel32", "GetLongPathNameA", "PPL", "L")
+
+    module_function
+
+    def get_long_path_name(short_path)
+      buf = '\0' * 1024
+      len = GetLongPathName.call(short_path, buf, buf.length)
+      buf[0...len]
+    end
+
+  end
+end

data/scripts/rdoc_filter.rb

@@ -0,0 +1,74 @@
+class Filter
+
+  def initialize
+    @filter = []
+  end
+
+  def define_replace(regexp, replace, key)
+    @filter << [regexp, lambda { replace }, key]
+  end
+
+  def define_insert_before(tag, snippet, key)
+    @filter << [tag, lambda { snippet + tag }, key]
+  end
+
+  def define_insert_after(tag, snippet, key)
+    @filter << [tag, lambda { tag + snippet }, key]
+  end
+
+  def update!(file)
+    b = File.read(file)
+    a = @filter.inject(b) {|bb,subs|
+      re, sub, key = *subs
+      if key and bb =~ /#{Regexp.quote(key)}/
+        bb
+      else
+        bb.gsub(re, &sub)
+      end
+    }
+    if b != a
+      puts file
+      File.open(file, "w") {|w| w.puts a }
+    end
+  end
+
+end
+
+
+GOOGLE_ANALYTICS_ACCOUNT = "UA-1161245-7"
+GOOGLE_ANALYTICS = <<GOOGLE
+
+<!-- Google Analytics -->
+<div id="google-analytics">
+  <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+  </script>
+  <script type="text/javascript">
+    _uacct = "#{GOOGLE_ANALYTICS_ACCOUNT}";
+    urchinTracker();
+  </script>
+</div>
+
+GOOGLE
+
+f = Filter.new
+f.define_replace(/\A\s+/m, "", nil)
+f.define_replace(/\s*<!--.*?-->\s*<html/m, "<html", nil)
+f.define_insert_before("</body>", GOOGLE_ANALYTICS, '<div id="google-analytics">')
+f.define_replace("</frameset>\n</html>", <<NOFRAME, '<div id="google-analytics">')
+</frameset>
+
+<noframe>
+<body>
+#{GOOGLE_ANALYTICS}
+</body>
+</noframe>
+
+</html>
+NOFRAME
+
+tag = %Q{\n<meta name="verify-v1" content="4xi61YK06FtgbbYoHU2oPltUGvJZLrQogTtv+vaPYTI=" />\n}
+f.define_insert_after("<head>", tag, '<meta name="verify-v1"')
+
+ARGV.each do |html|
+  f.update!(html)
+end