kirchhoff 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b4685b6ac03e6611ca24f2337f79d12078ea07a
-  data.tar.gz: 87cc14431e9556168881c17e0d2ddd08255dcab4
+  metadata.gz: 987620edb1eac2879b10b1663a04a89d3cc8ea0d
+  data.tar.gz: 2621540bb8c27ce300067dafc6f30c168b771dc7
 SHA512:
-  metadata.gz: 2b7fe60b4f1676c657dac0c62f67cb75c2e0a16370732a5029a0ec462ad6a260d6af6b485dc7c5b6cc63f117f23a01f07bb7c91cfbcc5351fd85b12b312fb4e9
-  data.tar.gz: 962ae7e2550548e7bb6992ff575c9b0d04802daae0beafe32316e63dc098c66a65f1279907ab601de49f714571f2a51f53d9f82a7642d75094472a6c94ea5a90
+  metadata.gz: f720d18bad08fc12a77718ca2e6fbd1b3366b2e3d972403cae465d421f7226c4ce473a32cd0a40c9a3c003fc1d2d0e31deb07d57cd21655e96634a8dde47c9c6
+  data.tar.gz: a550ee96668b781d7dd9cae0e608009ba337bbb02b97bdeabade7efe192d8eeda6f11162d175c0bd0e92d6bc1ab3e561d34fb0f5162369cb55112fde4647d83e

data/README.md

@@ -8,11 +8,11 @@ Smart selenium base web driver written in Ruby.
 
 1. Install gem as you like.
 
-    $ gem install kirchhoff
+  $ gem install kirchhoff
 
 2. Install chromedriver. (Below is the MacOS example.)
 
-    $ brew install chromedriver
+  $ brew install chromedriver
 
 
 ## Demo
@@ -20,14 +20,20 @@ Smart selenium base web driver written in Ruby.
 ```rb
 require 'kirchhoff'
 
-driver = Kirchhoff::Driver.new('https://www.facebook.com/')
+driver = Kirchhoff::Driver.new
+driver.go 'https://www.facebook.com/'
 driver.find('input#email').fill('mail@gogotanaka.com')
 driver.find('input#pass').fill('password')
 driver.submit
 
-if driver.has_text?('メールアドレスが正しくありません')
-  # ログインエラー後の処理
-else
-  # ログイン成功時の処理
+driver.find_text('メールアドレスが正しくありません') do |e|
+  unless e
+    # If there is no text 'メールアドレスが正しくありません'
+  end
 end
+
+driver.wait_element("div#wait", timeout: 5)
+
+driver.wait_text("wait for you...", timeout: 5, maybe: false)
+#=> raise err if there is no text 'wait for you...'
 ```

data/lib/kirchhoff.rb

@@ -6,17 +6,9 @@ require 'kirchhoff/logger'
 
 module Kirchhoff
   class Driver
-    attr_accessor :__driver__, :default_timeout
-    attr_reader :log_dir_path
-    include Kirchhoff::CommonInterface
-
-    def find_element selector
-      @__driver__.find_element selector
-    end
+    attr_accessor :__driver__, :waiter
 
-    def find_elements selector
-      @__driver__.find_elements selector
-    end
+    include Kirchhoff::CommonInterface
 
     def current_url
       @__driver__.current_url
@@ -26,9 +18,13 @@ module Kirchhoff
       @__driver__.quit
     end
 
-    def initialize(browser: :chrome, default_timeout: 6)
-      @__driver__      = Selenium::WebDriver.for(browser)
-      @default_timeout = default_timeout
+    def reload
+      @__driver__.navigate.refresh
+    end
+
+    def initialize(browser: :chrome, timeout: 6)
+      @__driver__ = Selenium::WebDriver.for(browser)
+      @waiter     = Selenium::WebDriver::Wait.new(timeout: timeout)
     end
 
     def go url
@@ -36,15 +32,15 @@ module Kirchhoff
       Kirchhoff::Logger.call :info, "visiting #{url}..."
     end
 
-    def reload
-      @__driver__.navigate.refresh
-    end
-
     def submit
       $focus.submit
       Kirchhoff::Logger.call :info, "submit form ..."
     end
 
+    def to_html
+      attribute "outerHTML"
+    end
+
     def exec_js(js_code)
       @__driver__.execute_script js_code
     end
@@ -61,26 +57,24 @@ module Kirchhoff
       @__driver__.switch_to.window @__driver__.window_handles[num]
     end
 
-    def wait_element(selector, maybe: true, t: nil)
-      wait = Selenium::WebDriver::Wait.new(timeout: (t || @default_timeout))
-      wait.until { self.find_element(css: selector) }
-    rescue Selenium::WebDriver::Error::TimeOutError
-      unless maybe
-        raise Selenium::WebDriver::Error::TimeOutError, "selector: #{selector}"
-      end
+    def to_html
+      @__driver__.page_source
     end
 
-    def wait_text(text, maybe: true, t: nil)
-      wait = Selenium::WebDriver::Wait.new(timeout: (t || @default_timeout))
-      wait.until { self.find_element(xpath: "//*[text()[contains(.,\"#{text}\")]]") }
-    rescue Selenium::WebDriver::Error::TimeOutError
-      unless maybe
-        raise Selenium::WebDriver::Error::TimeOutError, "text: #{text}"
-      end
+    private def weak_find selector
+      @__driver__.find_element(css: selector)
     end
 
-    def to_html
-      self.__driver__.page_source
+    private def weak_multi_find selector
+      @__driver__.find_elements(css: selector)
+    end
+
+    private def weak_find_text text
+      @__driver__.find_element(xpath: "//*[text()[contains(.,\"#{text}\")]]")
+    end
+
+    private def weak_multi_find_text text
+      @__driver__.find_elements(xpath: "//*[text()[contains(.,\"#{text}\")]]")
     end
   end
 end
@@ -89,13 +83,25 @@ class Selenium::WebDriver::Element
   include Kirchhoff::CommonInterface
   alias :origin_click :click
 
-  def click
-    origin_click()
-  end
-
   def fill(text)
     $focus = self
     send_key(text)
     Kirchhoff::Logger.call :info, "fill '#{text}'"
   end
+
+  def to_html
+    attribute "outerHTML"
+  end
+
+  private def weak_find selector
+    self.find_element(css: selector)
+  end
+
+  private def weak_find_text text
+    self.find_elements(xpath: "//*[text()[contains(.,\"#{text}\")]]")
+  end
+
+  def waiter
+    Selenium::WebDriver::Wait.new(timeout: 5)
+  end
 end

data/lib/kirchhoff/common_interface.rb

@@ -1,41 +1,41 @@
 module Kirchhoff
   module CommonInterface
-    def find selector
-      e = self.find_element(css: selector).tap do
-        Kirchhoff::Logger.call :info, "find #{selector}..."
-      end
+    def find selector, maybe: true, wait: true
+      e = wait ? self.waiter.until { weak_find(selector) } : weak_find(selector)
+
+      Kirchhoff::Logger.call :info, "find #{selector}..."
 
       block_given? ? yield(e) : e
-    rescue Selenium::WebDriver::Error::NoSuchElementError
-      nil
+    rescue Selenium::WebDriver::Error::NoSuchElementError, Selenium::WebDriver::Error::TimeOutError
+      unless maybe
+        raise Selenium::WebDriver::Error::NoSuchElementError, "selector: #{selector}"
+      end
     end
 
     def multi_find selector
-      self.find_elements(css: selector).tap do |e|
+      weak_multi_find(selector).tap do
         Kirchhoff::Logger.call :info, "multi find #{selector}..."
       end
     end
 
-    def find_text text
-      e = self.find_element({xpath: "//*[text()[contains(.,\"#{text}\")]]"}).tap do
-        Kirchhoff::Logger.call :info, "find text '#{text}'..."
-      end
+    def find_text text, maybe: true, wait: true
+      e = wait ? self.waiter.until { weak_find_text(text) } : weak_find_text(text)
+
+      Kirchhoff::Logger.call :info, "find text '#{text}'..."
 
       block_given? ? yield(e) : e
-    rescue Selenium::WebDriver::Error::NoSuchElementError
-      nil
+    rescue Selenium::WebDriver::Error::NoSuchElementError, Selenium::WebDriver::Error::TimeOutError
+      unless maybe
+        raise Selenium::WebDriver::Error::NoSuchElementError, "text: #{text}"
+      end
     end
 
     def multi_find_text text
-      self.find_elements({xpath: "//*[text()[contains(.,\"#{text}\")]]"}).tap do |e|
+      weak_multi_find_text(text).tap do
         Kirchhoff::Logger.call :info, "multi find text '#{text}'..."
       end
     end
 
-    def to_html
-      attribute "outerHTML"
-    end
-
     def to_nokogiri
       Nokogiri::HTML self.to_html
     end

data/lib/kirchhoff/version.rb

@@ -1,3 +1,3 @@
 module Kirchhoff
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kirchhoff
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - gogotanaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver