sleipnir-api 0.1.0 → 0.2.0

data/History.txt

@@ -1,3 +1,16 @@
+== 0.2.0 / 2007-07-29
+
+* Added grepnir command to search Sleipnir tab.
+* API changes:
+  * SleipnirAPI::Tab
+    +window+:: support block argument.
+    +document+:: ditto.
+    +browser+:: ditto.
+    +location+:: ditto.
+    +close+:: now take +force+ optional argument to close navigate locked tab.
+    +hilight+:: support multiple keywords.
+    +selection_text+:: add new method to get selected text.
+
 == 0.1.0 / 2007-07-22
 
 * Initial beta release

data/Manifest.txt

@@ -4,12 +4,16 @@ Manifest.txt
 README.txt
 Rakefile
 TODO.txt
+bin/grepnir
+examples/close_dup.rb
 examples/reload.rb
 helper/helper.rb
 helper/rake.rb
 helper/rake_sh_filter.rb
 helper/util.rb
 lib/sleipnir_api.rb
+lib/sleipnir_api/cli/base.rb
+lib/sleipnir_api/cli/grepnir.rb
 lib/sleipnir_api/dialog.rb
 lib/sleipnir_api/key_state.rb
 lib/sleipnir_api/output.rb
@@ -24,7 +28,10 @@ lib/sleipnir_api/version.rb
 lib/sleipnir_api/win32api.rb
 scripts/rdoc_filter.rb
 setup.rb
+spec/dsl/behaviour_eval.rb
+spec/matchers/exit_with.rb
 spec/matchers/path_eql.rb
+spec/sleipnir_api/cli/grepnir_spec.rb
 spec/sleipnir_api/dialog_mock_spec.rb
 spec/sleipnir_api/key_state_mock_spec.rb
 spec/sleipnir_api/output_spec.rb

data/README.txt

@@ -16,14 +16,19 @@ API 仕様は SleipnirAPI を参照してください。
   require "sleipnir_api"
 
   SleipnirAPI.new do |pnir|
-    pnir.each do |tab|
-      if tab.location.href =~ /workspace/
-        tab.location.reload
-      end
+    pnir.select{|tab| tab.location.href =~ /workspace/ }.each do |tab|
+      tab.location.reload
     end
   end
 
 
+=== COMMAND
+
+sleipnir-api は _grepnir_ コマンドが付属しています。
+
+詳細は {grepnir}[link:files/bin/grepnir.html] を参照してください。
+
+
 === INSTALL
 
 [Unix]
@@ -40,6 +45,7 @@ API 仕様は SleipnirAPI を参照してください。
 
 * Sleipnir 2.xx でのテストはあまりしていません。
 
+
 === COPYRIGHT
 
 Copyright (c) 2007 MIYAMUKO Katsuyuki.

data/TODO.txt

@@ -1,11 +1,28 @@
 == TODO
 
+* search, hilight を自前で実装する
+  * Sleipnir 2.x じゃサポートしていない
+  * 1.66 で hilight を同じページに対して何回も実行するとだんだん重くなる
+* watir サポート
+  * InternetExplorer.Application 互換のインターフェイスを提供する
+    Adapter を作ってタブごとに watir オブジェクトを取得できればよい? 
+    * InternetExplorer.Application == IWebBrowser2     == pnir.browser
+    * ie.document                  == DispHTMLDocument == pnir.document
+    * ie.parentWindow              == DispHTMLWindow2  == pnir.window
+* ipnir
+  * intaractive sleipnir shell
+* JavaScript の実行
 * Sleipnir の起動・終了を WMI を使わずに実装。
 * Sleipnir の終了時に Window Handle をちゃんと見る。
-* grepnir
-* example
+* Sleipnir の IE コンポーネント部分の Window Handle の取得。
+  * Internet Explorer_Server
+* ウィンドウの screen shot
+* Sleipnir.API proxy interface
+  * JSON-RPC
+  * XML-RPC
+  * dRuby
+  * Rinda
+  * Gearman
 * ExecCommand
   * コマンドの一覧
 * Sleipnir 2.x のサポート
-  * ExecAction とか
-

data/bin/grepnir

@@ -0,0 +1,91 @@
+#!/usr/bin/ruby
+
+#
+# == NAME
+#
+# grepnir - Sleipnir で開いている Web ページを grep する
+#
+# == SYNOPSIS
+#
+#      Usage: grepnir [OPTION]... PATTERN...
+#
+#
+# == DESCRIPTION
+#
+# grepnir は Sleipnir で開いている Web ページの内容をキーワード検索するコマンドです。
+#
+# キーワードにマッチしたタブに対して以下のアクションを実行できます。
+#
+# * アクティブなタブにする (-A)
+# * タイトルにスター (*) を付ける (-T)
+# * ナビゲートロック (-L)
+# * ハイライト (-H)
+# * キーワードを選択 (-S)
+# * ヒットした URL とタイトルを表示
+#
+# --include, --exclude, --only-locked-tab で特定の URL だけ検索することができます。
+#
+#
+# == USAGE
+#
+#     Usage: grepnir [OPTION]... PATTERN...
+#
+#       Sleipnir control:
+#         -A, --[no-]activate              activate 1st matched tab
+#         -T, --[no-]title-star            add star '*' to title
+#         -L, --[no-]lock                  navigate lock for each matched tab
+#         -H, --[no-]hilight               hilight to distinguish the matched text
+#         -S, --[no-]search                search and select matched text
+#
+#       Match control:
+#         -v, --invert-match               select non-matching tabs
+#         -l, --only-locked-tab            search navigate lock tabs only
+#             --include=PATTERN            URLs that match PATTERN will be examined
+#             --exclude=PATTERN            URLs that match PATTERN will be skipped
+#
+#       Miscellaneous:
+#         -V, --version                    print version information and exit
+#         -h, --help                       print this help and exit
+#
+#       Default options:
+#         -A -T -S
+#
+#
+# == CAVEATS
+#
+# * Sleipnir 2.x ではハイライト (-H) と選択 (-S) はサポートしていないので、
+#   オプションを指定しても単純に無視します。
+#
+# * Sleipnir 1.x で同じページに対して何回もハイライト処理をすると
+#   処理をするたびに重くなります。
+#
+#
+# == EXIT STATUS
+#
+# 0:: 指定したパターンがマッチした場合
+# 1:: 指定したパターンがマッチしなかった場合
+# 2:: 引数が不正など何かエラーが起きた場合
+#
+
+module SleipnirAPI
+  class Launcher #:nodoc:
+
+    def self.production?
+      $LOADED_FEATURES.include?("rubygems.rb") and File.exist?(File.join(File.dirname($0), "ruby.exe"))
+    end
+
+    def self.add_lib_to_load_path
+      $LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+    end
+
+    def self.launch
+      add_lib_to_load_path unless production?
+      require "optparse"
+      require "sleipnir_api/cli/grepnir"
+      ::SleipnirAPI::CLI::Grepnir.new.execute(ARGV)
+    end
+
+  end
+end
+
+SleipnirAPI::Launcher.launch

data/examples/close_dup.rb

@@ -0,0 +1,17 @@
+require "set"
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+require "sleipnir_api"
+
+SleipnirAPI.new do |pnir|
+  url2tab = pnir.to_set.classify{|e| e.document.URL }.select{|url,tabs| tabs.size > 1 }
+  url2tab.each do |url,tabs|
+    tabs.sort_by{|e|
+      [e.navigate_lock? ? 0 : 1,
+       e.active? ? 0 : 1,
+       e.read? ? 0 : 1,
+       e.busy? ? 1 : 0,
+       e.index]
+    }[1..-1].each{|e| e.close(true) }
+  end
+end

data/lib/sleipnir_api/cli/base.rb

@@ -0,0 +1,77 @@
+module SleipnirAPI
+  module CLI #:nodoc:
+  end
+end
+
+class SleipnirAPI::CLI::Base #:nodoc:
+
+  class SleipnirAPI::CLI::Exit < SystemExit #:nodoc:
+    attr_reader :status
+    def initialize(status)
+      @status = status
+    end
+  end
+
+  def initialize(stdin = nil, stdout = nil, stderr = nil, exit_when_done = true)
+    @stdin = stdin
+    @stdout = stdout
+    @stderr = stderr
+    @exit_when_done = exit_when_done
+  end
+
+  def done!(status)
+    if @exit_when_done
+      exit status
+    else
+      raise SleipnirAPI::CLI::Exit, status
+    end
+  end
+
+  def stdin
+    @stdin || $stdin
+  end
+
+  def stdout
+    @stdout || $stdout
+  end
+
+  def stderr
+    @stderr || $stderr
+  end
+
+  def initialize_context(ctx)
+  end
+
+  def process_arguments(ctx, args)
+  end
+
+  def prepare(args)
+    ctx = OpenStruct.new
+    initialize_context(ctx)
+    process_arguments(ctx, args)
+    ctx
+  end
+
+  def execute(args)
+    begin
+      execute0(args)
+    rescue SleipnirAPI::CLI::Exit => e
+      return e.status
+    end
+  end
+
+  def execute0(args)
+    ctx = prepare(args)
+
+    begin
+      match = SleipnirAPI.connect do |pnir|
+        perform(ctx, pnir)
+      end
+      done!(match ? 0 : 1)
+    rescue SleipnirAPI::ConnectError => e
+      stderr.puts "Sleipnir does not running."
+      done!(2)
+    end
+  end
+
+end

data/lib/sleipnir_api/cli/grepnir.rb

@@ -0,0 +1,188 @@
+require "ostruct"
+
+require "sleipnir_api"
+require "sleipnir_api/cli/base"
+
+class SleipnirAPI::CLI::Grepnir < SleipnirAPI::CLI::Base #:nodoc:
+
+  class Action #:nodoc:
+    def initialize(cli)
+      @cli = cli
+      @actions = self.private_methods(false) - ["initialize"]
+    end
+
+    def run(ctx, *args, &block)
+      @actions.each do |act|
+        next unless ctx.action.__send__(act)
+        self.__send__(act, ctx, *args, &block)
+      end
+    end
+
+    private
+
+    def activate(ctx, pnir, tab, doc, text, matched)
+      return if ctx.scope.req[:activated]
+      if matched
+        tab.activate
+        ctx.scope.req[:activated] = true
+      end
+    end
+
+    def title_star(ctx, pnir, tab, doc, text, matched)
+      current = tab.document.Title
+      star = current.match(/\A\* /)
+      if matched
+        tab.document.Title = "* #{current}" unless star
+      else
+        tab.document.Title = current[2..-1] if star
+      end
+    end
+
+    def lock(ctx, pnir, tab, doc, text, matched)
+      tab.navigate_lock = matched
+    end
+
+    def hilight(ctx, pnir, tab, doc, text, matched)
+      return if pnir.v2?
+      if ctx.invert_match or not matched
+        tab.hilight("")
+      else
+        tab.hilight(ctx.keywords)
+      end
+    end
+
+    def search(ctx, pnir, tab, doc, text, matched)
+      return if pnir.v2?
+      if ctx.invert_match or not matched
+        tab.document.Selection.Empty
+      else
+        ctx.keywords.each do |kwd|
+          break if tab.search(kwd)
+        end
+      end
+    end
+
+    def output(ctx, pnir, tab, doc, text, matched)
+      return unless matched
+      @cli.stdout.puts "- #{doc.Title}"
+      @cli.stdout.puts "  #{doc.URL}"
+    end
+
+  end
+
+
+  DEFAULT_ARGUMENTS = %W(-A -T -S)
+
+  def initialize(*args)
+    super(*args)
+    @action = Action.new(self)
+  end
+
+  def initialize_context(ctx)
+    ctx.action = OpenStruct.new
+    ctx.flag = OpenStruct.new
+    ctx.scope = OpenStruct.new.instance_eval {
+      self.app = {}
+      self.req = {}
+      self.tab = {}
+      self
+    }
+    ctx.action.output = true
+    ctx.includes = []
+    ctx.excludes = []
+  end
+
+  def argument_processor(ctx)
+    Proc.new do |opt|
+      opt.banner = "Usage: grepnir [OPTION]... PATTERN..."
+
+      opt.separator ""
+      opt.separator "  Sleipnir control:"
+      opt.on("-A", "--[no-]activate", "activate 1st matched tab") {|v|
+        ctx.action.activate = v }
+      opt.on("-T", "--[no-]title-star", "add star '*' to title") {|v|
+        ctx.action.title_star = v }
+      opt.on("-L", "--[no-]lock", "navigate lock for each matched tab") {|v|
+        ctx.action.lock = v }
+      opt.on("-H", "--[no-]hilight", "hilight to distinguish the matched text") {|v|
+        ctx.action.hilight = v }
+      opt.on("-S", "--[no-]search", "search and select matched text") {|v|
+        ctx.action.search = v }
+
+      opt.separator ""
+      opt.separator "  Match control:"
+      opt.on("-v", "--invert-match", "select non-matching tabs") {
+        ctx.invert_match = true }
+      opt.on("-l", "--only-locked-tab", "search navigate lock tabs only") {|v|
+        ctx.only_locked_tab = true }
+      opt.on("--include=PATTERN", "URLs that match PATTERN will be examined") {|v|
+        ctx.includes << v }
+      opt.on("--exclude=PATTERN", "URLs that match PATTERN will be skipped") {|v|
+        ctx.excludes << v }
+
+      opt.separator ""
+      opt.separator "  Miscellaneous:"
+      opt.on("-V", "--version", "print version information and exit") {
+        stdout.puts "grepnir #{SleipnirAPI::VERSION::STRING}"
+        done!(0)
+      }
+      opt.on("-h", "--help", "print this help and exit") {
+        stdout.puts opt
+        done!(0)
+      }
+
+      opt.separator ""
+      opt.separator "  Default options:"
+      opt.separator "    #{DEFAULT_ARGUMENTS * ' '}"
+
+      opt.parse!
+    end
+  end
+
+  def target_tab?(ctx, tab)
+    return false if ctx.only_locked_tab and not tab.navigate_lock?
+    url = tab.document.URL
+    return false if ctx.exclude_re.match(url)
+    return true if ctx.includes.empty?
+    return true if ctx.include_re.match(url)
+    false
+  end
+
+  def process_arguments(ctx, args)
+    proc = argument_processor(ctx)
+
+    defaults = DEFAULT_ARGUMENTS.dup.extend(OptionParser::Arguable)
+    defaults.options(&proc)
+
+    args.options(&proc)
+    if args.empty?
+      stderr.puts "missing PATTERN"
+      stderr.puts args.options
+      done!(2)
+    end
+
+    ctx.keywords = args.dup
+    ctx.keyword_re = ctx.keywords.map{|e| /#{Regexp.quote(e)}/i }
+
+    ctx.include_re = Regexp.union(*ctx.includes)
+    ctx.exclude_re = Regexp.union(*ctx.excludes)
+  end
+
+  def perform(ctx, pnir)
+    r = false
+    ctx.scope.req.clear
+    pnir.select{|tab| target_tab?(ctx, tab) }.each do |tab|
+      ctx.scope.tab.clear
+      tab.document {|doc|
+        text = doc.body.innerText
+        matched = ctx.keyword_re.all?{|re| re.match(text) }
+        matched = !matched if ctx.invert_match
+        @action.run(ctx, pnir, tab, doc, text, matched)
+        r = true if matched
+      }
+    end
+    r
+  end
+
+end
+