sleipnir-api 0.1.0 → 0.2.0

data/lib/sleipnir_api/output.rb

@@ -52,14 +52,14 @@ module SleipnirAPI
       api.OutputVisible=(show) #:nodoc:
     end
 
-    # アウトプットバーの表示します。
+    # アウトプットバーを表示します。
     #
     # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
     def show
       self.visible = true
     end
 
-    # アウトプットバーの隠します。
+    # アウトプットバーを隠します。
     #
     # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
     def hide

data/lib/sleipnir_api/tab.rb

@@ -40,25 +40,81 @@ module SleipnirAPI
       @id = id
     end
 
+    # call-seq:
+    #   window -> WIN32OLE object (DispHTMLWindow2)
+    #   window{|window| ... }
+    #
     # このタブの Window Object (DispHTMLWindow2 (WIN32OLE オブジェクト)) を取得します。
+    #
+    # * block を指定した場合、Window Object を引数に指定して block を実行し、block の結果を返します。
+    # * block を指定しない場合、Window Object を返します。
     def window
-      self.api.GetWindowObject(self.id)
+      r = self.api.GetWindowObject(self.id)
+      if block_given?
+        yield r
+      else
+        r
+      end
     end
 
+    # call-seq:
+    #   document -> WIN32OLE object (DispHTMLDocument)
+    #   document{|document| ... }
+    #
     # このタブの HTML Document Object (DispHTMLDocument (WIN32OLE オブジェクト)) を取得します。
+    #
+    # * block を指定した場合、Document Object を引数に指定して block を実行し、block の結果を返します。
+    # * block を指定しない場合、Document Object を返します。
     def document
-      self.api.GetDocumentObject(self.id)
+      r = self.api.GetDocumentObject(self.id)
+      if block_given?
+        yield r
+      else
+        r
+      end
     end
 
+    # call-seq:
+    #   browser -> WIN32OLE object (IWebBrowser2)
+    #   browser{|browser| ... }
+    #
     # このタブの WebBrowser Object (IWebBrowser2 (WIN32OLE オブジェクト)) を取得します。
+    #
+    # * block を指定した場合、WebBrowser Object を引数に指定して block を実行し、block の結果を返します。
+    # * block を指定しない場合、WebBrowser Object を返します。
     def browser
-      self.api.GetWebBrowserObject(self.id)
+      r = self.api.GetWebBrowserObject(self.id)
+      if block_given?
+        yield r
+      else
+        r
+      end
     end
     alias web_browser browser
 
-    # このタブの location Object (IHTMLLocation (WIN32OLE オブジェクト)) を取得します。
+    # call-seq:
+    #   location -> WIN32OLE object (IHTMLLocation)
+    #   location{|location| ... }
+    #
+    # このタブの Location Object (IHTMLLocation (WIN32OLE オブジェクト)) を取得します。
+    #
+    # * block を指定した場合、Location Object を引数に指定して block を実行し、block の結果を返します。
+    # * block を指定しない場合、Location Object を返します。
     def location
-      document.location
+      r = document.location
+      if block_given?
+        yield r
+      else
+        r
+      end
+    end
+
+    # このタブで選択しているテキストを取得します。
+    #
+    # 選択していない場合は空文字列を返します。
+    def selection_text
+      text = document.Selection.CreateRange.Text
+      text.gsub(/\r\n|[\r\n]/, "\n") if text
     end
 
     # このタブのセキュリティ設定を操作する SleipnirAPI::Security オブジェクトを取得します。
@@ -72,7 +128,11 @@ module SleipnirAPI
     end
 
     # このタブを閉じます。
-    def close
+    #
+    # * +force+ が +true+ の場合、ナビゲートロックされたタブも close します。
+    # * +force+ が +false+ の場合、ナビゲートロックされたタブは close されません。
+    def close(force = false)
+      self.navigate_lock = false if force and navigate_lock?
       self.api.Close(self.id)
     end
 
@@ -90,8 +150,8 @@ module SleipnirAPI
     end
 
     # 指定されたキーワードにマッチする部分をハイライトします。
-    def hilight(keyword)
-      self.api.Hilight(self.id, keyword)
+    def hilight(*keywords)
+      self.api.Hilight(self.id, join_keyword(keywords))
     end
 
     # ドキュメントが読み込み中の場合 true を返します。
@@ -112,7 +172,7 @@ module SleipnirAPI
 
     # このタブをアクティブにします。
     def activate
-      self.sleipnir.active_index = index
+      self.sleipnir.active_index = index unless active?
     end
 
 

data/lib/sleipnir_api/util.rb

@@ -8,6 +8,10 @@ module SleipnirAPI
       end
     end
 
+    def join_keyword(keywords)
+      keywords.flatten.compact.map{|e| %Q{"#{e}"} }.join(" ")
+    end
+
     def api
       self.sleipnir.api
     end

data/lib/sleipnir_api/version.rb

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

data/spec/dsl/behaviour_eval.rb

@@ -0,0 +1,5 @@
+module Spec::DSL::BehaviourEval::ModuleMethods
+  def sit(description=:__generate_description, opts={}, &block)
+    puts "skip: #{description}"
+  end
+end

data/spec/matchers/exit_with.rb

@@ -0,0 +1,35 @@
+module Spec::Matchers
+
+  class ExitWith #:nodoc:
+    def initialize(status)
+      @expected_status = status
+    end
+
+    def matches?(proc)
+      begin
+        proc.call
+        false
+      rescue SleipnirAPI::CLI::Exit => actual
+        @actual_status = actual.status
+        @actual_status == @expected_status
+      end
+    end
+
+    def failure_message
+      "expected exit with #{@expected_status}, got #{@actual_status.inspect}"
+    end
+
+    def negative_failure_message
+      "expected no exit with #{@expected_status}"
+    end
+
+    def description
+      "exit #{@expected_status}"
+    end
+  end
+
+  def exit_with(status)
+    ::Spec::Matchers::ExitWith.new(status)
+  end
+
+end

data/spec/matchers/path_eql.rb

@@ -7,35 +7,33 @@ class String
 end
 
 
-module Spec
-  module Matchers
-
-    class PathEql #:nodoc:
-      def initialize(expected)
-        @expected = expected.path_normalize
-      end
-
-      def matches?(actual)
-        @actual = actual.path_normalize
-        @actual.eql?(@expected)
-      end
-
-      def failure_message
-        return "expected #{@expected.inspect}, got #{@actual.inspect} (using path_normalize -> .eql?)", @expected, @actual
-      end
-
-      def negative_failure_message
-        return "expected #{@actual.inspect} not to equal #{@expected.inspect} (using path_normalize -> .eql?)", @expected, @actual
-      end
-
-      def description
-        "path_eql #{@expected.inspect}"
-      end
+module Spec::Matchers
+
+  class PathEql #:nodoc:
+    def initialize(expected)
+      @expected = expected.path_normalize
+    end
+
+    def matches?(actual)
+      @actual = actual.path_normalize
+      @actual.eql?(@expected)
+    end
+
+    def failure_message
+      return "expected #{@expected.inspect}, got #{@actual.inspect} (using path_normalize -> .eql?)", @expected, @actual
     end
 
-    def path_eql(expected)
-      Matchers::PathEql.new(expected)
+    def negative_failure_message
+      return "expected #{@actual.inspect} not to equal #{@expected.inspect} (using path_normalize -> .eql?)", @expected, @actual
     end
 
+    def description
+      "path_eql #{@expected.inspect}"
+    end
+  end
+
+  def path_eql(expected)
+    ::Spec::Matchers::PathEql.new(expected)
   end
+
 end

data/spec/sleipnir_api/cli/grepnir_spec.rb

@@ -0,0 +1,341 @@
+require File.join(File.dirname(__FILE__), "../../spec_helper.rb")
+require "sleipnir_api/cli/grepnir"
+
+describe SleipnirAPI::CLI::Grepnir do
+  include OptionParserSpecHelper
+
+  before(:all) do
+    @pnir = SleipnirAPI.connect
+  end
+
+  after(:all) do
+  end
+
+  before do
+    @stdin = StringIO.new
+    @stdout = ""
+    @stderr = ""
+    @grepnir = SleipnirAPI::CLI::Grepnir.new(@stdin, StringIO.new(@stdout), StringIO.new(@stderr), false)
+  end
+
+  it "default option are -T -S -A" do
+    ctx = @grepnir.prepare(args("baz"))
+    ctx.action.output.should be_true
+    ctx.action.activate.should be_true
+    ctx.action.search.should be_true
+    ctx.action.title_star.should be_true
+    ctx.action.lock.should be_nil
+    ctx.action.hilight.should be_nil
+  end
+
+  it "#prepare should parse options" do
+    ctx = @grepnir.prepare(args("--no-search --no-activate --no-lock -H foo bar baz"))
+    ctx.action.output.should be_true
+    ctx.action.activate.should be_false
+    ctx.action.lock.should be_false
+    ctx.action.search.should be_false
+    ctx.action.hilight.should be_true
+    ctx.action.title_star.should be_true
+    ctx.keywords.should == %W(foo bar baz)
+
+    ctx = @grepnir.prepare(args("--search --activate --hilight --lock foo"))
+    ctx.action.output.should be_true
+    ctx.action.activate.should be_true
+    ctx.action.title_star.should be_true
+    ctx.action.lock.should be_true
+    ctx.action.search.should be_true
+    ctx.action.hilight.should be_true
+    ctx.keywords.should == %W(foo)
+
+    ctx = @grepnir.prepare(args("baz"))
+    ctx.action.output.should be_true
+    ctx.action.activate.should be_true
+    ctx.action.search.should be_true
+    ctx.action.hilight.should be_nil
+    ctx.action.lock.should be_nil
+    ctx.action.hilight.should be_nil
+    ctx.keywords.should == %W(baz)
+  end
+
+  it "execute with empty keywords should output error message to stderr and exit with 2" do
+    @stdout.should be_empty
+    @stderr.should be_empty
+
+    r = @grepnir.execute(args(""))
+    r.should == 2
+
+    @stdout.should be_empty
+    @stderr.should match(/\Amissing PATTERN/)
+    @stderr.should match(/^Usage: grepnir/)
+  end
+
+  it "execute with -h should output help to stdout and exit with 0" do
+    @stdout.should be_empty
+    @stderr.should be_empty
+
+    r = @grepnir.execute(args("-h"))
+    r.should == 0
+
+    @stdout.should match(/\AUsage: grepnir/)
+    @stderr.should be_empty
+  end
+
+  it "execute with -V should output version to stdout and exit with 0" do
+    @stdout.should be_empty
+    @stderr.should be_empty
+
+    r = @grepnir.execute(args("-V"))
+    r.should == 0
+
+    @stdout.should == "grepnir #{SleipnirAPI::VERSION::STRING}\n"
+    @stderr.should be_empty
+  end
+
+  it "activate 1st matched tab by default" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:foobar")
+    begin
+      t2.activate
+      t1.should_not be_active
+
+      r = @grepnir.execute(args("foo"))
+      r.should == 0
+      t1.should be_active
+      t2.should_not be_active
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "search keyword by default" do
+    t1 = @pnir.new_tab("about:foobar")
+    begin
+      t1.selection_text.should be_empty
+
+      r = @grepnir.execute(args("foo"))
+      r.should == 0
+      t1.selection_text.should == "foo"
+    ensure
+      t1.close(true)
+    end
+  end
+
+  it "output matched title/url by default" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:foobar")
+    begin
+      @stdout.should be_empty
+      @stderr.should be_empty
+
+      t1.document.write("aqwsedrfgthyjuiklo")
+      t1.document.Title = "test test"
+      r = @grepnir.execute(args("aqwsedrfgthyjuiklo"))
+      r.should == 0
+      @stdout.should == "- * test test\n" +
+                        "  about:blank\n"
+      @stderr.should be_empty
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "execute with '-L' should navigate lock matched tab by default" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:foobar")
+    t3 = @pnir.new_tab("about:baz")
+    begin
+      t1.should_not be_navigate_lock
+      t2.should_not be_navigate_lock
+
+      r = @grepnir.execute(args("-L foo"))
+      r.should == 0
+      t1.should be_navigate_lock
+      t2.should be_navigate_lock
+      t3.should_not be_navigate_lock
+    ensure
+      t1.close(true)
+      t2.close(true)
+      t3.close(true)
+    end
+  end
+
+  it "execute with -v should perform invert match" do
+    t = @pnir.new_tab("about:foobar")
+    begin
+      t.should_not be_navigate_lock
+
+      r = @grepnir.execute(args("-L -v foobar"))
+      r.should == 1
+      t.should_not be_navigate_lock
+
+      r = @grepnir.execute(args("-L -v baz"))
+      r.should == 0
+      t.should be_navigate_lock
+    ensure
+      t.close(true)
+    end
+  end
+
+  it "execute with '--include xxx' #target_tab? should return properly" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz")
+
+    begin
+      ctx = @grepnir.prepare(args("--include foobar foo"))
+      @grepnir.target_tab?(ctx, t1).should be_true
+      @grepnir.target_tab?(ctx, t2).should be_false
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "execute with '--include xxx' twice #target_tab? should return properly" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz.com")
+    t3 = @pnir.new_tab("about:barbazDcom")
+
+    begin
+      ctx = @grepnir.prepare(args("--include foobar --include baz.com foo"))
+      @grepnir.target_tab?(ctx, t1).should be_true
+      @grepnir.target_tab?(ctx, t2).should be_true
+      @grepnir.target_tab?(ctx, t3).should be_false
+    ensure
+      t1.close(true)
+      t2.close(true)
+      t3.close(true)
+    end
+  end
+
+  it "execute with '--exclude xxx' #target_tab? should return properly" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz")
+
+    begin
+      ctx = @grepnir.prepare(args("--exclude foobar foo"))
+      @grepnir.target_tab?(ctx, t1).should be_false
+      @grepnir.target_tab?(ctx, t2).should be_true
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "execute with '--exclude xxx' twice #target_tab? should return properly" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz")
+    t3 = @pnir.new_tab("about:foofoo")
+
+    begin
+      ctx = @grepnir.prepare(args("--exclude foobar --exclude baz foo"))
+      @grepnir.target_tab?(ctx, t1).should be_false
+      @grepnir.target_tab?(ctx, t2).should be_false
+      @grepnir.target_tab?(ctx, t3).should be_true
+    ensure
+      t1.close(true)
+      t2.close(true)
+      t3.close(true)
+    end
+  end
+
+  it "execute with '--only-locked-tab' #target_tab? should return properly" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz")
+
+    begin
+      t1.navigate_lock = true
+      ctx = @grepnir.prepare(args("--only-locked-tab foo"))
+      @grepnir.target_tab?(ctx, t1).should be_true
+      @grepnir.target_tab?(ctx, t2).should be_false
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "execute with '--inlclude --exclude --l' #target_tab? should return properly" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:foobaz")
+    t3 = @pnir.new_tab("about:foofoo")
+
+    begin
+      t1.navigate_lock = true
+      ctx = @grepnir.prepare(args("-l --include foo --exclude baz kwd"))
+      @grepnir.target_tab?(ctx, t1).should be_true
+      @grepnir.target_tab?(ctx, t2).should be_false
+      @grepnir.target_tab?(ctx, t3).should be_false
+    ensure
+      t1.close(true)
+      t2.close(true)
+      t3.close(true)
+    end
+  end
+
+  it "execute with no match control flags, #target_tab? should return true always" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:foobaz")
+    t3 = @pnir.new_tab("about:foofoo")
+
+    begin
+      t1.navigate_lock = true
+      ctx = @grepnir.prepare(args(" kwd"))
+      @grepnir.target_tab?(ctx, t1).should be_true
+      @grepnir.target_tab?(ctx, t2).should be_true
+      @grepnir.target_tab?(ctx, t3).should be_true
+    ensure
+      t1.close(true)
+      t2.close(true)
+      t3.close(true)
+    end
+  end
+
+  it "execute with '--include xxx --exclude xxx', #target_tab? should return false" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:foobaz")
+
+    begin
+      t1.navigate_lock = true
+      ctx = @grepnir.prepare(args("--include foo --exclude foo kwd"))
+      @grepnir.target_tab?(ctx, t1).should be_false
+      @grepnir.target_tab?(ctx, t2).should be_false
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "execute with '--include xxx' should search only xxx" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz")
+
+    begin
+      r = @grepnir.execute(args("-L --include bar --exclude baz bar"))
+      r.should == 0
+      t1.should be_navigate_lock
+      t1.should be_active
+      t2.should_not be_navigate_lock
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+  it "execute with '--exclude xxx' should search without xxx" do
+    t1 = @pnir.new_tab("about:foobar")
+    t2 = @pnir.new_tab("about:barbaz")
+
+    begin
+      r = @grepnir.execute(args("-L --exclude about:foobar bar"))
+      r.should == 0
+      t1.should_not be_navigate_lock
+      t2.should be_active
+      t2.should be_navigate_lock
+    ensure
+      t1.close(true)
+      t2.close(true)
+    end
+  end
+
+end