sleipnir-api 0.2.1 → 0.3.0

data/lib/sleipnir_api/security.rb

@@ -30,6 +30,18 @@ module SleipnirAPI
   #   # Enumerable method
   #   tab.security.find_all{|e| e.disable? }
   #
+  # セキュリティ名は以下のシンボルを指定できます。
+  #
+  # * <tt>:javascript</tt>
+  # * <tt>:java</tt>
+  # * <tt>:run_activex</tt>
+  # * <tt>:download_activex</tt>
+  # * <tt>:picture</tt>
+  # * <tt>:sound</tt>
+  # * <tt>:video</tt>
+  #
+  # セキュリティ名の一覧は #keys で取得できます。
+  #
   class Security
     include Enumerable
     include SleipnirAPI::Util
@@ -43,19 +55,21 @@ module SleipnirAPI
 
       attr_reader :name
 
-      def initialize(security, name)
+      def initialize(security, tab, name, method)
         @security = security
+        @tab = tab
         @name = name
+        @method = method
       end
 
       # このセキュリティ設定が有効なら true を返します。
       def enable?
-        @security.enable?(@name)
+        @tab.sleipnir.api.__send__(@method, @tab.id)
       end
 
       # このセキュリティ設定が無効なら true を返します。
       def disable?
-        @security.disable?(@name)
+        not enable?
       end
 
       # このセキュリティ設定の有効・無効を切り替えます。
@@ -73,7 +87,7 @@ module SleipnirAPI
       # このセキュリティ設定を有効にします。
       #
       # 複数のセキュリティ設定を更新する場合は、
-      # このメソッドを利用せず SleipnirAPI::Security#set_security を利用して
+      # このメソッドを利用せず SleipnirAPI::Security#enable! を利用して
       # 一括設定してください。
       def enable!
         self.enable = true
@@ -82,7 +96,7 @@ module SleipnirAPI
       # このセキュリティ設定を無効にします。
       #
       # 複数のセキュリティ設定を更新する場合は、
-      # このメソッドを利用せず SleipnirAPI::Security#set_security を利用して
+      # このメソッドを利用せず SleipnirAPI::Security#disable! を利用して
       # 一括設定してください。
       def disable!
         self.enable = false
@@ -128,14 +142,14 @@ module SleipnirAPI
 
     def initialize(tab)
       @tab = tab
-      keys.each do |name|
-        instance_variable_set("@#{name}", Config.new(self, name))
+      NAME2API.each do |name, api|
+        instance_variable_set("@#{name}", Config.new(self, tab, name, api))
       end
     end
 
     # セキュリティ設定の名前 (シンボル) を配列で返します。
     #
-    # この名前は #[], #set_security, #enable?, #disable? に指定できます。
+    # この名前は [], #set_security, #enable?, #disable? などに指定できます。
     #
     #   pnir.active_tab.security.keys
     #   #=> [:javascript, :java, :run_activex, :download_activex, :picture, :sound, :video]
@@ -178,6 +192,7 @@ module SleipnirAPI
       keys.map{|e| self[e] }.each(&block)
     end
 
+
     # call-seq:
     #   set_security(:javascript => true_or_false,
     #                :java => true_or_false,
@@ -197,23 +212,78 @@ module SleipnirAPI
 
     # セキュリティ設定をハッシュで取得します。
     def get_security
-      NAME2API.inject({}) do |h, pair|
-        h[pair[0]] = api.__send__(pair[1], @tab.id)
-        h
-      end
+      inject({}) {|h,conf| h[conf.name] = conf.enable?; h }
     end
     alias to_hash get_security
 
-    # 指定された名前のセキュリティ設定が有効なら true を返します。
-    def enable?(name)
-      api.__send__(NAME2API.assoc(name.to_sym)[1], @tab.id)
+    # 指定された名前のセキュリティ設定がすべて有効なら true を返します。
+    #
+    # 引数に :all を指定するとすべてのセキュリティ設定が有効なら true を返します。
+    #
+    #   tab.security.enable?(:javascript)
+    #   tab.security.enable?(:picture, :sound, :video)
+    #   tab.security.enable?(:all)
+    #
+    def enable?(*names)
+      names = parse_name(*names)
+      names.all?{|name| self[name].enable? }
     end
 
-    # 指定された名前のセキュリティ設定が無効なら true を返します。
-    def disable?(name)
-      not enable?(name)
+    # 指定された名前のセキュリティ設定がすべて無効なら true を返します。
+    #
+    # 引数に :all を指定するとすべてのセキュリティ設定が無効なら true を返します。
+    #
+    #   tab.security.disable?(:javascript)
+    #   tab.security.disable?(:picture, :sound, :video)
+    #   tab.security.disable?(:all)
+    #
+    def disable?(*names)
+      names = parse_name(*names)
+      names.all?{|name| self[name].disable? }
     end
 
+    # 指定された名前のセキュリティ設定をすべて有効にします。
+    #
+    # 引数に :all を指定するとすべてのセキュリティ設定を有効にします。
+    #
+    #   tab.security.enable!(:javascript)
+    #   tab.security.enable!(:picture, :sound, :video)
+    #   tab.security.enable!(:all)
+    #
+    def enable!(*names)
+      set!(true, *names)
+    end
+
+    # 指定された名前のセキュリティ設定をすべて無効にします。
+    #
+    # 引数に :all を指定するとすべてのセキュリティ設定を無効にします。
+    #
+    #   tab.security.disable!(:javascript)
+    #   tab.security.disable!(:picture, :sound, :video)
+    #   tab.security.disable!(:all)
+    #
+    def disable!(*names)
+      set!(false, *names)
+    end
+
+    def set!(enable, *names)
+      names = parse_name(*names)
+      set_security(names.inject({}){|h,k| h[k] = enable; h})
+    end
+    private :set!
+
+    def parse_name(*names)
+      names = names.flatten.map{|e| e.to_sym }
+      invalid = names - keys - [:all]
+      unless invalid.empty?
+        raise ArgumentError, "invalid security name #{invalid.inspect}"
+      end
+      names = keys if names.include?(:all)
+      names
+    end
+    private :parse_name
+
+
     def inspect
       "#<%s:0x%x %s>" % [self.class, self.object_id << 1, to_hash.inspect ]
     end

data/lib/sleipnir_api/sleipnir.rb

@@ -4,6 +4,7 @@ require "sleipnir_api/output"
 require "sleipnir_api/profile"
 require "sleipnir_api/key_state"
 require "sleipnir_api/dialog"
+require "sleipnir_api/command"
 
 module SleipnirAPI
 
@@ -55,6 +56,7 @@ module SleipnirAPI
 
     # Sleipnir のウィンドウハンドル
     attr_reader :handle
+    alias hwnd handle
 
     # Sleipnir のバージョン
     attr_reader :version
@@ -194,6 +196,21 @@ module SleipnirAPI
       tabs.each(&block)
     end
 
+    # call-seq:
+    #   each_eval{ ... }
+    #
+    # すべてのタブで指定された block を評価します。
+    # block は SleipnirAPI::Tab のコンテキストで評価されます (self が SleipnirAPI::Tab です)
+    #
+    #   pnir.each_eval do
+    #     if location.href =~ /workspace/
+    #       self.navigate_lock = true
+    #     end
+    #   end
+    #
+    def each_eval(&block)
+      each {|tab| tab.instance_eval(&block) }
+    end
 
     # アクティブなドキュメントのタブ位置を取得します。
     def active_index
@@ -331,10 +348,36 @@ module SleipnirAPI
       api.AddSearchBarHistory
     end
 
-    # Sleipnir の任意のメニューを <tt>cmdid</tt> で指定して実行します。
-    # <tt>cmdid</tt> はマウスジェスチャー (Gesture.ini) 等から参照してください。
-    def exec_command(cmdid)
-      api.ExecCommand(cmdid)
+    # Sleipnir の任意のメニューを <tt>command</tt> で指定して実行します。
+    #
+    # command には以下の値を指定可能です。
+    #
+    # * SleipnirAPI::Command オブジェクト
+    # * 文字列 or 配列 (メニュー文字列)
+    #   * メニュー文字列のエンコーディングは Shift_JIS です
+    # * 数値 (コマンド番号)
+    #
+    # 例:
+    #
+    #   pnir = SleipnirAPI.connect
+    #   pnir.exec_command(57664)
+    #   pnir.exec_command("バージョン情報")
+    #   pnir.exec_command(SleipnirAPI::Command["バージョン情報"])
+    #   pnir.exec_command(["Netscape ブックマーク", "インポート"])
+    #
+    def exec_command(command)
+      case command
+      when String, Array
+        c = SleipnirAPI::Command[*Array(command)]
+        raise ArgumentError, "No such command: #{command}" unless c
+        exec_command(c.command_id)
+      when SleipnirAPI::Command
+        exec_command(command.command_id)
+      when Integer
+        api.ExecCommand(command)
+      else
+        raise ArgumentError, "Illegal command: #{command.inspect}"
+      end
     end
 
 
@@ -345,11 +388,52 @@ module SleipnirAPI
       SleipnirAPI::Output.new(self)
     end
 
+    # call-seq:
+    #   profile()
+    #   profile(ini_filename)
+    #   profile(:default => "default value")
+    #   profile(:cipher => true)
+    #   profile(:cipher => true, :default => "default value")
+    #   profile(:ini => ini_filename, :default => "default value")
+    #   profile(:ini => ini_filename, :cipher => true)
+    #   profile(:ini => ini_filename, :cipher => true, :default => "default value")
+    #
     # ini ファイルを操作するオブジェクトを取得します。
     #
-    # See Also: SleipnirAPI::Profile
-    def profile
-      SleipnirAPI::Profile.new(self)
+    # 引数には ini ファイル名、SleipnirAPI::Profile#get_string などに指定するオプションの
+    # デフォルト値を指定します。
+    # ここで指定したオプションは各メソッドの引数で上書きすることができます。
+    #
+    # なお、SleipnirAPI::Profile#delete はオプション引数を取らないので
+    # ここで指定した値は完全に無視されます。
+    #
+    # ini ファイル名を指定した場合、SleipnirAPI::Profile::Ini オブジェクトを返します。
+    # 指定しない場合は SleipnirAPI::Profile オブジェクトを返します。
+    #
+    # ex)
+    #   prof = pnir.profile                #=> #<SleipnirAPI::Profile:0xdeadbeaf ...>
+    #   proxy = pnir.profile("Proxy.ini")  #=> #<SleipnirAPI::Profile::Ini:0xdeadbeaf: Proxy.ini, opts={}>
+    #
+    # See Also: SleipnirAPI::Profile, SleipnirAPI::Profile::Ini
+    def profile(ini = nil, opts = nil)
+      if ini
+        case ini
+        when Hash
+          t = ini.delete(:ini)
+          ini, opts = t, ini
+        when String, Symbol
+          ini = ini.to_s
+        else
+          raise ArgumentError, "Invalid ini filename `#{ini.inspect}':#{ini.class} (expected String or Symbol)"
+        end
+      end
+
+      r = SleipnirAPI::Profile.new(self, opts)
+      if ini
+        r.ini(ini)
+      else
+        r
+      end
     end
 
   end

data/lib/sleipnir_api/tab.rb

@@ -2,6 +2,8 @@ require "sleipnir_api/util"
 require "sleipnir_api/key_state"
 require "sleipnir_api/dialog"
 require "sleipnir_api/security"
+require "sleipnir_api/tabbed_ie"
+require "sleipnir_api/searcher"
 
 module SleipnirAPI
 
@@ -38,6 +40,7 @@ module SleipnirAPI
     def initialize(sleipnir, id)
       @sleipnir = sleipnir
       @id = id
+      @searcher = SleipnirAPI::Searcher.new(self)
     end
 
     # call-seq:
@@ -109,6 +112,46 @@ module SleipnirAPI
       end
     end
 
+    # call-seq:
+    #   elem_by_tag(tag, parent=nil) -> Array of IHTMLElement
+    #   elem_by_tag(tag, index=0, parent=nil) -> IHTMLElement
+    #
+    # 指定された +tag+ 名の IHTMLElement を取得します。
+    #
+    # * +index+ を指定した場合、+index+ 番目の IHTMLElement を返します。
+    #   指定しない場合は IHTMLElement の配列を返します。
+    # * +parent+ を指定した場合は、+parent+ 配下から指定されたタグを探します。
+    #   指定しない場合はドキュメント全体から探します。
+    #
+    def elem_by_tag(tag, index=nil, parent=nil)
+      parent ||= document
+      tags = parent.getElementsByTagName(tag)
+      return unless tags
+      return tags unless index
+      tags.extend(Enumerable).to_a[index]
+    end
+
+    # このタブの base URI を返します。
+    #
+    # * <head> 内に <base> タグがあれば、最後の <base> タグの href 属性を返します。
+    # * <base> タグがなければこのドキュメントの URL を返します。
+    # * <body> 内の <base> タグは無視されます。
+    def base_uri
+      # document.baseUrl does not work :-(
+      base_uris.last || location.href
+    end
+
+    # <head> 内に <base> タグの配列を返します。
+    #
+    # <base> タグがなければ空の配列を返します。
+    def base_uris
+      head = elem_by_tag("head", 0)
+      return [] unless head
+      base = elem_by_tag("base", nil, head)
+      return [] unless base
+      base.extend(Enumerable).map{|e| e.href }
+    end
+
     # このタブで選択しているテキストを取得します。
     #
     # 選択していない場合は空文字列を返します。
@@ -122,6 +165,30 @@ module SleipnirAPI
       SleipnirAPI::Security.new(self)
     end
 
+    # このタブを操作する Watir オブジェクトを取得します。
+    #
+    #   pnir = SleipnirAPI.connect
+    #   ie = pnir.open("http://www.google.com").watir
+    #   ie.text_field(:name, "q").set("Sleipnir")
+    #   ie.button(:name, "btnG").click
+    #
+    def watir
+      begin
+        require "watir"
+      rescue LoadError
+        retry if require "rubygems"
+        raise
+      end
+
+      ie = SleipnirAPI::TabbedIE.new(self)
+      ::Watir::IE.new(true).instance_eval {
+        @ie = ie
+        set_defaults
+        self
+      }
+    end
+
+
     # このタブのタブ位置を取得します。
     def index
       self.api.GetIndex(self.id)
@@ -146,7 +213,7 @@ module SleipnirAPI
     # このメソッドを呼ぶたびにキーワードにマッチした次の位置に移動します。
     # キーワードが発見できない、または先頭のキーワードに戻ってきた場合 false を返します。
     def search(keyword)
-      self.api.Search(self.id, keyword)
+      @searcher.find_text(keyword, :select, :scroll)
     end
 
     # 指定されたキーワードにマッチする部分をハイライトします。
@@ -416,4 +483,3 @@ __END__
 [戻り値]
 　自動更新の時間（単位 = 秒）
 
-

data/lib/sleipnir_api/tabbed_ie.rb

@@ -0,0 +1,33 @@
+require "forwardable"
+
+module SleipnirAPI
+
+  class TabbedIE #:nodoc:
+    extend Forwardable
+
+    attr_accessor :visible
+
+    def initialize(tab)
+      @tab = tab
+      @browser = tab.browser
+      @visible = false
+    end
+
+    def quit
+      @tab.close
+    end
+
+    def statusBar
+      false
+    end
+
+    def statusText
+      nil
+    end
+
+    def method_missing(method, *args, &block)
+      @browser.__send__(method, *args, &block)
+    end
+  end
+
+end

data/lib/sleipnir_api/util.rb

@@ -17,4 +17,29 @@ module SleipnirAPI
     end
 
   end
+
+  module OptionUtil #:nodoc:
+    module_function
+
+    def parse_option_arguments(*options)
+      result = {}
+      rest = []
+      options.flatten.compact.map{|e| Symbol === e ? e.to_s : e }.each do |opt|
+        case opt
+        when /\A(?:no|without)_(.+)/
+          result[$1.to_sym] = false
+        when /\A(?:with)_(.+)/
+          result[$1.to_sym] = true
+        when /(.+)/
+          result[$1.to_sym] = true
+        when Hash
+          result.update(opt)
+        else
+          rest << opt
+        end
+      end
+      [result, rest]
+    end
+  end
+
 end